TPaletteToolList Class

Represents component palette in BDS style.

TPaletteToolList = class(TCustomToolList, IClassSelector);

File

edcToolList

Description

Tool list contains components from component palette. Component page is represented by the tool list category. Items may be easily adjusted by user using drag&drop operations.

Group

Classes

Topics

Topic	Description
TCustomToolList Methods	The methods of the TCustomToolList class are listed here.
TCustomToolList Properties	The properties of the TCustomToolList class are listed here.
TCustomToolList Events	The events of the TCustomToolList class are listed here.

IClassSelector Interface

Topic	Description
IClassSelector Methods	The methods of the IClassSelector class are listed here.

TPaletteToolList Class

Topic	Description
TPaletteToolList Methods	The methods of the TPaletteToolList class are listed here.
TPaletteToolList Properties	The properties of the TPaletteToolList class are listed here.
TPaletteToolList Events	The events of the TPaletteToolList class are listed here.

Legend

	Method
	virtual
	protected
	private
	Property
	read only
	Event

TCustomToolList Events

TCustomToolList Events	Description
OnItemArranged	Occurs when items order was changed.
OnItemChanged	Occurs when selected item is changes.

TPaletteToolList Class

TPaletteToolList Class	Description
OnPalChange	Occurs when component palette was changed.

TCustomToolList Methods

TCustomToolList Methods	Description
CollapseAll	Collapses all categories.
Create	Creates and initializes a TCustomToolList instance.
Destroy	Destroys an instance of TCustomToolList.
DrawItemImage	Draws item image.
ExpandAll	Expands all categories.
GetCategoryItem	Returns index of category item at the given position or above.
ItemAtPos	Returns items at the given position. If there are no item at the specified position function returns -1.
ItemIndexChanged	Called when selected item was changed.
ItemRect	Returns rectangle occupied by the item.
ItemsArranged	Called after items were rearranged by the drag&drop operations.
ItemsChanged	Called when items were changed (any changes).
ItemsHeight	Calculates total height of items.
MakeTopItem	Scrolls list to make specified item topmost item.
MakeVisible	Scrolls list to make specified item visible.
PaintItem	Calls TToolListItem.Paint and allows to customize item rendering in derived classes.
SelectFirstVisible	Selects first visible, i.e. not hidden, item.

IClassSelector Interface

IClassSelector Interface	Description
ClsChanged	Called when selected in component palette component class was changed.
ClsPalChanged	Called when component palette was changed.

TPaletteToolList Class

TPaletteToolList Class	Description
ClsChanged	Called when selected in component palette component class was changed.
ClsPalChanged	Called when component palette was changed.
ComponentAt	Returns associated component class info for toll item at Index position.
Create	Creates and initializes a TPaletteToolList instance.
Destroy	Destroys an instance of TPaletteToolList.
DrawItemImage	Draws item image.
ItemIndexChanged	Called when selected item was changed.
ItemsArranged	Called after items were rearranged by the drag&drop operations.
ShowCategory	Scrolls tool list to make category visible.

TCustomToolList Properties

TCustomToolList Properties	Description
AllowArrange	Specifies whether items can be arranged by the drag&drop operations.
AutoCollapse	Specifies whether all categories should be collapsed when one category is expanded or collapsed.
CategoryHeight	Specifies height of category item.
Filtered	Specifies whether items are filtered.
FilterString	Specifies filter string which is used to test item Caption.
FoldingIcon	Holds folding icon images.
HintProps	Provide properties to adjust hints processing.
Images	Determines which image list is associated with the tool list.
InsertAtItem	Specifies item index at which dragged object can be dropped.
ItemHeight	Specifies height of the normal item.
ItemIndex	Indicates which item is selected. If no item is selected ItemIndex is equal to -1.
Items	Provides access to items displayed in tool list.
MouseOverItem	Indicates item over which mouse cursor is located.
RightClickSelect	Specifies whether item can be selected by mouse right click.
RowSpace	Specifies space between two sequential items.
Selected	Currently selected item in tool list.
StyleCategory	Specifies style of category items.
StyleCategoryMouseOver	Specifies style of category item when mouse is over it.
StyleCategorySelected	Specifies style of selected category item.
StyleItem	Specifies style of tool items.
StyleItemMouseOver	Specifies style of tool item when mouse is over it.
StyleItemSelected	Specifies style of selected tool item.
VerticalGroups	Specifies whether category item should be displayed vertically along owned items.
ViewOrigin	Specifies scrolling position of the tool list control.

TPaletteToolList Class

