IlvFileChooserSheet Class Reference

Sheet class for file chooser dialog. More...

#include <ilviews/gadgets/filechoo.h>

Inheritance diagram for IlvFileChooserSheet:

List of all members.

Public Member Functions
	IlvFileChooserSheet (IlvDisplay *display, const IlvRect &rect, IlvFileChooser *fc)
	Constructor.
virtual void	changeSelectionTo (IlUShort col, IlUShort row)
	Clears the current selection and selects specified cell.
virtual IlvGadgetItem *	createItem (const char *label, IlvGraphic *graphic=0, IlvBitmap *bitmap=0, IlvBitmap *selbitmap=0, IlBoolean copy=IlTrue) const
	Returns a new gadget item.
virtual void	deSelect ()
	Deselects all the items in the matrix.
IlvMatrixCoordinate **	getSelectionRange (IlUShort &count) const
	Returns the selection.
virtual IlBoolean	handleMatrixEvent (IlvEvent &)
	Handles the events sent to the matrix.
virtual void	insertColumn (IlUShort col=0, IlUShort count=1)
	Inserts columns in the matrix.
virtual void	insertRow (IlUShort row=0, IlUShort count=1)
	Inserts rows in the matrix.
virtual IlBoolean	remove (IlUShort col, IlUShort row, IlBoolean destroy=IlTrue)
	Removes an item from the matrix.
virtual void	removeColumn (IlUShort col, IlBoolean destroy=IlTrue)
	Removes a column from the matrix.
virtual void	removeRow (IlUShort row, IlBoolean destroy=IlTrue)
	Removes a row from the matrix.
virtual void	set (IlUShort col, IlUShort row, IlvAbstractMatrixItem *item)
	Adds an item to the matrix at the specified location.
virtual void	setColumnSelected (IlUShort col, IlBoolean selected=IlTrue)
	Selects or deselects an entire column.
virtual void	setItemSelected (IlUShort col, IlUShort row, IlBoolean selected=IlTrue)
	Specifies whether the item located in the specified cell should be selected.
virtual void	setRowSelected (IlUShort row, IlBoolean selected=IlTrue)
	Selects or deselects an entire row.

---

Detailed Description

Sheet class for file chooser dialog.

Library: ilvadvgdt

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

See also:

IlvPathGadgetItem, IlvFileChooser, IlvSheet

---

Constructor & Destructor Documentation

IlvFileChooserSheet::IlvFileChooserSheet	(	IlvDisplay *	display,
		const IlvRect &	rect,
		IlvFileChooser *	fc
	)

Constructor.

Initializes a new instance of IlvFileChooserSheet class.

Parameters:

	display	The connection to the display.
	rect	The size and position of the sheet.
	fc	The dialog which contains the sheet.

---

Member Function Documentation

virtual void IlvFileChooserSheet::changeSelectionTo	(	IlUShort	col,
		IlUShort	row
	)			[virtual]

Clears the current selection and selects specified cell.

Clears the current selection, and selects the cell specified by col and row. It also sets the selection anchor to the specified cell.

This method is called by the matrix interactor when starting a multiple cell selection operation.

Parameters:

	col	The column index of the cell to select.
	row	The row index of the cell to select.

See also:

setSelectionAnchor, extendSelection

Reimplemented from IlvMatrix.

virtual IlvGadgetItem* IlvFileChooserSheet::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 items, however your subclass of gadget item must inherit from IlvPathGadgetItem.

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	A Boolean value specifying 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.

Warning:

[note] If the second and third parameters are both not null, only the second parameter is used.

Returns:

The created gadget item.

Reimplemented from IlvGadgetItemHolder.

virtual void IlvFileChooserSheet::deSelect

(

)

[virtual]

Deselects all the items in the matrix.

The matrix is not redrawn.

See also:

setItemSelected

Reimplemented from IlvMatrix.

IlvMatrixCoordinate** IlvFileChooserSheet::getSelectionRange

(

IlUShort &

count

)

const

Returns the selection.

Returns an array of IlvMatrixCoordinate objects. Each object contains the coordinates of a selected item.

Parameters:

count

The array size.

Returns:

The array of coordinates.

virtual IlBoolean IlvFileChooserSheet::handleMatrixEvent

(

IlvEvent &

event

)

[virtual]

Handles the events sent to the matrix.

Is called by the member function handleEvent to handle an event applying to the matrix. Scroll bar events are handled by the method IlvScrolledGadget::handleScrollBarsEvent. The default implementation does nothing and must be redefined if necessary.

Parameters:

event

The event.

Returns:

