Skip to content

class_popupmenu

Jump to bottom
reduz edited this page Feb 23, 2014 · 10 revisions

PopupMenu

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

Brief Description

PopupMenu displays a list of options.

Member Functions

Signals

  • item&#95pressed ( 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_icon_item

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_item

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_icon_check_item

  • void add&#95icon&#95check&#95item ( Object texture, String label, int id=-1, int accel=0 )

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.

add_check_item

  • void add&#95check&#95item ( 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.

set_item_text

  • void set&#95item&#95text ( int idx, String text )

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

set_item_icon

  • void set&#95item&#95icon ( int idx, Object icon )

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

set_item_accelerator

  • void set&#95item&#95accelerator ( 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.

set_item_checked

  • void set&#95item&#95checked ( int idx, bool arg1 )

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

set_item_ID

  • void set&#95item&#95ID ( int idx, int id )

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

get_item_text

  • String get&#95item&#95text ( int idx ) const

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

get_item_icon

  • Object get&#95item&#95icon ( int idx ) const

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

get_item_accelerator

  • int get&#95item&#95accelerator ( 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.

is_item_checked

  • bool is&#95item&#95checked ( int idx ) const

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

get_item_ID

  • int get&#95item&#95ID ( int idx ) const

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

get_item_index

  • int get&#95item&#95index ( int id ) const

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

get_item_count

  • int get&#95item&#95count ( ) const

Return the amount of items.

add_separator

  • void add&#95separator ( )

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

clear

  • void clear ( )

Clear the popup menu.

Clone this wiki locally