Functions
StatusInt	mdlDialog_treeGetInfo (UInt32 attributesP, long nRowsP, long nColumnsP, long detailPanelIdP, RawItemHdr *pTree)
	Retrieves several parameters associated with a Tree item. More...

StatusInt	mdlDialog_treeGetInfoEx (UInt32 attributesP, long nRowsP, long nColumnsP, long detailPanelIdP, UInt32 attributesExP, UInt32 statusFlagsP, RawItemHdr *pTree)
	An extension of mdlDialog_treeGetInfo that also gets extended attributes and status flags associated with a Tree item. More...

StatusInt	mdlDialog_treeSetInfo (UInt32 attributesP, long nRowsP, long detailPanelIdP, bool redraw, RawItemHdr pTree)
	Sets several parameters associated with a Tree item. More...

StatusInt	mdlDialog_treeSetInfoEx (UInt32 attributesP, long nRowsP, long detailPanelIdP, UInt32 attributesExP, bool redraw, RawItemHdr *pTree)
	An extension of mdlDialog_treeSetInfo that also can set extended attributes in a Tree item. More...

GuiTreeModelP	mdlDialog_treeGetTreeModelP (RawItemHdr *pTree)
	Retrieves the GuiTreeModel pointer from the Tree item. More...

ErrorCode	mdlDialog_treeSetTreeModelP (RawItemHdr *pTree, GuiTreeModelP pTreeModel)
	Sets the GuiTreeModel pointer in the Tree item. More...

ErrorCode	mdlDialog_treeSetTreeModelPEx (RawItemHdr *pTree, GuiTreeModelP pTreeModel, bool redraw)
	Sets the GuiTreeModel pointer in the Tree item and allows you to control the redrawing of the Tree item after setting the GuiTreeModel. More...

ErrorCode	mdlDialog_treeModelUpdated (RawItemHdr *pTree, bool redraw)
	Notifies the Tree item that the GuiTreeModel has been updated. More...

StatusInt	mdlDialog_treeGetHeights (int rowHeightP, int headingHeightP, int labelHeightP, RawItemHdr pTreeP)
	Retrieves certain internal heights from the Tree item. More...

ErrorCode	mdlDialog_treeGetDisplayRange (int topRowIndexP, int bottomRowIndexP, int leftColIndexP, int rightColIndexP, RawItemHdr *pTree)
	Gets the range of the cells that are displayed in the Tree item. More...

ErrorCode	mdlDialog_treeSetTopRow (RawItemHdr *pTree, int topRowIndex, bool redraw)
	Sets the first displayed row index in a Tree item. More...

ErrorCode	mdlDialog_treeDrawContents (RawItemHdr *pTree, int relRowIndex, int relColIndex)
	Draws the contents of a Tree item. More...

ErrorCode	mdlDialog_treeGetSelectRange (int minRowIndexP, int maxRowIndexP, int minColIndexP, int maxColIndexP, RawItemHdr *pTree)
	Gets the range of the cells that are currently selected in the Tree item. More...

ErrorCode	mdlDialog_treeGetNextSelection (bool foundP, int rowIndexP, int colIndexP, RawItemHdr pTree)
	Searches for the next selected cell of a Tree item. More...

StatusInt	mdlDialog_treeGetSelections (int nSelectionsP, Point2d selectionsPP, RawItemHdr pTree)
	Retrieves a pointer to an array indicating which cells of a Tree item are currently selected. More...

StatusInt	mdlDialog_treeSetSelections (RawItemHdr pTree, int nSelections, Point2d selectionsP, bool deselectAllFirst, bool redraw)
	Sets which cells in a Tree item are selected given a pointer to an array of cell coordinates. More...

StatusInt	mdlDialog_treeGetLocationCursor (int locationRowP, int locationColP, RawItemHdr *pTree)
	Retrieves the location of the selection cursor from a Tree item. More...

StatusInt	mdlDialog_treeSetLocationCursor (RawItemHdr *pTree, int locationRow, int locationCol)
	Sets the location of the selection cursor in a Tree item. More...

StatusInt	mdlDialog_treeFindCell (int iRowP, int iColP, RawItemHdr pTree, Point2d ptP)
	Returns the row and column in the Tree at the current mouse position, ptP. More...

bool	mdlDialog_treeIsCellSelected (RawItemHdr *pTree, int rowIndex, int colIndex)
	Determines if a cell is selected in a Tree item. More...

