Functions

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]pTreepoints 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]pTreepoints to the RawItemHdr for the Tree item
[in]columnIndexindicates which column to delete
[in]redrawindicates 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]pTreepoints to the RawItemHdr for the Tree item.
[in]relRowIndexis the 0-based index of row to draw. If the value is -1, all displayed rows will be redrawn
[in]relColIndexis 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]pTreeis the tree item to start the edit session for.
[in]rowIndexis the 0-based index of the row to edit.
[in]colIndexis 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]pTreepoints to the RawItemHdr for the Tree item
[in]minRowIndexis an integer representing the 0-based index of first row to process
[in]maxRowIndexis an integer representing the 0-based index of last row to process
[in]minColIndexis an integer representing the the 0-based index of first column to process
[in]maxColIndexis an integer representing the 0-based index of last column to process
[in]enableshould be set to true to enable the range of cells or false to disable the range
[in]redrawindicates 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]pTreeis the tree item to process.
[in]rowIndexis the 0-based index of the row to expand.
[in]bExpandAllIndicates 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]iRowPThe row in the Tree found at the cursor position. Can be NULL
[out]iColPThe column in the Tree found at the cursor position. Can be NULL
[in]pTreeTree to search for cell
[in]ptPthe 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]widthPpoints to an integer representing the width of the column in dialog coordinates
[out]maxSizePpoints to an integer representing the maximum allowable length of an entry in the specified column
[out]attributesPpoints to an unsigned long that contains the column's attributes.
[out]headingPpoints to a character buffer that contains the column's title
[out]originXPpoints to an integer representing the X origin of the column in pixels
[in]pTreepoints to the RawItemHdr for the Tree item
[in]columnIndexis 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]topRowIndexPpoints to an integer representing the 0-based index of first row displayed
[out]bottomRowIndexPpoints to an integer representing the 0-based index of last row displayed
[out]leftColIndexPpoints to an integer representing the the 0-based index of the leftmost column displayed
[out]rightColIndexPpoints to an integer representing the 0-based index of the rightmost column displayed
[in]pTreepoints 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]rowIndexPreceives the 0-based index of the row being edited.
[out]colIndexPreceives the 0-based index of the column being edited.
[in]pTreeis 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]iFullWidthPpoints to an integer that receives the Tree's full width.
[in]bSetColumnWidthsTRUE indicates to set the widths of the columns based on the widest column values.
[in]pTreeTree 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]rowHeightPpoints to an integer representing the height of a row
[out]headingHeightPpoints to an integer representing the height of the heading
[out]labelHeightPpoints to an integer representing the height of the label, if above the Tree
[in]pTreePpoints 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]attributesPpoints to an unsigned long that contains the Tree's attributes.
[out]nRowsPpoints to an integer representing the number of rows the Tree can display at once
[out]nColumnsPpoints to an integer representing the number of columns the Tree can display
[out]detailPanelIdPset NULL of don't want detailPanelId
[out]pTreepoints 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]attributesPpoints to an unsigned long that contains the Tree's attributes.
[out]nRowsPpoints to an integer representing the number of rows the Tree can display at once
[out]nColumnsPpoints to an integer representing the number of columns the Tree can display
[out]detailPanelIdPset NULL of don't want detailPanelId
[out]attributesExPpoints to an unsigned long that receives the Tree's extended attributes.
[out]statusFlagsPpoints to an unsigned long that receives the Tree's status flags.
[out]pTreepoints 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]locationRowPpoints to an integer to receive the selection cursor's row index.
[out]locationColPpoints to an integer to receive the selection cursor's column index.
[in]pTreepoints 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]foundPpoints 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]rowIndexProw to start search in, next selected
[in,out]colIndexPcolumn to start search in, next selected
[in]pTreepoints 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]nSelectionsPpoints to an integer to receive the number of currently selected cells, which is also the size of the selectionsPP array
[out]selectionsPPis 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]pTreepoints 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]minRowIndexPpoints to an integer representing the 0-based index of first row selected
[out]maxRowIndexPpoints to an integer representing the 0-based index of last row selected
[out]minColIndexPpoints to an integer representing the the 0-based index of first column selected
[out]maxColIndexPpoints to an integer representing the 0-based index of last column selected
[in]pTreepoints 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]pTreepoints 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]widthPpoints to an integer representing the width of the column in dialog coordinates
[in]maxSizePpoints to an integer representing the maximum allowable length of an entry in the specified column
[in]attributesPpoints to an unsigned long that contains the column's attributes.
[in]headingPpoints to a character buffer that contains the column's title
[in]pTreepoints to the RawItemHdr for the Tree item
[in]columnIndexis the index of the column before which to insert. A value of -1 means make the new column the rightmost
[in]redrawindicates 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]rowIndexrow index of cell to test
[in]colIndexcolumn index of cell to test
[in]pTreepoints 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]rowIndexrow index of cell to test
[in]colIndexcolumn index of cell to test
[in]pTreepoints 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]rowIndexPpoints to the integer that will receive the 0-based index of the last row clicked
[out]colIndexPpoints to the integer that will receive the 0-based index of the last column clicked
[in]pTreepoints 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]pTreeis the tree item to process.
[in]rowIndexis 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]pTreepoints to the RawItemHdr for the Tree item.
[in]redrawindicates 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]tnPortionPreceives the portion of the node last clicked.
[in]pTreeis 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]pTreepoints to the RawItemHdr for the Tree item
[in]minRowIndexis an integer representing the 0-based index of first row to process
[in]maxRowIndexis an integer representing the 0-based index of last row to process
[in]minColIndexis an integer representing the the 0-based index of first column to process
[in]maxColIndexis an integer representing the 0-based index of last column to process
[in]selectOnshould be set to true to select the range of cells or false to deselect the range
[in]redrawindicates 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]widthPpoints to an integer representing the width of the column in dialog coordinates
[in]maxSizePpoints to an integer representing the maximum allowable length of an entry in the specified column
[in]attributesPpoints to an unsigned long that contains the column's attributes.
[in]headingPpoints to a character buffer that contains the column's title
[in]pTreepoints to the RawItemHdr for the Tree item
[in]columnIndexis the index of the column to process
[in]redrawindicates 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]headingPpoints to a Unicode character buffer that contains the column's title.
[in]pTreepoints to the RawItemHdr of the Tree containing the column in question.
[in]columnIndexis the index of the column to update.
[in]redrawis 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]pTreeis the tree item to change the detail for.
[in]containerIdspecifies the Id of the container, which must be of type DialogItemListRscId.
[in]containerOwnerMDis the owner MD of the container.
[in]redrawif 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]attributesPpoints to an unsigned long that contains the Tree's attributes.
[in]nRowsPpoints to an integer representing the number of rows the Tree can display at once
[in]detailPanelIdPset NULL if not setting detailPanelId
[in]redrawindicates whether the Tree should be redrawn
[in]pTreepoints 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]attributesPpoints to an unsigned long that contains the Tree's attributes.
[in]nRowsPpoints to an integer representing the number of rows the Tree can display at once
[in]detailPanelIdPset NULL if not setting detailPanelId
[in]attributesExPpoints to an unsigned long that contains the Tree's extended attributes.
[in]redrawindicates whether the Tree should be redrawn
[in]pTreepoints 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]locationRowis an integer indicating the selection cursor's row index.
[in]locationColis an integer indicating the selection cursor's column index.
[in]pTreepoints 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]pTreepoints to the RawItemHdr for the Tree item
[in]nSelectionsindicates the number of selections in the selectionsP array
[in]selectionsPpoints to the array of cell coordinates to select.
[in]deselectAllFirstindicates whether all current selections should be dropped before the specified selections are made.
[in]redrawindicates 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]pTreepoints to the RawItemHdr for the Tree item
[in]topRowIndexis the new 0-based index of first row displayed
[in]redrawindicates 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]pTreepoints to the RawItemHdr for the Tree item
[in]pTreeModelpoints 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]pTreepoints to the RawItemHdr for the Tree item
[in]pTreeModelpoints to the GuiTreeModel to be used as the data source for the Tree
[in]redrawindicates whether the Tree should be redrawn
Returns
SUCCESS, or non-zero value if either pTree or pTreeModel is invalid.
See also
mdlDialog_treeGetTreeModelP

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.