IlTrue if the matrix used the events, or IlFalse otherwise.

See also:

IlvGadget::handleEvent, IlvScrolledGadget::handleScrollBarsEvent

Reimplemented from IlvSheet.

virtual void IlvFileChooserSheet::insertColumn	(	IlUShort	col = 0,
		IlUShort	count = 1
	)			[virtual]

Inserts columns in the matrix.

Parameters:

	col	The column before which the new columns will be added. If col is greater than the number of columns in the matrix, the new columns are added at the end of the matrix.
	count	The number of columns to be inserted.

See also:

removeColumn, insertRow, reinitialize

Reimplemented from IlvMatrix.

virtual void IlvFileChooserSheet::insertRow	(	IlUShort	row = 0,
		IlUShort	count = 1
	)			[virtual]

Inserts rows in the matrix.

Parameters:

	row	The row before which the new rows will be added. If row is greater that the number of rows in the matrix, the new rows are added at the end of the matrix.
	count	The number of rows to be inserted.

See also:

removeRow, insertColumn, reinitialize

Reimplemented from IlvMatrix.

virtual IlBoolean IlvFileChooserSheet::remove	(	IlUShort	col,
		IlUShort	row,
		IlBoolean	destroy = IlTrue
	)			[virtual]

Removes an item from the matrix.

Removes the item located in the matrix cell specified by col and row.

Parameters:

	col	The index of the column containing the item to be removed.
	row	The index of the row containing the item to be removed.
	destroy	A Boolean value specifying whether the removed item should be deleted.

Returns:

IlTrue if the operation was successful, and IlFalse if there is no item at the specified location.

See also:

add, set, getCardinal, getItem

Reimplemented from IlvMatrix.

virtual void IlvFileChooserSheet::removeColumn	(	IlUShort	col,
		IlBoolean	destroy = IlTrue
	)			[virtual]

Removes a column from the matrix.

Parameters:

	col	The index of the column to be removed.
	destroy	A Boolean value specifying whether the items that this column contains are deleted.

See also:

insertColumn, removeRow

Reimplemented from IlvMatrix.

virtual void IlvFileChooserSheet::removeRow	(	IlUShort	row,
		IlBoolean	destroy = IlTrue
	)			[virtual]

Removes a row from the matrix.

Parameters:

	row	The index of the row to be removed.
	destroy	A Boolean value specifying whether the items that this row contains are deleted.

See also:

insertRow, removeColumn

Reimplemented from IlvMatrix.

virtual void IlvFileChooserSheet::set	(	IlUShort	col,
		IlUShort	row,
		IlvAbstractMatrixItem *	item
	)			[virtual]

Adds an item to the matrix at the specified location.

Adds item to the matrix at the location specified by col and row. If there is already a matrix item at this location, this item is deleted before item is inserted.

Parameters:

	col	The index of the column where item is inserted.
	row	The index of the row where item is inserted.
	item	The matrix item to be inserted.

See also:

add, remove, getCardinal, getItem

Reimplemented from IlvMatrix.

virtual void IlvFileChooserSheet::setColumnSelected	(	IlUShort	col,
		IlBoolean	selected = IlTrue
	)			[virtual]

Selects or deselects an entire column.

Sets the selection state of col to selected. The column is not redrawn.

Parameters:

	col	The column index.
	selected	A Boolean value specifying whether the column should be selected (IlTrue) or not (IlFalse).

See also:

setRowSelected, setItemSelected, IlvAbstractMatrix::invalidateColumn

Reimplemented from IlvMatrix.

virtual void IlvFileChooserSheet::setItemSelected	(	IlUShort	col,
		IlUShort	row,
		IlBoolean	selected = IlTrue
	)			[virtual]

Specifies whether the item located in the specified cell should be selected.

Parameters:

	col	The index of the column containing the item.
	row	The index of the row containing the item.
	selected	A Boolean value specifying whether the item located in the cell specified by col and row should be selected (IlTrue) or not (IlFalse).

See also:

isItemSelected, setRowSelected, setColumnSelected

Reimplemented from IlvMatrix.

virtual void IlvFileChooserSheet::setRowSelected	(	IlUShort	row,
		IlBoolean	selected = IlTrue
	)			[virtual]

Selects or deselects an entire row.

Sets the selection state of row to selected. The row is not redrawn.

Parameters:

	row	The row index.
	selected	A Boolean value specifying whether the row should be selected (IlTrue) or not (IlFalse).

See also:

setColumnSelected, setItemSelected, IlvAbstractMatrix::invalidateRow

Reimplemented from IlvMatrix.