Class TInternalChildrenControls

Unit

CastleUIControls

Declaration

type TInternalChildrenControls = class(TObject)

Description

List of UI controls, with a parent control and container. Ordered from back to front. Used for TCastleContainer.Controls.

User code should not create instances of this class. The only way to have an instance of it, is to get a container, by creating a TCastleWindow or TCastleControl. Then you can access MyWindow.Container.Controls.

User code should rarely need to use methods and properties of this class. That's because most TCastleUserInterface controls should be added to TCastleView, so only TCastleView instances should be present at the top-level of the UI hierarchy in TInternalChildrenControls. And you should manage TCastleView instances using TCastleContainer.View, TCastleContainer.PushView etc. that will make it added / removed from the TInternalChildrenControls automatically.

Hierarchy

• TObject
• TInternalChildrenControls

Overview

Methods

	constructor Create(AParent: TCastleUserInterface);
	destructor Destroy; override;
	function Count: Integer;
	procedure Assign(const Source: TInternalChildrenControls);
	procedure Remove(const Item: TCastleUserInterface);
	procedure Clear;
	procedure Add(const Item: TCastleUserInterface); deprecated 'use InsertFront or InsertBack';
	procedure Insert(Index: Integer; const Item: TCastleUserInterface);
	function IndexOf(const Item: TCastleUserInterface): Integer;
	function MakeSingle(ReplaceClass: TCastleUserInterfaceClass; NewItem: TCastleUserInterface; AddFront: boolean = true): TCastleUserInterface;
	procedure InsertFront(const NewItem: TCastleUserInterface); overload;
	procedure InsertFrontIfNotExists(const NewItem: TCastleUserInterface);
	procedure InsertFront(const NewItems: TCastleUserInterfaceList); overload;
	procedure InsertBack(const NewItem: TCastleUserInterface); overload;
	procedure InsertBackIfNotExists(const NewItem: TCastleUserInterface);
	procedure InsertBack(const NewItems: TCastleUserInterfaceList); overload;
	procedure InsertIfNotExists(const Index: Integer; const NewItem: TCastleUserInterface); deprecated 'use InsertFrontIfNotExists or InsertBackIfNotExists';
	procedure AddIfNotExists(const NewItem: TCastleUserInterface); deprecated 'use InsertFrontIfNotExists or InsertBackIfNotExists';
	procedure BeginDisableContextOpenClose;
	procedure EndDisableContextOpenClose;

Properties

property Items[constI:Integer]: TCastleUserInterface read GetItem write SetItem;

Description

Methods

	constructor Create(AParent: TCastleUserInterface);

	destructor Destroy; override;

	function Count: Integer;

	procedure Assign(const Source: TInternalChildrenControls);

	procedure Remove(const Item: TCastleUserInterface);
Remove the Item from this list. Note that the given Item should always exist only once on a list (it is not allowed to add it multiple times), so there's no RemoveAll method.

	procedure Clear;

	procedure Add(const Item: TCastleUserInterface); deprecated 'use InsertFront or InsertBack';
Warning: this symbol is deprecated: use InsertFront or InsertBack

	procedure Insert(Index: Integer; const Item: TCastleUserInterface);

	function IndexOf(const Item: TCastleUserInterface): Integer;

	function MakeSingle(ReplaceClass: TCastleUserInterfaceClass; NewItem: TCastleUserInterface; AddFront: boolean = true): TCastleUserInterface;
Make sure that NewItem is the only instance of given ReplaceClass on the list, replacing old item if necesssary. See TCastleObjectList.MakeSingle for precise description.

	procedure InsertFront(const NewItem: TCastleUserInterface); overload;
Add at the end of the list.

	procedure InsertFrontIfNotExists(const NewItem: TCastleUserInterface);

	procedure InsertFront(const NewItems: TCastleUserInterfaceList); overload;

	procedure InsertBack(const NewItem: TCastleUserInterface); overload;
Add at the beginning of the list.

	procedure InsertBackIfNotExists(const NewItem: TCastleUserInterface);

	procedure InsertBack(const NewItems: TCastleUserInterfaceList); overload;

	procedure InsertIfNotExists(const Index: Integer; const NewItem: TCastleUserInterface); deprecated 'use InsertFrontIfNotExists or InsertBackIfNotExists';
Warning: this symbol is deprecated: use InsertFrontIfNotExists or InsertBackIfNotExists

	procedure AddIfNotExists(const NewItem: TCastleUserInterface); deprecated 'use InsertFrontIfNotExists or InsertBackIfNotExists';
Warning: this symbol is deprecated: use InsertFrontIfNotExists or InsertBackIfNotExists

	procedure BeginDisableContextOpenClose;
BeginDisableContextOpenClose disables sending TCastleUserInterface.GLContextOpen and TCastleUserInterface.GLContextClose to all the controls on the list. EndDisableContextOpenClose ends this. They work by increasing / decreasing the TCastleUserInterface.DisableContextOpenClose for all the items on the list.

	procedure EndDisableContextOpenClose;

Properties

	property Items[constI:Integer]: TCastleUserInterface read GetItem write SetItem;

---

Generated by PasDoc 0.16.0.