IlvTreePathGadgetItem Class Reference

Tree gadget item class with a pathname. More...

#include <ilviews/gadgets/filechoo.h>

Inheritance diagram for IlvTreePathGadgetItem:

Public Member Functions
	IlvTreePathGadgetItem (const char *label, IlvBitmap *bitmap=0, IlvPosition position=IlvRight, IlUShort spacing=IlvDefaultGadgetItemSpacing, IlBoolean copy=IlTrue)
	Constructor. More...
	IlvTreePathGadgetItem (const char *label, IlvGraphic *graphic, IlvPosition position=IlvRight, IlUShort spacing=IlvDefaultGadgetItemSpacing, IlBoolean copy=IlTrue)
	Constructor. More...
const IlPathName &	getPathName () const
	Returns the path. More...
void	setPathName (const IlPathName &path)
	Sets the path. More...
Public Member Functions inherited from IlvTreeGadgetItem
	IlvTreeGadgetItem (const char *label, IlvBitmap *bitmap=0, IlvPosition position=IlvRight, IlUShort spacing=IlvDefaultGadgetItemSpacing, IlBoolean copy=IlTrue)
	Constructor. More...
	IlvTreeGadgetItem (const char *label, IlvGraphic *graphic, IlvPosition position=IlvRight, IlUShort spacing=IlvDefaultGadgetItemSpacing, IlBoolean copy=IlTrue)
	Constructor. More...
	IlvTreeGadgetItem (IlvBitmap *bitmap)
	Constructor. More...
	IlvTreeGadgetItem (IlvGraphic *graphic)
	Constructor. More...
IlvTreeGadgetItem *	applyToChildren (IlvApplyGadgetItem func, IlAny arg=0) const
	Applies the specified function to all the children of the tree gadget item. More...
virtual void	deSelect ()
	Deselects the item. More...
void	detach ()
	Detaches the item from its parent. More...
virtual void	expand ()
	Expands the item. More...
void	expandAll ()
	Expands the item and all its children. More...
virtual IlUInt	getBitmapMask () const
	Returns the bitmap mask of the item. More...
IlUInt	getCardinal () const
	Returns the number of children of the tree gadget item. More...
virtual IlvBitmap *	getCurrentBitmap () const
	Returns the bitmap that is currently displayed by the item. More...
IlvTreeGadgetItem *	getFirstChild () const
	Returns the first child of the item. More...
IlvTreeGadgetItem *	getLastChild () const
	Returns the last child of the item. More...
IlvTreeGadgetItem *	getNextSibling () const
	Returns the next sibling of the item. More...
IlvTreeGadgetItem *	getParent () const
	Returns the parent of the item. More...
IlUInt	getPosition () const
	Returns the position of the item in its parent list. More...
IlvTreeGadgetItem *	getPrevSibling () const
	Returns the previous sibling of the item. More...
IlvTreeGadgetItemHolder *	getTreeHolder () const
	Returns a pointer to the item holder. More...
IlBoolean	hasChildren () const
	Indicates whether the item has children. More...
IlBoolean	hasUnknownChildCount () const
	Indicates that the number of children is not known. More...
IlBoolean	insertChild (IlvTreeGadgetItem *item, IlInt index=-1)
	Inserts the specified item in the list of children of this tree gadget item. More...
IlBoolean	isAncestorOf (IlvTreeGadgetItem *item) const
	Indicates whether the item is an ancestor of the specified item. More...
IlBoolean	isExpanded () const
	Indicates whether the item is expanded. More...
IlBoolean	isFirstChild () const
	Indicates whether the item is the first child in its parent list. More...
IlBoolean	isLastChild () const
	Indicates whether the item is the last child in its parent list. More...
IlBoolean	isVisible () const
	Indicates whether the item is visible. More...
IlvTreeGadgetItem *	lastVisible () const
	Returns the last visible children of the item. More...
IlvTreeGadgetItem *	nextSelected () const
	Returns the next selected item. More...
IlvTreeGadgetItem *	nextVisible () const
	Returns the next visible item. More...
IlvTreeGadgetItem *	previousVisible () const
	Returns the previous visible item. More...
