xBase and Clipper language compatible compiler
PrevNext

Class UIMENU

Name

UIMENU  --  Class of menu bar.

Synopsis

 UIMenu()	--> UIMenu object

Description

Class UIMenu

Attributes

<className> - Class name. Value should be "UIMenu".
<elem> - Array of menu items.

Methods

ADD Add menu item.
CLEAR Clear menu.
DISABLE Disable menu item.
ENABLE Make menu item active.
GETELEMENT Get object of menu item by its index.
ISENABLED Get flag of activity of menu item.
REMOVE Delete item from menu.
SETKEY Set menu item activation by shortcut.
UIMENU Constructor. Create horizontal menubar.
UNSETKEY Unset menu item activation from shortcut.

Method UIMENU:ADD()

 add([<pic>],<name>,<action>,[<isEnabled>])	--> <nItem>

In this method the object UIMenuItem is placed in the <elem> array. Method returns index of added object in this array.

<pic>

- Object UIImage. Icon of menu item.

<name>

- String. Menu item label. You can define accel key for widget activation. Just place symbol "&" before accel letter. This letter will be underlined and widget will be activated with key Alt-letter.

<action>

- Code block or UIPopupMenu object. Executed code block or sub-menu.

<isEnabled>

- Boolean. Flag of activity menu item.

Returns :

Index of added object UIMenuItem in array <elem>.

Method UIMENU:CLEAR()

 clear()

Returns :NIL

Method UIMENU:DISABLE()

 disable(<pos>)

<pos>

- Number. Index of menu item.

Returns :NIL

Method UIMENU:ENABLE()

 enable(<pos>)

<pos>

- Number. Index of menu item.

Returns :NIL

Method UIMENU:GETELEMENT()

 getElement(<pos>)	--> <oItem>

<pos>

- Number. Index of menu item.

Returns :

UIMenuItem or UIPopupMenu object. Menu item object.

Method UIMENU:ISENABLED()

 isEnabled(<pos>)	--> <bEnabled>

<pos>

- Number. Index of menu item.

Returns :

Flag of activity of menu item.

Method UIMENU:REMOVE()

 remove(<pos>)

<pos>

- Number. Index of menu item.

Returns :NIL

Method UIMENU:SETKEY()

 setKeyEvent(<pos>,<cKey>)

<pos>

- Number. Index of menu item.

<cKey>

- String. Shortcut definition. For example, "F5" or "Alt+M".

Returns :NIL

Method UIMENU:UIMENU()

 UIMenu() --> UIMenu object

Returns :NIL

Method UIMENU:UNSETKEY()

 unSetKey(<pos>,<cKey>)

<pos>

- Number. Index of menu item.

<cKey>

- String. Shortcut definition. For example, "F5" or "Alt+M".

Returns :NIL

Example:

 menu := UIMenu()
 window_menu := UIPopupMenu()
 
 menu:add(,"&Window", window_menu)
 window_menu:add(,"&Close", {|| win:childClose() } )
 window_menu:add(,"Close &all", {|| win:childCloseAll() } )

Platforms

No dependies of platform.

PrevHomeNext
Class UIMAINWINDOWUpClass UIMENUCHECKEDITEM