Difference between revisions of "Skinning HowTo/XUI Menus"

From Second Life Wiki
Jump to navigation Jump to search
Line 3: Line 3:
This page describes the XML attributes for the XUI menus.  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:
This page describes the XML attributes for the XUI menus.  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:


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


=== Example ===
=== Example ===
Line 35: Line 35:
*In source file llui/llmenugl.cpp
*In source file llui/llmenugl.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]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control


===Specific parameters===
===Special attributes===


==== drop_shadow ====
==== drop_shadow ====
Line 53: Line 53:
*In source file llui/llmenugl.cpp
*In source file llui/llmenugl.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]]:'''  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


===Specific parameters===
===Special attributes===


==== drop_shadow ====
==== drop_shadow ====
Line 81: Line 81:
*Can contain pie_menu.
*Can contain pie_menu.


===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
*'''[[Skinning HowTo/Common XUI attributes#General attributes|General]]:'''  name, mouse_opaque, tool_tip, control_name, enabled, visible, use_bounding_rect
*'''[[Skinning HowTo/Common XUI XML parameters#Text|Text]]:'''  label
*'''[[Skinning HowTo/Common XUI attributes#Text attributes|Text attributes]]:'''  label


== tearoff_menu  ==
== tearoff_menu  ==
Line 89: Line 89:
Used by menu.
Used by menu.


===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]]:'''  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


== menu_item_check  ==
== menu_item_check  ==
Line 100: Line 100:
*Class MenuItemCheckGL
*Class MenuItemCheckGL


===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]]:'''  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
===Specific parameters===
===Special attributes===


==== shortcut ====
==== shortcut ====
Line 113: Line 113:
Used by menu and pie_menu.
Used by menu and pie_menu.


===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]]:'''  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


== menu_item_call  ==
== menu_item_call  ==
Line 124: Line 124:
*Class LLMenuItemCallGL
*Class LLMenuItemCallGL


===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]]:'''  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


===Specific parameters===
===Special attributes===


==== shortcut ====
==== shortcut ====
Line 140: Line 140:
== on_check  ==
== on_check  ==


=== Parameters ===
=== Attributes ===
Used by menu_item_check.
Used by menu_item_check.
==== function ====
==== function ====
Line 151: Line 151:
== on_click  ==
== on_click  ==


=== Parameters ===
=== Attributes ===
Used by menu_item_call and menu_item_check.
Used by menu_item_call and menu_item_check.
==== filter ====
==== filter ====
Line 162: Line 162:
== on_visible  ==
== on_visible  ==


=== Parameters ===
=== Attributes ===
Used by menu_item_call.
Used by menu_item_call.
==== function ====
==== function ====
Line 168: Line 168:
== on_enable  ==
== on_enable  ==


=== Parameters ===
=== Attributes ===
Used by menu_item_call and menu_item_check.
Used by menu_item_call and menu_item_check.
==== function ====
==== function ====

Revision as of 15:36, 21 May 2010

Overview

This page describes the XML attributes for the XUI menus. They are used by the XUI files in the \skins\default\xui folders. You can find attributes for other XUI elements at:

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.

Example

<xml> <?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="643" min_height="150" min_width="250" mouse_opaque="true"
    name="example_menu" tab_stop="false" title="menu" width="250">
   <menu_bar bottom="-50" drop_shadow="true" enabled="true" follows="left|top" height="30"
        left="20" mouse_opaque="false" name="menu_bar" opaque="false"
        tear_off="false" width="200">
       <menu drop_shadow="false" enabled="true" mouse_opaque="false"
        name="menu" label="menu label" opaque="false" tear_off="true">
           <menu_item_call enabled="true" label="menu_item_call label" mouse_opaque="true"
                name="menu_item_call" />
           <menu_item_separator enabled="true" label="menu_item_separator label"
                mouse_opaque="true" name="menu_item_separator" />
           <tearoff_menu label="tearoff_menu label" />
           <menu_item_check enabled="true" label="menu_item_check label" mouse_opaque="true"
                name="menu_item_check" />
       </menu>
   </menu_bar>
</floater></xml>

menu_bar

  • Used by floater and panel.
  • Can contain menu.
  • Class LLMenuBarGL
  • In source file llui/llmenugl.cpp

Common attributes

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

Special attributes

drop_shadow

opaque

tear_off

Optional.

menu

  • Used by menu_bar and recursively by other menus.
  • Can contain menu, menu_item_call, menu_item_check, menu_item_separator, and tearoff_menu.
  • Class LLMenuGL
  • In source file llui/llmenugl.cpp

Common attributes

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

Special attributes

drop_shadow

Optional.

opaque

tear_off

Optional.

color

Optional.

create_jump_keys

Optional.

hidden

Optional.

pie_menu

  • Used recursively by other pie_menus.
  • Can contain pie_menu.

Common attributes

  • General: name, mouse_opaque, tool_tip, control_name, enabled, visible, use_bounding_rect
  • Text attributes: label

tearoff_menu

Used by menu.

Common attributes

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

menu_item_check

  • Used by menu.
  • Can contain on_check, on_click, and on_enable.
  • Class MenuItemCheckGL

Common attributes

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

Special attributes

shortcut

Optional.

menu_item_separator

Used by menu and pie_menu.

Common attributes

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

menu_item_call

  • Used by menu and pie_menu.
  • Can contain on_click, on_enable, and on_visible.
  • Class LLMenuItemCallGL

Common attributes

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

Special attributes

shortcut

Optional.

useMacCtrl

Optional.

hidden

Optional.

on_check

Attributes

Used by menu_item_check.

function

Optional.

userdata

Optional.

control

Optional.

on_click

Attributes

Used by menu_item_call and menu_item_check.

filter

Optional.

function

userdata

name

Optional.

on_visible

Attributes

Used by menu_item_call.

function

on_enable

Attributes

Used by menu_item_call and menu_item_check.

function

userdata

Optional.

name

Optional.

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