Difference between revisions of "Skinning HowTo/XUI Containers"

From Second Life Wiki
Jump to: navigation, search
(tab_container parameters)
Line 1: Line 1:
This page describes the XML attributes for the XUI containers.  They are used by the [[Skinning How To/The XML files and what they do | XUI files]] in the '''\skins\default\xui''' folders.  You can find attributes for other XUI elements at:
+
{{XUI Nav}}
*[[Skinning HowTo/XUI Menus]]
+
== Overview ==
*[[Skinning HowTo/XUI Buttons, Sliders, and Spinners]]
+
This page describes the XML attributes for the XUI containers.  They are used by the [[Skinning How To/The XML files and what they do | XUI files]] in the '''\skins\default\xui''' folders.   
*[[Skinning HowTo/XUI Selection Widgets]]
+
*[[Skinning HowTo/XUI Text Entry Widgets]]
+
*[[Skinning HowTo/XUI Other Widgets]]
+
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]].
 
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]].
  
=== floater parameters ===
+
== floater parameters ==
----
+
 
 
*Used by tab_container.
 
*Used by tab_container.
 
*Class LLFloater
 
*Class LLFloater
Line 22: Line 18:
 
  </floater>
 
  </floater>
  
====Common parameters====
+
===Common parameters===
 
*'''[[Skinning HowTo/Common XUI XML parameters#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 XML parameters#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 XML parameters#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
 
*'''[[Skinning HowTo/Common XUI XML parameters#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
Line 28: Line 24:
 
*'''Others:''' [[Skinning HowTo/Common XUI XML parameters#border|border]]
 
*'''Others:''' [[Skinning HowTo/Common XUI XML parameters#border|border]]
  
====Specific parameters====
+
===Specific parameters===
  
===== can_close =====
+
==== can_close ====
 
''Optional.''
 
''Optional.''
===== can_drag_on_left =====
+
==== can_drag_on_left ====
 
''Optional.''
 
''Optional.''
===== can_minimize =====
+
==== can_minimize ====
 
''Optional.''
 
''Optional.''
===== can_resize =====
+
==== can_resize ====
  
===== can_tear_off =====
+
==== can_tear_off ====
 
''Optional.''
 
''Optional.''
  
===== max_height =====
+
==== max_height ====
 
''Optional.''
 
''Optional.''
===== min_height =====
+
==== min_height ====
 
''Optional.''
 
''Optional.''
===== min_width =====
+
==== min_width ====
 
''Optional.''
 
''Optional.''
  
===== title =====
+
==== title ====
 
''Optional.''
 
''Optional.''
===== short_title =====
+
==== short_title ====
 
''Optional.''
 
''Optional.''
  
===== border_drop_shadow_visible =====
+
==== border_drop_shadow_visible ====
 
''Optional.''
 
''Optional.''
===== border_visible =====
+
==== border_visible ====
 
''Optional.''
 
''Optional.''
===== border_style =====
+
==== border_style ====
 
''Optional.''
 
''Optional.''
===== border_thickness =====
+
==== border_thickness ====
 
''Optional.''
 
''Optional.''
===== border_bevel =====
+
==== border_bevel ====
 
''Optional.''
 
''Optional.''
===== bevel_style =====
+
==== bevel_style ====
 
''Optional.''
 
''Optional.''
  
=== multi_floater parameters ===
+
== multi_floater parameters ==
----
+
 
 
*Can contain icon, string, tab_container, and panel.
 
*Can contain icon, string, tab_container, and panel.
  
====Common parameters====
+
===Common parameters===
 
*'''[[Skinning HowTo/Common XUI XML parameters#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 XML parameters#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 XML parameters#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
 
*'''[[Skinning HowTo/Common XUI XML parameters#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
  
====Specific parameters====
+
===Specific parameters===
  
===== can_close =====
+
==== can_close ====
===== can_drag_on_left =====
+
==== can_drag_on_left ====
===== can_minimize =====
+
==== can_minimize ====
===== can_resize =====
+
==== can_resize ====
  
===== min_height =====
+
==== min_height ====
 
''Optional.''
 
''Optional.''
===== min_width =====
+
==== min_width ====
 
''Optional.''
 
''Optional.''
  
===== title =====
+
==== title ====
  
===== title_bar =====
+
==== title_bar ====
 
''Optional.''
 
''Optional.''
  
=== panel parameters ===
+
== panel parameters ==
----
+
 
 
*Used by floater, tab_container, layout_panel, multi_floater, and recursively by other panels.
 
*Used by floater, tab_container, layout_panel, multi_floater, and recursively by other panels.
 
*Class LLPanel
 
*Class LLPanel
 
*In source file llui/llpanel.cpp
 
*In source file llui/llpanel.cpp
  
====Common parameters====
+
===Common parameters===
 
*'''[[Skinning HowTo/Common XUI XML parameters#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 XML parameters#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 XML parameters#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
 
*'''[[Skinning HowTo/Common XUI XML parameters#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
Line 103: Line 99:
 
*'''Others:'''  [[Skinning HowTo/Common XUI XML parameters#tab_group|tab_group]], [[Skinning HowTo/Common XUI XML parameters#border|border]]
 
*'''Others:'''  [[Skinning HowTo/Common XUI XML parameters#tab_group|tab_group]], [[Skinning HowTo/Common XUI XML parameters#border|border]]
  
====Specific parameters====
+
===Specific parameters===
  
===== background_opaque =====
+
==== background_opaque ====
 
''Optional.''
 
''Optional.''
===== background_visible =====
+
==== background_visible ====
 
''Optional.''
 
''Optional.''
===== bevel_style =====
+
==== bevel_style ====
 
''Optional.''
 
''Optional.''
===== bg_visible =====
+
==== bg_visible ====
 
''Optional.''
 
''Optional.''
===== bg_alpha_color =====
+
==== bg_alpha_color ====
 
''Optional.''
 
''Optional.''
===== bg_opaque_color =====
+
==== bg_opaque_color ====
 
''Optional.''
 
''Optional.''
===== can_resize =====
+
==== can_resize ====
 
''Optional.''
 
''Optional.''
===== can_close =====
+
==== can_close ====
 
''Optional.''
 
''Optional.''
===== can_minimize =====
+
==== can_minimize ====
 
''Optional.''
 
''Optional.''
===== filename =====
+
==== filename ====
 
''Optional.''
 
''Optional.''
===== placeholder =====
+
==== placeholder ====
 
''Optional.''
 
''Optional.''
===== border_drop_shadow_visible =====
+
==== border_drop_shadow_visible ====
 
''Optional.''
 
''Optional.''
===== border_visible =====
+
==== border_visible ====
 
''Optional.''
 
''Optional.''
===== border_style =====
+
==== border_style ====
 
''Optional.''
 
''Optional.''
===== border_thickness =====
+
==== border_thickness ====
 
''Optional.''
 
''Optional.''
===== border_color =====
+
==== border_color ====
 
''Optional.''
 
''Optional.''
===== title =====
+
==== title ====
 
''Optional.''
 
''Optional.''
===== auto_resize =====
+
==== auto_resize ====
 
''Optional.''
 
''Optional.''
===== user_resize =====
+
==== user_resize ====
 
''Optional.''
 
''Optional.''
===== left_in_finder =====
+
==== left_in_finder ====
 
''Optional.''
 
''Optional.''
===== select =====
+
==== select ====
 
''Optional.''
 
''Optional.''
  
  
=== layout_stack parameters ===
+
== layout_stack parameters ==
----
+
 
 
*Used by floater, panel, and layout_panel.
 
*Used by floater, panel, and layout_panel.
 
*Can contain button, flyout_button, icon, layout_panel, and scroll_list.
 
*Can contain button, flyout_button, icon, layout_panel, and scroll_list.
Line 173: Line 169:
 
  </floater>
 
  </floater>
  
====Common parameters====
+
===Common parameters===
 
*'''[[Skinning HowTo/Common XUI XML parameters#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 XML parameters#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 XML parameters#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
 
*'''[[Skinning HowTo/Common XUI XML parameters#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
 
*'''Others:'''  [[Skinning HowTo/Common XUI XML parameters#tab_group|tab_group]], [[Skinning HowTo/Common XUI XML parameters#border|border]]
 
*'''Others:'''  [[Skinning HowTo/Common XUI XML parameters#tab_group|tab_group]], [[Skinning HowTo/Common XUI XML parameters#border|border]]
  
====Specific parameters====
+
===Specific parameters===
  
===== min_height =====
+
==== min_height ====
 
''Optional.''
 
''Optional.''
===== min_width =====
+
==== min_width ====
 
''Optional.''
 
''Optional.''
===== orientation =====
+
==== orientation ====
 
''Optional.''
 
''Optional.''
===== border_size =====
+
==== border_size ====
 
''Optional.''
 
''Optional.''
  
=== layout_panel parameters ===
+
== layout_panel parameters ==
----
+
 
 
*Used by layout_stack.
 
*Used by layout_stack.
 
*Can contain button, check_box, combo_box, icon, layout_stack, line_editor, panel, progress_bar, scroll_list, text, text_editor, and web_browser.   
 
*Can contain button, check_box, combo_box, icon, layout_stack, line_editor, panel, progress_bar, scroll_list, text, text_editor, and web_browser.   
 
* In source file llui/llpanel.cpp
 
* In source file llui/llpanel.cpp
  
====Common parameters====
+
===Common parameters===
 
*'''[[Skinning HowTo/Common XUI XML parameters#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 XML parameters#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 XML parameters#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
 
*'''[[Skinning HowTo/Common XUI XML parameters#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
Line 201: Line 197:
 
*'''Others:''' [[Skinning HowTo/Common XUI XML parameters#border|border]]
 
*'''Others:''' [[Skinning HowTo/Common XUI XML parameters#border|border]]
  
====Specific parameters====
+
===Specific parameters===
  
===== min_height =====
+
==== min_height ====
 
''Optional.''
 
''Optional.''
===== min_width =====
+
==== min_width ====
 
''Optional.''
 
''Optional.''
===== auto_resize =====
+
==== auto_resize ====
 
''Optional.''
 
''Optional.''
===== can_resize =====
+
==== can_resize ====
 
''Optional.''
 
''Optional.''
===== user_resize =====
+
==== user_resize ====
 
''Optional.''
 
''Optional.''
===== filename =====
+
==== filename ====
 
''Optional.''
 
''Optional.''
===== background_visible =====
+
==== background_visible ====
 
''Optional.''
 
''Optional.''
  
=== scroll_container parameters ===
+
== scroll_container parameters ==
----
+
 
 
*Used by floater.
 
*Used by floater.
 
*Can contain panel.
 
*Can contain panel.
Line 239: Line 235:
 
  </floater>
 
  </floater>
  
====Common parameters====
+
===Common parameters===
 
*'''[[Skinning HowTo/Common XUI XML parameters#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 XML parameters#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 XML parameters#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
 
*'''[[Skinning HowTo/Common XUI XML parameters#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
  
====Specific parameters====
+
===Specific parameters===
 +
 
 +
==== opaque ====
  
===== opaque =====
+
== tab_container parameters ==
  
=== tab_container parameters ===
 
----
 
 
*Used by floater, panel, and multi_floater.
 
*Used by floater, panel, and multi_floater.
 
*Can contain inventory_panel, panel, and floater.
 
*Can contain inventory_panel, panel, and floater.
Line 269: Line 265:
 
  </floater>
 
  </floater>
  
====Common parameters====
+
===Common parameters===
 
*'''[[Skinning HowTo/Common XUI XML parameters#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 XML parameters#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 XML parameters#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
 
*'''[[Skinning HowTo/Common XUI XML parameters#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
 
*'''Others:'''  [[Skinning HowTo/Common XUI XML parameters#tab_group|tab_group]], [[Skinning HowTo/Common XUI XML parameters#border|border]]
 
*'''Others:'''  [[Skinning HowTo/Common XUI XML parameters#tab_group|tab_group]], [[Skinning HowTo/Common XUI XML parameters#border|border]]
  
====Specific parameters====
+
===Specific parameters===
  
===== tab_position =====
+
==== tab_position ====
  
===== tab_width =====
+
==== tab_width ====
 
''Optional.''
 
''Optional.''
===== tab_min_width =====
+
==== tab_min_width ====
 
''Optional.''
 
''Optional.''
===== tab_max_width =====
+
==== tab_max_width ====
 
''Optional.''
 
''Optional.''
===== hide_tabs =====
+
==== hide_tabs ====
 
''Optional.''
 
''Optional.''

Revision as of 16:15, 14 May 2010

Contents

Overview

This page describes the XML attributes for the XUI containers. 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 XML parameters.

floater parameters

  • Used by tab_container.
  • Class LLFloater
  • In source file llui/llfloater.cpp
<?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_floater" tab_stop="false" title="floater" width="250">
</floater>

Common parameters

  • 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

Specific parameters

can_close

Optional.

can_drag_on_left

Optional.

can_minimize

Optional.

can_resize

can_tear_off

Optional.

max_height

Optional.

min_height

Optional.

min_width

Optional.

title

Optional.

short_title

Optional.

border_drop_shadow_visible

Optional.

border_visible

Optional.

border_style

Optional.

border_thickness

Optional.

border_bevel

Optional.

bevel_style

Optional.

multi_floater parameters

  • Can contain icon, string, tab_container, and panel.

Common parameters

  • 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

Specific parameters

can_close

can_drag_on_left

can_minimize

can_resize

min_height

Optional.

min_width

Optional.

title

title_bar

Optional.

panel parameters

  • Used by floater, tab_container, layout_panel, multi_floater, and recursively by other panels.
  • Class LLPanel
  • In source file llui/llpanel.cpp

Common parameters

  • 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: tab_group, border

Specific parameters

background_opaque

Optional.

background_visible

Optional.

bevel_style

Optional.

bg_visible

Optional.

bg_alpha_color

Optional.

bg_opaque_color

Optional.

can_resize

Optional.

can_close

Optional.

can_minimize

Optional.

filename

Optional.

placeholder

Optional.

border_drop_shadow_visible

Optional.

border_visible

Optional.

border_style

Optional.

border_thickness

Optional.

border_color

Optional.

title

Optional.

auto_resize

Optional.

user_resize

Optional.

left_in_finder

Optional.

select

Optional.


layout_stack parameters

  • Used by floater, panel, and layout_panel.
  • Can contain button, flyout_button, icon, layout_panel, and scroll_list.
  • Class LLLayoutStack
  • In source file llui/llpanel.cpp
<?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="621" min_height="100" min_width="250" mouse_opaque="true"
    name="example_layout_stack" tab_stop="false" title="layout_stack"
    width="250">
   <layout_stack bottom="10" enabled="true" height="50" left="0" mouse_opaque="true"
        name="stack" orientation="horizontal" width="235" >
       <layout_panel name="panel1" min_height="10" height="200" width="640"/>
       <layout_panel name="panel2" min_height="10" height="200" width="640">
           <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" />
       </layout_panel>
   </layout_stack>
</floater>

Common parameters

  • 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: tab_group, border

Specific parameters

min_height

Optional.

min_width

Optional.

orientation

Optional.

border_size

Optional.

layout_panel parameters

  • Used by layout_stack.
  • Can contain button, check_box, combo_box, icon, layout_stack, line_editor, panel, progress_bar, scroll_list, text, text_editor, and web_browser.
  • In source file llui/llpanel.cpp

Common parameters

  • 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

Specific parameters

min_height

Optional.

min_width

Optional.

auto_resize

Optional.

can_resize

Optional.

user_resize

Optional.

filename

Optional.

background_visible

Optional.

scroll_container parameters

  • Used by floater.
  • Can contain panel.
  • Class LLScrollableContainerView : LLUICtrl : LLView
  • in source file llui/llscrollcontainer.cpp
<?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="200" min_width="250" mouse_opaque="true"
    name="example_scroll_container" tab_stop="false" title="scroll_container"
    width="250">
   <scroll_container bottom="20" enabled="true" height="150" left="20" mouse_opaque="false"
        name="scroll_container" opaque="false" tab_stop="false" width="200">
       <panel bottom="149" enabled="true" height="700" left="1" mouse_opaque="true"
            name="panel" tab_stop="false" width="200">
       </panel>
   </scroll_container>
</floater>

Common parameters

  • 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

Specific parameters

opaque

tab_container parameters

  • Used by floater, panel, and multi_floater.
  • Can contain inventory_panel, panel, and floater.
  • Class LLTabContainer
  • In source file llui/lltabcontainer.cpp
<?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="600" min_height="150" min_width="200" mouse_opaque="true"
    name="example_tab_container"
    tab_stop="false" title="tab_container" width="200">
   <tab_container bottom="-80" enabled="true" follows="left|top" height="20" left="20"
        mouse_opaque="false" name="tab_container" tab_position="top"
        tab_stop="false" width="150">
       <panel border="true" bottom="-19" enabled="true" follows="left|top|right|bottom"
            height="3" label="panel" left="1" mouse_opaque="false" name="panel"
            tab_stop="false" width="148" />
   </tab_container>
</floater>

Common parameters

  • 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: tab_group, border

Specific parameters

tab_position

tab_width

Optional.

tab_min_width

Optional.

tab_max_width

Optional.

hide_tabs

Optional.