Skip to content
reduz edited this page Nov 14, 2014 · 10 revisions

PopupMenu

####Inherits: Popup ####Category: Core

Brief Description

PopupMenu displays a list of options.

Member Functions

Signals

  • item_pressed ( int ID )

Description

PopupMenu is the typical Control that displays a list of options. They are popular in toolbars or context menus.

Member Function Description

Add a new item with text "label" and icon "texture. An id can optonally be provided, as well as an accelerator. If no id is provided, one will be created from the index.

Add a new item with text "label". An id can optonally be provided, as well as an accelerator. If no id is provided, one will be created from the index.

Add a new checkable item with text "label" and icon "texture. An id can optonally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don"apos;t have any built-in checking behavior and must be checked/unchecked manually.

  • void add_check_item ( String label, int id=-1, int accel=0 )

Add a new checkable item with text "label". An id can optonally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don"apos;t have any built-in checking behavior and must be checked/unchecked manually.

  • void set_item_text ( int idx, String text )

Set the text of the item at index "idx".

  • void set_item_icon ( int idx, Object icon )

Set the icon of the item at index "idx".

  • void set_item_accelerator ( int idx, int accel )

Set the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is fucused.

  • void set_item_checked ( int idx, bool arg1 )

Set the checkstate status of the item at index "idx".

  • void set_item_ID ( int idx, int id )

Set the id of the item at index "idx".

Return the text of the item at index "idx".

Return the icon of the item at index "idx".

  • int get_item_accelerator ( int idx ) const

Return the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is fucused.

  • bool is_item_checked ( int idx ) const

Return the checkstate status of the item at index "idx".

  • int get_item_ID ( int idx ) const

Return the id of the item at index "idx".

  • int get_item_index ( int id ) const

Find and return the index of the item containing a given id.

  • int get_item_count ( ) const

Return the amount of items.

  • void add_separator ( )

Add a separator between items. Separators also occupy an index.

  • void clear ( )

Clear the popup menu.

Clone this wiki locally