bool	mdlDialog_treeIsCellEnabled (RawItemHdr *pTree, int rowIndex, int colIndex)
	Determines if a cell is enabled in a Tree item. More...

ErrorCode	mdlDialog_treeLastCellClicked (int rowIndexP, int colIndexP, RawItemHdr *pTree)
	Determines the cell in the Tree item in which the data button was last clicked. More...

ErrorCode	mdlDialog_treeSelectCells (RawItemHdr *pTree, int minRowIndex, int maxRowIndex, int minColIndex, int maxColIndex, bool selectOn, bool redraw)
	Selects/deselects a range of cells in a Tree item. More...

ErrorCode	mdlDialog_treeEnableCells (RawItemHdr *pTree, int minRowIndex, int maxRowIndex, int minColIndex, int maxColIndex, bool enable, bool redraw)
	Enables/disables a range of cells in a Tree item. More...

StatusInt	mdlDialog_treeGetColInfo (int widthP, int maxSizeP, UInt32 attributesP, WChar headingP, int originXP, RawItemHdr pTree, int columnIndex)
	Retrieves several parameters associated with individual columns in a Tree item. More...

StatusInt	mdlDialog_treeSetColInfo (int widthP, int maxSizeP, UInt32 attributesP, WCharCP headingP, RawItemHdr pTree, int columnIndex, bool redraw)
	Sets several parameters associated with individual columns in a Tree item. More...

StatusInt	mdlDialog_treeInsertColumn (int widthP, int maxSizeP, UInt32 attributesP, WCharCP headingP, RawItemHdr pTree, int columnIndex, bool redraw)
	Inserts a new column into a Tree item. More...

StatusInt	mdlDialog_treeDeleteColumn (RawItemHdr *pTree, int columnIndex, bool redraw)
	Deletes one column from a Tree item. More...

StatusInt	mdlDialog_treeDeleteAll (RawItemHdr *pTree)
	Deletes all columns from a Tree item. More...

StatusInt	mdlDialog_treeSetContainer (RawItemHdr pTree, int containerId, MdlDesc containerOwnerMD, bool redraw)
	Sets the container and owner in the specified Tree item. More...

ErrorCode	mdlDialog_treeGetEditCell (int rowIndexP, int colIndexP, RawItemHdr *pTree)
	Gets the row and column of the cell being edited in the Tree item. More...

ErrorCode	mdlDialog_treeEditCell (RawItemHdr *pTree, int rowIndex, int colIndex)
	Starts a cell editing session on the specified row and column in the Tree item. More...

ErrorCode	mdlDialog_treeExpandRow (RawItemHdr *pTree, int rowIndex, bool bExpandAll)
	Expands a tree row and optionally expands all the row's descendents. More...

ErrorCode	mdlDialog_treeMakeRowVisible (RawItemHdr *pTree, int rowIndex)
	Makes a row visible by scrolling it into view. More...

ErrorCode	mdlDialog_treeNodePortionClicked (TreeNodePortion tnPortionP, RawItemHdr pTree)
	Gets the portion of the node last clicked. More...

ErrorCode	mdlDialog_treeGetFullWidth (int iFullWidthP, bool bSetColumnWidths, RawItemHdr pTree)
	Gets the width of a Tree with all columns expanded based on the widest column values. More...

ErrorCode	mdlDialog_treeSetColumnHeading (WCharCP headingP, RawItemHdr *pTree, int columnIndex, bool redraw)
	Updates a column's heading to a Unicode string. More...

Detailed Description

Function Documentation

StatusInt mdlDialog_treeDeleteAll ( RawItemHdr * pTree )

Deletes all columns from a Tree item.

Parameters

[in] pTree points to the RawItemHdr for the Tree item

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeDeleteColumn

StatusInt mdlDialog_treeDeleteColumn	(	RawItemHdr *	pTree,
		int	columnIndex,
		bool	redraw
	)

Deletes one column from a Tree item.

Parameters

[in]	pTree	points to the RawItemHdr for the Tree item
[in]	columnIndex	indicates which column to delete
[in]	redraw	indicates whether the Tree should be redrawn

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeDeleteAll

ErrorCode mdlDialog_treeDrawContents	(	RawItemHdr *	pTree,
		int	relRowIndex,
		int	relColIndex
	)

Draws the contents of a Tree item.

Parameters

