Class TMenu

Description

Hierarchy

Fields

Methods

Properties

Unit

CastleWindow

Declaration

type TMenu = class(TMenuEntryWithCaption)

Description

TMenuEntry that contains a list of menu entries. This is the basic class to represent a drop-down menu, a submenu etc.

Hierarchy

Overview

Methods

	`procedure ClearHandles; override;`
	`constructor Create(const ACaption: String);`
	`destructor Destroy; override;`
	`function Count: Integer;`
	`procedure Insert(Index: Integer; Value: TMenuEntry);`
	`procedure Append(Value: TMenuEntry);`
	`procedure Delete(Index: Integer);`
	`procedure Clear;`
	`function EntriesCount: Integer; deprecated;`
	`procedure EntryDelete(Index: Integer); deprecated;`
	`procedure EntriesDeleteAll; deprecated;`
	`procedure DeleteAll;`
	`function AppendRadioGroup(const Items: array of string; BaseIntData: Cardinal; SelectedIndex: Integer; AAutoCheckedToggle: boolean; QuoteCaption: boolean = true): TMenuItemRadioGroup;`

Properties

property Entries [Index: Integer]: TMenuEntry read GetEntries;

Description

Methods

procedure ClearHandles; override;

This item has no description. Showing description inherited from TMenuEntry.ClearHandles.

Recursively clear TMenuEntry.Handle values.

	`constructor Create(const ACaption: String);`
This item has no description.

	`destructor Destroy; override;`
This item has no description.

	`function Count: Integer;`
This item has no description.

	`procedure Insert(Index: Integer; Value: TMenuEntry);`
This item has no description.

	`procedure Append(Value: TMenuEntry);`
Add at the end. Same as Insert(Count, Value).

	`procedure Delete(Index: Integer);`
This item has no description.

	`procedure Clear;`
This item has no description.

function EntriesCount: Integer; deprecated;

Warning: this symbol is deprecated.

Deprecated name for Count.

procedure EntryDelete(Index: Integer); deprecated;

Warning: this symbol is deprecated.

Deprecated name for Delete.

procedure EntriesDeleteAll; deprecated;

Warning: this symbol is deprecated.

Deprecated name for Clear.

procedure DeleteAll;

Warning: this symbol is deprecated.

Deprecated name for Clear.

function AppendRadioGroup(const Items: array of string; BaseIntData: Cardinal; SelectedIndex: Integer; AAutoCheckedToggle: boolean; QuoteCaption: boolean = true): TMenuItemRadioGroup;

Append a number of radio menu items. This is a comfortable shortcut for an often task of adding many TMenuItemRadio items that create a new radio group (TMenuItemRadioGroup).

For each item of Items list, we'll add a new TMenuItemRadio instance.

TMenuItemRadio.Caption will be set to the Items[I] string. Additionally it will be quoted by SQuoteMenuEntryCaption to avoid interpreting underscore characters (if QuoteCaption).
TMenuItemRadio.IntData will be set to BaseIntData + the number of this item. (This is usually most comfortable, you can handle this radio group by "case" with a range.)
TMenuItemRadio.Group will be equal. More precisely: along with creating the first TMenuItemRadio, we will also create new TMenuItemRadioGroup. For the rest of TMenuItemRadio, we'll assign this group.
TMenuItemRadio.Checked will be set to True on only one item: the one numbered SelectedIndex. Pass SelectedIndex negative (or >= than items count) to have no radio item checked by default.
TMenuItemRadio.AutoCheckedToggle will be set according to ou parameter AAutoCheckedToggle.

We return the newly created TMenuItemRadioGroup. If Items is empty, this does nothing and returns Nil.

Properties

	`property Entries [Index: Integer]: TMenuEntry read GetEntries;`
Items (entries) on the menu. Items are owned by this menu instance (are automatically freed at destruction, at Delete and such).

Generated by PasDoc 0.16.0-snapshot.

API Reference

Class TMenu

Unit

Declaration

Description

Hierarchy

Overview

Methods

Properties

Description

Methods

Properties