virtual void	select ()
	Selects the item. More...
void	setUnknownChildCount (IlBoolean value)
	Specifies whether the item should behave as if it had children. More...
virtual void	shrink ()
	Shrinks the item. More...
void	sortChildren (IlUInt levels=(IlUInt) -1, IlvTreeGadgetItemCompareFunction func=0)
	Sorts the children of the tree gadget item. More...
Public Member Functions inherited from IlvGadgetItem
	IlvGadgetItem (const char *label, IlvBitmap *bitmap=0, IlvPosition position=IlvRight, IlUShort spacing=4, IlBoolean copy=IlTrue)
	Constructor. More...
	IlvGadgetItem (const char *label, IlvGraphic *graphic, IlvPosition position=IlvRight, IlUShort spacing=4, IlBoolean copy=IlTrue)
	Constructor. More...
	IlvGadgetItem (IlvBitmap *bitmap)
	Constructor. More...
	IlvGadgetItem (IlvGraphic *graphic)
	Constructor. More...
virtual void	activate ()
	Activates the item. More...
virtual IlvGadgetItem *	copy () const
	Copies this object. More...
virtual void	draw (IlvPort *dst, const IlvRect &rect, const IlvTransformer *t=0, const IlvRegion *clip=0) const
	Is called to draw the item. More...
virtual void	drawLabel (IlvPort *dst, IlvPalette *palette, const IlvRect &rect, const IlvTransformer *t=0, const IlvRegion *clip=0) const
	Is called to draw the item label. More...
virtual void	drawPicture (IlvPort *dst, const IlvRect &rect, const IlvTransformer *t=0, const IlvRegion *clip=0) const
	Is called to draw the item picture. More...
virtual void	edit ()
	Edits the item label. More...
IlvBitmap *	getBitmap (const IlSymbol *symbol) const
	Returns the bitmap corresponding to the specified symbol. More...
IlvBitmap *	getBitmap (IlUShort index=(IlUShort) 0) const
	Returns the bitmap whose index is specified. More...
IlUShort	getBitmapCount () const
	Returns the number of bitmaps used by this item. More...
IlAny	getClientData () const
	Returns the client data of the item. More...
IlvGraphic *	getGraphic () const
	Returns the IlvGraphic object associated with this item. More...
virtual IlUShort	getHeight () const
	Returns the item height. More...
virtual IlvPalette *	getHighlightTextPalette () const
	Returns the palette used to draw the label of highlighted items. More...
IlvGadgetItemHolder *	getHolder () const
	Returns the item holder. More...
virtual IlvPalette *	getInsensitivePalette () const
	Returns the palette used to draw a nonsensitive item. More...
const char *	getLabel () const
	Returns the item label. More...
IlvAlignment	getLabelAlignment () const
	Returns the label alignment. More...
void	getLabelOrientation (IlvOrientation &orientation, IlBoolean &flip) const
	Returns the orientation of the item label. More...
IlvPosition	getLabelPosition () const
	Returns the position of the label relative to the picture. More...
virtual const char *	getMessage () const
	Returns the message of the item. More...
char	getMnemonic () const
	Returns the mnemonic letter associated with the item. More...
const char *	getName () const
	Returns the item name. More...
IlvNamedProperty *	getNamedProperty (const IlSymbol *name) const
	Returns the property whose name is specified. More...
virtual IlvPalette *	getNormalTextPalette () const
	Returns the default palette used to draw an item. More...
virtual IlvPalette *	getOpaquePalette () const
	Returns the palette that is used to draw opaque items. More...
IlAny	getProperty (const IlSymbol *key) const
	Returns the object property whose symbol is provided as the parameter. More...
virtual IlvPalette *	getSelectionPalette () const
	Returns the palette used to draw selected items. More...
virtual IlvPalette *	getSelectionTextPalette () const
	Returns the palette used to draw the label of selected items. More...
IlUShort	getSpacing () const
	Returns the spacing between the label and the picture of the item. More...
virtual IlUShort	getWidth () const
	Returns the item width. More...
IlBoolean	hasProperty (const IlSymbol *key) const
	Indicates whether the item has the property whose symbol is specified. More...
