Difference between revisions of "XUI Reference"
Jump to navigation
Jump to search
Rand Linden (talk | contribs) |
Rand Linden (talk | contribs) |
||
(3 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{XUI Nav}} | {{XUI Nav}} | ||
NOTE: The set of possible container widgets in the following table is not complete. | |||
{| class="lltable" border=1 | {| class="lltable" border=1 | ||
Line 10: | Line 12: | ||
|[[Skinning_HowTo/XUI Buttons, Sliders, and Spinners#button|button]] | |[[Skinning_HowTo/XUI Buttons, Sliders, and Spinners#button|button]] | ||
| [[Skinning_HowTo/XUI_Containers#panel|panel]], [[Skinning_HowTo/XUI_Containers#layout_panel|layout_panel]] | | [[Skinning_HowTo/XUI_Containers#panel|panel]], [[Skinning_HowTo/XUI_Containers#layout_panel|layout_panel]] | ||
| | |Button widget | ||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Selection Widgets#check_box|check_box]] | |[[Skinning_HowTo/XUI Selection Widgets#check_box|check_box]] | ||
|[[Skinning_HowTo/XUI_Containers#panel|panel]] | |[[Skinning_HowTo/XUI_Containers#panel|panel]] | ||
| | |Check box widget | ||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Selection Widgets#color_swatch|color_swatch]] | |[[Skinning_HowTo/XUI Selection Widgets#color_swatch|color_swatch]] | ||
|[[Skinning_HowTo/XUI_Containers#panel|panel]] | |[[Skinning_HowTo/XUI_Containers#panel|panel]] | ||
|Container for other widgets | |||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Selection Widgets#column|column]] | |[[Skinning_HowTo/XUI Selection Widgets#column|column]] | ||
|row | |row | ||
|For layout | |||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Selection Widgets#combo_box|combo_box]] | |[[Skinning_HowTo/XUI Selection Widgets#combo_box|combo_box]] | ||
| | |[[Skinning_HowTo/XUI_Containers#floater|floater]] | ||
|Combo-box (drop-down selection) widget | |||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Selection Widgets#combo_item|combo_item]] | |[[Skinning_HowTo/XUI Selection Widgets#combo_item|combo_item]] | ||
| | |[[Skinning_HowTo/XUI Selection Widgets#combo_box|combo_box]] | ||
|-- | |-- | ||
|[[Skinning_HowTo/XUI_Containers#floater|floater]] | |[[Skinning_HowTo/XUI_Containers#floater|floater]] | ||
| | |N/A (top-level) | ||
|A free-floating window within the Viewer UI. | |||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Buttons, Sliders, and Spinners#flyout_button|flyout_button]] | |[[Skinning_HowTo/XUI Buttons, Sliders, and Spinners#flyout_button|flyout_button]] | ||
|[[Skinning_HowTo/XUI_Containers#panel|panel]] | |||
|[[Skinning_HowTo/ | |||
| | | | ||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Other Widgets#icon|icon]] | |[[Skinning_HowTo/XUI Other Widgets#icon|icon]] | ||
| | |[[Skinning_HowTo/XUI_Containers#panel|panel]] | ||
|Displays a graphical icon image. | |||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Other Widgets#inventory_panel|inventory_panel]] | |[[Skinning_HowTo/XUI Other Widgets#inventory_panel|inventory_panel]] | ||
|[[Skinning_HowTo/XUI_Containers#tab_container|tab_container]] | |||
|[[Skinning_HowTo/ | |||
| | | | ||
|-- | |-- | ||
|[[Skinning_HowTo/XUI_Containers#layout_stack|layout_stack]] | |[[Skinning_HowTo/XUI_Containers#layout_stack|layout_stack]] | ||
|[[Skinning_HowTo/XUI_Containers#panel|panel]] | |||
| | | | ||
|-- | |-- | ||
|[[Skinning_HowTo/XUI_Containers#layout_panel|layout_panel]] | |[[Skinning_HowTo/XUI_Containers#layout_panel|layout_panel]] | ||
|[[Skinning_HowTo/XUI_Containers#layout_stack|layout_stack]], [[Skinning_HowTo/XUI_Containers#panel|panel]] | |||
| | | | ||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Text Entry Widgets#line_editor|line_editor]] | |[[Skinning_HowTo/XUI Text Entry Widgets#line_editor|line_editor]] | ||
|[[Skinning_HowTo/XUI_Containers#panel|panel]] | |||
| | | | ||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Other Widgets#locate|locate]] | |[[Skinning_HowTo/XUI Other Widgets#locate|locate]] | ||
|[[Skinning_HowTo/XUI_Containers#panel|panel]] | |||
| | | | ||
|-- | |-- | ||
|[[Skinning_HowTo/XUI_Menus#menu|menu]] | |[[Skinning_HowTo/XUI_Menus#menu|menu]] | ||
| | |[[Skinning_HowTo/XUI_Menus#menu_bar|menu_bar]] | ||
|An drop-down menu (e.g. File) | |||
|-- | |-- | ||
|[[Skinning_HowTo/XUI_Menus#menu_bar|menu_bar]] | |[[Skinning_HowTo/XUI_Menus#menu_bar|menu_bar]] | ||
| | |[[Skinning_HowTo/XUI_Containers#panel|panel]] | ||
|Set of menus arranged in a horizontal bar | |||
|-- | |||
|[[Skinning_HowTo/XUI_Menus#menu_item_call|menu_item_call]] | |||
|[[Skinning_HowTo/XUI_Menus#menu|menu]] | |||
|An individual menu item (e.g. Open on the File menu) | |||
|-- | |-- | ||
|[[Skinning_HowTo/XUI_Menus#menu_item_check|menu_item_check]] | |[[Skinning_HowTo/XUI_Menus#menu_item_check|menu_item_check]] | ||
|[[Skinning_HowTo/XUI_Menus#menu|menu]] | |||
| | | | ||
|-- | |-- | ||
|[[Skinning_HowTo/XUI_Menus#menu_item_separator|menu_item_separator]] | |[[Skinning_HowTo/XUI_Menus#menu_item_separator|menu_item_separator]] | ||
|[[Skinning_HowTo/XUI_Menus#menu|menu]] | |||
|Horizontal line between menu items | |||
|[[Skinning_HowTo/XUI_Menus# | |||
| | |||
|-- | |-- | ||
|[[Skinning_HowTo/XUI_Containers#multi_floater|multi_floater]] | |[[Skinning_HowTo/XUI_Containers#multi_floater|multi_floater]] | ||
| | |N/A (top-level) | ||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Buttons, Sliders, and Spinners#multi_slider|multi_slider]] | |[[Skinning_HowTo/XUI Buttons, Sliders, and Spinners#multi_slider|multi_slider]] | ||
|[[Skinning_HowTo/XUI_Containers#panel|panel]] | |||
|See example in Day Cycle Editor. | |||
|[[Skinning_HowTo/ | |||
| | |||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Selection Widgets#name_list|name_list]] | |[[Skinning_HowTo/XUI Selection Widgets#name_list|name_list]] | ||
| | |[[Skinning_HowTo/XUI_Containers#panel|panel]] | ||
|Displays a list of Resident names. | |||
|-- | |-- | ||
|[[Skinning_HowTo/XUI_Menus#on_check|on_check]] | |[[Skinning_HowTo/XUI_Menus#on_check|on_check]] | ||
| | |[[Skinning_HowTo/XUI_Menus#menu_item_check|menu_item_check]] | ||
|Function to call when menu item is checked. | |||
|-- | |-- | ||
|[[Skinning_HowTo/XUI_Menus#on_click|on_click]] | |[[Skinning_HowTo/XUI_Menus#on_click|on_click]] | ||
|[[Skinning_HowTo/XUI_Menus#menu_item_call|menu_item_call]] | |||
|Function to call when menu item is clicked. | |||
|[[Skinning_HowTo/XUI_Menus# | |||
| | |||
|-- | |-- | ||
|[[Skinning_HowTo/XUI_Menus#on_enable|on_enable]] | |[[Skinning_HowTo/XUI_Menus#on_enable|on_enable]] | ||
| | |[[Skinning_HowTo/XUI_Menus#menu_item_call|menu_item_call]] | ||
|Function to call when menu item is enabled. | |||
|-- | |-- | ||
|[[Skinning_HowTo/XUI_Containers#panel|panel]] | |[[Skinning_HowTo/XUI_Containers#panel|panel]] | ||
| | |[[Skinning_HowTo/XUI_Containers#floater|floater]], [[Skinning_HowTo/XUI_Containers#layout_panel|layout_panel]] | ||
|Contains other widgets. | |||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Other Widgets#progress_bar|progress_bar]] | |[[Skinning_HowTo/XUI Other Widgets#progress_bar|progress_bar]] | ||
| | | [[Skinning_HowTo/XUI_Containers#panel|panel]], [[Skinning_HowTo/XUI_Containers#layout_panel|layout_panel]] | ||
|Progress bar widget. | |||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Selection Widgets#radio_group|radio_group]] | |[[Skinning_HowTo/XUI Selection Widgets#radio_group|radio_group]] | ||
| | | [[Skinning_HowTo/XUI_Containers#panel|panel]], [[Skinning_HowTo/XUI_Containers#layout_panel|layout_panel]] | ||
|Group of radio buttons, of which only one can be selected. | |||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Selection Widgets#radio_item|radio_item]] | |[[Skinning_HowTo/XUI Selection Widgets#radio_item|radio_item]] | ||
| | |[[Skinning_HowTo/XUI Selection Widgets#radio_group|radio_group]] | ||
|Single radio button in a radio group. | |||
|-- | |-- | ||
Line 152: | Line 159: | ||
|-- | |-- | ||
|[[Skinning_HowTo/XUI_Containers#scroll_container|scroll_container]] | |[[Skinning_HowTo/XUI_Containers#scroll_container|scroll_container]] | ||
| [[Skinning_HowTo/XUI_Containers#panel|panel]], [[Skinning_HowTo/XUI_Containers#layout_panel|layout_panel]] | |||
| | | | ||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Selection Widgets#scroll_list|scroll_list]] | |[[Skinning_HowTo/XUI Selection Widgets#scroll_list|scroll_list]] | ||
| [[Skinning_HowTo/XUI_Containers#panel|panel]], [[Skinning_HowTo/XUI_Containers#layout_panel|layout_panel]] | |||
| | | | ||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Other Widgets#search_editor|search_editor]] | |[[Skinning_HowTo/XUI Other Widgets#search_editor|search_editor]] | ||
| | | [[Skinning_HowTo/XUI_Containers#panel|panel]] | ||
|See World Map (floater_world_map.xml) for example. | |||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Buttons, Sliders, and Spinners#slider|slider]] | |[[Skinning_HowTo/XUI Buttons, Sliders, and Spinners#slider|slider]] | ||
| | | [[Skinning_HowTo/XUI_Containers#panel|panel]] | ||
|Slider widget | |||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Buttons, Sliders, and Spinners#slider_bar|slider_bar]] | |[[Skinning_HowTo/XUI Buttons, Sliders, and Spinners#slider_bar|slider_bar]] | ||
| [[Skinning_HowTo/XUI_Containers#panel|panel]] | |||
| | | | ||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Buttons, Sliders, and Spinners#spinner|spinner]] | |[[Skinning_HowTo/XUI Buttons, Sliders, and Spinners#spinner|spinner]] | ||
| [[Skinning_HowTo/XUI_Containers#panel|panel]] | |||
| | | | ||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Other Widgets#string|string]] | |[[Skinning_HowTo/XUI Other Widgets#string|string]] | ||
| | | [[Skinning_HowTo/XUI_Containers#panel|panel]] | ||
|Defines a text string to be displayed. | |||
|-- | |-- | ||
|[[Skinning_HowTo/XUI_Containers#tab_container|tab_container]] | |[[Skinning_HowTo/XUI_Containers#tab_container|tab_container]] | ||
| [[Skinning_HowTo/XUI_Containers#panel|panel]] | |||
| | | | ||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Selection Widgets#texture_picker|texture_picker]] | |[[Skinning_HowTo/XUI Selection Widgets#texture_picker|texture_picker]] | ||
| | | [[Skinning_HowTo/XUI_Containers#panel|panel]] | ||
|Texture picker widget. | |||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Text Entry Widgets#text|text]] | |[[Skinning_HowTo/XUI Text Entry Widgets#text|text]] | ||
| [[Skinning_HowTo/XUI_Containers#panel|panel]], [[Skinning_HowTo/XUI_Containers#layout_panel|layout_panel]] | |||
| | | | ||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Text Entry Widgets#text_editor|text_editor]] | |[[Skinning_HowTo/XUI Text Entry Widgets#text_editor|text_editor]] | ||
| [[Skinning_HowTo/XUI_Containers#panel|panel]] | |||
| | | | ||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Other Widgets#view_border|view_border]] | |[[Skinning_HowTo/XUI Other Widgets#view_border|view_border]] | ||
| [[Skinning_HowTo/XUI_Containers#panel|panel]] | |||
| Specifies border for container panel. | |||
|[[Skinning_HowTo/ | |||
| | |||
|-- | |-- | ||
|[[Skinning_HowTo/XUI Other Widgets#web_browser|web_browser]] | |[[Skinning_HowTo/XUI Other Widgets#web_browser|web_browser]] | ||
| | | [[Skinning_HowTo/XUI_Containers#panel|panel]], [[Skinning_HowTo/XUI_Containers#layout_panel|layout_panel]] | ||
| The built-in Webkit-based web browser. | |||
|} | |} |
Latest revision as of 15:44, 26 May 2010
NOTE: The set of possible container widgets in the following table is not complete.
Widget | Container widget | Description |
---|---|---|
button | panel, layout_panel | Button widget |
check_box | panel | Check box widget |
color_swatch | panel | Container for other widgets |
column | row | For layout |
combo_box | floater | Combo-box (drop-down selection) widget |
combo_item | combo_box | |
floater | N/A (top-level) | A free-floating window within the Viewer UI. |
flyout_button | panel | |
icon | panel | Displays a graphical icon image. |
inventory_panel | tab_container | |
layout_stack | panel | |
layout_panel | layout_stack, panel | |
line_editor | panel | |
locate | panel | |
menu | menu_bar | An drop-down menu (e.g. File) |
menu_bar | panel | Set of menus arranged in a horizontal bar |
menu_item_call | menu | An individual menu item (e.g. Open on the File menu) |
menu_item_check | menu | |
menu_item_separator | menu | Horizontal line between menu items |
multi_floater | N/A (top-level) | |
multi_slider | panel | See example in Day Cycle Editor. |
name_list | panel | Displays a list of Resident names. |
on_check | menu_item_check | Function to call when menu item is checked. |
on_click | menu_item_call | Function to call when menu item is clicked. |
on_enable | menu_item_call | Function to call when menu item is enabled. |
panel | floater, layout_panel | Contains other widgets. |
progress_bar | panel, layout_panel | Progress bar widget. |
radio_group | panel, layout_panel | Group of radio buttons, of which only one can be selected. |
radio_item | radio_group | Single radio button in a radio group. |
row | scroll_list | |
scroll_container | panel, layout_panel | |
scroll_list | panel, layout_panel | |
search_editor | panel | See World Map (floater_world_map.xml) for example. |
slider | panel | Slider widget |
slider_bar | panel | |
spinner | panel | |
string | panel | Defines a text string to be displayed. |
tab_container | panel | |
texture_picker | panel | Texture picker widget. |
text | panel, layout_panel | |
text_editor | panel | |
view_border | panel | Specifies border for container panel. |
web_browser | panel, layout_panel | The built-in Webkit-based web browser. |