Difference between revisions of "UI Floaters"

From Second Life Wiki
Jump to navigation Jump to search
Line 1: Line 1:
Documentation of the current XUI xml format as used in the Second Life viewer for its UI elements.  
Documentation of the current XUI xml format as used in the Second Life viewer for its UI floaters.  


===Widget Options===
===Floater Options===
You will see the following information in XML files as you go.  Here's what all the options mean.
You will see the following information in XML files as you go.  Here's what all the options mean.


<b>Name</b>
<b>Name</b>
* name="SuperWidget" // name of the widget.  You will use this name in the code to identify your widget when you need it  
* name="SuperWidget" // name of the floater.  You will use this name in the code to identify your widget when you need it  
 
<b>Control Name</b>
* control_name="DebugSetting" // Allows you to instantly tie a widget to [[Debug_Settings]] without writing any code. Very useful.


<b>Width and Height</b>
<b>Width and Height</b>
* width="100"  // sets the width of the widget to be 100 pixels  
* width="100"  // sets the width of the floater to be 100 pixels  
** Note: This is the entire width of the widget, not just the label.
** Note: This is the entire width of the floater, not just the label.
* height="20" // sets the height of the widget to be 20 pixels  
* height="20" // sets the height of the floater to be 20 pixels  
** Note: This is the entire width of the widget, not just the label.
** Note: This is the entire width of the floater, not just the label.


<b>Left</b>
<b>Left</b>
* left="10" // sets the horizontal position of the left edge of the widget to be 10 pixels from the left edge of the panel or floater
* left="10" // sets the horizontal position of the left edge of the floater to be 10 pixels from the left edge of the panel or floater
* left_delta="100" // sets the horizontal position of the left edge of the widget to be 100 pixels from the left edge of previously listed widget
* left_delta="100" // sets the horizontal position of the left edge of the floater to be 100 pixels from the left edge of previously listed widget
** Note: Use left *or* left_delta, never both.
** Note: Use left *or* left_delta, never both.


<b>Bottom</b>
<b>Bottom</b>
* bottom="300" // sets the vertical position of the bottom edge of the widget to be 300 pixels from the bottom edge of the panel or floater
* bottom="300" // sets the vertical position of the bottom edge of the floater to be 300 pixels from the bottom edge of the panel or floater
* bottom="-30" // sets the vertical position of the bottom edge of the widget to be 30 pixels from the top edge of the panel or floater
* bottom="-30" // sets the vertical position of the bottom edge of the floater to be 30 pixels from the top edge of the panel or floater
* bottom_delta="-30" // sets the vertical position of the bottom edge of widget to be 30 pixels from the bottom edge of previously listed widget
* bottom_delta="-30" // sets the vertical position of the bottom edge of floater to be 30 pixels from the bottom edge of previously listed floater
** Note: Use bottom *or* bottom_delta, never both.
** Note: Use bottom *or* bottom_delta, never both.



Revision as of 22:19, 15 January 2008

Documentation of the current XUI xml format as used in the Second Life viewer for its UI floaters.

Floater Options

You will see the following information in XML files as you go. Here's what all the options mean.

Name

  • name="SuperWidget" // name of the floater. You will use this name in the code to identify your widget when you need it

Width and Height

  • width="100" // sets the width of the floater to be 100 pixels
    • Note: This is the entire width of the floater, not just the label.
  • height="20" // sets the height of the floater to be 20 pixels
    • Note: This is the entire width of the floater, not just the label.

Left

  • left="10" // sets the horizontal position of the left edge of the floater to be 10 pixels from the left edge of the panel or floater
  • left_delta="100" // sets the horizontal position of the left edge of the floater to be 100 pixels from the left edge of previously listed widget
    • Note: Use left *or* left_delta, never both.

Bottom

  • bottom="300" // sets the vertical position of the bottom edge of the floater to be 300 pixels from the bottom edge of the panel or floater
  • bottom="-30" // sets the vertical position of the bottom edge of the floater to be 30 pixels from the top edge of the panel or floater
  • bottom_delta="-30" // sets the vertical position of the bottom edge of floater to be 30 pixels from the bottom edge of previously listed floater
    • Note: Use bottom *or* bottom_delta, never both.
      • Note: All floaters, panels and widgets appear to accept these, so I will simply refer to them as "coordinates" rather than spell them out for each file.

Generic Floater XML Elements