[in]	pTree	points to the RawItemHdr for the Tree item.
[in]	relRowIndex	is the 0-based index of row to draw. If the value is -1, all displayed rows will be redrawn
[in]	relColIndex	is the 0-based index of column to draw. If the value is -1, all displayed columns will be redrawn

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeGetDisplayRange

ErrorCode mdlDialog_treeEditCell	(	RawItemHdr *	pTree,
		int	rowIndex,
		int	colIndex
	)

Starts a cell editing session on the specified row and column in the Tree item.

Parameters

[in]	pTree	is the tree item to start the edit session for.
[in]	rowIndex	is the 0-based index of the row to edit.
[in]	colIndex	is the 0-based index of the column to edit.

Returns: SUCCESS, or non-zero value if an error occurs.

See also: mdlDialog_treeGetEditCell

ErrorCode mdlDialog_treeEnableCells	(	RawItemHdr *	pTree,
		int	minRowIndex,
		int	maxRowIndex,
		int	minColIndex,
		int	maxColIndex,
		bool	enable,
		bool	redraw
	)

Enables/disables a range of cells in a Tree item.

Parameters

[in]	pTree	points to the RawItemHdr for the Tree item
[in]	minRowIndex	is an integer representing the 0-based index of first row to process
[in]	maxRowIndex	is an integer representing the 0-based index of last row to process
[in]	minColIndex	is an integer representing the the 0-based index of first column to process
[in]	maxColIndex	is an integer representing the 0-based index of last column to process
[in]	enable	should be set to true to enable the range of cells or false to disable the range
[in]	redraw	indicates whether the Tree should be redrawn

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeSelectCells mdlDialog_treeIsCellEnabled mdlDialog_treeIsCellSelected

ErrorCode mdlDialog_treeExpandRow	(	RawItemHdr *	pTree,
		int	rowIndex,
		bool	bExpandAll
	)

Expands a tree row and optionally expands all the row's descendents.

Parameters

[in]	pTree	is the tree item to process.
[in]	rowIndex	is the 0-based index of the row to expand.
[in]	bExpandAll	Indicates whether to expand all descendents of the row.

Returns: SUCCESS, or non-zero value if an error occurs.

StatusInt mdlDialog_treeFindCell	(	int *	iRowP,
		int *	iColP,
		RawItemHdr *	pTree,
		Point2d *	ptP
	)

Returns the row and column in the Tree at the current mouse position, ptP.

Parameters

[out]	iRowP	The row in the Tree found at the cursor position. Can be NULL
[out]	iColP	The column in the Tree found at the cursor position. Can be NULL
[in]	pTree	Tree to search for cell
[in]	ptP	the cursor location

Returns: SUCCESS if a row and colunm were located at the cursor position, or ERROR otherwise.

See also: mdlDialog_treeGetNextSelection

StatusInt mdlDialog_treeGetColInfo	(	int *	widthP,
		int *	maxSizeP,
		UInt32 *	attributesP,
		WChar *	headingP,
		int *	originXP,
		RawItemHdr *	pTree,
		int	columnIndex
	)

Retrieves several parameters associated with individual columns in a Tree item.

Parameters

[out]	widthP	points to an integer representing the width of the column in dialog coordinates
[out]	maxSizeP	points to an integer representing the maximum allowable length of an entry in the specified column
[out]	attributesP	points to an unsigned long that contains the column's attributes.
[out]	headingP	points to a character buffer that contains the column's title
[out]	originXP	points to an integer representing the X origin of the column in pixels
[in]	pTree	points to the RawItemHdr for the Tree item
[in]	columnIndex	is the index of the column to process

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeSetInfo

ErrorCode mdlDialog_treeGetDisplayRange	(	int *	topRowIndexP,
		int *	bottomRowIndexP,
		int *	leftColIndexP,
		int *	rightColIndexP,
		RawItemHdr *	pTree
	)

Gets the range of the cells that are displayed in the Tree item.

Parameters

[out]	topRowIndexP	points to an integer representing the 0-based index of first row displayed
[out]	bottomRowIndexP	points to an integer representing the 0-based index of last row displayed
[out]	leftColIndexP	points to an integer representing the the 0-based index of the leftmost column displayed
[out]	rightColIndexP	points to an integer representing the 0-based index of the rightmost column displayed
[in]	pTree	points to the RawItemHdr for the Tree item

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeSetTopRow

