Difference between revisions of "Skinning HowTo/XUI Other Widgets"
m (moved Skinning HowTo/XUI Widgets to Skinning HowTo/XUI Other Widgets: Splitting the page into smaller pieces.) |
|
(No difference)
| |
Revision as of 16:10, 7 September 2009
This page describes the XML attributes for the XUI widgets. These are 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. You can find attributes for other XUI elements at:
and you can find more general information at Skinning HowTo/Basics
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 XML parameters.
button parameters
- Class LLButton : LLUICtrl : LLView
- In source file llui/llbutton.cpp
- 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 true where the button size is not equal to 32x128.
Boolean: scale_image="true"
label
Optional. Label is the text on the button's face. Without a specified label (and no image_overlay declared), your button will be labeled "Button".
String: label="Click Me!"
label_selected
Optional. Label is the text on the button's face when pressed into an 'on' state. Your button will inherit the label if you omit this property.
String: label_selected="I've been clicked."
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: font_style="bold|underline|drop_shadow_soft"
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 ..\skins\textures directory within the Second Life application folder (on a Mac, this is inside the package at Contents/MacOS/Resources/skins/textures). Art must also be named in textures.xml with an assigned UUID. By default, the button art is stretched to fit the specified button size.
String: image_unselected="btn_square_32x128.tga"
image_selected
Optional. Overrides the default button art for the selected/down button state. Art must be located in the ..\skins\[SKIN]\textures directory within the Second Life application folder (on a Mac, this is inside the package at Contents/MacOS/Resources/skins/textures). By default, the button art is stretched to fit the specified button size.
String: image_selected="btn_square-down_32x128.tga"
image_hover_selected
Optional. Overrides the default button art for the selected/down and mouseover/hover button state. Art must be located in the ..\skins\textures directory within the Second Life application folder (on a Mac, this is inside the package at Contents/MacOS/Resources/skins/[SKIN]/textures). Art must also be named in textures.xml with an assigned UUID. By default, the button art is stretched to fit the specified button size.
String: image_unselected="btn_square-down-hover_32x128.tga"
image_hover_unselected
Optional. Overrides the default button art for the unselected/up and mouseover/hover button state. Art must be located in the ..\skins\[SKIN]\textures directory within the Second Life application folder (on a Mac, this is inside the package at Contents/MacOS/Resources/skins/[SKIN]/textures). Art must also be named in textures.xml with an assigned UUID. By default, the button art is stretched to fit the specified button size.
String: image_unselected="btn_square-up-hover_32x128.tga"
image_disabled
Optional. Overrides the default button art for the disabled button state. Art must be located in the ..\skins\textures directory within the Second Life application folder (on a Mac, this is inside the package at Contents/MacOS/Resources/skins/[SKIN]/textures). Art must also be named in textures.xml with an assigned UUID. By default, the button art is stretched to fit the specified button size.
String: image_unselected="btn_square-disabled_32x128.tga"
image_disabled_selected
Optional. Overrides the default button art for the disabled and selected/down button state. Art must be located in the ..\skins\[SKIN]\textures directory within the Second Life application folder (on a Mac, this is inside the package at Contents/MacOS/Resources/skins/textures). Art must also be named in textures.xml with an assigned UUID. By default, the button art is stretched to fit the specified button size.
String: image_unselected="btn_square-down-disabled_32x128.tga"
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 ..\skins\[SKIN]\textures directory within the Second Life application folder (on a Mac, this is inside the package at Contents/MacOS/Resources/skins/[SKIN]/textures). Art must also be named in textures.xml with an assigned UUID. See image_overlay_alignment for alignment options.
String: image_overlay="icn_media-play_16.tga"
image_overlay_alignment
Optional. Sets the alignment of the image_overlay 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: image_overlay_alignment="left"
toggle
Optional. Determines whether the button is a toggle button or not. The Fly/Stop Flying button is a toggle button, for example.
Boolean: toggle="false"
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.
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.
check_box parameters
- Class LLCheckBoxCtrl : LLUICtrl : LLView
- In source file llui/llcheckboxctrl.cpp
- 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.
visible
Optional.
tab_group
Optional.
halign
Optional.
border_drop_shadow_visible
Optional.
Optional.
max_length
Optional.
color_swatch parameters
- Class LLColorSwatchCtrl : LLUICtrl : LLView
- In source file newview/llcolorswatch.cpp
- 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.
combo_box parameters
- Class LLComboBox : LLUICtrl : LLView
- In source file llui/llcombobox.cpp
- 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.
combo_item parameters
- member of LLComboBox : LLUICtrl : LLView
- In source file llui/llcombobox.cpp
- Used by combo_box.
name
value
Optional.
type
Optional.
length
Optional.
enabled
Optional.
flyout_button parameters
- Class LLFlyoutButton : LLComboBox : LLUICtrl : LLView
- In source file llui/llcombobox.cpp
- 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.
flyout_button_item parameters
- member of LLFlyoutButton : LLComboBox : LLUICtrl : LLView
- In source file llui/llcombobox.cpp
- Used by flyout_button.
value
name
icon parameters
- Class LLIconCtrl : LLUICtrl : LLView
- In source file llui/lliconctrl.cpp
- 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.
String: image_name="myicon.png"
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.
inventory_panel parameters
- Class LLInventoryPanel : LLPanel : LLUICtrl : LLView
- In source file newview/llinventoryview.cpp
- 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.
joystick_turn parameters
- Class LLJoystickAgentTurn : LLJoystick : LLButton : LLUICtrl : LLView
- In source file newview/lljoystickbutton.cpp
- 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
- Class LLJoystickAgentSlide : LLJoystick : LLButton : LLUICtrl : LLView
- In source file newview/lljoystickbutton.cpp
- Used by floater.
bottom
left
enabled
follows
halign
height
width
image_selected
image_unselected
mouse_opaque
name
quadrant
scale_image
tool_tip
line_editor parameters
<line_editor> creates a single line text box
- Class LLLineEditor : LLUICtrl : LLView
- In source file llui/lllineeditor.cpp
- Used by floater, panel, and layout_panel.
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.
Optional.
is_unicode
Optional.
increment
Optional.
initial_val
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.
locate parameters
Also called <pad>.
- Class LLUICtrlLocate : LLUICtrl : LLView
- In source file llui/lluictrlfactory.cpp
- Used by panel.
bottom_delta
height
left_delta
name
width
multi_slider parameters
- Class LLMultiSlider : LLUICtrl : LLView
- In source file llui/llmultislider.cpp
- 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
name_editor parameters
- Class LLNameEditor : LLLineEditor : LLUICtrl : LLView
- In source file newview/llnameditor.cpp
- 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.
name_list parameters
- Class LLNameListCtrl : LLScrollListCtrl : LLUICtrl : LLView
- In source file newview/llnamelistctrl.cpp
- 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.
column parameters
- member of LLScrollListCtrl : LLUICtrl : LLView
- In source file newview/llnamelistctrl.cpp
- Used by name_list and scroll_list.
name
label
Optional.
sort
Optional.
width
Optional.
dynamicwidth
Optional.
relwidth
Optional.
image
Optional.
tool_tip
Optional.
user_resize
Optional.
pad parameters
Also called <locate>.
- Class LLUICtrlLocate : LLUICtrl : LLView
- in source file llui/lluictrlfactory.cpp
- Used by floater and panel.
height
width
Optional.
bottom
Optional.
left
Optional.
progress_bar parameters
- Class LLProgressBar : LLView
- In source file llui/llprogressbar.cpp
- Used by layout_panel.
name
color
height
bottom
left
right
follows
radio_group parameters
- Class LLRadioGroup : LLUICtrl : LLView
- In source file llui/llradiogroup.cpp
- 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.
radio_item parameters
- Class LLRadioItem : LLCheckBoxCtrl : LLUICtrl : LLView
- In source file llui/llradiogroup.cpp
- 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
scroll_container parameters
- Class LLScrollableContainerView : LLUICtrl : LLView
- in source file llui/llscrollcontainer.cpp
- Used by floater.
bottom
left
follows
height
width
mouse_opaque
opaque
name
scroll_list parameters
- Class LLScrollListCtrl : LLUICtrl : LLView
- In source file llui/llscrolllist.cpp
- Used by floater, panel, layout_stack, and layout_panel.
- Can contain column.
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.
column parameters
- member of LLNameListCtrl : LLScrollListCtrl : LLUICtrl : LLView
- In source file newview/llnamelistctrl.cpp
- Used by name_list and scroll_list.
name
label
Optional.
sort
Optional.
width
Optional.
dynamicwidth
Optional.
relwidth
Optional.
image
Optional.
tool_tip
Optional.
user_resize
Optional.
search_editor parameters
- Class LLSearchEditor : LLUICtrl : LLView
- In source file llui/lllineeditor.cpp
- Used by floater.
bottom
left
follows
height
width
label
Optional.
mouse_opaque
name
enabled
Optional.
slider parameters
- Class LLSliderCtrl : LLUICtrl : LLView
- In source file llui/llsliderctrl.cpp
- 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.
slider_bar parameters
- Class LLSlider : LLUICtrl : LLView
- In source file llui/llslider.cpp
- Used by panel.
bottom
enabled
follows
height
width
increment
initial_val
left
max_val
min_val
mouse_opaque
name
spinner parameters
- Class LLSpinCtrl : LLUICtrl : LLView
- In source file llui/llspinctrl.cpp
- 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.
string parameters
- member of LLPanel : LLUICtrl : LLView
- In source file llui/llpanel.cpp
- Used by floater, panel, and multi_floater.
name
word_wrap
Optional.
text parameters
- Class LLTextBox : LLUICtrl : LLView
- In source file llui/lltextbox.cpp
- 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.
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.
text_editor and simple_text_editor parameters
Both create a multi-line text box, but text_editor has more functionality
- Class LLViewerTextEditor : LLTextEditor : LLUICtrl : LLView
- In source file newview/llviewertexteditor.cpp
- Class LLTextEditor : LLUICtrl : LLView
- In source file llui/lltexteditor.cpp
- Used by floater, panel, and layout_panel.
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.
texture_picker parameters
- Class LLTextureCtrl : LLUICtrl : LLView
- In source file newview/lltexturectrl.cpp
- Used by floater and panel.
allow_no_texture
Optional.
bottom
Optional.
bottom_delta
Optional.
left
Optional.
left_delta
Optional.
right
Optional.
can_apply_immediately
Optional.
default_image_name
Optional.
enabled
Optional.
follows
Optional.
height
width
label
Optional.
mouse_opaque
Optional.
name
tool_tip
Optional.
visible
Optional.
view_border parameters
- Class LLViewBorder : LLView
- In source file llui/llviewborder.cpp
- 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.
volume_slider parameters
- Class LLSlider : LLUICtrl : LLView
- In source file llui/llslider.cpp
- Used by floater and panel.
bottom
Optional.
bottom_delta
Optional.
left
Optional.
left_delta
Optional.
follows
Optional.
height
width
increment
initial_val
max_val
min_val
name
mouse_opaque
Optional.
Optional.
enabled
Optional.
tool_tip
Optional.
control_name
Optional.
web_browser parameters
- Class LLWebBrowserCtrl : LLUICtrl : LLView
- In source file newview/llwebbrowserctrl.cpp
- 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.