IlvFileChooserTree Class Reference

Tree class for file chooser dialog. More...

#include <ilviews/gadgets/filechoo.h>

Inheritance diagram for IlvFileChooserTree:

Public Member Functions
	IlvFileChooserTree (IlvDisplay *display, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Constructor. More...
virtual IlvGadgetItem *	createItem (const char *label, IlvGraphic *graphic=0, IlvBitmap *bitmap=0, IlvBitmap *selbitmap=0, IlBoolean copy=IlTrue) const
	Returns a new gadget item. More...
Public Member Functions inherited from IlvTreeGadget
	IlvTreeGadget (IlvDisplay *display, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Constructor. More...
IlvTreeGadgetItem *	addItem (IlvTreeGadgetItem *parent, const char *label, IlInt index=-1, IlvBitmap *bitmap=0, IlvBitmap *expandedBitmap=0, IlBoolean redraw=IlTrue)
	Adds a new item to the tree gadget. More...
virtual IlBoolean	allowDragDrop () const
	Indicates whether drag-and-drop operations are allowed for the tree gadget. More...
void	allowDragDrop (IlBoolean allow)
	Specifies whether drag-and-drop operations should be allowed for the tree gadget. More...
IlBoolean	areButtonsVisible () const
	Indicates whether the buttons located to the left of parent items are displayed. More...
IlBoolean	areLinesVisible () const
	Indicates whether the lines connecting tree items to their parent are visible. More...
IlBoolean	areRootsLinked () const
	Indicates whether the children of the root item are linked by a connecting line. More...
virtual void	beginPopulate ()
	Stops all scroll bar computing while populating the tree gadget. More...
IlBoolean	buttonBBox (IlvTreeGadgetItem *item, IlvRect &bbox, const IlvTransformer *t=0) const
	Returns the bounding box of the button associated with the specified item. More...
virtual void	constantItemHeightAssumed (IlBoolean assumed)
	Indicates that all items are assumed to be the same height. More...
void	deSelectAll (IlBoolean redraw=IlTrue)
	Deselects all the selected items. More...
virtual void	drawBackground (IlvPort *, const IlvTransformer *, const IlvRegion *) const
	Draws the gadget background. More...
virtual void	drawButton (IlvPort *dst, const IlvTreeGadgetItem *item, const IlvRect &bbox, const IlvRegion *clip=0) const
	Is called to draw the button of the specified item. More...
virtual void	drawFrame (IlvPort *, const IlvTransformer *, const IlvRegion *) const
	Draws the gadget frame. More...
virtual void	drawGadgetItem (const IlvGadgetItem *, IlvPort *port, const IlvRect &rect, const IlvTransformer *t, const IlvRegion *clip) const
	Draws a specific gadget item. More...
virtual void	endPopulate (IlBoolean redraw=IlTrue)
	Launches all scroll bar computing after the populating of tree. gadget. More...
void	ensureVisible (IlvTreeGadgetItem *item, IlBoolean horizontal=IlTrue, IlBoolean redraw=IlTrue)
	Ensures that the specified tree gadget item is visible. More...
void	expandItem (IlvTreeGadgetItem *item, IlBoolean redraw=IlTrue, IlBoolean all=IlFalse)
	Expands the specified item so that its children become visible. More...
virtual void	getButtonSize (const IlvTreeGadgetItem *item, IlvDim &width, IlvDim &height) const
	Returns the size of the button of the specified tree gadget item. More...
IlvTreeGadgetItem *	getCallbackItem () const
	Returns the item that triggered the callback. More...
IlvTreeGadgetItem *	getFirstVisibleItem () const
	Returns the first visible item of the tree gadget. More...
IlvDim	getIndent () const
	Returns the number of pixels that children are indented relative to the parent. More...
virtual void	getLabelOrientation (IlvOrientation &orientation, IlBoolean &flip) const
	Returns the default orientation of the tree item labels. More...
virtual IlvPosition	getLabelPosition () const
	Returns the default position of the tree item labels, relative to the picture. More...
IlvTreeGadgetItem *	getLastFullVisibleItem (const IlvTransformer *t=0) const
	Returns the last visible item that can be seen without scrolling the tree gadget. More...
IlvTreeGadgetItem *	getLastVisibleItem (const IlvTransformer *t=0) const
	Returns the last visible item of the tree gadget. More...
IlBoolean	getLinesAtRoot () const
	Indicates whether lines connecting the root item to its children are drawn. More...
virtual IlvPalette *	getNormalTextPalette () const
	Returns the default palette used to draw an item. More...
IlvDim	getOffset () const
	Returns the horizontal offset defined for the tree gadget. More...
virtual IlvPalette *	getOpaquePalette () const
	Returns the opaque palette used to draw opaque items. More...
IlvTreeGadgetItem *	getRoot () const
	Returns the root item of the tree hierarchy. More...
IlvTreeSelectionMode	getSelectionMode () const
	Returns the selection mode of the tree gadget. More...
virtual IlBoolean	handleGadgetEvent (IlvEvent &event)
	Handles the gadget events. More...
virtual IlBoolean	handleTreeEvent (IlvEvent &event)
	Handles the events occurring to the tree. More...
virtual IlBoolean	hasToolTips () const
	Indicates whether the tree gadget displays tooltips. More...
virtual IlBoolean	isConstantItemHeightAssumed () const
	Returns IlTrue when all items are assumed to be the same height. More...
virtual IlBoolean	isEditable () const
	Indicates whether the tree items can be edited. More...
virtual IlBoolean	isShowingLabel () const
	Indicates whether the tree item labels are displayed. More...
virtual IlBoolean	isShowingPicture () const
	Indicates whether the tree item pictures are displayed. More...
IlBoolean	itemBBox (IlvTreeGadgetItem *item, IlvRect &bbox, const IlvTransformer *t=0) const
	Returns the bounding box of the specified item. More...
void	linkRoots (IlBoolean value, IlBoolean redraw=IlTrue)
	Specifies whether the children of the root item should be linked by a connecting line. More...
IlvTreeGadgetItem *	pointToItem (const IlvPoint &point, IlBoolean &button, const IlvTransformer *t) const
	Returns the item located at the specified position. More...
IlvTreeGadgetItem *	pointToItemLine (const IlvPoint &point, const IlvTransformer *t) const
	Returns the item located at the specified point. More...
virtual void	recomputeAllItems ()
	Recomputes the size of all the items managed by the holder. More...
void	removeAllItems (IlBoolean redraw=IlTrue)
	Removes all the items from the tree gadget. More...
void	removeItem (IlvTreeGadgetItem *item, IlBoolean redraw=IlTrue)
	Removes and destroys the specified item. More...
void	scrollToItem (IlvTreeGadgetItem *item, IlBoolean redraw=IlTrue)
	Sets the specified item as the first visible item in the tree gadget. More...
void	selectItem (IlvTreeGadgetItem *item, IlBoolean value, IlBoolean deselectAll=IlTrue, IlBoolean redraw=IlTrue)
	Selects or deselects the specified tree gadget item. More...
void	setEditable (IlBoolean value=IlTrue)
	Specifies whether the tree gadget should be editable. More...
void	setIndent (IlvDim indent, IlBoolean redraw=IlTrue)
	Sets the number of pixels that children are indented relative to the parent. More...
void	setLabelOrientation (IlvOrientation orientation, IlBoolean flip=IlFalse, IlBoolean redraw=IlTrue)
	Sets the default orientation of the tree item labels. More...
void	setLabelPosition (IlvPosition position, IlBoolean redraw=IlTrue)
	Sets the default position of the tree item labels, relative to the picture. More...
void	setLinesAtRoot (IlBoolean value, IlBoolean redraw=IlTrue)
	Specifies whether lines connecting the root item to its children should be drawn. More...
void	setOffset (IlvDim offset, IlBoolean redraw=IlTrue)
	Sets the horizontal offset of the tree gadget. More...
void	setSelectionMode (IlvTreeSelectionMode mode)
	Specifies the selection mode of the tree gadget. More...
void	showButtons (IlBoolean value, IlBoolean redraw=IlTrue)
	Shows or hides the buttons appearing to the left of each parent item. More...
void	showLabel (IlBoolean value=IlTrue, IlBoolean redraw=IlTrue)
	Indicates whether the tree item labels should be shown or hidden. More...
void	showLines (IlBoolean value, IlBoolean redraw=IlTrue)
	Shows or hides the lines connecting the tree items to their parent. More...
void	showPicture (IlBoolean value=IlTrue, IlBoolean redraw=IlTrue)
	Specifies whether the tree item pictures should be shown or hidden. More...
void	shrinkItem (IlvTreeGadgetItem *item, IlBoolean redraw=IlTrue)
	Shrinks the specified item so that its children are no longer visible. More...
virtual void	sort (IlvTreeGadgetItem *=0, IlUInt levels=(IlUInt) -1, IlvTreeGadgetItemCompareFunction=0)
	Sorts the children of the specified item. More...
void	useToolTips (IlBoolean value=IlTrue)
	Specifies whether the tree gadget should display tooltips. More...
Public Member Functions inherited from IlvScrolledGadget
	IlvScrolledGadget (IlvDisplay *display, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Constructor. More...
virtual void	adjustScrollBars (IlBoolean redraw=IlFalse)
	Recomputes the scroll bars. More...
void	computeBBox (IlvRect &ibox, IlvRect &vbox, IlvRect &vs, IlvRect &hs, const IlvTransformer *t=0) const
	Computes the bounding boxes of the elements that compose the gadget. More...
void	computeBBox (IlvRect &ibox, IlvRect &vs, IlvRect &hs, const IlvTransformer *t=0) const
	Computes the bounding boxes of the elements that compose the gadget. More...
virtual IlvScrollBar *	createScrollBar (const IlvRect &rect, IlvDirection direction, IlUShort thickness, IlvPalette *palette)
	Returns a new instance of the IlvScrollBar class. More...
virtual void	drawScrollBar (IlvPort *dst, IlvDirection direction, const IlvTransformer *t=0, const IlvRegion *clip=0) const
	Draws the specified internal scroll bar. More...
void	fitToRect (const IlvRect &rect)
	Resizes the object so that the scrollable area fits the specified rectangle. More...
IlUShort	getBottomMargin () const
	Returns the bottom margin. More...
IlvScrollBar *	getHorizontalScrollBar () const
	Returns a pointer to the internal horizontal scroll bar. More...
IlUShort	getLeftMargin () const
	Returns the left margin. More...
IlUShort	getRightMargin () const
	Returns the right margin. More...
IlvScrollBar *	getScrollBar (IlvDirection direction) const
	Returns a pointer to the specified internal scroll bar. More...
void	getScrollBarShowAsNeeded (IlBoolean &vert, IlBoolean &hor) const
	Returns the scroll bar mode of the internal scroll bars. More...
IlUShort	getTopMargin () const
	Returns the top margin. More...
IlvScrollBar *	getVerticalScrollBar () const
	Returns a pointer to the internal vertical scroll bar. More...
virtual IlBoolean	handleScrollBarsEvent (IlvEvent &event)
	Handles the internal scroll bars event. More...
void	hideScrollBar (IlvDirection direction, IlBoolean redraw=IlTrue)
	Hides the specified internal scroll bar. More...
virtual void	internalBBox (IlvRect &bbox, const IlvTransformer *t=0) const
	Returns the internal bounding box of the gadget. More...
void	moveScrollBar (IlvDirection direction, IlvPosition where, IlBoolean redraw=IlTrue)
	Moves the specified internal scroll bar to a new position. More...
virtual void	scrollableSize (IlvDim &width, IlvDim &height) const
	Returns the size of the scrollable area of the gadget. More...
virtual void	scrollBarBBox (IlvDirection direction, IlvRect &bbox, const IlvTransformer *t=0) const
	Returns the bounding box of the specified internal scroll bar. More...
virtual void	scrollBarHasMoved (IlvDirection direction)
	Is called when an internal scroll bar has moved. More...
void	scrollBarShowAsNeeded (IlBoolean vertical, IlBoolean horizontal, IlBoolean redraw=IlTrue)
	Sets the scroll bar mode of the internal scroll bars. More...
virtual void	scrollBarVisibilityChanged (IlvDirection direction)
	Is called when an internal scroll bar is shown or hidden. More...
void	setBottomMargin (IlUShort margin)
	Sets the bottom margin. More...
void	setLeftMargin (IlUShort margin)
	Sets the left margin. More...
void	setMargin (IlUShort val)
	Sets the left, right, top, and bottom margins. More...
void	setRightMargin (IlUShort margin)
	Sets the right margin. More...
void	setTopMargin (IlUShort margin)
	Sets the top margin. More...
void	showScrollBar (IlvDirection direction, IlBoolean redraw=IlTrue)
	Shows the specified internal scroll bar. More...
virtual void	visibleBBox (IlvRect &bbox, const IlvTransformer *t=0) const
	Returns the visible bounding box of the gadget. More...
IlvPosition	whereIsScrollBar (IlvDirection direction) const
	Returns the location of the specified internal scroll bar. More...
Public Member Functions inherited from IlvTreeGadgetItemHolder
void	addItem (IlvTreeGadgetItem *parent, IlvTreeGadgetItem *item, IlInt index=-1)
	Adds the specified item to the tree hierarchy. More...
virtual IlvGadgetItem *	applyToItems (IlvApplyGadgetItem f, IlAny arg)
	Applies the specified function to all the items of the holder. More...
virtual int	compareItems (const IlvTreeGadgetItem *item1, const IlvTreeGadgetItem *item2) const
	Compares a pair of items. More...
void	deSelectAll ()
	Deselects all the selected items. More...
void	detachItem (IlvTreeGadgetItem *item)
	Removes the specified item from the tree without destroying it. More...
IlvTreeGadgetItem *	getFirstSelectedItem () const
	Retrieves the first selected item. More...
IlUInt	getItemsCount () const
	Returns the number of items in the tree. More...
IlUInt	getVisibleItemsCount () const
	Returns the number of visible tree items. More...
void	moveItem (IlvTreeGadgetItem *item, IlvTreeGadgetItem *parent, IlInt index=-1)
	Moves the specified item to a new parent. More...
void	removeItem (IlvTreeGadgetItem *item)
	Removes the specified item from the tree. More...
Public Member Functions inherited from IlvGadgetItemHolder
IlvGadgetItem *	getCallbackItem () const
	Returns the item that triggered a callback. More...
IlvGadgetItem *	getDragDropTarget () const
	Returns the target item of a drag-and-drop operation. More...
IlvGraphic *	getDraggedImage () const
	Returns the graphic object used to draw the ghost image during a drag-and-drop operation. More...
IlvGadgetItem *	getDraggedItem () const
	Returns the item that is being dragged during a drag-and-drop operation. More...
IlvGadgetItem *	getEditedItem () const
	Returns the item that is being edited. More...
virtual IlvPalette *	getHighlightTextPalette () const
	Returns the highlight palette used to draw the label of highlighted items. More...
virtual IlvGadgetItem *	getItemByName (const char *name) const
	Returns the item whose name is specified. More...
IlvGadgetItem *	getToolTipItem () const
	Returns the item that is displaying a tooltip. More...
virtual void	initReDrawItems ()
	Begins a redraw session. More...
virtual void	reDrawItems ()
	Ends a redraw session. More...
void	setDragDropTarget (IlvGadgetItem *item)
	Sets the target item of a drag-and-drop operation. More...
void	setDraggedImage (IlvGraphic *graphic)
	Sets the graphic object used to draw the ghost image during a drag-and-drop operation. More...
void	setDraggedItem (IlvGadgetItem *item)
	Sets the dragged item. More...

Additional Inherited Members
Static Public Member Functions inherited from IlvTreeGadget
static IlSymbol *	ExpandCallbackType ()
	Returns the callback type for the Expand callback. More...
static IlSymbol *	SelectCallbackType ()
	Returns the callback type for the Select callback. More...
static IlSymbol *	ShrinkCallbackType ()
	Returns the callback type for the Shrink callback. More...
Static Public Member Functions inherited from IlvScrolledGadget
static IlSymbol *	ScrollBarMovedSymbol ()
	Returns the callback type for the Scroll Bar Moved callback. More...
static IlSymbol *	ScrollBarVisibilitySymbol ()
	Returns the callback type for the Scroll Bar Visibility Changed callback. More...
Static Public Member Functions inherited from IlvGadgetItemHolder
static IlSymbol *	AbortDragItemCallbackType ()
	Returns the callback type of the Abort Drag callback. More...
static IlSymbol *	AbortEditItemCallbackType ()
	Returns the callback type of the Abort Edit callback. More...
static IlSymbol *	ActivateCallbackType ()
	Returns the callback type of the Activate callback. More...
static IlSymbol *	DragItemCallbackType ()
	Returns the callback type of the Drag Item callback. More...
static IlSymbol *	EndDragItemCallbackType ()
	Returns the callback type of the End Drag callback. More...
static IlSymbol *	EndEditItemCallbackType ()
	Returns the callback type of the End Edit callback. More...
static IlSymbol *	StartDragItemCallbackType ()
	Returns the callback type of the Start Drag callback. More...
static IlSymbol *	StartEditItemCallbackType ()
	Returns the callback type of the Start Edit callback. More...
Protected Member Functions inherited from IlvTreeGadget
virtual void	activate (IlvTreeGadgetItem *item)
	Is called by the interactor when an item is activated. More...
virtual void	adjustFromScrollBar (const IlvScrollBar *sb, IlvDirection dir)
	Is called to adjust the gadget to the scroll bars values. More...
virtual void	adjustScrollBarValue (IlvScrollBar *sb, IlvDirection dir)
	Is called to adjust the scroll bar values. More...
virtual void	deSelect (IlvTreeGadgetItem *item)
	Is called by the interactor when an item is deselected. More...
virtual void	drawGadgetContents (IlvPort *dst, const IlvTransformer *t=0, const IlvRegion *clip=0) const
	Draws the gadget contents. More...
virtual void	expand (IlvTreeGadgetItem *item)
	Is called by the interactor when an item is expanded. More...
virtual void	itemActivated (IlvGadgetItem *item)
	Is called when an item is activated. More...
virtual void	itemDeSelected (IlvGadgetItem *item)
	Is called when an item is deselected. More...
virtual void	itemSelected (IlvGadgetItem *item)
	Is called when an item is selected. More...
virtual void	select (IlvTreeGadgetItem *item)
	Is called by the interactor when an item is selected. More...
virtual void	shrink (IlvTreeGadgetItem *item)
	Is called by the interactor when an item is shrunk. More...
Protected Member Functions inherited from IlvScrolledGadget
IlvDim	getLimitHeightValue () const
	Returns the limit value for the vertical scrolling. More...
IlvDim	getLimitWidthValue () const
	Returns the limit value for the horizontal scrolling. More...
IlvDim	getScrollableHeight () const
	Returns the height of the scrollable area. More...
IlvDim	getScrollableWidth () const
	Returns the width of the scrollable area. More...
void	setLimitHeightValue (IlvDim value)
	Sets the limit value for the vertical scrolling. More...
void	setLimitWidthValue (IlvDim value)
	Sets the limit value for the horizontal scrolling. More...
void	setScrollableHeight (IlvDim height)
	Sets the height of the scrollable area. More...
void	setScrollableWidth (IlvDim width)
	Sets the width of the scrollable area. More...
Protected Member Functions inherited from IlvGadgetItemHolder
virtual void	abortDragItem ()
	Is called when a drag-and-drop operation is aborted. More...
virtual void	abortEdit (IlvGadgetItem *item)
	Is called when the editing of the specified item is aborted. More...
virtual void	drawDraggedImage (const IlvPoint &point, const IlvTransformer *t)
	Is called to draw the ghost image during a drag-and-drop operation. More...
virtual void	endDragItem (const IlvPoint &point)
	Is called when a drag-and-drop operation is finished. More...
virtual void	endEdit (IlvGadgetItem *item)
	Is called after an item has been edited. More...
virtual void	itemDragged (const IlvPoint &point)
	Is called each time the user moves the mouse during a drag-and-drop operation. More...
virtual void	itemHighlighted (IlvGadgetItem *item)
	Is called when an item is highlighted or unhighlighted. More...
virtual void	startDragItem (IlvGadgetItem *item)
	Is called when a drag-and-drop operation begins. More...
virtual void	startEdit (IlvGadgetItem *item)
	Is called when an item is edited. More...

Detailed Description

Tree class for file chooser dialog.

Library: ilvadvgdt

This tree gadget class manages a subclass of tree gadget item (IlvTreePathGadgetItem) which can store path name information. An object of this class is used by the file chooser dialog to display the directory tree. Note: The objects of this class cannot be saved to ilv files.

See also

IlvTreePathGadgetItem, IlvFileChooser, IlvTreeGadget.

Constructor & Destructor Documentation

IlvFileChooserTree()

IlvFileChooserTree::IlvFileChooserTree	(	IlvDisplay *	display,
		const IlvRect &	rect,
		IlUShort	thickness = IlvDefaultGadgetThickness,
		IlvPalette *	palette = 0
	)

Constructor.

Initializes a new instance of the class IlvFileChooserTree.

Parameters

display	The connection to the display.
rect	The size and position of the tree gadget.
thickness	The thickness of the tree gadget.
palette	The palette used by the tree gadget.

Member Function Documentation

createItem()

virtual IlvGadgetItem* IlvFileChooserTree::createItem ( const char *  label, IlvGraphic *  graphic = 0, IlvBitmap *  bitmap = 0, IlvBitmap *  selbitmap = 0, IlBoolean  copy = IlTrue  ) const

virtual

Returns a new gadget item.

You can override this member function in a subclass to create your own gadget items, however your subclass of gadget item must inherit from IlvTreePathGadgetItem.

Parameters

label	The item label.
graphic	The IlvGraphic object representing the picture associated with the item.
bitmap	The IlvBitmap object representing the picture associated with the item.
selbitmap	The IlvBitmap object representing the picture of the item when it is selected.
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 IlvGadgetItem.

Note

If the second and third parameters are both not 0, only the second parameter is used.

Returns

The created gadget item.

Reimplemented from IlvTreeGadget.