ErrorCode mdlDialog_treeGetEditCell	(	int *	rowIndexP,
		int *	colIndexP,
		RawItemHdr *	pTree
	)

Gets the row and column of the cell being edited in the Tree item.

Parameters

[out]	rowIndexP	receives the 0-based index of the row being edited.
[out]	colIndexP	receives the 0-based index of the column being edited.
[in]	pTree	is the tree item containing the cell being edited.

Returns: SUCCESS, or non-zero value if an error occurs.

See also: mdlDialog_treeEditCell

ErrorCode mdlDialog_treeGetFullWidth	(	int *	iFullWidthP,
		bool	bSetColumnWidths,
		RawItemHdr *	pTree
	)

Gets the width of a Tree with all columns expanded based on the widest column values.

Parameters

[out]	iFullWidthP	points to an integer that receives the Tree's full width.
[in]	bSetColumnWidths	TRUE indicates to set the widths of the columns based on the widest column values.
[in]	pTree	Tree to get full width from.

Returns: SUCCESS on success or TRUE if there is an error.

See also: mdlDialog_treeGetColInfo mdlDialog_treeSetColInfo

StatusInt mdlDialog_treeGetHeights	(	int *	rowHeightP,
		int *	headingHeightP,
		int *	labelHeightP,
		RawItemHdr *	pTreeP
	)

Retrieves certain internal heights from the Tree item.

Parameters

[out]	rowHeightP	points to an integer representing the height of a row
[out]	headingHeightP	points to an integer representing the height of the heading
[out]	labelHeightP	points to an integer representing the height of the label, if above the Tree
[in]	pTreeP	points to the RawItemHdr for the Tree item

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeGetInfo

StatusInt mdlDialog_treeGetInfo	(	UInt32 *	attributesP,
		long *	nRowsP,
		long *	nColumnsP,
		long *	detailPanelIdP,
		RawItemHdr *	pTree
	)

Retrieves several parameters associated with a Tree item.

Parameters

[out]	attributesP	points to an unsigned long that contains the Tree's attributes.
[out]	nRowsP	points to an integer representing the number of rows the Tree can display at once
[out]	nColumnsP	points to an integer representing the number of columns the Tree can display
[out]	detailPanelIdP	set NULL of don't want detailPanelId
[out]	pTree	points to the RawItemHdr for the Tree item

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeSetInfo mdlDialog_treeGetColInfo mdlDialog_treeSetColInfo

StatusInt mdlDialog_treeGetInfoEx	(	UInt32 *	attributesP,
		long *	nRowsP,
		long *	nColumnsP,
		long *	detailPanelIdP,
		UInt32 *	attributesExP,
		UInt32 *	statusFlagsP,
		RawItemHdr *	pTree
	)

An extension of mdlDialog_treeGetInfo that also gets extended attributes and status flags associated with a Tree item.

Parameters

[out]	attributesP	points to an unsigned long that contains the Tree's attributes.
[out]	nRowsP	points to an integer representing the number of rows the Tree can display at once
[out]	nColumnsP	points to an integer representing the number of columns the Tree can display
[out]	detailPanelIdP	set NULL of don't want detailPanelId
[out]	attributesExP	points to an unsigned long that receives the Tree's extended attributes.
[out]	statusFlagsP	points to an unsigned long that receives the Tree's status flags.
[out]	pTree	points to the RawItemHdr for the Tree item

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeSetInfoEx

StatusInt mdlDialog_treeGetLocationCursor	(	int *	locationRowP,
		int *	locationColP,
		RawItemHdr *	pTree
	)

Retrieves the location of the selection cursor from a Tree item.

Parameters

[out]	locationRowP	points to an integer to receive the selection cursor's row index.
[out]	locationColP	points to an integer to receive the selection cursor's column index.
[in]	pTree	points to the RawItemHdr for the Tree item

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeSetLocationCursor

ErrorCode mdlDialog_treeGetNextSelection	(	bool *	foundP,
		int *	rowIndexP,
		int *	colIndexP,
		RawItemHdr *	pTree
	)

Searches for the next selected cell of a Tree item.

Parameters

[out] foundP points to a boolean set to true is a selected cell was found

Remarks: On input, rowIndexP and colIndexP specify the cell to start the search after. Setting both of these arguments to -1 indicates that the search should start from the beginning. If a selected cell is found, its row index and column index are copied to the locations specified by rowIndexP and colIndexP.

Parameters

