Difference between revisions of "Skinning HowTo/XUI Other Widgets"

From Second Life Wiki
Jump to navigation Jump to search
 
(94 intermediate revisions by 4 users not shown)
Line 1: Line 1:
These are the XML elements and parameters used to define the floaters, panels, and so forth, that make up the viewer user interface.  They are used by the [[Skinning How To/The XML files and what they do | XUI files]] in the '''\skins\default\xui''' folders.  See [[Skinning HowTo/Basics]] for an explanation of how these are used.
{{XUI Nav}}
== Overview ==
This page describes the XML attributes for the XUI widgets that don't fit into any other category below.  These are some of the XML elements and parameters used within the floaters, panels, and so forth, that make up the viewer user interface.  They are used by the [[Skinning How To/The XML files and what they do | XUI files]] in the '''\skins\default\xui''' folders.   


== Common parameters ==
Many XUI elements share the same parameters.  Rather than repeatedly describing them, we just list their names here and describe them at [[Skinning HowTo/Common XUI attributes]].


The most common parameters are described here and are just listed under the elements that use them.
== icon ==


===== name =====
*Class LLIconCtrl : LLUICtrl : LLView
''Required.'' The XML name of this element. The name must be unique to the floater you are editing.  
*In source file llui/lliconctrl.cpp
*Used by floater, panel, layout_stack, layout_panel, multi_floater, and widgetset.


* IMPORTANT: As noted above, do not re-name XML elements, even for localization. Many of the element names are looked up by the viewer. If the viewer cannot find an element name it expects, it will crash.
<xml><?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<floater bottom="400" can_close="true" can_drag_on_left="false" can_minimize="true"
    can_resize="true" can_tear_off="false" enabled="true" follows="left|top"
    height="80" left="551" min_height="80" min_width="250" mouse_opaque="true"
    name="example_icon" tab_stop="false" title="icon" width="250">
    <icon bottom="20" color="1 0.5 0 1" enabled="true" height="30" left="10"
        mouse_opaque="false" name="icon" tab_stop="false" width="223"
        image_name="icon_day_cycle.tga" />
</floater></xml>


String: <code>name="input_first_name"</code>
===Common attributes===
===== width =====
*'''[[Skinning HowTo/Common XUI attributes#Used by all XUI elements|General]]:'''  name, mouse_opaque, tool_tip, control_name, enabled, visible, use_bounding_rect, default_tab_group
''Required.'' The width of the element, in pixels.
*'''[[Skinning HowTo/Common XUI attributes#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
*'''[[Skinning HowTo/Common XUI attributes#Text|Text]]:'''  label
*'''Others:''' [[Skinning HowTo/Common XUI attributes#border|border]]


For text, this defines the visible text as well as the clickable area. If the width of a text element is not sufficient to hold the text, the text will be truncated. This is most likely what you will widen when localizing the viewer.
===Special attributes===


For most other elements, this describes the dimensions of an element, such as a button, icon, panel, text_area, etc.
==== image_name ====
 
* Tip: See the bounding boxes of all XML elements in the viewer: ''Advanced'' menu > UI > Debug Views.
 
Integer: <code>width="140"</code>
===== height =====
''Required.'' The height of the element, in pixels.
 
For text, this defines the visible text as well as the clickable area. If the height of a text element is not sufficient to hold the text, the text will be truncated. This is most likely what you will lengthen when localizing the viewer.
 
For most other elements, this describes the dimensions of an element, such as a button, icon, panel, text_area, etc.
 
Integer: <code>height="24"</code>
===== left =====
''Optional.'' Sets the position in the x dimension of the ''element's'' <u>left edge</u> relative to the container's '''left''' edge. Positive and negative values are accepted. A negative value will set the position relative to the '''right''' edge of the container.
 
Integer: <code> left="6"</code>
 
===== right =====
''Optional.'' Sets the position in the x dimension of the ''element's'' <u>right edge</u> relative to the container's '''left''' edge. Positive and negative values are accepted.  A negative value will set the position relative to the '''right''' edge of the container.  Best used to align something to the right.
* For example, given a floater with a width of 500 and a button we wish to right align in the floater, we can set the <code>right</code> to 490 -- this puts the right edge of the button 10 pixels away from the right border of the floater.
 
Integer: <code> right="6"</code>
 
===== left_delta =====
''Optional. (use instead of <code>left</code>)'' Sets the position in the x dimension of the element's left edge relative to the previous element, or, for the first widget, the left edge of the container. Positive and negative values are accepted. Best used to left-align the current element with the previous element.
* For example, given Button B with a width of 100, a previous Button A with a width of 50 and a distance between elements of 6, we would set the <code>left_delta</code> to -106, putting the left edge of Button B 106 pixels to the left of Button A. We use a negative number to move left, and a positive number to move right.
 
Integer: <code> left_delta="-106"</code>
 
===== right_delta =====
''Optional. (use instead of <code>right</code>)'' Sets the position in the x dimension of the element's right edge relative to the previous element, or, for the first widget, the left edge of the container. Positive and negative values are accepted. Best used to right-align the current element with the previous element.
* For example, given Button B with a width of 100, a previous Button A with a width of 50 and a distance between elements of 6, we would set the <code>right_delta</code> to 106, putting the left edge of Button B 106 pixels to the left of Button A.
 
Integer: <code> left_delta="106"</code>
 
===== bottom =====
''Optional.'' Sets the position in the y dimension of the element's bottom edge relative to the container. Positive and negative values are accepted. For example, given a floater with a height of 300 and a title 20 pixels tall and we want , we can set the <code>bottom</code> to (NEED TO DO MATH, LOL) -- putting the bottom edge of the title 40 pixels away from the top border of the floater.
 
Integer: <code> bottom="(NEED TO DO MATH, LOL)"</code>
 
===== bottom_delta =====
 
===== follows =====
''Optional.'' Sets which edge(s) an element follows when the containing element is resized. Specifying all edges results in an element that can dynamically resize itself with its container.
 
Values: left, top, right, bottom. String multiple values together using pipes.
 
The following example sets an element to follow both the left and the top, such as a floater's title may be designed:
String: <code>follows="left|top"</code>
 
===== font =====
''Optional.'' Sets which size and style of the application font to use. The default is SansSerifSmall for <code>text</code> elements and SansSerif for controls (such as <code>check_box</code> and <code>button</code>.
 
Values: SansSerifSmall, SansSerif, SansSerifBig, SansSerifBold, Monospace
 
String: <code>font="SansSerifSmall"</code>
 
== Widgets With No Parameters ==
 
=== alerts ===
=== fonts ===
Can contain font and font_size.
=== file ===
Used by font and os.
=== defaultlabel ===
Used by mimetypes.
=== defaultwidget ===
Used by mimetypes.
=== defaultimpl ===
Used by mimetypes.
=== default_type ===
Used by widgetset.
=== allow_resize ===
Used by widgetset.
=== allow_looping ===
USed by widgetset.
=== widgettype ===
Used by scheme and mimetype.
=== impl ===
Used by mimetype.
=== notifications ===
Can contain global, notification, and template.
=== unique ===
Used by notification.
Can contain context.
=== role_actions ===
Can contain action_set.
=== strings ===
Can contain string.
=== teleport_messages ===
Can contain message_set.
=== xui_version ===
 
== Widget Parameters ==
 
 
=== floater parameters ===
----
Used by tab_container.
 
===== can_close =====
''Optional.''
===== can_drag_on_left =====
''Optional.''
===== can_minimize =====
''Optional.''
===== can_resize =====
===== height =====
''Optional.''
===== width =====
''Optional.''
===== max_height =====
''Optional.''
===== min_height =====
''Optional.''
===== min_width =====
''Optional.''
===== name =====
===== rect_control =====
''Optional.''
===== title =====
''Optional.''
===== bottom =====
''Optional.''
===== left =====
''Optional.''
===== can_tear_off =====
''Optional.''
===== enabled =====
''Optional.''
===== mouse_opaque =====
''Optional.''
===== control_name =====
''Optional.''
===== follows =====
''Optional.''
===== border =====
''Optional.''
===== default_tab_group =====
''Optional.''
===== label =====
''Optional.''
===== border_drop_shadow_visible =====
''Optional.''
===== border_visible =====
''Optional.''
===== border_style =====
''Optional.''
===== border_thickness =====
''Optional.''
===== border_bevel =====
''Optional.''
===== bevel_style =====
''Optional.''
===== short_title =====
''Optional.''
===== sound_flags =====
''Optional.''
 
=== multi_floater parameters ===
----
Can contain icon, string, tab_container, and panel.
===== can_close =====
===== can_drag_on_left =====
===== can_minimize =====
===== can_resize =====
===== height =====
===== width =====
===== min_height =====
''Optional.''
===== min_width =====
''Optional.''
===== name =====
===== rect_control =====
===== title =====
===== bottom =====
''Optional.''
===== left =====
''Optional.''
===== enabled =====
''Optional.''
===== follows =====
''Optional.''
===== mouse_opaque =====
''Optional.''
===== title_bar =====
''Optional.''
 
=== panel parameters ===
----
Used by floater, tab_container, layout_panel, multi_floater, and recursively by other panels.
===== border =====
''Optional.''
===== bottom =====
''Optional.''
===== bottom_delta =====
''Optional.''
===== top =====
''Optional.''
===== left =====
''Optional.''
===== left_delta =====
''Optional.''
===== right =====
''Optional.''
===== enabled =====
''Optional.''
===== follows =====
''Optional.''
===== height =====
''Optional.''
===== width =====
''Optional.''
===== label =====
''Optional.''
===== mouse_opaque =====
''Optional.''
===== name =====
''Optional.''
===== background_opaque =====
''Optional.''
===== background_visible =====
''Optional.''
===== bevel_style =====
''Optional.''
===== bg_alpha_color =====
''Optional.''
===== bg_opaque_color =====
''Optional.''
===== can_resize =====
''Optional.''
===== filename =====
''Optional.''
===== tab_group =====
''Optional.''
===== default_tab_group =====
''Optional.''
===== placeholder =====
''Optional.''
===== border_drop_shadow_visible =====
''Optional.''
===== border_visible =====
''Optional.''
===== border_style =====
''Optional.''
===== border_thickness =====
''Optional.''
===== border_color =====
''Optional.''
===== tool_tip =====
''Optional.''
===== title =====
''Optional.''
===== auto_resize =====
''Optional.''
===== user_resize =====
''Optional.''
===== use_bounding_rect =====
''Optional.''
===== bg_visible =====
''Optional.''
===== can_close =====
''Optional.''
===== can_minimize =====
''Optional.''
===== left_in_finder =====
''Optional.''
===== select =====
''Optional.''
===== visible =====
''Optional.''
 
=== menu parameters ===
----
Used by menu_bar and recursively by other menus.
Can contain menu, menu_item_call, menu_item_check, menu_item_separator, and tearoff_menu.
===== bottom_delta =====
''Optional.''
===== bottom =====
''Optional.''
===== left =====
''Optional.''
===== drop_shadow =====
''Optional.''
===== height =====
''Optional.''
===== width =====
''Optional.''
===== label =====
''Optional.''
===== mouse_opaque =====
===== opaque =====
===== name =====
===== tear_off =====
''Optional.''
===== enabled =====
''Optional.''
===== color =====
''Optional.''
===== create_jump_keys =====
''Optional.''
===== visible =====
''Optional.''
===== hidden =====
''Optional.''
 
=== menu_bar parameters ===
----
Used by floater and panel.
Can contain menu.
===== bottom =====
===== left =====
===== drop_shadow =====
===== follows =====
===== height =====
===== width =====
===== mouse_opaque =====
===== opaque =====
===== name =====
===== enabled =====
''Optional.''
===== tear_off =====
''Optional.''
 
 
=== pie_menu parameters ===
----
Used recursively by other pie_menus.
Can contain pie_menu.
===== name =====
===== label =====
''Optional.''
===== enabled =====
''Optional.''
 
=== mimetypes parameters ===
----
===== name =====
 
=== icon parameters ===
----
Used by floater, panel, layout_stack, layout_panel, multi_floater, and widgetset.
===== image_name =====
''Required.'' Specifies the name of the image to load for this icon.
''Required.'' Specifies the name of the image to load for this icon.


String: <code>image_name="myicon.png"</code>
String: <code>image_name="myicon.png"</code>
===== bottom =====
''Optional.''
===== bottom_delta =====
''Optional.''
===== top =====
''Optional.''
===== left =====
''Optional.''
===== left_delta =====
''Optional.''
===== right =====
''Optional.''
===== follows =====
''Optional.''
===== name =====
''Optional.''
===== color =====
''Optional.''
===== enabled =====
''Optional.''
===== height =====
''Optional.''
===== width =====
''Optional.''
===== mouse_opaque =====
''Optional.''
===== bg_alpha_color =====
''Optional.''
===== border =====
''Optional.''
===== scale_image =====
''Optional.''
===== auto_resize =====
''Optional.''
===== visible =====
''Optional.''
===== label =====
''Optional.''
===== tool_tip =====
''Optional.''


=== button parameters ===
==== color ====
----
Used by floater, panel, layout_stack, layout_panel, and form.
 
===== scale_image =====
''Optional.'' Specifies whether to scale the button art as its container/floater is resized. As of 1.18.x, all button art has this property set to <code>true</code> where the button size is not equal to 32x128.
 
Boolean: <code>scale_image="true"</code>
 
===== label =====
''Optional.'' Label is the text on the button's face. Without a specified label (and no <code>image_overlay</code> declared), your button will be labeled "Button".
String: <code>label="Click Me!" </code>
===== label_selected =====
''Optional.'' Label is the text on the button's face when pressed into an 'on' state. Your button will inherit the <code> label</code> if you omit this property.
String: <code>label_selected="I've been clicked." </code>
===== font =====
(under construction)
===== font_style =====
''Optional.'' Styles the text. Allows multiple style selections. As of 1.18.x, the style options are:
 
* normal: Apply the default styles of the selected font. (For example, SansSerifBold has a default bold style applied to it.)
* bold: Bolds the text.
* italic: Italicizes the text.
* underline: Underlines the text.
* drop_shadow: Old-style 1px offset of black under the text.
* drop_shadow_soft: New-style 3px offset of blurred shadow under the text.
 
String: <code>font_style="bold|underline|drop_shadow_soft"</code>
 
===== halign =====
''Optional.'' Controls horizontal alignment of label on button face.  Options are "left", "center" and "right".
 
===== image_unselected =====
''Optional.'' Overrides the default button art for the unselected/up and enabled button state. Art must be located in the <code>..\skins\textures</code> directory within the Second Life application folder (on a Mac, this is inside the package at <code>Contents/MacOS/Resources/skins/textures</code>). Art must also be named in <code>textures.xml</code> with an assigned UUID. By default, the button art is stretched to fit the specified button size.
 
String: <code>image_unselected="btn_square_32x128.tga"</code>
 
===== image_selected =====
''Optional.'' Overrides the default button art for the selected/down button state. Art must be located in the <code>..\skins\[SKIN]\textures</code> directory within the Second Life application folder (on a Mac, this is inside the package at <code>Contents/MacOS/Resources/skins/textures</code>). By default, the button art is stretched to fit the specified button size.
 
String: <code>image_selected="btn_square-down_32x128.tga"</code>
 
===== image_hover_selected =====
''Optional.'' Overrides the default button art for the selected/down and mouseover/hover button state. Art must be located in the <code>..\skins\textures</code> directory within the Second Life application folder (on a Mac, this is inside the package at <code>Contents/MacOS/Resources/skins/[SKIN]/textures</code>). Art must also be named in <code>textures.xml</code> with an assigned UUID. By default, the button art is stretched to fit the specified button size.
 
String: <code>image_unselected="btn_square-down-hover_32x128.tga"</code>
 
===== image_hover_unselected =====
''Optional.'' Overrides the default button art for the unselected/up and mouseover/hover button state. Art must be located in the <code>..\skins\[SKIN]\textures</code> directory within the Second Life application folder (on a Mac, this is inside the package at <code>Contents/MacOS/Resources/skins/[SKIN]/textures</code>). Art must also be named in <code>textures.xml</code> with an assigned UUID. By default, the button art is stretched to fit the specified button size.
 
String: <code>image_unselected="btn_square-up-hover_32x128.tga"</code>
 
===== image_disabled =====
''Optional.'' Overrides the default button art for the disabled button state. Art must be located in the <code>..\skins\textures</code> directory within the Second Life application folder (on a Mac, this is inside the package at <code>Contents/MacOS/Resources/skins/[SKIN]/textures</code>). Art must also be named in <code>textures.xml</code> with an assigned UUID. By default, the button art is stretched to fit the specified button size.
 
String: <code>image_unselected="btn_square-disabled_32x128.tga"</code>
 
===== image_disabled_selected =====
''Optional.'' Overrides the default button art for the disabled and selected/down button state. Art must be located in the <code>..\skins\[SKIN]\textures</code> directory within the Second Life application folder (on a Mac, this is inside the package at <code>Contents/MacOS/Resources/skins/textures</code>). Art must also be named in <code>textures.xml</code> with an assigned UUID. By default, the button art is stretched to fit the specified button size.
 
String: <code>image_unselected="btn_square-down-disabled_32x128.tga"</code>
 
===== image_overlay =====
''Optional.'' Applies an overlay image to the button. The button art will be sized to fit. As of 1.18.x, these icons should be 16 pixels high at maximum on a standard height 24px button to minimize scaling artifacts. Can be used with or without text. Art must be located in the <code>..\skins\[SKIN]\textures</code> directory within the Second Life application folder (on a Mac, this is inside the package at <code>Contents/MacOS/Resources/skins/[SKIN]/textures</code>). Art must also be named in <code>textures.xml</code> with an assigned UUID. See [[#image_overlay_alignment|image_overlay_alignment]] for alignment options.
 
String: <code>image_overlay="icn_media-play_16.tga"</code>
 
===== image_overlay_alignment =====
''Optional.'' Sets the alignment of the <code>image_overlay</code> icon.
 
Values:
* left: left-aligns the art on the button. This standard is used for new button art with text in the Dazzle branch.
* right: right-aligns the the art on the button.
* center: centers the art on the button. This standard is used for new button art without text in the Dazzle branch.
 
String: <code>image_overlay_alignment="left"</code>
 
===== toggle =====
''Optional.'' Determines whether the button is a toggle button or not. The Fly/Stop Flying button is a toggle button, for example.
 
Boolean: <code>toggle="false"</code>
 
===== bottom =====
''Optional.''
===== bottom_delta =====
''Optional.''
===== left =====
''Optional.''
===== left_delta =====
''Optional.''
===== right =====
''Optional.''
===== enabled =====
''Optional.''
===== follows =====
''Optional.''
===== height =====
''Optional.''
===== width =====
''Optional.''
===== mouse_opaque =====
''Optional.''
===== name =====
===== tool_tip =====
''Optional.''
===== visible =====
''Optional.''
===== tab_group =====
''Optional.''
===== pad_right =====
''Optional.''
''Optional.''
===== hidden =====
''Optional.''
===== tab_stop =====
''Optional.''
===== help_url =====
''Optional.''
===== sound_flags =====
''Optional.''
===== auto_resize =====
''Optional.''
===== user_resize =====
''Optional.''
===== valign =====
''Optional.''
===== default =====
''Optional.''
===== index =====
''Optional.''
===== text =====
''Optional.''
===== ignore =====
''Optional.''
===== control_name =====
''Optional.''
===== label_width =====
''Optional.''
===== image =====
''Optional.''
=== text_editor parameters ===
----
Used by floater, panel, and layout_panel.
<text_editor> creates a multi-line text box
===== max_length =====
''Optional. ''
===== embedded_items =====
''Optional. ''
===== font =====
''Optional. ''
===== word_wrap =====
''Optional. ''
===== hide_scrollbar =====
''Optional. ''
===== cursor_color =====
''Optional. ''
===== text_color =====
''Optional. ''
===== text_readonly_color =====
''Optional. ''
===== bg_readonly_color =====
''Optional. ''
===== bg_writeable_color =====
''Optional. ''
===== bg_focus_color =====
''Optional. ''
===== bottom =====
''Optional. ''
===== bottom_delta =====
''Optional. ''
===== left =====
''Optional. ''
===== left_delta =====
''Optional. ''
===== right =====
''Optional. ''
===== top =====
''Optional. ''
===== follows =====
''Optional. ''
===== height =====
''Optional. ''
===== width =====
''Optional. ''
===== max_length =====
''Optional. ''
===== mouse_opaque =====
''Optional. ''
===== name =====
===== type =====
''Optional. ''
===== bevel_style =====
''Optional. ''
===== border_style =====
''Optional. ''
===== border_thickness =====
''Optional. ''
===== enabled =====
''Optional. ''
===== handle_edit_keys_directly =====
''Optional. ''
===== select_all_on_focus_received =====
''Optional. ''
===== select_on_focus =====
''Optional. ''
===== length =====
''Optional. ''
===== track_bottom =====
''Optional. ''
===== ignore_tab =====
''Optional. ''
===== border_drop_shadow_visible =====
''Optional. ''
===== border_visible =====
''Optional. ''
===== show_line_numbers =====
''Optional. ''
===== allow_html =====
''Optional. ''
===== hide_border =====
''Optional. ''
===== tab_stop =====
''Optional. ''
===== is_unicode =====
''Optional. ''
===== bg_visible =====
''Optional. ''
===== drop_shadow_visible =====
''Optional. ''
===== h_pad =====
''Optional. ''
===== v_pad =====
''Optional. ''
===== halign =====
''Optional. ''
===== background_visible =====
''Optional. ''
===== text_wrap =====
''Optional. ''


=== line_editor parameters ===
==== bg_alpha_color ====
----
Used by floater, panel, and layout_panel.
<line_editor> creates a single line text box
===== label =====
''Optional.''
===== max_length =====
''Optional.''
===== font =====
''Optional.''
===== bevel_style =====
''Optional.''
* none
* in
* out
* bright
* line
* texture
===== border_style =====
''Optional.''
===== border_thickness =====
''Optional.''
===== select_on_focus =====
''Optional.''
===== select_all_focus_received =====
''Optional.''
===== handle_edit_keys_directly =====
''Optional.''
===== cursor_color =====
''Optional.''
===== text_color =====
''Optional.''
===== text_readonly_color =====
''Optional.''
===== bg_readonly_color =====
''Optional.''
===== bg_writeable_color =====
''Optional.''
===== bg_focus_color =====
''Optional.''
===== bottom =====
''Optional.''
===== left =====
''Optional.''
===== right =====
''Optional.''
===== enabled =====
''Optional.''
===== follows =====
''Optional.''
===== handle_edit_keys_directly =====
''Optional.''
===== height =====
===== width =====
''Optional.''
===== mouse_opaque =====
''Optional.''
===== name =====
===== bottom_delta =====
''Optional.''
===== tool_tip =====
''Optional.''
===== left_delta =====
''Optional.''
===== tab_group =====
''Optional.''
===== commit_on_focus_lost =====
''Optional.''
===== hidden =====
''Optional.''
===== is_unicode =====
''Optional.''
''Optional.''
===== increment =====
==== scale_image ====
''Optional.''
''Optional.''
===== initial_val =====
==== auto_resize ====
''Optional.''
===== max_val =====
''Optional.''
===== min_val =====
''Optional.''
===== visible =====
''Optional.''
===== bg_visible =====
''Optional.''
===== border_drop_shadow_visible =====
''Optional.''
===== border_visible =====
''Optional.''
===== drop_shadow_visible =====
''Optional.''
===== h_pad =====
''Optional.''
===== halign =====
''Optional.''
===== prevalidate =====
''Optional.''
===== v_pad =====
''Optional.''
===== word_wrap =====
''Optional.''
===== control_name =====
''Optional.''
''Optional.''


== inventory_panel ==


=== layout_panel parameters ===
*Class LLInventoryPanel : LLPanel : LLUICtrl : LLView
----
*In source file newview/llinventoryview.cpp
Used by layout_stack.
*Used by floater, panel, and tab_container.
Can contain button, check_box, combo_box, icon, layout_stack, line_editor, panel, progress_bar, scroll_list, text, text_editor, and web_browser. 
===== border =====
''Optional.''
===== bottom =====
''Optional.''
===== left =====
''Optional.''
===== top_delta =====
''Optional.''
===== default_tab_group =====
''Optional.''
===== height =====
''Optional.''
===== min_height =====
''Optional.''
===== width =====
===== min_width =====
''Optional.''
===== name =====
===== auto_resize =====
''Optional.''
===== can_resize =====
''Optional.''
===== user_resize =====
''Optional.''
===== filename =====
''Optional.''
===== visible =====
''Optional.''
===== follows =====
''Optional.''
===== background_visible =====
''Optional.''
===== mouse_opaque =====
''Optional.''
===== use_bounding_rect =====
''Optional.''


=== layout_stack parameters ===
<xml><?xml version="1.0" encoding="utf-8" standalone="yes" ?>
----
<floater bottom="400" can_close="true" can_drag_on_left="false" can_minimize="true"
Used by floater, panel, and layout_panel.
    can_resize="false" can_tear_off="false" enabled="true" follows="left|top"
Can contain button, flyout_button, icon, layout_panel, and scroll_list.
    height="300" left="550" min_height="300" min_width="250" mouse_opaque="true"
===== border =====
    name="example_inventory_panel" tab_stop="false" title="inventory_panel"
''Optional.''
    width="250">
===== bottom =====
    <inventory_panel allow_multi_select="true" border="true" bottom="20" enabled="true" height="250"
===== top =====
        left="20" mouse_opaque="true" name="inventory_panel" tab_stop="false"
''Optional.''
        width="215" />
===== left =====
</floater></xml>
===== right =====
''Optional.''
===== follows =====
===== height =====
''Optional.''
===== min_height =====
''Optional.''
===== width =====
''Optional.''
===== min_width =====
''Optional.''
===== orientation =====
''Optional.''
===== name =====
===== tab_group =====
''Optional.''
===== border_size =====
''Optional.''
===== mouse_opaque =====
''Optional.''
===== use_bounding_rect =====
''Optional.''


=== string parameters ===
===Common attributes===
----
*'''[[Skinning HowTo/Common XUI attributes#Used by all XUI elements|General]]:'''  name, mouse_opaque, tool_tip, control_name, enabled, visible, use_bounding_rect, default_tab_group
Used by floater, panel, multi_floater, and strings.
*'''[[Skinning HowTo/Common XUI attributes#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
===== name =====
*'''[[Skinning HowTo/Common XUI attributes#Text|Text]]:'''  label
===== word_wrap =====
*'''Others:''' [[Skinning HowTo/Common XUI attributes#border|border]]
''Optional.''


=== tab_container parameters ===
===Special attributes===
----
Used by floater, panel, and multi_floater.
Can contain inventory_panel, panel, and floater.
===== enabled =====
''Optional.''
===== follows =====
''Optional.''
===== height =====
''Optional.''
===== left =====
===== right =====
''Optional.''
===== top =====
''Optional.''
===== bottom =====
''Optional.''
===== bottom_delta =====
''Optional.''
===== mouse_opaque =====
''Optional.''
===== name =====
===== tab_position =====
===== width =====
''Optional.''
===== tab_width =====
''Optional.''
===== tab_min_width =====
''Optional.''
===== tab_max_width =====
''Optional.''
===== border =====
''Optional.''
===== tab_group =====
''Optional.''
===== hide_tabs =====
''Optional.''


==== allow_multi_select ====
==== sort_order ====


== locate  ==


=== text parameters ===
These are two tags that mean the same thing.
----
Used by floater, panel, and layout_panel.
===== type =====
''Optional.''
===== length =====
''Optional.''
===== width =====
''Optional.''
===== height =====
''Optional.''
===== bg_visible =====
''Optional.''
===== border_drop_shadow_visible =====
''Optional.''
===== drop_shadow_visible =====
''Optional.''
===== border_visible =====
''Optional.''
===== bottom =====
''Optional.''
===== bottom_delta =====
''Optional.''
===== top =====
''Optional.''
===== left =====
''Optional.''
===== left_delta =====
''Optional.''
===== right =====
''Optional.''
===== enabled =====
''Optional.''
===== follows =====
''Optional.''
===== font =====
''Optional.''
===== h_pad =====
''Optional.''
===== halign =====
''Optional.''
===== v_pad =====
''Optional.''
===== valign =====
''Optional.''
===== mouse_opaque =====
''Optional.''
===== name =====
''Optional.''
===== visible =====
''Optional.''
===== hidden =====
''Optional.''
===== tool_tip =====
''Optional.''
===== tab_stop =====
''Optional.''
===== initial_value =====
''Optional.''
===== label =====
''Optional.''
===== radio_style =====
''Optional.''
===== word_wrap =====
''Optional.''
===== control_name =====
''Optional.''
===== font_size =====
''Optional.''
===== font_style =====
''Optional.''
===== font-style =====
''Optional.''
===== bevel_style =====
''Optional.''
===== border_style =====
''Optional.''
===== border_thickness =====
''Optional.''
===== is_unicode =====
''Optional.''
===== max_length =====
''Optional.''
===== hover =====
''Optional.''
===== hover_cursor =====
''Optional.''
===== hover_color =====
''Optional.''
===== text_color =====
''Optional.''
===== align =====
''Optional.''
===== text_wrap =====
''Optional.''
===== text_enabled_color =====
''Optional.''
===== allow_html =====
''Optional.''
===== bg_readonly_color =====
''Optional.''
===== embedded_items =====
''Optional.''
===== hide_border =====
''Optional.''
===== hide_scrollbar =====
''Optional.''
===== line_spacing =====
''Optional.''
===== disabled_color =====
''Optional.''


=== message parameters ===
*Class LLUICtrlLocate : LLUICtrl : LLView
----
*In source file llui/lluictrlfactory.cpp
Used by message_set.
*Used by floater and panel.
===== name =====


=== message_set parameters ===
<xml><?xml version="1.0" encoding="utf-8" standalone="yes" ?>
----
<floater bottom="400" can_close="true" can_drag_on_left="false" can_minimize="true"
Used by teleport_messages.
    can_resize="true" can_tear_off="false" enabled="true" follows="left|top"
Can contain message.
    height="150" left="550" min_height="150" min_width="250" mouse_opaque="true"
===== name =====
    name="example_locate" tab_stop="false" title="locate" width="250">
    <locate bottom="100" enabled="true" left="20" mouse_opaque="false"
        name="locate" tab_stop="false" />
    <icon color="1 0.5 0 1" enabled="true" height="30"
        mouse_opaque="false" name="icon" tab_stop="false" width="210"
        image_name="icon_day_cycle.tga" />
</floater></xml>


=== action parameters ===
'''NOTE''': The pad element is deprecated and not used in Viewer2.
----
Used by action_set.
===== description =====
===== longdescription =====
===== name =====
===== value =====


=== action_set parameters ===
<xml><?xml version="1.0" encoding="utf-8" standalone="yes" ?>
----
<floater bottom="400" can_close="true" can_drag_on_left="false" can_minimize="true"
Used by role_actions.
    can_resize="true" can_tear_off="false" enabled="true" follows="left|top"
Can contain action.
    height="150" left="550" min_height="150" min_width="250" mouse_opaque="true"
===== description =====
    name="example_pad" tab_stop="false" title="pad" width="250">
===== name =====
    <pad bottom="100" enabled="true" left="20" mouse_opaque="false"
        name="pad" tab_stop="false" />
    <icon color="1 0.5 0 1" enabled="true" height="30"
        mouse_opaque="false" name="icon" tab_stop="false" width="210"
        image_name="icon_day_cycle.tga" />
</floater></xml>


=== progress_bar parameters ===
===Common attributes===
----
*'''[[Skinning HowTo/Common XUI attributes#Used by all XUI elements|General]]:'''  name, mouse_opaque, tool_tip, control_name, enabled, visible, use_bounding_rect, default_tab_group
Used by layout_panel.
*'''[[Skinning HowTo/Common XUI attributes#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
===== name =====
===== color =====
===== height =====
===== bottom =====
===== left =====
===== right =====
===== follows =====


=== slider_bar parameters ===
== progress_bar ==
----
Used by panel.
===== bottom =====
===== enabled =====
===== follows =====
===== height =====
===== width =====
===== increment =====
===== initial_val =====
===== left =====
===== max_val =====
===== min_val =====
===== mouse_opaque =====
===== name =====


=== locate parameters ===
*Class LLProgressBar : LLView
----
*In source file llui/llprogressbar.cpp
Used by panel.
*Used by layout_panel.
===== bottom_delta =====
===== height =====
===== left_delta =====
===== name =====
===== width =====


=== context parameters ===
<xml><?xml version="1.0" encoding="utf-8" standalone="yes" ?>
----
<floater bottom="400" can_close="true" can_drag_on_left="false" can_minimize="true"
Used by unique.
    can_resize="true" can_tear_off="false" enabled="true" follows="left|top"
===== key =====
    height="100" left="550" min_height="100" min_width="250" mouse_opaque="true"
    name="example_progress_bar" tab_stop="false" title="progress_bar"
    width="250">
    <progress_bar bottom="20" enabled="true" height="50" left="20" mouse_opaque="false"
        name="progress_bar" width="200" />
</floater></xml>


=== input parameters ===
===Common attributes===
----
*'''[[Skinning HowTo/Common XUI attributes#Used by all XUI elements|General]]:'''  name, mouse_opaque, tool_tip, control_name, enabled, visible, use_bounding_rect, default_tab_group
Used by form.
*'''[[Skinning HowTo/Common XUI attributes#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
===== name =====
===== type =====


=== form parameters ===
===Special attributes===
----
Used by template and notification.
Can contain button, ignore, and input.
===== name =====
''Optional.''


=== url parameters ===
==== color ====
----
Used by notification.
===== option =====
===== name =====


=== usetemplate parameters ===
== search_editor ==
----
Used by notification.
===== name =====
===== yestext =====
===== notext =====
''Optional.''
===== canceltext =====
''Optional.''
===== ignoretext =====
''Optional.''
 
=== notification parameters ===
----
Used by notifications.
Can contain form, unique, url, and usetemplate.
===== functor =====
''Optional.''
===== icon =====
===== name =====
===== label =====
''Optional.''
===== type =====
===== priority =====
''Optional.''
===== sound =====
''Optional.''
===== duration =====
''Optional.''
 
=== ignore parameters ===
----
Used by form.
===== text =====
===== name =====
''Optional.''
===== save_option =====
''Optional.''
 
=== template parameters ===
----
Used by notifications.
Can contain form.
===== name =====
 
=== global parameters ===
----
Used by notifications.
===== name =====
 
=== mimetype parameters ===
----
Used by mimetypes.
Can contain impl, label, and widgettype.
===== name =====
===== menu =====
''Optional.''
 
=== scheme parameters ===
----
Used by mimetypes.
Can contain label and widgettype.
===== name =====
 
=== playtip parameters ===
----
Used by widgetset.
===== name =====
 
=== tooltip parameters ===
----
Used by widgetset.
===== name =====
 
=== label parameters ===
----
Used by widgetset, scheme, mimetype.
===== name =====
 
=== widgetset parameters ===
----
Used by mimetypes.
Can contain allow_looping, allow_resize, default_type, icon, label, playtip, and tooltip. 
===== name =====
 
=== menu_item_check parameters ===
----
Used by menu.
Can contain on_check, on_click, and on_enable.
===== bottom_delta =====
''Optional.''
===== bottom =====
''Optional.''
===== left =====
===== control_name =====
''Optional.''
===== height =====
===== width =====
===== label =====
===== mouse_opaque =====
===== name =====
===== enabled =====
''Optional.''
===== shortcut =====
''Optional.''
 
=== menu_item_separator parameters ===
----
Used by menu and pie_menu.
===== bottom_delta =====
''Optional.''
===== bottom =====
''Optional.''
===== left =====
''Optional.''
===== height =====
''Optional.''
===== width =====
''Optional.''
===== label =====
''Optional.''
===== mouse_opaque =====
''Optional.''
===== name =====
''Optional.''
===== enabled =====
''Optional.''
 
=== menu_item_call parameters ===
----
Used by menu and pie_menu.
Can contain on_click, on_enable, and on_visible.
===== bottom_delta =====
''Optional.''
===== bottom =====
''Optional.''
===== left =====
''Optional.''
===== height =====
''Optional.''
===== width =====
''Optional.''
===== label =====
===== mouse_opaque =====
''Optional.''
===== name =====
===== enabled =====
''Optional.''
===== shortcut =====
''Optional.''
===== useMacCtrl =====
''Optional.''
===== visible =====
''Optional.''
===== hidden =====
''Optional.''


=== on_click parameters ===
*Class LLSearchEditor : LLUICtrl : LLView
----
*In source file llui/lllineeditor.cpp
Used by menu_item_call and menu_item_check.
*Used by floater.
===== filter =====
''Optional.''
===== function =====
===== userdata =====
===== name =====
''Optional.''
 
=== on_check parameters ===
----
Used by menu_item_check.
===== function =====
''Optional.''
===== userdata =====
''Optional.''
===== control =====
''Optional.''


=== on_visible parameters ===
<xml><?xml version="1.0" encoding="utf-8" standalone="yes" ?>
----
<floater bottom="400" can_close="true" can_drag_on_left="false" can_minimize="true"
Used by menu_item_call.
    can_resize="true" can_tear_off="false" enabled="true" follows="left|top"
===== function =====
    height="80" left="550" min_height="80" min_width="250" mouse_opaque="true"
    name="example_search_editor" tab_stop="false" title="search_editor"
    width="250">
    <search_editor bottom="20" enabled="true" height="20" left="20" mouse_opaque="true"
        name="search_editor" tab_stop="true" width="200" />
</floater></xml>


=== on_enable parameters ===
===Common attributes===
----
*'''[[Skinning HowTo/Common XUI attributes#Used by all XUI elements|General]]:'''  name, mouse_opaque, tool_tip, control_name, enabled, visible, use_bounding_rect, default_tab_group
Used by menu_item_call and menu_item_check.
*'''[[Skinning HowTo/Common XUI attributes#Positioning|Positioning]]:''' width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
===== function =====
*'''[[Skinning HowTo/Common XUI attributes#Text|Text]]:''' label
===== userdata =====
''Optional.''
===== name =====
''Optional.''


=== tearoff_menu parameters ===
== string  ==
----
Used by menu.
===== bottom =====
===== enabled =====
===== height =====
===== label =====
===== left =====
===== mouse_opaque =====
===== name =====
===== width =====


*member of LLPanel : LLUICtrl : LLView
*In source file llui/llpanel.cpp
*Used by floater, panel, and multi_floater.


=== os parameters ===
<xml><?xml version="1.0" encoding="utf-8" standalone="yes" ?>
----
<floater bottom="400" can_close="true" can_drag_on_left="false" can_minimize="true"
Used by font.
    can_resize="true" can_tear_off="false" enabled="true" follows="left|top"
Can contain file.
    height="200" left="550" min_height="50" min_width="50" mouse_opaque="true"
===== name =====
    name="example_string" tab_stop="false" title="string" width="250">
    <string name="string">String</string>
</floater></xml>


=== font parameters ===
==== name ====
----
==== word_wrap ====
Used by fonts.
Can contain file and os.
===== name =====
===== comment =====
===== font_style =====
''Optional.''
''Optional.''


== view_border  ==


=== font_size parameters ===
*Class LLViewBorder : LLView
----
*In source file llui/llviewborder.cpp
Used by fonts.
*Used by panel.
===== name =====
===== comment =====
===== size =====
 
=== joystick_turn parameters ===
----
Used by floater.
===== bottom =====
===== left =====
===== enabled =====
===== follows =====
===== halign =====
===== height =====
===== width =====
===== image_selected =====
===== image_unselected =====
===== mouse_opaque =====
===== name =====
===== quadrant =====
===== scale_image =====
===== tool_tip =====
 
=== joystick_slide parameters ===
----
Used by floater.
===== bottom =====
===== left =====
===== enabled =====
===== follows =====
===== halign =====
===== height =====
===== width =====
===== image_selected =====
===== image_unselected =====
===== mouse_opaque =====
===== name =====
===== quadrant =====
===== scale_image =====
===== tool_tip =====
 
 
 
=== search_editor parameters ===
----
Used by floater.
===== bottom =====
===== left =====
===== follows =====
===== height =====
===== width =====
===== label =====
''Optional.''
===== mouse_opaque =====
===== name =====
===== enabled =====
''Optional.''
 
=== name_editor parameters ===
----
Used by panel.
===== bevel_style =====
===== bg_readonly_color =====
''Optional.''
===== border_style =====
===== border_thickness =====
===== bottom =====
===== left_delta =====
===== follows =====
===== font =====
===== height =====
===== width =====
===== max_length =====
===== mouse_opaque =====
===== name =====
===== text_readonly_color =====
''Optional.''
===== enabled =====
''Optional.''
===== is_unicode =====
''Optional.''
 
=== web_browser parameters ===
----
Used by floater, panel, and layout_panel.
===== bottom =====
===== top =====
''Optional.''
===== left =====
===== right =====
''Optional.''
===== follows =====
===== font =====
''Optional.''
===== name =====
===== border_visible =====
''Optional.''
===== width =====
''Optional.''
===== height =====
''Optional.''
===== caret_color =====
''Optional.''
===== start_url =====
''Optional.''
===== embedded_items =====
''Optional.''
===== max_length =====
''Optional.''
===== mouse_opaque =====
''Optional.''
===== word_wrap =====
''Optional.''
===== ignore_ui_scale =====
''Optional.''
 
=== view_border parameters ===
----
Used by panel.
===== bevel_style =====
''Optional.''
===== border_thickness =====
''Optional.''
===== bottom_delta =====
''Optional.''
===== bottom =====
''Optional.''
===== left_delta =====
''Optional.''
===== left =====
''Optional.''
===== right =====
''Optional.''
===== follows =====
===== height =====
===== width =====
===== mouse_opaque =====
''Optional.''
===== name =====
''Optional.''
===== blevel_style =====
''Optional.''
===== border =====
''Optional.''
 
=== multi_slider parameters ===
----
Used by panel.
===== allow_overlap =====
===== bottom =====
===== left =====
===== can_edit_text =====
===== control_name =====
===== decimal_digits =====
===== draw_track =====
''Optional.''
===== follows =====
===== height =====
===== width =====
===== increment =====
===== initial_val =====
===== label =====
===== max_sliders =====
===== max_val =====
===== min_val =====
===== mouse_opaque =====
===== name =====
===== show_text =====
===== use_triangle =====
''Optional.''
===== value =====
 
=== scroll_container parameters ===
----
Used by floater.
===== bottom =====
===== left =====
===== follows =====
===== height =====
===== width =====
===== mouse_opaque =====
===== opaque =====
===== name =====
 
=== color_swatch parameters ===
----
Used by floater and panel.
===== border_color =====
''Optional.''
===== bottom =====
''Optional.''
===== bottom_delta =====
''Optional.''
===== left =====
''Optional.''
===== left_delta =====
''Optional.''
===== can_apply_immediately =====
===== color =====
''Optional.''
===== height =====
===== width =====
===== label =====
===== mouse_opaque =====
''Optional.''
===== name =====
===== tool_tip =====
''Optional.''
===== visible =====
''Optional.''
===== control_name =====
''Optional.''
===== enabled =====
''Optional.''
 
=== radio_item parameters ===
----
Used by radio_group.
===== type =====
''Optional.''
===== length =====
''Optional.''
===== height =====
===== width =====
''Optional.''
===== bottom =====
''Optional.''
===== bottom_delta =====
''Optional.''
===== left =====
''Optional.''
===== left_delta =====
''Optional.''
===== follows =====
''Optional.''
===== mouse_opaque =====
''Optional.''
===== name =====
 
=== radio_group parameters ===
----
Used by floater and panel.
Can contain radio_item.
===== bottom =====
''Optional.''
===== bottom_delta =====
''Optional.''
===== left =====
''Optional.''
===== left_delta =====
''Optional.''
===== right =====
''Optional.''
===== control_name =====
''Optional.''
===== draw_border =====
''Optional.''
===== follows =====
===== height =====
===== width =====
''Optional.''
===== mouse_opaque =====
''Optional.''
===== name =====
===== tool_tip =====
''Optional.''
===== label =====
''Optional.''
===== text_disabled_color =====
''Optional.''
===== enabled =====
''Optional.''
===== visible =====
''Optional.''
===== enabled =====
''Optional.''
===== tool_tip =====
''Optional.''
 
=== flyout_button_item parameters ===
----
Used by flyout_button.
===== value =====
===== name =====
 
=== flyout_button parameters ===
----
Used by floater, panel, and layout_stack.
Can contain flyout_button_item.
===== bottom =====
''Optional.''
===== bottom_delta =====
''Optional.''
===== left =====
''Optional.''
===== left_delta =====
''Optional.''
===== follows =====
===== height =====
===== halign =====
''Optional.''
===== width =====
===== label =====
===== label_selected =====
''Optional.''
===== list_position =====
''Optional.''
===== mouse_opaque =====
''Optional.''
===== name =====
===== tool_tip =====
===== font =====
''Optional.''
===== auto_resize =====
''Optional.''
===== user_resize =====
''Optional.''
===== enabled =====
''Optional.''
 
=== inventory_panel parameters ===
----
Used by floater, panel, and tab_container.
===== allow_multi_select =====
===== border =====
===== bottom =====
''Optional.''
===== bottom_delta =====
''Optional.''
===== left =====
''Optional.''
===== left_delta =====
''Optional.''
===== follows =====
===== height =====
===== width =====
===== mouse_opaque =====
===== name =====
===== sort_order =====
===== label =====
''Optional.''
===== enabled =====
''Optional.''
 
=== slider parameters ===
----
Used by floater and panel.
===== bottom_delta =====
''Optional.''
===== bottom =====
''Optional.''
===== left_delta =====
''Optional.''
===== left =====
''Optional.''
===== right =====
''Optional.''
===== follows =====
''Optional.''
===== height =====
===== width =====
''Optional.''
===== increment =====
===== initial_val =====
''Optional.''
===== label =====
''Optional.''
===== label_width =====
''Optional.''
===== max_val =====
===== min_val =====
===== name =====
===== show_text =====
''Optional.''
===== control_name =====
''Optional.''
===== decimal_digits =====
''Optional.''
===== can_edit_text =====
''Optional.''
===== enabled =====
''Optional.''
===== mouse_opaque =====
''Optional.''
===== value =====
''Optional.''
===== tool_tip =====
''Optional.''
===== volume =====
''Optional.''
===== edit_text =====
''Optional.''
 
=== pad parameters ===
----
Used by floater and panel.
===== height =====
===== width =====
''Optional.''
===== bottom =====
''Optional.''
===== left =====
''Optional.''


=== volume_slider parameters ===
<xml><?xml version="1.0" encoding="utf-8" standalone="yes" ?>
----
<floater bottom="400" can_close="true" can_drag_on_left="false" can_minimize="true"
Used by floater and panel.
    can_resize="true" can_tear_off="false" enabled="true" follows="left|top"
===== bottom =====
    height="80" left="550" min_height="80" min_width="250" mouse_opaque="true"
''Optional.''
    name="example_view_border" tab_stop="false" title="view_border" width="250">
===== bottom_delta =====
    <view_border bottom="20" enabled="true" height="20" left="20" mouse_opaque="false"
''Optional.''
        name="view_border" width="200" bevel_style="out" />
===== left =====
</floater></xml>
''Optional.''
===== left_delta =====
''Optional.''
===== follows =====
''Optional.''
===== height =====
===== width =====
===== increment =====
===== initial_val =====
===== max_val =====
===== min_val =====
===== name =====
===== mouse_opaque =====
''Optional.''
===== hidden =====
''Optional.''
===== enabled =====
''Optional.''
===== tool_tip =====
''Optional.''
===== control_name =====
''Optional.''


===Common attributes===
*'''[[Skinning HowTo/Common XUI attributes#Used by all XUI elements|General]]:'''  name, mouse_opaque, tool_tip, control_name, enabled, visible, use_bounding_rect, default_tab_group
*'''[[Skinning HowTo/Common XUI attributes#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
*'''Others:''' [[Skinning HowTo/Common XUI attributes#border|border]]


=== spinner parameters ===
===Special attributes===
----
Used by floater and panel.
===== bottom =====
''Optional.''
===== bottom_delta =====
''Optional.''
===== left =====
''Optional.''
===== left_delta =====
''Optional.''
===== right_delta =====
''Optional.''
===== decimal_digits =====
''Optional.''
===== enabled =====
''Optional.''
===== follows =====
''Optional.''
===== halign =====
''Optional.''
===== height =====
''Optional.''
===== width =====
''Optional.''
===== increment =====
''Optional.''
===== initial_val =====
''Optional.''
===== max_val =====
===== min_val =====
''Optional.''
===== name =====
===== tool_tip =====
''Optional.''
===== label =====
''Optional.''
===== label_width =====
''Optional.''
===== mouse_opaque =====
''Optional.''
===== control_name =====
''Optional.''
===== can_edit_text =====
''Optional.''
===== visible =====
''Optional.''
===== allow_text_entry =====
''Optional.''
===== text_enabled_color =====
''Optional.''
===== text_disabled_color =====
''Optional.''
===== bg_visible =====
''Optional.''
===== border_drop_shadow_visible =====
''Optional.''
===== border_visible =====
''Optional.''
===== drop_shadow_visible =====
''Optional.''
===== font =====
''Optional.''
===== h_pad =====
''Optional.''
===== v_pad =====
''Optional.''


=== texture_picker parameters ===
==== bevel_style ====
----
Used by floater and panel.
===== allow_no_texture =====
''Optional.''
===== bottom =====
''Optional.''
===== bottom_delta =====
''Optional.''
===== left =====
''Optional.''
===== left_delta =====
''Optional.''
''Optional.''
===== right =====
==== border_thickness ====
''Optional.''
''Optional.''
===== can_apply_immediately =====
==== blevel_style ====
''Optional.''
===== default_image_name =====
''Optional.''
===== enabled =====
''Optional.''
===== follows =====
''Optional.''
===== height =====
===== width =====
===== label =====
''Optional.''
===== mouse_opaque =====
''Optional.''
===== name =====
===== tool_tip =====
''Optional.''
===== visible =====
''Optional.''
''Optional.''


=== combo_item parameters ===
== web_browser  ==
----
Used by combo_box.
===== name =====
===== value =====
''Optional.''
===== type =====
''Optional.''
===== length =====
''Optional.''
===== enabled =====
''Optional.''


=== combo_box parameters ===
*Class LLWebBrowserCtrl : LLUICtrl : LLView
----
*In source file newview/llwebbrowserctrl.cpp
Used by floater, panel, and layout_panel.
*Used by floater, panel, and layout_panel.
Can contain combo_item.
===== allow_text_entry =====
''Optional.''
===== bottom =====
''Optional.''
===== bottom_delta =====
''Optional.''
===== left =====
''Optional.''
===== left_delta =====
''Optional.''
===== right =====
''Optional.''
===== enabled =====
''Optional.''
===== follows =====
''Optional.''
===== height =====
===== width =====
''Optional.''
===== length =====
''Optional.''
===== max_chars =====
''Optional.''
===== mouse_opaque =====
''Optional.''
===== name =====
===== visible =====
''Optional.''
===== tool_tip =====
''Optional.''
===== label =====
''Optional.''
===== tab_group =====
''Optional.''
===== control_name =====
''Optional.''
===== font =====
''Optional.''
===== initial_value =====
''Optional.''
===== halign =====
''Optional.''
===== max_length =====
''Optional.''
===== bg_readonly_color =====
''Optional.''
===== text_readonly_color =====
''Optional.''


=== column parameters ===
<xml><?xml version="1.0" encoding="utf-8" standalone="yes" ?>
----
<floater bottom="400" can_close="true" can_drag_on_left="false" can_minimize="true"
Used by name_list and scroll_list.
    can_resize="true" can_tear_off="false" enabled="true" follows="left|top"
===== name =====
    height="400" left="350" min_height="150" min_width="150" mouse_opaque="true"
===== label =====
    name="example_web_browser" tab_stop="false" title="web_browser" width="550">
''Optional.''
    <web_browser bottom="20" enabled="true" height="350" left="20" mouse_opaque="false"
===== sort =====
        name="web_browser" tab_stop="true" width="500" start_url="www.secondlife.com" follows="all" />
''Optional.''
</floater></xml>
===== width =====
''Optional.''
===== dynamicwidth =====
''Optional.''
===== relwidth =====
''Optional.''
===== image =====
''Optional.''
===== tool_tip =====
''Optional.''
===== user_resize =====
''Optional.''


=== scroll_list parameters ===
===Common attributes===
----
*'''[[Skinning HowTo/Common XUI attributes#Used by all XUI elements|General]]:''' name, mouse_opaque, tool_tip, control_name, enabled, visible, use_bounding_rect, default_tab_group
Used by floater, panel, layout_stack, and layout_panel.
*'''[[Skinning HowTo/Common XUI attributes#Positioning|Positioning]]:''' width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
Can contain column.
*'''[[Skinning HowTo/Common XUI attributes#Text|Text]]:''' font, font_size, font_style
===== bottom =====
''Optional.''
===== bottom_delta =====
''Optional.''
===== top =====
''Optional.''
===== left =====
===== right =====
''Optional.''
===== can_resize =====
''Optional.''
===== column_padding =====
''Optional.''
===== column_widths =====
''Optional.''
===== draw_heading =====
''Optional.''
===== draw_stripes =====
''Optional.''
===== draw_border =====
''Optional.''
===== follows =====
''Optional.''
===== multi_select =====
''Optional.''
===== name =====
===== search_column =====
''Optional.''
===== sort_column =====
''Optional.''
===== background_visible =====
''Optional.''
===== height =====
''Optional.''
===== width =====
''Optional.''
===== mouse_opaque =====
''Optional.''
===== enabled =====
''Optional.''
===== tab_group =====
''Optional.''
===== bg_selected_color =====
''Optional.''
===== fg_disable_color =====
''Optional.''
===== fg_selected_color =====
''Optional.''
===== fg_unselected_color =====
''Optional.''
===== tool_tip =====
''Optional.''
===== font =====
''Optional.''
===== heading_font =====
''Optional.''
===== heading_height =====
''Optional.''
===== allow_calling_card_drop =====
''Optional.''
===== tab_stop =====
''Optional.''
===== user_resize =====
''Optional.''
===== sort_ascending =====
''Optional.''


=== name_list parameters ===
===Special attributes===
----
Used by floater and panel.
Can contain column.
===== allow_calling_card_drop =====
''Optional.''
===== background_visible =====
''Optional.''
===== bottom =====
''Optional.''
===== bottom_delta =====
''Optional.''
===== left =====
''Optional.''
===== left_delta =====
''Optional.''
===== column_padding =====
''Optional.''
===== draw_border =====
''Optional.''
===== draw_heading =====
''Optional.''
===== draw_stripes =====
''Optional.''
===== enabled =====
''Optional.''
===== follows =====
''Optional.''
===== height =====
===== width =====
===== mouse_opaque =====
''Optional.''
===== multi_select =====
===== name =====
===== name_column_index =====
''Optional.''
===== heading_font =====
''Optional.''
===== heading_height =====
''Optional.''
===== tool_tip =====
''Optional.''
===== bg_selected_color =====
''Optional.''
===== fg_selected_color =====
''Optional.''
===== fg_disable_color =====
''Optional.''
===== fg_unselected_color =====
''Optional.''
===== background_opaque =====
''Optional.''
===== bg_alpha_color =====
''Optional.''
===== bg_opaque_color =====
''Optional.''


=== check_box parameters ===
==== border_visible ====
----
Used by floater, panel, and layout_panel.
===== bottom =====
''Optional.''
===== bottom_delta =====
''Optional.''
===== left =====
''Optional.''
===== left_delta =====
''Optional.''
===== right =====
''Optional.''
===== enabled =====
''Optional.''
===== follows =====
''Optional.''
===== font =====
''Optional.''
===== height =====
''Optional.''
===== width =====
''Optional.''
===== initial_value =====
''Optional.''
===== label =====
''Optional.''
===== mouse_opaque =====
''Optional.''
===== name =====
===== radio_style =====
''Optional.''
===== tool_tip =====
''Optional.''
===== tab_stop =====
''Optional.''
===== control_name =====
''Optional.''
''Optional.''
===== visible =====
==== caret_color ====
''Optional.''
''Optional.''
===== tab_group =====
==== start_url ====
''Optional.''
''Optional.''
===== halign =====
==== embedded_items ====
''Optional.''
''Optional.''
===== border_drop_shadow_visible =====
==== max_length ====
''Optional.''
''Optional.''
===== hidden =====
==== word_wrap ====
''Optional.''
''Optional.''
===== max_length =====
==== ignore_ui_scale ====
''Optional.''
''Optional.''

Latest revision as of 23:11, 24 May 2010

Overview

This page describes the XML attributes for the XUI widgets that don't fit into any other category below. These are some of the XML elements and parameters used within the floaters, panels, and so forth, that make up the viewer user interface. They are used by the XUI files in the \skins\default\xui folders.

Many XUI elements share the same parameters. Rather than repeatedly describing them, we just list their names here and describe them at Skinning HowTo/Common XUI attributes.

icon

  • Class LLIconCtrl : LLUICtrl : LLView
  • In source file llui/lliconctrl.cpp
  • Used by floater, panel, layout_stack, layout_panel, multi_floater, and widgetset.

<xml><?xml version="1.0" encoding="utf-8" standalone="yes" ?>

<floater bottom="400" can_close="true" can_drag_on_left="false" can_minimize="true"
    can_resize="true" can_tear_off="false" enabled="true" follows="left|top"
    height="80" left="551" min_height="80" min_width="250" mouse_opaque="true"
    name="example_icon" tab_stop="false" title="icon" width="250">
   <icon bottom="20" color="1 0.5 0 1" enabled="true" height="30" left="10"
        mouse_opaque="false" name="icon" tab_stop="false" width="223"
        image_name="icon_day_cycle.tga" />
</floater></xml>

Common attributes

  • General: name, mouse_opaque, tool_tip, control_name, enabled, visible, use_bounding_rect, default_tab_group
  • Positioning: width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
  • Text: label
  • Others: border

Special attributes

image_name

Required. Specifies the name of the image to load for this icon.

String: image_name="myicon.png"

color

Optional.

bg_alpha_color

Optional.

scale_image

Optional.

auto_resize

Optional.

inventory_panel

  • Class LLInventoryPanel : LLPanel : LLUICtrl : LLView
  • In source file newview/llinventoryview.cpp
  • Used by floater, panel, and tab_container.

<xml><?xml version="1.0" encoding="utf-8" standalone="yes" ?>

<floater bottom="400" can_close="true" can_drag_on_left="false" can_minimize="true"
    can_resize="false" can_tear_off="false" enabled="true" follows="left|top"
    height="300" left="550" min_height="300" min_width="250" mouse_opaque="true"
    name="example_inventory_panel" tab_stop="false" title="inventory_panel"
    width="250">
   <inventory_panel allow_multi_select="true" border="true" bottom="20" enabled="true" height="250"
        left="20" mouse_opaque="true" name="inventory_panel" tab_stop="false"
        width="215" />
</floater></xml>

Common attributes

  • General: name, mouse_opaque, tool_tip, control_name, enabled, visible, use_bounding_rect, default_tab_group
  • Positioning: width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
  • Text: label
  • Others: border

Special attributes

allow_multi_select

sort_order

locate

These are two tags that mean the same thing.

  • Class LLUICtrlLocate : LLUICtrl : LLView
  • In source file llui/lluictrlfactory.cpp
  • Used by floater and panel.

<xml><?xml version="1.0" encoding="utf-8" standalone="yes" ?>

<floater bottom="400" can_close="true" can_drag_on_left="false" can_minimize="true"
    can_resize="true" can_tear_off="false" enabled="true" follows="left|top"
    height="150" left="550" min_height="150" min_width="250" mouse_opaque="true"
    name="example_locate" tab_stop="false" title="locate" width="250">
   <locate bottom="100" enabled="true" left="20" mouse_opaque="false"
        name="locate" tab_stop="false" />
   <icon color="1 0.5 0 1" enabled="true" height="30"
        mouse_opaque="false" name="icon" tab_stop="false" width="210"
        image_name="icon_day_cycle.tga" />
</floater></xml>

NOTE: The pad element is deprecated and not used in Viewer2.

<xml><?xml version="1.0" encoding="utf-8" standalone="yes" ?>

<floater bottom="400" can_close="true" can_drag_on_left="false" can_minimize="true"
    can_resize="true" can_tear_off="false" enabled="true" follows="left|top"
    height="150" left="550" min_height="150" min_width="250" mouse_opaque="true"
    name="example_pad" tab_stop="false" title="pad" width="250">
   <pad bottom="100" enabled="true" left="20" mouse_opaque="false"
        name="pad" tab_stop="false" />
   <icon color="1 0.5 0 1" enabled="true" height="30"
        mouse_opaque="false" name="icon" tab_stop="false" width="210"
        image_name="icon_day_cycle.tga" />
</floater></xml>

Common attributes

  • General: name, mouse_opaque, tool_tip, control_name, enabled, visible, use_bounding_rect, default_tab_group
  • Positioning: width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control

progress_bar

  • Class LLProgressBar : LLView
  • In source file llui/llprogressbar.cpp
  • Used by layout_panel.

<xml><?xml version="1.0" encoding="utf-8" standalone="yes" ?>

<floater bottom="400" can_close="true" can_drag_on_left="false" can_minimize="true"
    can_resize="true" can_tear_off="false" enabled="true" follows="left|top"
    height="100" left="550" min_height="100" min_width="250" mouse_opaque="true"
    name="example_progress_bar" tab_stop="false" title="progress_bar"
    width="250">
   <progress_bar bottom="20" enabled="true" height="50" left="20" mouse_opaque="false"
        name="progress_bar" width="200" />
</floater></xml>

Common attributes

  • General: name, mouse_opaque, tool_tip, control_name, enabled, visible, use_bounding_rect, default_tab_group
  • Positioning: width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control

Special attributes

color

search_editor

  • Class LLSearchEditor : LLUICtrl : LLView
  • In source file llui/lllineeditor.cpp
  • Used by floater.

<xml><?xml version="1.0" encoding="utf-8" standalone="yes" ?>

<floater bottom="400" can_close="true" can_drag_on_left="false" can_minimize="true"
    can_resize="true" can_tear_off="false" enabled="true" follows="left|top"
    height="80" left="550" min_height="80" min_width="250" mouse_opaque="true"
    name="example_search_editor" tab_stop="false" title="search_editor"
    width="250">
   <search_editor bottom="20" enabled="true" height="20" left="20" mouse_opaque="true"
        name="search_editor" tab_stop="true" width="200" />
</floater></xml>

Common attributes

  • General: name, mouse_opaque, tool_tip, control_name, enabled, visible, use_bounding_rect, default_tab_group
  • Positioning: width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
  • Text: label

string

  • member of LLPanel : LLUICtrl : LLView
  • In source file llui/llpanel.cpp
  • Used by floater, panel, and multi_floater.

<xml><?xml version="1.0" encoding="utf-8" standalone="yes" ?>

<floater bottom="400" can_close="true" can_drag_on_left="false" can_minimize="true"
    can_resize="true" can_tear_off="false" enabled="true" follows="left|top"
    height="200" left="550" min_height="50" min_width="50" mouse_opaque="true"
    name="example_string" tab_stop="false" title="string" width="250">
   <string name="string">String</string>
</floater></xml>

name

word_wrap

Optional.

view_border

  • Class LLViewBorder : LLView
  • In source file llui/llviewborder.cpp
  • Used by panel.

<xml><?xml version="1.0" encoding="utf-8" standalone="yes" ?>

<floater bottom="400" can_close="true" can_drag_on_left="false" can_minimize="true"
    can_resize="true" can_tear_off="false" enabled="true" follows="left|top"
    height="80" left="550" min_height="80" min_width="250" mouse_opaque="true"
    name="example_view_border" tab_stop="false" title="view_border" width="250">
   <view_border bottom="20" enabled="true" height="20" left="20" mouse_opaque="false"
        name="view_border" width="200" bevel_style="out" />
</floater></xml>

Common attributes

  • General: name, mouse_opaque, tool_tip, control_name, enabled, visible, use_bounding_rect, default_tab_group
  • Positioning: width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
  • Others: border

Special attributes

bevel_style

Optional.

border_thickness

Optional.

blevel_style

Optional.

web_browser

  • Class LLWebBrowserCtrl : LLUICtrl : LLView
  • In source file newview/llwebbrowserctrl.cpp
  • Used by floater, panel, and layout_panel.

<xml><?xml version="1.0" encoding="utf-8" standalone="yes" ?>

<floater bottom="400" can_close="true" can_drag_on_left="false" can_minimize="true"
    can_resize="true" can_tear_off="false" enabled="true" follows="left|top"
    height="400" left="350" min_height="150" min_width="150" mouse_opaque="true"
    name="example_web_browser" tab_stop="false" title="web_browser" width="550">
   <web_browser bottom="20" enabled="true" height="350" left="20" mouse_opaque="false"
        name="web_browser" tab_stop="true" width="500" start_url="www.secondlife.com" follows="all" />
</floater></xml>

Common attributes

  • General: name, mouse_opaque, tool_tip, control_name, enabled, visible, use_bounding_rect, default_tab_group
  • Positioning: width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
  • Text: font, font_size, font_style

Special attributes

border_visible

Optional.

caret_color

Optional.

start_url

Optional.

embedded_items

Optional.

max_length

Optional.

word_wrap

Optional.

ignore_ui_scale

Optional.