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

From Second Life Wiki
Jump to navigation Jump to search
(→‎Common parameters: Moved to new page: Skinning HowTo/Common XUI XML parameters)
Line 4: Line 4:


== Common parameters ==
== Common parameters ==
The most common parameters are described here and are just listed under the elements that use them.
===== name =====
''Required.'' The XML name of this element. The name must be unique to the floater you are editing.
* 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.
String: <code>name="input_first_name"</code>
===== width =====
''Required.'' The width of the element, in pixels.
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.
For most other elements, this describes the dimensions of an element, such as a button, icon, panel, text_area, etc.
* 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>
===== mouse_opaque =====
===== enabled =====
===== label =====
===== tool_tip =====
===== visible =====
===== control_name =====
===== tab_group =====
===== border =====
===== top =====


== XUI Text Parameters ==
== XUI Text Parameters ==

Revision as of 10:56, 20 June 2009

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. See Skinning HowTo/Basics for an explanation of how these are used.

Many widgets use the same XML parameters. Rather than repeating them for every widget, they are described separately in Skinning HowTo/Common XUI XML parameters and just listed under the elements that use them.

Common parameters

XUI Text Parameters

XUI Containers Parameters

XUI Menus Parameters

XUI Widgets Parameters

button parameters

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.

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.

check_box parameters

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.

hidden

Optional.

max_length

Optional.

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.

combo_box parameters

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

Used by combo_box.

name
value

Optional.

type

Optional.

length

Optional.

enabled

Optional.

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.


flyout_button_item parameters

Used by flyout_button.

value
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.

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

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

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

line_editor parameters

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.

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

Used by panel.

bottom_delta
height
left_delta
name
width

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

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.

name_list parameters

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

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

Used by floater and panel.

height
width

Optional.

bottom

Optional.

left

Optional.

progress_bar parameters

Used by layout_panel.

name
color
height
bottom
left
right
follows

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.

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

scroll_container parameters

Used by floater.

bottom
left
follows
height
width
mouse_opaque
opaque
name

scroll_list parameters

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

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

Used by floater.

bottom
left
follows
height
width
label

Optional.

mouse_opaque
name
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.

slider_bar parameters

Used by panel.

bottom
enabled
follows
height
width
increment
initial_val
left
max_val
min_val
mouse_opaque
name

spinner parameters

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

Used by floater, panel, multi_floater, and strings.

name
word_wrap

Optional.

text parameters

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.

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.

texture_picker parameters

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

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

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.

hidden

Optional.

enabled

Optional.

tool_tip

Optional.

control_name

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.

Retrieved from "https://wiki.secondlife.com/w/index.php?title=Skinning_HowTo/XUI_Other_Widgets&oldid=399523"