[in,out]	rowIndexP	row to start search in, next selected
[in,out]	colIndexP	column to start search in, next selected
[in]	pTree	points to the RawItemHdr for the Tree item

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeGetSelectRange

StatusInt mdlDialog_treeGetSelections	(	int *	nSelectionsP,
		Point2d **	selectionsPP,
		RawItemHdr *	pTree
	)

Retrieves a pointer to an array indicating which cells of a Tree item are currently selected.

The array is a series of contiguous Point2d structures, each of which has two integer fields call x and y. There is no need to deallocate the array returned.

Parameters

[out]	nSelectionsP	points to an integer to receive the number of currently selected cells, which is also the size of the selectionsPP array
[out]	selectionsPP	is a pointer to the pointer variable that is to receive the location of the array of selected cells. This is valid for the current selection only.
[in]	pTree	points to the RawItemHdr for the Tree item

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeSetSelections

ErrorCode mdlDialog_treeGetSelectRange	(	int *	minRowIndexP,
		int *	maxRowIndexP,
		int *	minColIndexP,
		int *	maxColIndexP,
		RawItemHdr *	pTree
	)

Gets the range of the cells that are currently selected in the Tree item.

Parameters

[out]	minRowIndexP	points to an integer representing the 0-based index of first row selected
[out]	maxRowIndexP	points to an integer representing the 0-based index of last row selected
[out]	minColIndexP	points to an integer representing the the 0-based index of first column selected
[out]	maxColIndexP	points to an integer representing the 0-based index of last column selected
[in]	pTree	points to the RawItemHdr for the Tree item

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeGetNextSelection mdlDialog_treeIsCellSelected

GuiTreeModelP mdlDialog_treeGetTreeModelP ( RawItemHdr * pTree )

Retrieves the GuiTreeModel pointer from the Tree item.

Parameters

[in] pTree points to the RawItemHdr for the Tree item.

Returns: A pointer to the GuiTreeModel used as the data source for the Tree

See also: mdlDialog_treeSetTreeModelP

StatusInt mdlDialog_treeInsertColumn	(	int *	widthP,
		int *	maxSizeP,
		UInt32 *	attributesP,
		WCharCP	headingP,
		RawItemHdr *	pTree,
		int	columnIndex,
		bool	redraw
	)

Inserts a new column into a Tree item.

Parameters

[in]	widthP	points to an integer representing the width of the column in dialog coordinates
[in]	maxSizeP	points to an integer representing the maximum allowable length of an entry in the specified column
[in]	attributesP	points to an unsigned long that contains the column's attributes.
[in]	headingP	points to a character buffer that contains the column's title
[in]	pTree	points to the RawItemHdr for the Tree item
[in]	columnIndex	is the index of the column before which to insert. A value of -1 means make the new column the rightmost
[in]	redraw	indicates whether the Tree should be redrawn

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeDeleteColumn

bool mdlDialog_treeIsCellEnabled	(	RawItemHdr *	pTree,
		int	rowIndex,
		int	colIndex
	)

Determines if a cell is enabled in a Tree item.

An enabled cell is selectable; a disabled cell is dim and unselectable.

Remarks: rowIndex and colIndex are the 0-based indexes that indicate which cell to test.

Parameters

[in]	rowIndex	row index of cell to test
[in]	colIndex	column index of cell to test
[in]	pTree	points to the RawItemHdr for the Tree item

Returns: true if the specified cell is enabled, or false if not

See also: mdlDialog_treeIsCellSelected mdlDialog_treeLastCellClicked

bool mdlDialog_treeIsCellSelected	(	RawItemHdr *	pTree,
		int	rowIndex,
		int	colIndex
	)

Determines if a cell is selected in a Tree item.

A selected cell has been selected by the user and is drawn with a darker background.

Remarks: rowIndex and colIndex are the 0-based indexes that indicate which cell to test.

Parameters

[in]	rowIndex	row index of cell to test
[in]	colIndex	column index of cell to test
[in]	pTree	points to the RawItemHdr for the Tree item

Returns: true if the specified cell is selected, or false if not

See also: mdlDialog_treeIsCellEnabled mdlDialog_treeLastCellClicked

ErrorCode mdlDialog_treeLastCellClicked	(	int *	rowIndexP,
		int *	colIndexP,
		RawItemHdr *	pTree
	)

Determines the cell in the Tree item in which the data button was last clicked.

Parameters

