Methods Index

CToolPalette


`CToolPaletteAttachment`	`itsPopupAttachment;`	Internal attachment
`CToolPaletteAttachment`	`itsStickyAttachment;`	Internal attachment
`RWGSlist(CTool)`	`itsTools;`	List of nested tools
`CToolPalette`	`itsParentPalette;`	Parent `CToolPalette`
`long`	`itsSelectedTool;`	Selected tool ID
`CStringRW`	`itsTitle;`	Title for titlebar
`CDragSource`	`itDragSource;`	Drag and drop support
`long`	`itsEnterCommand;`	Drag and drop support
`long`	`itsLeaveCommand;`	Drag and drop support

Friends

friend class CToolPaletteButton;
friend class CToolPaletteAttachment;


friend class	`CToolPaletteButton`;
friend class	`CToolPaletteAttachment`;

Public Methods

Constructor, Destructor, and Initializer Methods

CToolPalette(const CStringRW& theTitle = NULLString);

Constructor for a new tool palette.

CToolPalette(const CToolPalette &theToolPalette);

Copy constructor which performs a deep copy of theToolPaltte.

CToolPalette & operator= (const CToolPalette &theToolPalette);

Assignment operator which performs a deep copy of theToolPalette.

~CToolPalette();

Class destructor which cleans up tool palette data.

Utility Methods

void AppendTool(
	CImage* theImage,
	long theId,
	BOOLEAN isDraggable   = FALSE,
	BOOLEAN isEnabled     = TRUE);

Appends a tool to the palette. The tool is represented by theImage, a pointer which is consumed by the tool palette. The tool is identified by theId, a unique value which you can use in other CToolPalette methods that interact with tools.

void AppendTool(
	CImage*         theImage,
	long                theId,
	CToolPalette* theSubPalette,
	BOOLEAN     isEnabled = TRUE);

Appends a tool containing theSubPalette, represented by a pointer which is consumed.

void InsertTool(
	size_t        theLocation,
	CImage*       theImage,
	long          theId,
	BOOLEAN       isDraggable   = FALSE,
	BOOLEAN       isEnabled     = TRUE);

Inserts a tool to the palette exactly before the tool found at theLocation, where the first tool is at location 0. The tool is represented by theImage, a pointer which is consumed by the tool palette, and identified by theId, a unique value which you can use in other CToolPalette methods that interact with tools.

void InsertTool(
	size_t        theLocation,
	CImage*       theImage,
	long          theId,
	CToolPalette* theSubPalette,
	BOOLEAN       isEnabled = TRUE);

Inserts a tool containing theSubPalette, represented by a pointer which is consumed.

CToolPalette* RemoveTool(long theId);

Removes a tool from the palette. If the tool has a subpalette, the method returns it. Otherwise it returns NULL.

CToolPalette* GetParent(void);

Returns the parent of the tools that are subpalettes. If this is not a subpalette, the method returns NULL.

void AppendSeparator(void);
void InsertSeparatorAfter(long theId);
void RemoveSeparatorAfter(long theId);
void RemoveAllSeparators(BOOLEAN itIsRecursive = FALSE);

Allow insertion and removal of separators to the tool palette. Separators are represented by small gaps between tool buttons.

void EnableTool(long theId, BOOLEAN isEnabled);
BOOLEAN IsToolEnabled(long theId) const;

Allow enabling or disabling of any tool button in the palette.

void SelectTool(long theId);
long GetSelectedTool(void) const;
void DeselectTools(void);
void DeselectAllTools(void);
void DeselectLocalTools(void);

Allow selection or deselection of any tool in the palette.

const CImage* GetToolImage(long theId);

Returns the image used by a tool.

void CloseSubPalettes(CToolPalette* anException = (CToolPalette *) NULL);

Closes all its subpalettes that are in pop-up or detached state, with the exception of the CToolPalette pointed to by anException.

void ClosePalettes(void);

Closes the tool palette and all its subpalettes.

void CloseAllPalettes(void);

Closes all except the top most palette. This is done by first finding this topmost parent and then calling CloseSubPalettes().

CToolPaletteAttachment* Popup(
	CWindow* theWindow,
	CPoint   theTopLeft,
	long     theSelectCommand  = NULLcmd,
	BOOLEAN  hasTitleBar       = TRUE,
	CAttachmentFrame* theFrame = NULL);

Creates a pop-up window inside theWindow at the location indicated by theTopLeft. The tools of the CToolPalette are created inside the pop-up window. The pop-up generates theSelectCommand whenever a tool button is selected.

CToolPaletteAttachment* PopupDetached(
	CWindow* theWindow,
	CPoint   theTopLeft,
	long     theSelectCommand  = NULLcmd,
	BOOLEAN  hasTitleBar       = TRUE,
	CAttachmentFrame* theFrame = NULL);

Creates a detached floating window at the location relative to theWindow indicated by theTopLeft. The pop-up generates theSelectCommand whenever a tool button is selected.

void SetDragSource(CDragSource *theDragSource);
CDragSource* GetDragSource(void);

Allow the registration of a CDragSource used to drag-and-drop data from tool buttons. If a CDragSource is provided, the CToolPalette invokes the source's DoDrag() method in response to a button click and drag. The button's ID is passed along with the data of the drag command.

void SetTitle(const CStringRW& theNewTitle);
const CStringRW& GetTitle(void) const;

Methods for getting and setting the tool palette's title.

void SetCommands(long theEnterCommand, long theLeaveCommand);
long GetEnterCommand(void);
long GetLeaveCommand(void);

Allow access to commands generated when the mouse enters and leaves each tool button. The tool button's ID is passed along as the data of the command.

Protected Methods

CTool* FindTool(
	long theId,
	CToolPalette** aFoundPalette = (CToolPalette**)NULL,
	int* aFoundIndex   = (int*) NULL);

Internal recursive tool search method.

CTool* FindSubTool(
	RWGSlist(CTool)* theSearchList,
	long theId,
	int* aFoundIndex = (int *)NULL);

Internal recursive tool search method.

virtual CToolPaletteAttachment* ConstructAttachment(
	CWindow* theWindow,
	long theCommand);

Factory method used to construct a

CToolPaletteAttachment

[Classes] [Prev] [Next] [Methods]

support@xvt.com

CToolPalette

CToolPalette

Heritage

Description

Usage

Protected Data Members

Friends

Public Methods

Constructor, Destructor, and Initializer Methods

Utility Methods

Protected Methods