virtual void	highlight (IlBoolean value=IlTrue)
	Highlights the item. More...
IlBoolean	isDragDropTarget () const
	Indicates whether the item is the target of a drag-and-drop operation. More...
IlBoolean	isEditable () const
	Indicates whether the item can be edited. More...
IlBoolean	isHighlighted () const
	Indicates whether the item is highlighted. More...
IlBoolean	isOpaque () const
	Indicates whether the item is opaque. More...
virtual IlBoolean	isSelectable () const
	Indicates whether the item can be selected. More...
IlBoolean	isSelected () const
	Indicates whether the item is selected. More...
IlBoolean	isSensitive () const
	Indicates whether the item is sensitive. More...
IlBoolean	isShowingLabel () const
	Indicates whether the item label is visible. More...
IlBoolean	isShowingPicture () const
	Indicates whether the item picture is visible. More...
virtual void	itemRect (IlvRect &rect, const IlvRect &bbox) const
	Returns the item bounding bbox. More...
virtual void	labelRect (IlvRect &rect, const IlvRect &bbox) const
	Returns the bounding box of the item label. More...
virtual void	pictureRect (IlvRect &rect, const IlvRect &bbox) const
	Returns the bounding bbox of the item picture. More...
virtual void	recomputeSize (IlBoolean redraw=IlTrue)
	Recomputes the item geometry. More...
void	removeAllBitmaps ()
	Removes all the bitmaps associated with the item. More...
IlvNamedProperty *	removeNamedProperty (IlSymbol *name)
	Removes the specified named property from the object. More...
IlBoolean	removeProperty (const IlSymbol *key)
	Removes a property from the object. More...
virtual void	selectionRect (IlvRect &rect, const IlvRect &bbox) const
	Returns the bounding box of the item selection. More...
void	setBitmap (const IlSymbol *symbol, IlvBitmap *bitmap)
	Sets the specified bitmap to the item using the specified symbol. More...
void	setBitmap (IlUShort index, IlvBitmap *bitmap)
	Sets the specified bitmap to the item at the specified index. More...
void	setBitmap (IlvBitmap *bitmap)
	Sets the sensitive bitmap of the item. More...
void	setClientData (IlAny data)
	Sets the new client data for this item. More...
void	setEditable (IlBoolean value)
	Specifies whether the item should be editable. More...
void	setGraphic (IlvGraphic *graphic)
	Specifies the graphic object associated with this item. More...
virtual void	setHighlightTextPalette (IlvPalette *palette)
	Sets the palette used to draw the label of highlighted items. More...
void	setLabel (const char *label, IlBoolean copy=IlTrue)
	Sets the item label. More...
void	setLabelAlignment (IlvAlignment alignment)
	Sets the label alignment. More...
void	setLabelOrientation (IlvOrientation orientation, IlBoolean flip=IlFalse)
	Sets the orientation of the item label. More...
void	setLabelPosition (IlvPosition position)
	Sets the label position relative to the picture. More...
void	setName (const char *name)
	Sets the item name. More...
IlvNamedProperty *	setNamedProperty (IlvNamedProperty *property)
	Sets the specified named property to the object. More...
virtual void	setNormalTextPalette (IlvPalette *palette)
	Sets the default palette used to draw an item. More...
void	setOpaque (IlBoolean value)
	Specifies whether the item should be opaque. More...
virtual void	setOpaquePalette (IlvPalette *palette)
	Sets the palette used to draw opaque items. More...
void	setProperty (const IlSymbol *key, IlAny value)
	Sets the property whose symbol is specified to the item. More...
virtual void	setSelectionTextPalette (IlvPalette *palette)
	Sets the palette used to draw the label of selected items. More...
void	setSensitive (IlBoolean value)
	Specifies whether the item should be sensitive or not. More...
void	setSpacing (IlUShort spacing)
	Sets the spacing between the label and the picture of the item. More...
void	showLabel (IlBoolean value=IlTrue)
	Specifies whether the item label should be shown. More...
void	showPicture (IlBoolean value=IlTrue)
	Specifies whether the item picture should be shown. More...
