Class TGUIContextMenu

Description

Hierarchy

Fields

Methods

Properties

Unit

Irrlicht

Declaration

type TGUIContextMenu = class(TGUIElement)

Description

A GUI context menu.

Hierarchy

TInterfacedObject
TWrapper
TReferenceCounted
TAttributeExchangingObject
TGUIElement
TGUIContextMenu

Overview

Methods

	`function AddItem(const Text: StringType; NCommandID: LongInt=-1; Enabled: Boolean = True; NHasSubMenu: Boolean = False; NChecked: Boolean = False; NAutoChecking: Boolean = False): LongWord; inline;`
	`function FindItemWithCommandID(CommandID: LongInt; StartIndex: LongWord=0): LongInt; inline;`
	`function GetItemAutoChecking(Index: LongWord): Boolean; inline;`
	`function GetItemCommandID(Index: LongWord): LongInt; inline;`
	`function GetItemText(Index: LongWord): StringType; inline;`
	`function GetSubMenu(Index: LongWord): TGUIContextMenu; inline;`
	`function InsertItem(Index: LongWord; const Text: StringType; NCommandID: LongInt=-1; Enabled: Boolean = True; NHasSubMenu: Boolean = False; NChecked: Boolean = False; NAutoChecking: Boolean = False): LongWord; inline;`
	`function IsItemChecked(Index: LongWord): Boolean; inline;`
	`function IsItemEnabled(Index: LongWord): Boolean; inline;`
	`procedure AddSeparator; inline;`
	`procedure RemoveAllItems; inline;`
	`procedure RemoveItem(Index: LongWord); inline;`
	`procedure SetEventParent(Parent: TGUIElement); inline;`
	`procedure SetItemChecked(Index: LongWord; Enabled: Boolean); inline;`
	`procedure SetItemCommandID(Index: LongWord; ID: LongInt); inline;`
	`procedure SetItemEnabled(Index: LongWord; Enabled: Boolean); inline;`
	`procedure SetItemText(Index: LongWord; const Text: StringType); inline;`

Properties

	`property CloseAction: TGUIContextMenuCloseAction read GetCloseAction write SetCloseAction;`
	`property ItemCount: LongWord read GetItemCount;`
	`property SelectedItem: LongInt read GetSelectedItem;`

Description

Methods

function AddItem(const Text: StringType; NCommandID: LongInt=-1; Enabled: Boolean = True; NHasSubMenu: Boolean = False; NChecked: Boolean = False; NAutoChecking: Boolean = False): LongWord; inline;

Adds a menu item.

Parameters

Text: Text of menu item. Set this to 0 to create an separator instead of a real item, which is the same like calling AddSeparator.
CommandId: Command id of menu item, a simple id you may set to whatever you want.
Enabled: Specifies if the menu item should be enabled.
HasSubMenu: Set this to true if there should be a submenu at this item. You can access this submenu via GetSubMenu
Checked: Specifies if the menu item should be initially checked.
AutoChecking: Specifies if the item should be checked by clicking.

Returns

he index of the new item.

function FindItemWithCommandID(CommandID: LongInt; StartIndex: LongWord=0): LongInt; inline;

Find an item by it's CommandID.

Parameters

CommandID: We are looking for the first item which has this CommandID.
StartIndex: Start searching from this index.

Returns

the index of the item when found or otherwise -1.

	`function GetItemAutoChecking(Index: LongWord): Boolean; inline;`
Specifies whether the element changes its checked state when clicked.

function GetItemCommandID(Index: LongWord): LongInt; inline;

Returns the command ID of a menu item.

Parameters

Index: Zero based index of the menu item.

function GetItemText(Index: LongWord): StringType; inline;

Returns the visible caption of a menu item.

Parameters

Index: Zero based index of the menu item.

function GetSubMenu(Index: LongWord): TGUIContextMenu; inline;

Returns a submenu.

Parameters

Index: Zero based index of the menu item which contains the submenu.

Returns

The submenu or nil if there is no submenu.

function InsertItem(Index: LongWord; const Text: StringType; NCommandID: LongInt=-1; Enabled: Boolean = True; NHasSubMenu: Boolean = False; NChecked: Boolean = False; NAutoChecking: Boolean = False): LongWord; inline;

Insert a menu item at specified position.

Parameters

Index: Position to insert the new element, should be smaller than itemcount otherwise the item is added to the end.
Text: Text of menu item. Set this to 0 to create an separator instead of a real item, which is the same like calling AddSeparator.
NCommandID: Command id of menu item, a simple id you may set to whatever you want.
Enabled: Specifies if the menu item should be enabled.
NHasSubMenu: Set this to true if there should be a submenu at this item. You can access this submenu via GetSubMenu.
NChecked: Specifies if the menu item should be initially checked.
NAutoChecking: Specifies if the item should be checked by clicking.

Returns

The index of the new item.

	`function IsItemChecked(Index: LongWord): Boolean; inline;`
Returns if a certain item is checked.

	`function IsItemEnabled(Index: LongWord): Boolean; inline;`
Returns if a certain item is enabled.

	`procedure AddSeparator; inline;`
Adds a separator item to the menu.

	`procedure RemoveAllItems; inline;`
Removes all menu items.

procedure RemoveItem(Index: LongWord); inline;

Removes a single menu item.

Parameters

Index: Zero based index of the menu item.

	`procedure SetEventParent(Parent: TGUIElement); inline;`
When an EventParent is set, it will receive events instead of the usual parent element.

procedure SetItemChecked(Index: LongWord; Enabled: Boolean); inline;

Modifies the checked state of a menu item.

Parameters

Index: Zero based index of the menu item.
Enabled: True if the item is to be checked, False otherwise.

procedure SetItemCommandID(Index: LongWord; ID: LongInt); inline;

Sets the command id of a menu item.

Parameters

Index: Zero based index of the menu item.
ID: The new command id.

procedure SetItemEnabled(Index: LongWord; Enabled: Boolean); inline;

Enables or disables a menu item.

Parameters

Index: Zero based index of the menu item.
Enabled: The new enabled state.

procedure SetItemText(Index: LongWord; const Text: StringType); inline;

Sets the visible caption of a menu item.

Parameters

Index: Zero based index of the menu item.
Text: The new caption.

Properties

	`property CloseAction: TGUIContextMenuCloseAction read GetCloseAction write SetCloseAction;`
The closing behaviour of this menu.

	`property ItemCount: LongWord read GetItemCount;`
The count of items currently in the meun.

	`property SelectedItem: LongInt read GetSelectedItem;`
Contains the index of the currently selected item or -1 if none is selected.

Generated by PasDoc 0.12.1 on 2012-09-14 17:32:22