[out]	rowIndexP	points to the integer that will receive the 0-based index of the last row clicked
[out]	colIndexP	points to the integer that will receive the 0-based index of the last column clicked
[in]	pTree	points to the RawItemHdr for the Tree item

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeIsCellEnabled mdlDialog_treeIsCellSelected

ErrorCode mdlDialog_treeMakeRowVisible	(	RawItemHdr *	pTree,
		int	rowIndex
	)

Makes a row visible by scrolling it into view.

Parameters

[in]	pTree	is the tree item to process.
[in]	rowIndex	is the 0-based index of the row to make visible.

Returns: SUCCESS, or non-zero value if an error occurs.

ErrorCode mdlDialog_treeModelUpdated	(	RawItemHdr *	pTree,
		bool	redraw
	)

Notifies the Tree item that the GuiTreeModel has been updated.

Parameters

[in]	pTree	points to the RawItemHdr for the Tree item.
[in]	redraw	indicates whether the Tree should be redrawn.

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeSetTreeModelP

ErrorCode mdlDialog_treeNodePortionClicked	(	TreeNodePortion *	tnPortionP,
		RawItemHdr *	pTree
	)

Gets the portion of the node last clicked.

Parameters

[out]	tnPortionP	receives the portion of the node last clicked.
[in]	pTree	is the tree last clicked.

Returns: SUCCESS, or non-zero value if an error occurs.

ErrorCode mdlDialog_treeSelectCells	(	RawItemHdr *	pTree,
		int	minRowIndex,
		int	maxRowIndex,
		int	minColIndex,
		int	maxColIndex,
		bool	selectOn,
		bool	redraw
	)

Selects/deselects a range of cells in a Tree item.

Parameters

[in]	pTree	points to the RawItemHdr for the Tree item
[in]	minRowIndex	is an integer representing the 0-based index of first row to process
[in]	maxRowIndex	is an integer representing the 0-based index of last row to process
[in]	minColIndex	is an integer representing the the 0-based index of first column to process
[in]	maxColIndex	is an integer representing the 0-based index of last column to process
[in]	selectOn	should be set to true to select the range of cells or false to deselect the range
[in]	redraw	indicates whether the Tree should be redrawn

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeEnableCells mdlDialog_treeIsCellEnabled mdlDialog_treeIsCellSelected

StatusInt mdlDialog_treeSetColInfo	(	int *	widthP,
		int *	maxSizeP,
		UInt32 *	attributesP,
		WCharCP	headingP,
		RawItemHdr *	pTree,
		int	columnIndex,
		bool	redraw
	)

Sets several parameters associated with individual columns in a Tree item.

Parameters

[in]	widthP	points to an integer representing the width of the column in dialog coordinates
[in]	maxSizeP	points to an integer representing the maximum allowable length of an entry in the specified column
[in]	attributesP	points to an unsigned long that contains the column's attributes.
[in]	headingP	points to a character buffer that contains the column's title
[in]	pTree	points to the RawItemHdr for the Tree item
[in]	columnIndex	is the index of the column to process
[in]	redraw	indicates whether the Tree should be redrawn

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeGetInfo

ErrorCode mdlDialog_treeSetColumnHeading	(	WCharCP	headingP,
		RawItemHdr *	pTree,
		int	columnIndex,
		bool	redraw
	)

Updates a column's heading to a Unicode string.

Parameters

[in]	headingP	points to a Unicode character buffer that contains the column's title.
[in]	pTree	points to the RawItemHdr of the Tree containing the column in question.
[in]	columnIndex	is the index of the column to update.
[in]	redraw	is a boolean flag indicating whether the Tree to be redrawn after the column information is modified.

Returns: SUCCESS on success or non-zero value if there is an error.

StatusInt mdlDialog_treeSetContainer	(	RawItemHdr *	pTree,
		int	containerId,
		MdlDesc *	containerOwnerMD,
		bool	redraw
	)

Sets the container and owner in the specified Tree item.

Parameters

[in]	pTree	is the tree item to change the detail for.
[in]	containerId	specifies the Id of the container, which must be of type DialogItemListRscId.
[in]	containerOwnerMD	is the owner MD of the container.
[in]	redraw	if set to true forces the tree and container to be redrawn.

Returns: SUCCESS, or non-zero value if an error occurs.

See also: mdlDialog_treeGetInfo