TPaletteToolList Class	Description
Align	Determines how the control aligns within its container (parent control).
AllowArrange	Specifies whether items can be arranged by the drag&drop operations.
Anchors	Specifies how the control is anchored to its parent.
AutoCollapse	Specifies whether all categories should be collapsed when one category is expanded or collapsed.
BevelEdges	Specifies which edges of the control are beveled.
BevelInner	Specifies the cut of the inner bevel.
BevelKind	Specifies the control’s bevel style.
BevelOuter	Specifies the cut of the outer bevel.
BiDiMode	Specifies the bi-directional mode for the control.
CategoryHeight	Specifies height of category item.
Color	Specifies the background color of the control.
Constraints	Specifies the size constraints for the control.
Ctl3D	Determines whether a control has a three-dimensional (3-D) or two-dimensional look.
CustomItems	Allows managing of items in component toll list. Item in list means: 1. Specification component item ComponentClassName 2. Specification new category +CategoryName 3. Specification existed category (components page) with adding all components which belong to this page. ++CategoryName 4. Rename existed category (components page) with adding all components which belong to this page. ++CategoryName=Display_name_of_category 5. Adding all components which belong to the page without adding category. ++CategoryName=
DragCursor	Indicates the image used to represent the mouse pointer when the control is being dragged.
DragImageType	Specifies drag image when dragging component on form.
DragKind	Specifies whether the control is being dragged normally or for docking.
DragMode	Determines how the control initiates drag-and-drop or drag-and-dock operations.
Enabled	Controls whether the control responds to mouse, keyboard, and timer events.
Filtered	Specifies whether items are filtered.
FilterString	Specifies filter string which is used to test item Caption.
FoldingIcon	Holds folding icon images.
Font	Controls the attributes of text written on or in the control.
HintProps	Provide properties to adjust hints processing.
ItemHeight	Specifies height of the normal item.
Items	Provides access to items displayed in tool list.
OnCanResize	Occurs when an attempt is made to resize the control.
OnClick	Occurs when the user clicks the control.
OnConstrainedResize	Adjust resize constraints.
OnContextPopup	Occurs when the user right-clicks the control or otherwise invokes the popup menu (such as using the keyboard).
OnDblClick	Occurs when the user double-clicks the left mouse button when the mouse pointer is over the control.
OnDragDrop	Occurs when the user drops an object being dragged.
OnDragOver	Occurs when the user drags an object over a control.
OnEndDrag	Occurs when the dragging of an object ends, either by dropping the object or by canceling the dragging.
OnEnter	Occurs when a control receives the input focus.
OnExit	Occurs when the input focus shifts away from one control to another.
OnKeyDown	Occurs when a user presses any key while the control has focus.
OnKeyPress	Occurs when key pressed.
OnKeyUp	Occurs when the user releases a key that has been pressed.
OnMouseDown	Occurs when the user presses a mouse button with the mouse pointer over a control.
OnMouseMove	Occurs when the user moves the mouse pointer while the mouse pointer is over a control.
OnMouseUp	Occurs when the user releases a mouse button that was pressed with the mouse pointer over a component.
OnResize	Occurs immediately after the control is resized.
OnStartDrag	Occurs when the user begins to drag the control or an object it contains by left-clicking on the control and holding the mouse button down.
ParentBiDiMode	Specifies whether the control uses its parent’s BiDiMode.
ParentColor	Determines where a control looks for its color information.
ParentCtl3D	Determines where a component looks to determine if it should appear three dimensional.
ParentFont	Determines where a control looks for its font information.
ParentShowHint	Determines where a control looks to find out if its Help Hint should be shown.
PopupMenu	Identifies the pop-up menu associated with the control.
RowSpace	Specifies space between two sequential items.
ShowCaptions	Specifies whether button captions displayed in tool list.
ShowHint	Determines whether the control displays a Help Hint when the mouse pointer rests momentarily on the control.
StyleCategory	Specifies style of category items.
StyleCategoryMouseOver	Specifies style of category item when mouse is over it.
StyleCategorySelected	Specifies style of selected category item.
StyleItem	Specifies style of tool items.
StyleItemMouseOver	Specifies style of tool item when mouse is over it.
StyleItemSelected	Specifies style of selected tool item.
TabOrder	Indicates the position of the control in its parent's tab order.
TabStop	Determines if the user can tab to a control.
TransparentImages	Specifies whether bottom-left pixel is transparent color. If TransparentImages is False, images are drawn without transparency.
VerticalGroups	Specifies whether category item should be displayed vertically along owned items.
Visible	Determines whether the component appears on screen.

Links

Classes, Legend, Members, Topics, TPaletteToolList Methods, TPaletteToolList Properties, TPaletteToolList Events, TCustomToolList Events, TCustomToolList Methods, TCustomToolList Properties

Contents | Index

What do you think about this topic? Send feedback!