Difference between revisions of "Skinning HowTo/XUI Containers"

From Second Life Wiki
Jump to: navigation, search
(Page repair. <xml></xml> replaced with <syntaxhighlight lang="xml"></syntaxhighlight>)
 
(6 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
{{XUI Nav}}
 
{{XUI Nav}}
 +
{{TOClimit}}
 
== Overview ==
 
== Overview ==
 
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.   
 
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.   
  
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 attributes.  Rather than repeatedly describing them, we just list their names here and describe them at [[Skinning HowTo/Common XUI attributes]].
  
== floater parameters ==
+
== floater ==
  
 
*Used by tab_container.
 
*Used by tab_container.
Line 11: Line 12:
 
*In source file llui/llfloater.cpp
 
*In source file llui/llfloater.cpp
  
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
+
<syntaxhighlight lang="xml"><?xml version="1.0" encoding="utf-8" standalone="yes" ?>
 
  <floater bottom="400" can_close="true" can_drag_on_left="false" can_minimize="true"
 
  <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"
 
     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"
 
     height="200" left="550" min_height="50" min_width="50" mouse_opaque="true"
 
     name="example_floater" tab_stop="false" title="floater" width="250">
 
     name="example_floater" tab_stop="false" title="floater" width="250">
  </floater>
+
  </floater></syntaxhighlight>
  
===Common parameters===
+
===Common attributes===
*'''[[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_attributes#General_attributes|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 attributes#Positioning and size attributes|Positioning and size attributes]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
*'''[[Skinning HowTo/Common XUI XML parameters#Text|Text]]:'''  label
+
*'''[[Skinning HowTo/Common XUI attributes#Text attributes|Text attributes]]:'''  label
*'''Others:''' [[Skinning HowTo/Common XUI XML parameters#border|border]]
+
*'''Others:''' [[Skinning HowTo/Common XUI attributes#border|border]]
  
===Specific parameters===
+
===Special attributes===
 +
 
 +
==== bevel_style ====
 +
''Optional.''
 +
==== border_drop_shadow_visible ====
 +
''Optional.''
 +
==== border_visible ====
 +
''Optional.''
 +
==== border_style ====
 +
''Optional.''
 +
==== border_thickness ====
 +
''Optional.''
 +
==== border_bevel ====
 +
''Optional.''
  
 
==== can_close ====
 
==== can_close ====
Line 36: Line 50:
 
==== can_tear_off ====
 
==== can_tear_off ====
 
''Optional.''
 
''Optional.''
 +
 +
====help_topic====
 +
 +
Floaters can include an optional help_topic attribute to specify the name of the floater's help topic. If this value is non-empty, the floater will display a help button, "?", next to the minimize and close buttons in the title bar. Clicking on that button will cause the relevant help topic to be displayed in the Help Viewer.
  
 
==== max_height ====
 
==== max_height ====
Line 49: Line 67:
 
''Optional.''
 
''Optional.''
  
==== border_drop_shadow_visible ====
+
== multi_floater ==
''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.
 
*Can contain icon, string, tab_container, and panel.
  
===Common parameters===
+
===Common attributes===
*'''[[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_attributes#General_attributes|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 attributes#Positioning and size attributes|Positioning and size attributes]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
  
===Specific parameters===
+
===Special attributes===
  
 
==== can_close ====
 
==== can_close ====
Line 87: Line 92:
 
''Optional.''
 
''Optional.''
  
== panel parameters ==
+
== panel ==
  
 
*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.
Line 93: Line 98:
 
*In source file llui/llpanel.cpp
 
*In source file llui/llpanel.cpp
  
===Common parameters===
+
===Common attributes===
*'''[[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_attributes#General_attributes|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 attributes#Positioning and size attributes|Positioning and size attributes]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
*'''[[Skinning HowTo/Common XUI XML parameters#Text|Text]]:'''  label
+
*'''[[Skinning HowTo/Common XUI attributes#Text attributes|Text attributes]]:'''  label
*'''Others:'''  [[Skinning HowTo/Common XUI XML parameters#tab_group|tab_group]], [[Skinning HowTo/Common XUI XML parameters#border|border]]
+
*'''Others:'''  [[Skinning HowTo/Common XUI attributes#tab_group|tab_group]], [[Skinning HowTo/Common XUI attributes#border|border]]
  
===Specific parameters===
+
===Special attributes===
  
 
==== background_opaque ====
 
==== background_opaque ====
Line 144: Line 149:
 
''Optional.''
 
''Optional.''
  
 
+
== layout_stack ==
== layout_stack parameters ==
+
  
 
*Used by floater, panel, and layout_panel.
 
*Used by floater, panel, and layout_panel.
Line 152: Line 156:
 
*In source file llui/llpanel.cpp
 
*In source file llui/llpanel.cpp
  
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
+
<syntaxhighlight lang="xml"><?xml version="1.0" encoding="utf-8" standalone="yes" ?>
 
  <floater bottom="400" can_close="true" can_drag_on_left="false" can_minimize="true"
 
  <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"
 
     can_resize="true" can_tear_off="false" enabled="true" follows="left|top"
Line 167: Line 171:
 
         </layout_panel>
 
         </layout_panel>
 
     </layout_stack>
 
     </layout_stack>
  </floater>
+
  </floater></syntaxhighlight>
  
===Common parameters===
+
===Common attributes===
*'''[[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_attributes#General_attributes|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 attributes#Positioning and size attributes|Positioning and size attributes]]:'''  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 attributes#tab_group|tab_group]], [[Skinning HowTo/Common XUI attributes#border|border]]
  
===Specific parameters===
+
===Special attributes===
  
 
==== min_height ====
 
==== min_height ====
Line 185: Line 189:
 
''Optional.''
 
''Optional.''
  
== layout_panel parameters ==
+
== layout_panel ==
  
 
*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 attributes, Text attributes_editor, and web_browser.   
 
* In source file llui/llpanel.cpp
 
* In source file llui/llpanel.cpp
  
===Common parameters===
+
===Common attributes===
*'''[[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_attributes#General_attributes|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 attributes#Positioning and size attributes|Positioning and size attributes]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
*'''[[Skinning HowTo/Common XUI XML parameters#Text|Text]]:'''  label
+
*'''[[Skinning HowTo/Common XUI attributes#Text attributes|Text attributes]]:'''  label
*'''Others:''' [[Skinning HowTo/Common XUI XML parameters#border|border]]
+
*'''Others:''' [[Skinning HowTo/Common XUI attributes#border|border]]
  
===Specific parameters===
+
===Special attributes===
  
 
==== min_height ====
 
==== min_height ====
Line 214: Line 218:
 
''Optional.''
 
''Optional.''
  
== scroll_container parameters ==
+
== scroll_container ==
 +
 
 +
A scroll_container's children must be a panel, list, container_view or scrolling_panel_list.
  
 
*Used by floater.
 
*Used by floater.
Line 221: Line 227:
 
*in source file llui/llscrollcontainer.cpp
 
*in source file llui/llscrollcontainer.cpp
  
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
+
<syntaxhighlight lang="xml"><?xml version="1.0" encoding="utf-8" standalone="yes" ?>
 
  <floater bottom="400" can_close="true" can_drag_on_left="false" can_minimize="true"
 
  <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"
 
     can_resize="true" can_tear_off="false" enabled="true" follows="left|top"
Line 233: Line 239:
 
         </panel>
 
         </panel>
 
     </scroll_container>
 
     </scroll_container>
  </floater>
+
  </floater></syntaxhighlight>
  
===Common parameters===
+
===Common attributes===
*'''[[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_attributes#General_attributes|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 attributes#Positioning and size attributes|Positioning and size attributes]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
  
===Specific parameters===
+
===Special attributes===
  
 
==== opaque ====
 
==== opaque ====
  
== tab_container parameters ==
+
== tab_container ==
  
 
*Used by floater, panel, and multi_floater.
 
*Used by floater, panel, and multi_floater.
Line 250: Line 256:
 
*In source file llui/lltabcontainer.cpp
 
*In source file llui/lltabcontainer.cpp
  
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
+
<syntaxhighlight lang="xml"><?xml version="1.0" encoding="utf-8" standalone="yes" ?>
 
  <floater bottom="400" can_close="true" can_drag_on_left="false" can_minimize="true"
 
  <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"
 
     can_resize="true" can_tear_off="false" enabled="true" follows="left|top"
Line 263: Line 269:
 
             tab_stop="false" width="148" />
 
             tab_stop="false" width="148" />
 
     </tab_container>
 
     </tab_container>
  </floater>
+
  </floater></syntaxhighlight>
  
===Common parameters===
+
===Common attributes===
*'''[[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_attributes#General_attributes|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 attributes#Positioning and size attributes|Positioning and size attributes]]:'''  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 attributes#tab_group|tab_group]], [[Skinning HowTo/Common XUI attributes#border|border]]
  
===Specific parameters===
+
===Special attributes===
  
 
==== tab_position ====
 
==== tab_position ====

Latest revision as of 05:01, 19 April 2016

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 attributes. Rather than repeatedly describing them, we just list their names here and describe them at Skinning HowTo/Common XUI attributes.

floater

  • 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 attributes

Special attributes

bevel_style

Optional.

border_drop_shadow_visible

Optional.

border_visible

Optional.

border_style

Optional.

border_thickness

Optional.

border_bevel

Optional.

can_close

Optional.

can_drag_on_left

Optional.

can_minimize

Optional.

can_resize

can_tear_off

Optional.

help_topic

Floaters can include an optional help_topic attribute to specify the name of the floater's help topic. If this value is non-empty, the floater will display a help button, "?", next to the minimize and close buttons in the title bar. Clicking on that button will cause the relevant help topic to be displayed in the Help Viewer.

max_height

Optional.

min_height

Optional.

min_width

Optional.

title

Optional.

short_title

Optional.

multi_floater

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

Common attributes

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

Special attributes

can_close

can_drag_on_left

can_minimize

can_resize

min_height

Optional.

min_width

Optional.

title

title_bar

Optional.

panel

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

Common attributes

Special attributes

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

  • 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 attributes

Special attributes

min_height

Optional.

min_width

Optional.

orientation

Optional.

border_size

Optional.

layout_panel

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

Common attributes

Special attributes

min_height

Optional.

min_width

Optional.

auto_resize

Optional.

can_resize

Optional.

user_resize

Optional.

filename

Optional.

background_visible

Optional.

scroll_container

A scroll_container's children must be a panel, list, container_view or scrolling_panel_list.

  • 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 attributes

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

Special attributes

opaque

tab_container

  • 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 attributes

Special attributes

tab_position

tab_width

Optional.

tab_min_width

Optional.

tab_max_width

Optional.

hide_tabs

Optional.