StatusInt mdlDialog_treeSetInfo	(	UInt32 *	attributesP,
		long *	nRowsP,
		long *	detailPanelIdP,
		bool	redraw,
		RawItemHdr *	pTree
	)

Sets several parameters associated with a Tree item.

Parameters

[in]	attributesP	points to an unsigned long that contains the Tree's attributes.
[in]	nRowsP	points to an integer representing the number of rows the Tree can display at once
[in]	detailPanelIdP	set NULL if not setting detailPanelId
[in]	redraw	indicates whether the Tree should be redrawn
[in]	pTree	points to the RawItemHdr for the Tree item

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeGetInfo mdlDialog_treeGetColInfo mdlDialog_treeSetColInfo

StatusInt mdlDialog_treeSetInfoEx	(	UInt32 *	attributesP,
		long *	nRowsP,
		long *	detailPanelIdP,
		UInt32 *	attributesExP,
		bool	redraw,
		RawItemHdr *	pTree
	)

An extension of mdlDialog_treeSetInfo that also can set extended attributes in a Tree item.

Parameters

[in]	attributesP	points to an unsigned long that contains the Tree's attributes.
[in]	nRowsP	points to an integer representing the number of rows the Tree can display at once
[in]	detailPanelIdP	set NULL if not setting detailPanelId
[in]	attributesExP	points to an unsigned long that contains the Tree's extended attributes.
[in]	redraw	indicates whether the Tree should be redrawn
[in]	pTree	points to the RawItemHdr for the Tree item

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeSetInfoEx

StatusInt mdlDialog_treeSetLocationCursor	(	RawItemHdr *	pTree,
		int	locationRow,
		int	locationCol
	)

Sets the location of the selection cursor in a Tree item.

Parameters

[in]	locationRow	is an integer indicating the selection cursor's row index.
[in]	locationCol	is an integer indicating the selection cursor's column index.
[in]	pTree	points to the RawItemHdr for the Tree item

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeGetLocationCursor

StatusInt mdlDialog_treeSetSelections	(	RawItemHdr *	pTree,
		int	nSelections,
		Point2d *	selectionsP,
		bool	deselectAllFirst,
		bool	redraw
	)

Sets which cells in a Tree item are selected given a pointer to an array of cell coordinates.

The array is a series of contiguous Point2d structures, each of which has two integer fields call x and y.

Parameters

[in]	pTree	points to the RawItemHdr for the Tree item
[in]	nSelections	indicates the number of selections in the selectionsP array
[in]	selectionsP	points to the array of cell coordinates to select.
[in]	deselectAllFirst	indicates whether all current selections should be dropped before the specified selections are made.
[in]	redraw	indicates whether the Tree should be redrawn

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeGetSelections

ErrorCode mdlDialog_treeSetTopRow	(	RawItemHdr *	pTree,
		int	topRowIndex,
		bool	redraw
	)

Sets the first displayed row index in a Tree item.

Parameters

[in]	pTree	points to the RawItemHdr for the Tree item
[in]	topRowIndex	is the new 0-based index of first row displayed
[in]	redraw	indicates whether the Tree should be redrawn

Returns: SUCCESS, or non-zero value if pTree is invalid.

See also: mdlDialog_treeGetDisplayRange

ErrorCode mdlDialog_treeSetTreeModelP	(	RawItemHdr *	pTree,
		GuiTreeModelP	pTreeModel
	)

Sets the GuiTreeModel pointer in the Tree item.

Parameters

[in]	pTree	points to the RawItemHdr for the Tree item
[in]	pTreeModel	points to the GuiTreeModel to be used as the data source for the Tree

Returns: SUCCESS, or non-zero value if either pTree or pTreeModel is invalid.

See also: mdlDialog_treeGetTreeModelP

ErrorCode mdlDialog_treeSetTreeModelPEx	(	RawItemHdr *	pTree,
		GuiTreeModelP	pTreeModel,
		bool	redraw
	)

Sets the GuiTreeModel pointer in the Tree item and allows you to control the redrawing of the Tree item after setting the GuiTreeModel.

Parameters

[in]	pTree	points to the RawItemHdr for the Tree item
[in]	pTreeModel	points to the GuiTreeModel to be used as the data source for the Tree
[in]	redraw	indicates whether the Tree should be redrawn

Returns: SUCCESS, or non-zero value if either pTree or pTreeModel is invalid.

See also: mdlDialog_treeGetTreeModelP

Functions

Detailed Description

Function Documentation