Difference between revisions of "Skinning HowTo/XUI Menus"

Latest revision as of 15:10, 26 May 2010

XUI Reference

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

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

Deprecated elements

These elements are deprecated and not used by Viewer 2.

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

@@ Line 1: / Line 1: @@
 {{XUI Nav}}
+{{TOClimit}}
 == Overview ==
 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 ===
@@ Line 28: / Line 29: @@
   </floater></xml>
-=== menu_bar parameters ===
+== menu_bar ==
 *Used by floater and panel.
@@ Line 35: / Line 36: @@
 *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 ====
-===== opaque =====
+==== opaque ====
-===== tear_off =====
+==== tear_off ====
 ''Optional.''
-=== menu parameters ===
+== menu ==
 *Used by menu_bar and recursively by other menus.
@@ Line 53: / Line 54: @@
 *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 ====
-''Optional.''
+''Optional.''  Boolean value.
-===== opaque =====
+==== opaque ====
-===== tear_off =====
+==== tear_off ====
 ''Optional.''
-===== color =====
+==== color ====
 ''Optional.''
-===== create_jump_keys =====
+==== create_jump_keys ====
 ''Optional.''
-===== hidden =====
+==== hidden ====
 ''Optional.''
-=== pie_menu parameters ===
+== menu_item_check  ==
-----
-*Used recursively by other pie_menus.
-*Can contain pie_menu.
-====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
-*'''[[Skinning HowTo/Common XUI XML parameters#Text|Text]]:'''  label
-=== tearoff_menu parameters ===
-Used by menu.
-====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#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
-*'''[[Skinning HowTo/Common XUI XML parameters#Text|Text]]:'''  label
-=== menu_item_check parameters ===
 *Used by menu.
@@ Line 100: / Line 83: @@
 *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 ====
 ''Optional.''
-=== menu_item_separator parameters ===
+== menu_item_separator  ==
 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 parameters ===
+== menu_item_call  ==
 *Used by menu and pie_menu.
@@ Line 124: / Line 107: @@
 *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 ====
 ''Optional.''
-===== useMacCtrl =====
+==== useMacCtrl ====
 ''Optional.''
-===== hidden =====
+==== hidden ====
 ''Optional.''
-=== on_check parameters ===
+== on_check  ==
+=== Attributes ===
 Used by menu_item_check.
-===== function =====
+==== function ====
 ''Optional.''
-===== userdata =====
+==== userdata ====
 ''Optional.''
-===== control =====
+==== control ====
 ''Optional.''
-=== on_click parameters ===
+== on_click  ==
+=== Attributes ===
 Used by menu_item_call and menu_item_check.
-===== filter =====
+==== filter ====
 ''Optional.''
-===== function =====
+==== function ====
-===== userdata =====
+==== userdata ====
-===== name =====
+==== name ====
 ''Optional.''
-=== on_visible parameters ===
+== on_visible  ==
+=== Attributes ===
 Used by menu_item_call.
-===== function =====
+==== function ====
-=== on_enable parameters ===
+== on_enable  ==
+=== Attributes ===
 Used by menu_item_call and menu_item_check.
-===== function =====
+==== function ====
-===== userdata =====
+==== userdata ====
 ''Optional.''
-===== name =====
+==== name ====
 ''Optional.''
+== Deprecated elements ==
+'''These elements are deprecated and not used by Viewer 2.'''
+=== pie_menu  ===
+*Used recursively by other pie_menus.
+*Can contain pie_menu.
+====Common attributes====
+*'''[[Skinning HowTo/Common XUI attributes#General attributes|General]]:'''  name, mouse_opaque, tool_tip, control_name, enabled, visible, use_bounding_rect
+*'''[[Skinning HowTo/Common XUI attributes#Text attributes|Text attributes]]:'''  label
+=== tearoff_menu  ===
+Used by menu.
+====Common attributes====
+*'''[[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 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 attributes#Text attributes|Text attributes]]:'''  label

Difference between revisions of "Skinning HowTo/XUI Menus"

Latest revision as of 15:10, 26 May 2010

Overview

Example

menu_bar

Common attributes

Special attributes

drop_shadow

opaque

tear_off

menu

Common attributes

Special attributes

drop_shadow

opaque

tear_off

color

create_jump_keys

hidden

menu_item_check

Common attributes

Special attributes

shortcut

menu_item_separator

Common attributes

menu_item_call

Common attributes

Special attributes

shortcut

useMacCtrl

hidden

on_check

Attributes

function

userdata

control

on_click

Attributes

filter

function

userdata

name

on_visible

Attributes

function

on_enable

Attributes

function

userdata

name

Deprecated elements

pie_menu

Common attributes

tearoff_menu

Common attributes

Navigation menu

Search