Difference between revisions of "Skinning HowTo/XUI Menus"

From Second Life Wiki
Jump to navigation Jump to search
Line 1: Line 1:
{{XUI Nav}}
{{XUI Nav}}
== 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:
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:


Line 6: Line 7:
=== Example ===
=== Example ===


<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<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 25: Line 26:
         </menu>
         </menu>
     </menu_bar>
     </menu_bar>
  </floater>
  </floater></xml>


=== menu_bar parameters ===
=== menu_bar parameters ===
----
 
*Used by floater and panel.
*Used by floater and panel.
*Can contain menu.
*Can contain menu.
Line 46: Line 47:


=== menu parameters ===
=== menu parameters ===
----
 
*Used by menu_bar and recursively by other menus.
*Used by menu_bar and recursively by other menus.
*Can contain menu, menu_item_call, menu_item_check, menu_item_separator, and tearoff_menu.
*Can contain menu, menu_item_call, menu_item_check, menu_item_separator, and tearoff_menu.
Line 85: Line 86:


=== tearoff_menu parameters ===
=== tearoff_menu parameters ===
----
 
Used by menu.
Used by menu.


Line 94: Line 95:


=== menu_item_check parameters ===
=== menu_item_check parameters ===
----
 
*Used by menu.
*Used by menu.
*Can contain on_check, on_click, and on_enable.
*Can contain on_check, on_click, and on_enable.
Line 109: Line 110:


=== menu_item_separator parameters ===
=== menu_item_separator parameters ===
----
 
Used by menu and pie_menu.
Used by menu and pie_menu.


Line 118: Line 119:


=== menu_item_call parameters ===
=== menu_item_call parameters ===
----
 
*Used by menu and pie_menu.
*Used by menu and pie_menu.
*Can contain on_click, on_enable, and on_visible.
*Can contain on_click, on_enable, and on_visible.
Line 138: Line 139:


=== on_check parameters ===
=== on_check parameters ===
----
 
Used by menu_item_check.
Used by menu_item_check.
===== function =====
===== function =====
Line 148: Line 149:


=== on_click parameters ===
=== on_click parameters ===
----
 
Used by menu_item_call and menu_item_check.
Used by menu_item_call and menu_item_check.
===== filter =====
===== filter =====
Line 158: Line 159:


=== on_visible parameters ===
=== on_visible parameters ===
----
 
Used by menu_item_call.
Used by menu_item_call.
===== function =====
===== function =====


=== on_enable parameters ===
=== on_enable parameters ===
----
 
Used by menu_item_call and menu_item_check.
Used by menu_item_call and menu_item_check.
===== function =====
===== function =====

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

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 parameters

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

menu parameters

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

drop_shadow

Optional.

opaque
tear_off

Optional.

color

Optional.

create_jump_keys

Optional.

hidden

Optional.

pie_menu parameters


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

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 parameters

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

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 parameters

  • 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

Specific parameters

shortcut

Optional.

useMacCtrl

Optional.

hidden

Optional.

on_check parameters

Used by menu_item_check.

function

Optional.

userdata

Optional.

control

Optional.

on_click parameters

Used by menu_item_call and menu_item_check.

filter

Optional.

function
userdata
name

Optional.

on_visible parameters

Used by menu_item_call.

function

on_enable parameters

Used by menu_item_call and menu_item_check.

function
userdata

Optional.

name

Optional.