Difference between revisions of "Skinning HowTo/XUI Menus"

Revision as of 15:27, 21 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 parameters. Rather than repeatedly describing them, we just list their names here and describe them at Skinning HowTo/Common XUI XML parameters.

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

drop_shadow

opaque

tear_off

Optional.

pie_menu

Used recursively by other pie_menus.
Can contain pie_menu.

Common parameters

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

tearoff_menu

Used by menu.

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

menu_item_check

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

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

Specific parameters

shortcut

Optional.

menu_item_separator

Used by menu and pie_menu.

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

menu_item_call

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

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

@@ Line 28: / Line 28: @@
   </floater></xml>
-=== menu_bar parameters ===
+== menu_bar ==
 *Used by floater and panel.
@@ Line 35: / Line 35: @@
 *In source file llui/llmenugl.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#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
-====Specific parameters====
+===Specific parameters===
-===== 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 53: @@
 *In source file llui/llmenugl.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#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
 *'''[[Skinning HowTo/Common XUI XML parameters#Text|Text]]:'''  label
-====Specific parameters====
+===Specific parameters===
-===== drop_shadow =====
+==== drop_shadow ====
 ''Optional.''
-===== opaque =====
+==== opaque ====
-===== tear_off =====
+==== tear_off ====
 ''Optional.''
-===== color =====
+==== color ====
 ''Optional.''
-===== create_jump_keys =====
+==== create_jump_keys ====
 ''Optional.''
-===== hidden =====
+==== hidden ====
 ''Optional.''
-=== pie_menu parameters ===
+== pie_menu  ==
-----
 *Used recursively by other pie_menus.
 *Can contain pie_menu.
-====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
 *'''[[Skinning HowTo/Common XUI XML parameters#Text|Text]]:'''  label
-=== tearoff_menu parameters ===
+== tearoff_menu  ==
 Used by menu.
-====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#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 ===
+== menu_item_check  ==
 *Used by menu.
@@ Line 100: / Line 100: @@
 *Class MenuItemCheckGL
-====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#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
 *'''[[Skinning HowTo/Common XUI XML parameters#Text|Text]]:'''  label
-====Specific parameters====
+===Specific parameters===
-===== shortcut =====
+==== shortcut ====
 ''Optional.''
-=== menu_item_separator parameters ===
+== menu_item_separator  ==
 Used by menu and pie_menu.
-====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#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_call parameters ===
+== menu_item_call  ==
 *Used by menu and pie_menu.
@@ Line 124: / Line 124: @@
 *Class LLMenuItemCallGL
-====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#Positioning|Positioning]]:'''  width, height, left, right, left_delta, bottom, top, bottom_delta, follows, rect_control
 *'''[[Skinning HowTo/Common XUI XML parameters#Text|Text]]:'''  label
-====Specific parameters====
+===Specific parameters===
-===== shortcut =====
+=== shortcut ===
 ''Optional.''
-===== useMacCtrl =====
+=== useMacCtrl ===
 ''Optional.''
-===== hidden =====
+=== hidden ===
 ''Optional.''
-=== on_check parameters ===
+== on_check  ==
+=== Parameters ===
 Used by menu_item_check.
-===== function =====
+=== function ===
 ''Optional.''
-===== userdata =====
+=== userdata ===
 ''Optional.''
-===== control =====
+=== control ===
 ''Optional.''
-=== on_click parameters ===
+== on_click  ==
+=== Parameters ===
 Used by menu_item_call and menu_item_check.
-===== filter =====
+==== filter ====
 ''Optional.''
-===== function =====
+==== function ===
-===== userdata =====
+==== userdata ===
-===== name =====
+==== name ====
 ''Optional.''
-=== on_visible parameters ===
+== on_visible  ==
+=== Parameters ===
 Used by menu_item_call.
-===== function =====
+==== function ====
-=== on_enable parameters ===
+== on_enable  ==
+=== Parameters ===
 Used by menu_item_call and menu_item_check.
-===== function =====
+==== function ====
-===== userdata =====
+==== userdata ====
 ''Optional.''
-===== name =====
+==== name ====
 ''Optional.''

Difference between revisions of "Skinning HowTo/XUI Menus"

Revision as of 15:27, 21 May 2010

Overview

Example

menu_bar

Common parameters

Specific parameters

drop_shadow

opaque

tear_off

menu

Common parameters

Specific parameters

drop_shadow

opaque

tear_off

color

create_jump_keys

hidden

pie_menu

Common parameters

tearoff_menu

Common parameters

menu_item_check

Common parameters

Specific parameters

shortcut

menu_item_separator

Common parameters

menu_item_call

Common parameters

Specific parameters

shortcut

useMacCtrl

hidden

on_check

Parameters

function

userdata

control

on_click

Parameters

filter

= function

= userdata

name

on_visible

Parameters

function

on_enable

Parameters

function

userdata

name

Navigation menu

Search