xBase and Clipper language compatible compiler
PrevNext

Class UIPOPUPMENU

Name

UIPOPUPMENU  --  Class of popup menu.

Synopsis

 UIPopupMenu()	--> UIPopupMenu object

Description

Class UIPopupMenu

Attributes

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

Methods

ADD Add menu item.
ADDCHECKED Add checked menu item.
ADDSEPARATOR Add separator to popup menu.
CLEAR Clear menu.
DISABLE Disable menu item.
ENABLE Make menu item active.
GETELEMENT Get object of menu item by its index.
ISCHECKED Get checked status of checked menu item.
ISENABLED Get flag of activity of menu item.
REMOVE Delete item from menu.
SETKEY Set menu item activation by shortcut.
UIPOPUPMENU Constructor. Create popup menu.
UNSETKEY Unset menu item activation from shortcut.

Method UIPOPUPMENU: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 UIPOPUPMENU:ADDCHECKED()

 addChecked([<def_status>],<name>,<action>,[<isEnabled>])	--> <nItem>

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

<def_status>

- Boolean. Checked status by default.

<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 UIMenuCheckedItem in array <elem>.

Method UIPOPUPMENU:ADDSEPARATOR()

 addSeparator()

Returns :NIL

Method UIPOPUPMENU:CLEAR()

 clear()

Returns :NIL

Method UIPOPUPMENU:DISABLE()

 disable(<pos>)

<pos>

- Number. Index of menu item.

Returns :NIL

Method UIPOPUPMENU:ENABLE()

 enable(<pos>)

<pos>

- Number. Index of menu item.

Returns :NIL

Method UIPOPUPMENU:GETELEMENT()

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

<pos>

- Number. Index of menu item.

Returns :

UIMenuItem or UIMenuCheckedItem or UIPopupMenu object. Menu item object.

Method UIPOPUPMENU:ISCHECKED()

 isChecked(<pos>)	--> <bChecked>

<pos>

- Number. Index of menu item.

Returns :

Checked status of checked menu item.

Method UIPOPUPMENU:ISENABLED()

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

<pos>

- Number. Index of menu item.

Returns :

Flag of activity of menu item.

Method UIPOPUPMENU:REMOVE()

 remove(<pos>)

<pos>

- Number. Index of menu item.

Returns :NIL

Method UIPOPUPMENU:SETKEY()

 setKeyEvent(<pos>,<cKey>)

<pos>

- Number. Index of menu item.

<cKey>

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

Returns :NIL

Method UIPOPUPMENU:UIPOPUPMENU()

 UIPopupMenu() --> UIPopupMenu object

Returns :NIL

Method UIPOPUPMENU:UNSETKEY()

 unSetKey(<pos>,<cKey>)

<pos>

- Number. Index of menu item.

<cKey>

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

Returns :NIL

Example:

 menu := UIPopupMenu()
 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 UIMENUITEMUpClass UIPROGRESSBAR