virtual void	write (IlvOutputFile &file) const
	Writes an object description to a file. More...

Additional Inherited Members
Static Public Member Functions inherited from IlvTreeGadgetItem
static IlSymbol *	ExpandedBitmapSymbol ()
	Returns the symbol associated with the expanded bitmap. More...
Static Public Member Functions inherited from IlvGadgetItem
static void	AddItemBitmapSymbol (const IlSymbol *symbol, IlUShort index)
	Links a new bitmap symbol with the specified index. More...
static IlSymbol *	BitmapSymbol ()
	Returns the symbol associated with the sensitive bitmap. More...
static IlShort	GetItemBitmapIndex (const IlSymbol *symbol)
	Returns the index corresponding to the specified symbol. More...
static IlSymbol *	GetItemBitmapSymbol (IlUShort index)
	Returns the symbol corresponding to the specified index. More...
static IlSymbol *	HighlightedBitmapSymbol ()
	Returns the symbol associated with the highlighted bitmap. More...
static IlSymbol *	InsensitiveBitmapSymbol ()
	Returns the symbol associated with the nonsensitive bitmap. More...
static IlvGadgetItem *	readItem (IlvInputFile &file, IlvDisplay *display)
	Reads an object description from a file. More...
static IlSymbol *	SelectedBitmapSymbol ()
	Returns the symbol associated with the selected bitmap. More...
Protected Member Functions inherited from IlvTreeGadgetItem
virtual void	computeSize (IlUShort &, IlUShort &) const
	Computes the item size. More...
Protected Member Functions inherited from IlvGadgetItem
virtual void	computeRects (IlvRect &labelRect, IlvRect &pictureRect) const
	Computes the label and picture bounding boxes. More...

Detailed Description

Tree gadget item class with a pathname.

Library: ilvadvgdt

This tree gadget item class is used by the IlvFileChooserTree objects to store a path for each item of the tree gadget.

See also

IlvFileChooserTree, IlvTreeGadgetItem.

Constructor & Destructor Documentation

IlvTreePathGadgetItem() [1/2]

IlvTreePathGadgetItem::IlvTreePathGadgetItem	(	const char *	label,
		IlvBitmap *	bitmap = 0,
		IlvPosition	position = IlvRight,
		IlUShort	spacing = IlvDefaultGadgetItemSpacing,
		IlBoolean	copy = IlTrue
	)

Constructor.

Initializes a new instance of the IlvTreePathGadgetItem class. This constructor allows you to specify both a label and a bitmap, as well as their relative alignment and spacing. The bitmap is locked.

Parameters

label	The item label.
bitmap	The item sensitive bitmap.
position	The label position relative to the picture.
spacing	The spacing between the label and the picture.
copy	Specifies whether a label should be copied. If the value is IlFalse, then memory must be allocated for the label because the label characters are deleted from memory by the IlvTreePathGadgetItem.

IlvTreePathGadgetItem() [2/2]

IlvTreePathGadgetItem::IlvTreePathGadgetItem	(	const char *	label,
		IlvGraphic *	graphic,
		IlvPosition	position = IlvRight,
		IlUShort	spacing = IlvDefaultGadgetItemSpacing,
		IlBoolean	copy = IlTrue
	)

Constructor.

Initializes a new instance of the IlvTreePathGadgetItem class. This constructor allows you to specify both a label and a graphic, as well as their relative alignment and spacing.

Parameters

label	The item label.
graphic	The item picture.
position	The label position relative to the picture.
spacing	The spacing between the label and the picture.
copy	Specifies whether a label should be copied. If the value is IlFalse, then memory must be allocated for the label because the label characters are deleted from memory by the IlvTreePathGadgetItem.

Member Function Documentation

getPathName()

const IlPathName& IlvTreePathGadgetItem::getPathName

(

)

const

Returns the path.

Returns

The full path corresponding to the label of the tree gadget item.

setPathName()

void IlvTreePathGadgetItem::setPathName

(

const IlPathName &

path

)

Sets the path.

Sets the full path corresponding to the label of the tree gadget item.

Parameters

path

The path.