Functions
TreeNodes

Functions

GuiTreeNodeP mdlTreeNode_create (GuiTreeModelP pModel, bool bAllowsChildren)
 Creates a GuiTreeNode with the specified GuiTreeModel as an owner. More...
 
StatusInt mdlTreeNode_destroy (GuiTreeNodeP pNode)
 Destroys a GuiTreeNode and all of its GuiTreeCells. More...
 
GuiTreeModelP mdlTreeNode_getModel (GuiTreeNodeCP pNode)
 Returns a pointer to the owning GuiTreeModel. More...
 
GuiTreeNodeP mdlTreeNode_getParent (GuiTreeNodeCP pNode)
 Returns a pointer to the tree node that is the parent of the given GuiTreeNode. More...
 
bool mdlTreeNode_getAllowsChildren (GuiTreeNodeCP pNode)
 Returns whether the GuiTreeNode allows children. More...
 
StatusInt mdlTreeNode_setAllowsChildren (GuiTreeNodeP pNode, bool bAllowsChildren)
 Sets whether the GuiTreeNode allows children. More...
 
bool mdlTreeNode_isLeaf (GuiTreeNodeCP pNode)
 Returns true if this GuiTreeNode is a leaf node. More...
 
bool mdlTreeNode_isParent (GuiTreeNodeCP pNode)
 Returns true if this GuiTreeNode is a parent node. More...
 
bool mdlTreeNode_isParentPopulated (GuiTreeNodeCP pNode)
 Returns true if this GuiTreeNode is a parent node and if it is populated with any children. More...
 
bool mdlTreeNode_isRoot (GuiTreeNodeCP pNode)
 Returns true if this GuiTreeNode is the root node of the owning GuiTreeModel. More...
 
bool mdlTreeNode_isExpanded (GuiTreeNodeCP pNode)
 Returns true if this GuiTreeNode is expanded in the Gui Tree item. More...
 
bool mdlTreeNode_isDisplayable (GuiTreeNodeP pNode)
 Returns true if this GuiTreeNode is displayable in the Gui Tree item. More...
 
GuiTreeNodeP mdlTreeNode_getNextSibling (GuiTreeNodeCP pNode)
 Returns the next sibling node in the parent's child list. More...
 
GuiTreeNodeP mdlTreeNode_getPrevSibling (GuiTreeNodeCP pNode)
 Returns the previous sibling node in the parent's child list. More...
 
GuiTreeNodeP mdlTreeNode_getNextDisplayNode (GuiTreeNodeCP pNode, bool bCheckChildren)
 Returns the next displayable node in the GuiTreeModel. More...
 
GuiTreeNodeP mdlTreeNode_getPrevDisplayNode (GuiTreeNodeCP pNode)
 Returns the previous displayable node in the GuiTreeModel. More...
 
int mdlTreeNode_getStatus (GuiTreeNodeCP pNode)
 Returns the status of a specified GuiTreeNode. More...
 
StatusInt mdlTreeNode_setStatus (GuiTreeNodeP pNode, int status)
 Sets the status of a specified GuiTreeNode. More...
 
UserDataP mdlTreeNode_getAppData (GuiTreeNodeCP pNode)
 Returns a pointer to application data associated with the GuiTreeNode. More...
 
StatusInt mdlTreeNode_setAppData (GuiTreeNodeP pNode, UserDataP pAppData)
 Sets the pointer to application data to be associated with the GuiTreeNode. More...
 
int mdlTreeNode_getLevel (GuiTreeNodeCP pNode)
 Returns the level of a specified GuiTreeNode. More...
 
StatusInt mdlTreeNode_setLevel (GuiTreeNodeP pNode, bool bSetInDescendents)
 Sets the level of a specified GuiTreeNode based on its position in the GuiTreeModel. More...
 
GuiTreeNodeP mdlTreeNode_getAncestorAtLevel (GuiTreeNodeCP pNode, int level)
 Returns the ancestor GuiTreeNode at a certain level up from a specified child GuiTreeNode. More...
 
GuiTreeNodePathCP mdlTreeNode_getPathFromRoot (GuiTreeNodeP pNode)
 Builds and returns a GuiTreeNodePath from the root node to the specified GuiTreeNode. More...
 
GuiTreeNodePathCP mdlTreeNode_getPathFromAncestor (GuiTreeNodeP pNode, GuiTreeNodeCP pAncestor)
 Builds and returns a GuiTreeNodePath from the ancestor node to the specified GuiTreeNode. More...
 
StatusInt mdlTreeNode_moveUp (GuiTreeNodeP pNode)
 Moves the node up within its parent node. More...
 
StatusInt mdlTreeNode_moveDown (GuiTreeNodeP pNode)
 Moves the node down within its parent node. More...
 
StatusInt mdlTreeNode_getCurrentIcon (GuiTreeNodeCP pNode, RscId *pIconRscId, RscType *pIconRscType, MdlDesc **ppIconOwnerMD)
 Returns information about the current icon to be displayed in the Gui Tree item based on the status of the node. More...
 
StatusInt mdlTreeNode_setIcon (GuiTreeNodeP pNode, RscId iconRscId, RscType iconRscType, MdlDesc *iconOwnerMD)
 Sets information about the icon to be displayed in the Gui Tree item for this node. More...
 
StatusInt mdlTreeNode_setIconRsc (GuiTreeNodeP pNode, IconRsc *pIconRsc)
 Sets the IconRsc for the icon to be displayed in the Gui Tree item for this node. More...
 
StatusInt mdlTreeNode_setIconByName (GuiTreeNodeP pNode, WCharCP pIconName, Point2dCP pIconSize)
 Sets the name of the icon to be displayed in the Gui Tree item for this node. More...
 
StatusInt mdlTreeNode_getLeafIcon (GuiTreeNodeCP pNode, RscId *pIconRscId, RscType *pIconRscType, MdlDesc **ppIconOwnerMD)
 Returns information about the icon to be displayed in the Gui Tree item if this node is a leaf node. More...
 
StatusInt mdlTreeNode_setLeafIcon (GuiTreeNodeP pNode, RscId iconRscId, RscType iconRscType, MdlDesc *iconOwnerMD)
 Sets information about the icon to be displayed in the Gui Tree item if this node is a leaf node. More...
 
StatusInt mdlTreeNode_getLeafSelectedIcon (GuiTreeNodeCP pNode, RscId *pIconRscId, RscType *pIconRscType, MdlDesc **ppIconOwnerMD)
 Returns information about the icon to be displayed in the Gui Tree item if this node is a selected leaf node. More...
 
StatusInt mdlTreeNode_setLeafSelectedIcon (GuiTreeNodeP pNode, RscId iconRscId, RscType iconRscType, MdlDesc *iconOwnerMD)
 Sets information about the icon to be displayed in the Gui Tree item if this node is a selected leaf node. More...
 
StatusInt mdlTreeNode_getLeafDeselectedIcon (GuiTreeNodeCP pNode, RscId *pIconRscId, RscType *pIconRscType, MdlDesc **ppIconOwnerMD)
 Returns information about the icon to be displayed in the Gui Tree item if this node is a leaf node that is not selected. More...
 
StatusInt mdlTreeNode_setLeafDeselectedIcon (GuiTreeNodeP pNode, RscId iconRscId, RscType iconRscType, MdlDesc *iconOwnerMD)
 Sets information about the icon to be displayed in the Gui Tree item if this node is a leaf node that is not selected. More...
 
StatusInt mdlTreeNode_getCollapsedIcon (GuiTreeNodeCP pNode, RscId *pIconRscId, RscType *pIconRscType, MdlDesc **ppIconOwnerMD)
 Returns information about the icon to be displayed in the Gui Tree item if this node is a collapsed parent node. More...
 
StatusInt mdlTreeNode_setCollapsedIcon (GuiTreeNodeP pNode, RscId iconRscId, RscType iconRscType, MdlDesc *iconOwnerMD)
 Sets information about the icon to be displayed in the Gui Tree item if this node is a collapsed parent node. More...
 
StatusInt mdlTreeNode_getCollapsedSelectedIcon (GuiTreeNodeCP pNode, RscId *pIconRscId, RscType *pIconRscType, MdlDesc **ppIconOwnerMD)
 Returns information about the icon to be displayed in the Gui Tree item if this node is a selected collapsed parent node. More...
 
StatusInt mdlTreeNode_setCollapsedSelectedIcon (GuiTreeNodeP pNode, RscId iconRscId, RscType iconRscType, MdlDesc *iconOwnerMD)
 Sets information about the icon to be displayed in the Gui Tree item if this node is a selected collapsed parent node. More...
 
StatusInt mdlTreeNode_getCollapsedDeselectedIcon (GuiTreeNodeCP pNode, RscId *pIconRscId, RscType *pIconRscType, MdlDesc **ppIconOwnerMD)
 Returns information about the icon to be displayed in the Gui Tree item if this node is a collapsed parent node that is not selected. More...
 
StatusInt mdlTreeNode_setCollapsedDeselectedIcon (GuiTreeNodeP pNode, RscId iconRscId, RscType iconRscType, MdlDesc *iconOwnerMD)
 Sets information about the icon to be displayed in the Gui Tree item if this node is a collapsed parent node that is not selected. More...
 
StatusInt mdlTreeNode_getExpandedIcon (GuiTreeNodeCP pNode, RscId *pIconRscId, RscType *pIconRscType, MdlDesc **ppIconOwnerMD)
 Returns information about the icon to be displayed in the Gui Tree item if this node is an expanded parent node. More...
 
StatusInt mdlTreeNode_setExpandedIcon (GuiTreeNodeP pNode, RscId iconRscId, RscType iconRscType, MdlDesc *iconOwnerMD)
 Sets information about the icon to be displayed in the Gui Tree item if this node is an expanded parent node. More...
 
StatusInt mdlTreeNode_getExpandedSelectedIcon (GuiTreeNodeCP pNode, RscId *pIconRscId, RscType *pIconRscType, MdlDesc **ppIconOwnerMD)
 Returns information about the icon to be displayed in the Gui Tree item if this node is a selected expanded parent node. More...
 
StatusInt mdlTreeNode_setExpandedSelectedIcon (GuiTreeNodeP pNode, RscId iconRscId, RscType iconRscType, MdlDesc *iconOwnerMD)
 Sets information about the icon to be displayed in the Gui Tree item if this node is a selected expanded parent node. More...
 
StatusInt mdlTreeNode_getExpandedDeselectedIcon (GuiTreeNodeCP pNode, RscId *pIconRscId, RscType *pIconRscType, MdlDesc **ppIconOwnerMD)
 Returns information about the icon to be displayed in the Gui Tree item if this node is an expanded parent node that is not selected. More...
 
StatusInt mdlTreeNode_setExpandedDeselectedIcon (GuiTreeNodeP pNode, RscId iconRscId, RscType iconRscType, MdlDesc *iconOwnerMD)
 Sets information about the icon to be displayed in the Gui Tree item if this node is an expanded parent node that is not selected. More...
 
IconRscmdlTreeNode_getCurrentIconRsc (GuiTreeNodeCP pNode)
 Returns the IconRsc for the current icon to be displayed in the Gui Tree item based on the status of the node. More...
 
IconRscmdlTreeNode_getLeafSelectedIconRsc (GuiTreeNodeCP pNode)
 Returns the IconRsc for the icon to be displayed in the Gui Tree item if this node is a selected leaf. More...
 
IconRscmdlTreeNode_getLeafDeselectedIconRsc (GuiTreeNodeCP pNode)
 Returns the IconRsc for the icon to be displayed in the Gui Tree item if this node is a deselected leaf. More...
 
StatusInt mdlTreeNode_setLeafIconRsc (GuiTreeNodeP pNode, IconRsc *pIconRsc)
 Sets the IconRsc of the icon to be displayed in the Gui Tree item if this node is a leaf node, either selected or not. More...
 
StatusInt mdlTreeNode_setLeafSelectedIconRsc (GuiTreeNodeP pNode, IconRsc *pIconRsc)
 Sets the IconRsc of the icon to be displayed in the Gui Tree item if this node is a selected leaf node. More...
 
StatusInt mdlTreeNode_setLeafDeselectedIconRsc (GuiTreeNodeP pNode, IconRsc *pIconRsc)
 Sets the IconRsc of the icon to be displayed in the Gui Tree item if this node is a deselected leaf node. More...
 
StatusInt mdlTreeNode_setLeafIconByName (GuiTreeNodeP pNode, WCharCP pIconName, Point2dCP pIconSize)
 Sets the name of the icon to be displayed in the Gui Tree item if this node is a leaf node, either selected or not. More...
 
StatusInt mdlTreeNode_setLeafSelectedIconByName (GuiTreeNodeP pNode, WCharCP pIconName, Point2dCP pIconSize)
 Sets the name of the icon to be displayed in the Gui Tree item if this node is a selected leaf node. More...
 
StatusInt mdlTreeNode_setLeafDeselectedIconByName (GuiTreeNodeP pNode, WCharCP pIconName, Point2dCP pIconSize)
 Sets the name of the icon to be displayed in the Gui Tree item if this node is a deselected leaf node. More...
 
IconRscmdlTreeNode_getCollapsedSelectedIconRsc (GuiTreeNodeCP pNode)
 Returns the IconRsc for the icon to be displayed in the Gui Tree item if this node is a selected collapsed parent. More...
 
IconRscmdlTreeNode_getCollapsedDeselectedIconRsc (GuiTreeNodeCP pNode)
 Returns the IconRsc for the icon to be displayed in the Gui Tree item if this node is a deselected collapsed parent. More...
 
StatusInt mdlTreeNode_setCollapsedIconRsc (GuiTreeNodeP pNode, IconRsc *pIconRsc)
 Sets the IconRsc of the icon to be displayed in the Gui Tree item if this node is a collapsed parent node, either selected or not. More...
 
StatusInt mdlTreeNode_setCollapsedSelectedIconRsc (GuiTreeNodeP pNode, IconRsc *pIconRsc)
 Sets the IconRsc of the icon to be displayed in the Gui Tree item if this node is a selected collapsed parent node. More...
 
StatusInt mdlTreeNode_setCollapsedDeselectedIconRsc (GuiTreeNodeP pNode, IconRsc *pIconRsc)
 Sets the IconRsc of the icon to be displayed in the Gui Tree item if this node is a deselected collapsed parent node. More...
 
StatusInt mdlTreeNode_setCollapsedIconByName (GuiTreeNodeP pNode, WCharCP pIconName, Point2dCP pIconSize)
 Sets the name of the icon to be displayed in the Gui Tree item if this node is a collapsed parent node, either selected or not. More...
 
StatusInt mdlTreeNode_setCollapsedSelectedIconByName (GuiTreeNodeP pNode, WCharCP pIconName, Point2dCP pIconSize)
 Sets the name of the icon to be displayed in the Gui Tree item if this node is a selected collapsed parent node. More...
 
StatusInt mdlTreeNode_setCollapsedDeselectedIconByName (GuiTreeNodeP pNode, WCharCP pIconName, Point2dCP pIconSize)
 Sets the name of the icon to be displayed in the Gui Tree item if this node is a deselected collapsed parent node. More...
 
IconRscmdlTreeNode_getExpandedSelectedIconRsc (GuiTreeNodeCP pNode)
 Returns the IconRsc for the icon to be displayed in the Gui Tree item if this node is a selected expanded parent. More...
 
IconRscmdlTreeNode_getExpandedDeselectedIconRsc (GuiTreeNodeCP pNode)
 Returns the IconRsc for the icon to be displayed in the Gui Tree item if this node is a deselected expanded parent. More...
 
StatusInt mdlTreeNode_setExpandedIconRsc (GuiTreeNodeP pNode, IconRsc *pIconRsc)
 Sets the IconRsc of the icon to be displayed in the Gui Tree item if this node is a expanded parent node, either selected or not. More...
 
StatusInt mdlTreeNode_setExpandedSelectedIconRsc (GuiTreeNodeP pNode, IconRsc *pIconRsc)
 Sets the IconRsc of the icon to be displayed in the Gui Tree item if this node is a selected expanded parent node. More...
 
StatusInt mdlTreeNode_setExpandedDeselectedIconRsc (GuiTreeNodeP pNode, IconRsc *pIconRsc)
 Sets the IconRsc of the icon to be displayed in the Gui Tree item if this node is a deselected expanded parent node. More...
 
StatusInt mdlTreeNode_setExpandedIconByName (GuiTreeNodeP pNode, WCharCP pIconName, Point2dCP pIconSize)
 Sets the name of the icon to be displayed in the Gui Tree item if this node is a expanded parent node, either selected or not. More...
 
StatusInt mdlTreeNode_setExpandedSelectedIconByName (GuiTreeNodeP pNode, WCharCP pIconName, Point2dCP pIconSize)
 Sets the name of the icon to be displayed in the Gui Tree item if this node is a selected expanded parent node. More...
 
StatusInt mdlTreeNode_setExpandedDeselectedIconByName (GuiTreeNodeP pNode, WCharCP pIconName, Point2dCP pIconSize)
 Sets the name of the icon to be displayed in the Gui Tree item if this node is a deselected expanded parent node. More...
 
StatusInt mdlTreeNode_makeDisplayable (GuiTreeNodeP pNode)
 Makes the GuiTreeNode displayable by expanding all of its ancestors. More...
 
GuiTreeCellP mdlTreeNode_getCellAtIndex (GuiTreeNodeCP pNode, int colIndex)
 Returns a pointer to the GuiTreeCell at the specified column index within the GuiTreeNode. More...
 
GuiTreeCellP mdlTreeNode_getCellById (GuiTreeNodeCP pNode, int cellId)
 Returns a pointer to the GuiTreeCell with the specified Id within the GuiTreeNode. More...
 
GuiTreeCellP mdlTreeNode_getCellByName (GuiTreeNodeCP pNode, WCharCP pwName)
 Returns a pointer to the GuiTreeCell with the specified name contained within the given GuiTreeNode. More...
 
StatusInt mdlTreeNode_setStatusInCells (GuiTreeNodeP pNode, int status)
 Sets the status in each GuiTreeCell within the GuiTreeNode. More...
 
StatusInt mdlTreeNode_getDisplayText (GuiTreeNodeCP pNode, WCharCP *pwString)
 Returns a Unicode string with the display text of the GuiTreeCell at index 0 within a GuiTreeNode. More...
 
StatusInt mdlTreeNode_setDisplayText (GuiTreeNodeP pNode, WCharCP pwString)
 Sets the display text of the GuiTreeCell at index 0 within a GuiTreeNode fromthe given Unicode string. More...
 
StatusInt mdlTreeNode_getDisplayTextWString (GuiTreeNodeCP pNode, WStringR wString)
 Returns the display text of the specified GuiTreeNode in a WString. More...
 
StatusInt mdlTreeNode_getValue (GuiTreeNodeCP pNode, MSValueDescrR valueDescr)
 Returns a copy of the internal value descriptor of the GuiTreeCell at index 0 within a specified GuiTreeNode. More...
 
StatusInt mdlTreeNode_setValue (GuiTreeNodeP pNode, MSValueDescrCR pValueDescr, bool bSetDisplayText)
 Sets the internal value descriptor of the GuiTreeCell at index 0 within a specified GuiTreeNode. More...
 
StatusInt mdlTreeNode_setFontIndex (GuiTreeNodeP pNode, int fontIndex)
 Sets the font to use when drawing cells in the specified node. More...
 
StatusInt mdlTreeNode_setColorDescr (GuiTreeNodeP pNode, BSIColorDescr *pDescr)
 Sets the color descriptor to use when drawing cells in the specified node. More...
 
StatusInt mdlTreeNode_setBgColorDescr (GuiTreeNodeP pNode, BSIColorDescr *pDescr)
 Sets the background color descriptor to use when drawing cells in the specified node. More...
 
StatusInt mdlTreeNode_setSelectedColorDescr (GuiTreeNodeP pNode, BSIColorDescr *pDescr)
 Sets the color descriptor to use when drawing selected cells in the specified node. More...
 
StatusInt mdlTreeNode_setSelectedBgColorDescr (GuiTreeNodeP pNode, BSIColorDescr *pDescr)
 Sets the background color descriptor to use when drawing selected cells in the specified node. More...
 
StatusInt mdlTreeNode_getEditor (GuiTreeNodeCP pNode, long *pEditorType, long *pEditorId, MdlDesc **pEditorOwnerMD, bool *pbEditDisplay, bool *pbUpdateDisplay)
 Gets information about the editor for the specified tree node. More...
 
StatusInt mdlTreeNode_setEditor (GuiTreeNodeP pNode, long editorType, long editorId, MdlDesc *editorOwnerMD, bool bEditDisplay, bool bUpdateDisplay)
 Sets information about the editor for the specified tree node. More...
 
int mdlTreeNode_getChildCount (GuiTreeNodeCP pParentNode)
 Returns the number of children in the one level below a parent GuiTreeNode. More...
 
int mdlTreeNode_getDescendentCount (GuiTreeNodeCP pParentNode)
 Returns the number of descendents in all levels below a parent GuiTreeNode. More...
 
int mdlTreeNode_getDisplayableDescendentCount (GuiTreeNodeCP pParentNode)
 Returns the number of displayable descendents in all levels below a parent GuiTreeNode. More...
 
GuiTreeNodeP mdlTreeNode_getChildAtIndex (GuiTreeNodeCP pParentNode, int index)
 Returns a pointer to the GuiTreeNode at a specified child index in the one level below a parent GuiTreeNode. More...
 
GuiTreeCellP mdlTreeNode_getChildCellAtIndexes (GuiTreeNodeCP pParentNode, int childIndex, int columnIndex)
 Returns a pointer to the GuiTreeCell at a specified child index and column index in the one level below a parent GuiTreeNode. More...
 
GuiTreeNodeP mdlTreeNode_getFirstChild (GuiTreeNodeCP pParentNode)
 Returns a pointer to the first GuiTreeNode in the one level below a parent GuiTreeNode. More...
 
GuiTreeNodeP mdlTreeNode_getNextChild (GuiTreeNodeCP pParentNode, GuiTreeNodeCP pInChild)
 Returns a pointer to the next GuiTreeNode after a given child node in the one level below a parent GuiTreeNode. More...
 
GuiTreeNodeP mdlTreeNode_getPrevChild (GuiTreeNodeCP pParentNode, GuiTreeNodeCP pInChild)
 Returns a pointer to the previous GuiTreeNode before a given child node in the one level below a parent GuiTreeNode. More...
 
GuiTreeNodeP mdlTreeNode_getLastChild (GuiTreeNodeCP pParentNode)
 Returns a pointer to the last GuiTreeNode in the one level below a parent GuiTreeNode. More...
 
int mdlTreeNode_addChild (GuiTreeNodeP pParentNode, GuiTreeNodeP pChild)
 Adds a specified GuiTreeNode to the end of a parent GuiTreeNode. More...
 
int mdlTreeNode_insertChild (GuiTreeNodeP pParentNode, GuiTreeNodeP pChild, int index)
 Inserts a specified GuiTreeNode into the first level child list of a parent GuiTreeNode before a certain child index. More...
 
StatusInt mdlTreeNode_destroyChildAtIndex (GuiTreeNodeP pParentNode, int iNode)
 Destroys a GuiTreeNode at a specified index within a parent node and all of its GuiTreeCells. More...
 
StatusInt mdlTreeNode_removeChild (GuiTreeNodeP pParentNode, GuiTreeNodeP pChild, bool bDestroy)
 Removes a specified GuiTreeNode from the first level child list of a parent GuiTreeNode and optionally destroys the child node. More...
 
StatusInt mdlTreeNode_removeChildAtIndex (GuiTreeNodeP pParentNode, int iNode, bool bDestroyNode)
 Removes a GuiTreeNode at a specified index from the first level child list of a parent GuiTreeNode and optionally destroys the child node. More...
 
StatusInt mdlTreeNode_removeChildren (GuiTreeNodeP pParentNode, int iNode, int nNodes, bool bDestroy)
 Removes a certain number of GuiTreeNodes from the first level child list of a parent GuiTreeNode and optionally destroys the child nodes. More...
 
GuiTreeNodeP mdlTreeNode_insertData (GuiTreeNodeP pParentNode, MSValueDescrCR valueDescr, int index)
 Inserts a GuiTreeNode into the first level child list of a parent GuiTreeNode before a certain index with a specified value. More...
 
GuiTreeNodeP mdlTreeNode_insertString (GuiTreeNodeP pParentNode, WCharCP pString, int index)
 Inserts a GuiTreeNode into the first level child list of a parent GuiTreeNode before a certain index with a specified string as the value. More...
 
int mdlTreeNode_getChildIndex (GuiTreeNodeCP pParentNode, GuiTreeNodeCP pChild)
 Returns the index of the specified GuiTreeNode within the first level child list of a parent GuiTreeNode. More...
 
int mdlTreeNode_expand (GuiTreeNodeP pParentNode)
 Expands a parent node. More...
 
StatusInt mdlTreeNode_collapse (GuiTreeNodeP pParentNode, bool bCollapseDescendents)
 Collapses a parent node and optionally collapses its descendent parent nodes. More...
 
StatusInt mdlTreeNode_sort (GuiTreeNodeP pParentNode, bool ascending, int startIndex, int numToSort, int columnIndex)
 Sorts the GuiTreeNodes within the first level child list of a parent GuiTreeNode in ascending or descending order based on values in a specified column index. More...
 
StatusInt mdlTreeNode_search (GuiTreeNodeP pParentNode, MSValueDescrCP pValueDescr, InfoField *pInfoFields, int startIndex, int numToSearch, int columnIndex, bool bSearchAll, GuiTreeNodeP *ppFoundNode)
 Searches through either the first level child list of a parent GuiTreeNode or optionally all of its descendents for a specified value in a certain column. More...
 
StatusInt mdlTreeNode_searchUsingFunction (GuiTreeNodeP pParentNode, MSValueDescrCP pValueDescr, InfoField *pInfoFields, int startIndex, int numToSearch, int columnIndex, bool bSearchAll, TreeColumnSearchFuncP pSearchFunc, MdlDesc *pSearchOwnerMD, GuiTreeNodeP *ppFoundNode)
 Searches through either the first level child list of a parent GuiTreeNode or optionally all of its descendents for a specified value in a certain column. More...
 
bool mdlTreeNode_isDescendent (GuiTreeNodeCP pParentNode, GuiTreeNodeCP pNode)
 Determines is a given node is a descendent of a parent node. More...
 
StatusInt mdlTreeNode_moveChildToIndex (GuiTreeNodeP pParentNode, GuiTreeNodeP pNode, int index)
 Moves a child node to a particular index. More...
 
StatusInt mdlTreeCell_getDisplayTextWString (GuiTreeCellCP pCell, WStringR wString)
 Returns the display text of the specified GuiTreeCell in a WString. More...
 

Detailed Description

Function Documentation

StatusInt mdlTreeCell_getDisplayTextWString ( GuiTreeCellCP  pCell,
WStringR  wString 
)

Returns the display text of the specified GuiTreeCell in a WString.

Parameters
[in,out]wStringthe WString object that will receive the display text
[in]pCellpoints to the GuiTreeCell to process
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeCell_setDisplayText mdlTreeCell_setDisplayText
Remarks
Required Library: mdlbltin.lib
int mdlTreeNode_addChild ( GuiTreeNodeP  pParentNode,
GuiTreeNodeP  pChild 
)

Adds a specified GuiTreeNode to the end of a parent GuiTreeNode.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
[in]pChildpoints to the node to add as a child to the end of the parent node
Returns
MDLERR_ADDRNOTVALID if pModel is invalid, MDLERR_INSFMEMORY if there was not enough memory to insert the row
See also
mdlTreeNode_destroy
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_collapse ( GuiTreeNodeP  pParentNode,
bool  bCollapseDescendents 
)

Collapses a parent node and optionally collapses its descendent parent nodes.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
[in]bCollapseDescendentsIndicates whether to collapse the descendents that are themselves parents
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pParentNode is invalid, MDLERR_NOMATCH if pParentNode is not owned by a GuiTreeModel
See also
mdlTreeNode_expand
Remarks
Required Library: mdlbltin.lib
GuiTreeNodeP mdlTreeNode_create ( GuiTreeModelP  pModel,
bool  bAllowsChildren 
)

Creates a GuiTreeNode with the specified GuiTreeModel as an owner.

A GuiTreeCell is also created for each GuiTreeColumn in the GuiTreeModel, containing the number info fields based on the number set in the GuiTreeColumn.

Parameters
[in]pModelpoints to the GuiTreeModel.
[in]bAllowsChildrenindicates whether this node can be a parent of other GuiTreeNodes
Returns
A pointer to the GuiTreeNode created
See also
mdlTreeModel_create mdlTreeNode_destroy
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_destroy ( GuiTreeNodeP  pNode)

Destroys a GuiTreeNode and all of its GuiTreeCells.

If the GuiTreeNode is the child of a parent node, it is removed from the parent. If mdlTreeModel_setDestroyFunction has been called, the destroy function will be called.

Parameters
[in]pNodepoints to the GuiTreeNode to destroy
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_create
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_destroyChildAtIndex ( GuiTreeNodeP  pParentNode,
int  iNode 
)

Destroys a GuiTreeNode at a specified index within a parent node and all of its GuiTreeCells.

It is also removed from the parent.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
[in]iNodeindex of the child node to destroy
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pParentNode is invalid, MDLERR_BADINDEX if iNode is invalid
See also
mdlTreeNode_destroy
Remarks
Required Library: mdlbltin.lib
int mdlTreeNode_expand ( GuiTreeNodeP  pParentNode)

Expands a parent node.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
Returns
Row index of the last displayed descendent, MDLERR_ADDRNOTVALID if pParentNode is invalid, MDLERR_NOMATCH if pParentNode is not owned by a GuiTreeModel
See also
mdlTreeNode_collapse
Remarks
Required Library: mdlbltin.lib
bool mdlTreeNode_getAllowsChildren ( GuiTreeNodeCP  pNode)

Returns whether the GuiTreeNode allows children.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
true if the GuiTreeNode allows children, or false if it does not.
See also
mdlTreeNode_create mdlTreeNode_setAllowsChildren
Remarks
Required Library: mdlbltin.lib
GuiTreeNodeP mdlTreeNode_getAncestorAtLevel ( GuiTreeNodeCP  pNode,
int  level 
)

Returns the ancestor GuiTreeNode at a certain level up from a specified child GuiTreeNode.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]levelindicates the level of the ancestor to get
Returns
A pointer to the ancestor GuiTreeNode, or NULL if pNode or level are invalid.
See also
mdlTreeNode_getLevel mdlTreeNode_setLevel
Remarks
Required Library: mdlbltin.lib
UserDataP mdlTreeNode_getAppData ( GuiTreeNodeCP  pNode)

Returns a pointer to application data associated with the GuiTreeNode.

Parameters
[in]pNodethe GuiTreeNode to process.
Returns
A pointer to the application data associated with the GuiTreeNode.
See also
mdlTreeNode_setAppData
Remarks
Required Library: mdlbltin.lib
GuiTreeCellP mdlTreeNode_getCellAtIndex ( GuiTreeNodeCP  pNode,
int  colIndex 
)

Returns a pointer to the GuiTreeCell at the specified column index within the GuiTreeNode.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]colIndexcolumn index of the cell to get
Returns
A pointer to the desired GuiTreeCell, or NULL if pNode or colIndex are invalid
See also
mdlTreeNode_getCellById
Remarks
Required Library: mdlbltin.lib
GuiTreeCellP mdlTreeNode_getCellById ( GuiTreeNodeCP  pNode,
int  cellId 
)

Returns a pointer to the GuiTreeCell with the specified Id within the GuiTreeNode.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]cellIdId of the GuiTreeCell
Returns
A pointer to the desired GuiTreeCell, or NULL if pNode or cellId are invalid
See also
mdlTreeNode_getCellAtIndex
Remarks
Required Library: mdlbltin.lib
GuiTreeCellP mdlTreeNode_getCellByName ( GuiTreeNodeCP  pNode,
WCharCP  pwName 
)

Returns a pointer to the GuiTreeCell with the specified name contained within the given GuiTreeNode.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pwNameName of the GuiTreeCell to get
Returns
A pointer to the GuiTreeCell.
See also
mdlTreeNode_getCellAtIndex
Remarks
Required Library: mdlbltin.lib
GuiTreeNodeP mdlTreeNode_getChildAtIndex ( GuiTreeNodeCP  pParentNode,
int  index 
)

Returns a pointer to the GuiTreeNode at a specified child index in the one level below a parent GuiTreeNode.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
[in]indexIndex of the child to get
Returns
A pointer to the child node at the specified index in the one level below this parent node.
See also
mdlTreeNode_getChildIndex
Remarks
Required Library: mdlbltin.lib
GuiTreeCellP mdlTreeNode_getChildCellAtIndexes ( GuiTreeNodeCP  pParentNode,
int  childIndex,
int  columnIndex 
)

Returns a pointer to the GuiTreeCell at a specified child index and column index in the one level below a parent GuiTreeNode.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
[in]childIndexChild index of the cell to get
[in]columnIndexColumn index of the cell to get
Returns
A pointer to the GuiTreeCell at a column index in a child node at the specified child index in the one level below this parent node.
See also
mdlTreeNode_getChildAtIndex mdlTreeNode_getCellAtIndex
Remarks
Required Library: mdlbltin.lib
int mdlTreeNode_getChildCount ( GuiTreeNodeCP  pParentNode)

Returns the number of children in the one level below a parent GuiTreeNode.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
Returns
The number of children in the level below this parent node.
See also
mdlTreeNode_destroy
Remarks
Required Library: mdlbltin.lib
int mdlTreeNode_getChildIndex ( GuiTreeNodeCP  pParentNode,
GuiTreeNodeCP  pChild 
)

Returns the index of the specified GuiTreeNode within the first level child list of a parent GuiTreeNode.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
[in]pChildpoints to the child node to find
Returns
Index of the child node, or MDLERR_ADDRNOTVALID if pParentNode is invalid, MDLERR_NOMATCH if the child node is not in the parent
Remarks
Note: All MDLERR_ codes are negative
See also
mdlTreeNode_destroy
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_getCollapsedDeselectedIcon ( GuiTreeNodeCP  pNode,
RscId pIconRscId,
RscType pIconRscType,
MdlDesc **  ppIconOwnerMD 
)

Returns information about the icon to be displayed in the Gui Tree item if this node is a collapsed parent node that is not selected.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in,out]pIconRscIdpoints to an integer that receives the icon resource Id
[in,out]pIconRscTypepoints to an integer that receives the icon resource type
[in,out]ppIconOwnerMDpoints to a void pointer that is set to the address of the owner of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_setCollapsedDeselectedIcon
Remarks
Required Library: mdlbltin.lib
IconRsc* mdlTreeNode_getCollapsedDeselectedIconRsc ( GuiTreeNodeCP  pNode)

Returns the IconRsc for the icon to be displayed in the Gui Tree item if this node is a deselected collapsed parent.

The IconRsc is only returned if the icon was set by one of the ByName functions.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
The IconRsc for SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_setCollapsedDeselectedIconByName
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_getCollapsedIcon ( GuiTreeNodeCP  pNode,
RscId pIconRscId,
RscType pIconRscType,
MdlDesc **  ppIconOwnerMD 
)

Returns information about the icon to be displayed in the Gui Tree item if this node is a collapsed parent node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in,out]pIconRscIdpoints to an integer that receives the icon resource Id
[in,out]pIconRscTypepoints to an integer that receives the icon resource type
[in,out]ppIconOwnerMDpoints to a void pointer that is set to the address of the owner of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_setCollapsedIcon
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_getCollapsedSelectedIcon ( GuiTreeNodeCP  pNode,
RscId pIconRscId,
RscType pIconRscType,
MdlDesc **  ppIconOwnerMD 
)

Returns information about the icon to be displayed in the Gui Tree item if this node is a selected collapsed parent node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in,out]pIconRscIdpoints to an integer that receives the icon resource Id
[in,out]pIconRscTypepoints to an integer that receives the icon resource type
[in,out]ppIconOwnerMDpoints to a void pointer that is set to the address of the owner of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_setCollapsedSelectedIcon
Remarks
Required Library: mdlbltin.lib
IconRsc* mdlTreeNode_getCollapsedSelectedIconRsc ( GuiTreeNodeCP  pNode)

Returns the IconRsc for the icon to be displayed in the Gui Tree item if this node is a selected collapsed parent.

The IconRsc is only returned if the icon was set by one of the ByName functions.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
The IconRsc for SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_setCollapsedSelectedIconByName
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_getCurrentIcon ( GuiTreeNodeCP  pNode,
RscId pIconRscId,
RscType pIconRscType,
MdlDesc **  ppIconOwnerMD 
)

Returns information about the current icon to be displayed in the Gui Tree item based on the status of the node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in,out]pIconRscIdpoints to an integer that receives the icon resource Id
[in,out]pIconRscTypepoints to an integer that receives the icon resource type
[in,out]ppIconOwnerMDpoints to a void pointer that is set to the address of the owner of the icon
Returns
MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_setLeafIcon mdlTreeNode_setLeafSelectedIcon mdlTreeNode_setCollapsedIcon mdlTreeNode_setCollapsedSelectedIcon mdlTreeNode_setCollapsedDeselectedIcon mdlTreeNode_setExpandedIcon mdlTreeNode_setExpandedSelectedIcon mdlTreeNode_setExpandedDeselectedIcon mdlTreeCell_setIcon
Remarks
Required Library: mdlbltin.lib
IconRsc* mdlTreeNode_getCurrentIconRsc ( GuiTreeNodeCP  pNode)

Returns the IconRsc for the current icon to be displayed in the Gui Tree item based on the status of the node.

The IconRsc is returned if the icon was set by one of the "SetByName" or "SetIconRsc" functions.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
The IconRsc for the the current icon, or NULL if pNode is invalid
See also
mdlTreeNode_setLeafIconByName mdlTreeNode_setLeafIconRsc mdlTreeNode_setCollapsedIconByName mdlTreeNode_setCollapsedIconRsc mdlTreeNode_setExpandedIconByName mdlTreeNode_setExpandedIconRsc
Remarks
Required Library: mdlbltin.lib
int mdlTreeNode_getDescendentCount ( GuiTreeNodeCP  pParentNode)

Returns the number of descendents in all levels below a parent GuiTreeNode.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
Returns
The number of descendents in all levels below this parent node.
See also
mdlTreeNode_getChildCount
Remarks
Required Library: mdlbltin.lib
int mdlTreeNode_getDisplayableDescendentCount ( GuiTreeNodeCP  pParentNode)

Returns the number of displayable descendents in all levels below a parent GuiTreeNode.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
Returns
The number of displayable descendents in all levels below this parent node.
See also
mdlTreeNode_getChildCount mdlTreeNode_getDescendentCount
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_getDisplayText ( GuiTreeNodeCP  pNode,
WCharCP *  pwString 
)

Returns a Unicode string with the display text of the GuiTreeCell at index 0 within a GuiTreeNode.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in,out]pwStringpoints to the Unicode pointer that will receive the address of the display text
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid
See also
mdlTreeNode_setDisplayText mdlTreeNode_setDisplayText mdlTreeNode_getDisplayText
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_getDisplayTextWString ( GuiTreeNodeCP  pNode,
WStringR  wString 
)

Returns the display text of the specified GuiTreeNode in a WString.

Parameters
[in,out]wStringthe WString object that will receive the display text
[in]pNodepoints to the GuiTreeNode to process
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_setDisplayText mdlTreeNode_setDisplayText
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_getEditor ( GuiTreeNodeCP  pNode,
long *  pEditorType,
long *  pEditorId,
MdlDesc **  pEditorOwnerMD,
bool *  pbEditDisplay,
bool *  pbUpdateDisplay 
)

Gets information about the editor for the specified tree node.

Parameters
[in]pNodethe GuiTreeNode to get the editor information from
[in,out]pEditorTypethe type of the editor for the specified tree node
[in,out]pEditorIdthe Id of the editor for the tree node
[in,out]pEditorOwnerMDthe editor ownerMD
[in,out]pbEditDisplayif true, only the display text of the node is editable
[in,out]pbUpdateDisplayif true, the node display text is updated after editing
Returns
SUCCESS if pNode points to a valid tree cell
Remarks
Required Library: mdlbltin.lib
See also
mdlTreeNode_setEditor
StatusInt mdlTreeNode_getExpandedDeselectedIcon ( GuiTreeNodeCP  pNode,
RscId pIconRscId,
RscType pIconRscType,
MdlDesc **  ppIconOwnerMD 
)

Returns information about the icon to be displayed in the Gui Tree item if this node is an expanded parent node that is not selected.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in,out]pIconRscIdpoints to an integer that receives the icon resource Id
[in,out]pIconRscTypepoints to an integer that receives the icon resource type
[in,out]ppIconOwnerMDpoints to a void pointer that is set to the address of the owner of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_setExpandedDeselectedIcon
Remarks
Required Library: mdlbltin.lib
IconRsc* mdlTreeNode_getExpandedDeselectedIconRsc ( GuiTreeNodeCP  pNode)

Returns the IconRsc for the icon to be displayed in the Gui Tree item if this node is a deselected expanded parent.

The IconRsc is only returned if the icon was set by one of the ByName functions.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
The IconRsc for SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_setExpandedDeselectedIconByName
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_getExpandedIcon ( GuiTreeNodeCP  pNode,
RscId pIconRscId,
RscType pIconRscType,
MdlDesc **  ppIconOwnerMD 
)

Returns information about the icon to be displayed in the Gui Tree item if this node is an expanded parent node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in,out]pIconRscIdpoints to an integer that receives the icon resource Id
[in,out]pIconRscTypepoints to an integer that receives the icon resource type
[in,out]ppIconOwnerMDpoints to a void pointer that is set to the address of the owner of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_setExpandedIcon
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_getExpandedSelectedIcon ( GuiTreeNodeCP  pNode,
RscId pIconRscId,
RscType pIconRscType,
MdlDesc **  ppIconOwnerMD 
)

Returns information about the icon to be displayed in the Gui Tree item if this node is a selected expanded parent node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in,out]pIconRscIdpoints to an integer that receives the icon resource Id
[in,out]pIconRscTypepoints to an integer that receives the icon resource type
[in,out]ppIconOwnerMDpoints to a void pointer that is set to the address of the owner of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_setExpandedSelectedIcon
Remarks
Required Library: mdlbltin.lib
IconRsc* mdlTreeNode_getExpandedSelectedIconRsc ( GuiTreeNodeCP  pNode)

Returns the IconRsc for the icon to be displayed in the Gui Tree item if this node is a selected expanded parent.

The IconRsc is only returned if the icon was set by one of the ByName functions.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
The IconRsc for SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_setExpandedSelectedIconByName
Remarks
Required Library: mdlbltin.lib
GuiTreeNodeP mdlTreeNode_getFirstChild ( GuiTreeNodeCP  pParentNode)

Returns a pointer to the first GuiTreeNode in the one level below a parent GuiTreeNode.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
Returns
A pointer to the first child node of a parent node
See also
mdlTreeNode_getNextChild mdlTreeNode_getPrevChild mdlTreeNode_getLastChild
Remarks
Required Library: mdlbltin.lib
GuiTreeNodeP mdlTreeNode_getLastChild ( GuiTreeNodeCP  pParentNode)

Returns a pointer to the last GuiTreeNode in the one level below a parent GuiTreeNode.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
Returns
A pointer to the last child node of a parent node
See also
mdlTreeNode_getFirstChild mdlTreeNode_getNextChild mdlTreeNode_getPrevChild
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_getLeafDeselectedIcon ( GuiTreeNodeCP  pNode,
RscId pIconRscId,
RscType pIconRscType,
MdlDesc **  ppIconOwnerMD 
)

Returns information about the icon to be displayed in the Gui Tree item if this node is a leaf node that is not selected.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in,out]pIconRscIdpoints to an integer that receives the icon resource Id
[in,out]pIconRscTypepoints to an integer that receives the icon resource type
[in,out]ppIconOwnerMDpoints to a void pointer that is set to the address of the owner of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_setLeafDeselectedIcon
Remarks
Required Library: mdlbltin.lib
IconRsc* mdlTreeNode_getLeafDeselectedIconRsc ( GuiTreeNodeCP  pNode)

Returns the IconRsc for the icon to be displayed in the Gui Tree item if this node is a deselected leaf.

The IconRsc is only returned if the icon was set by one of the ByName functions.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
The IconRsc for SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_setLeafDeselectedIconByName
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_getLeafIcon ( GuiTreeNodeCP  pNode,
RscId pIconRscId,
RscType pIconRscType,
MdlDesc **  ppIconOwnerMD 
)

Returns information about the icon to be displayed in the Gui Tree item if this node is a leaf node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in,out]pIconRscIdpoints to an integer that receives the icon resource Id
[in,out]pIconRscTypepoints to an integer that receives the icon resource type
[in,out]ppIconOwnerMDpoints to a void pointer that is set to the address of the owner of the icon
Returns
MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_setLeafIcon
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_getLeafSelectedIcon ( GuiTreeNodeCP  pNode,
RscId pIconRscId,
RscType pIconRscType,
MdlDesc **  ppIconOwnerMD 
)

Returns information about the icon to be displayed in the Gui Tree item if this node is a selected leaf node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in,out]pIconRscIdpoints to an integer that receives the icon resource Id
[in,out]pIconRscTypepoints to an integer that receives the icon resource type
[in,out]ppIconOwnerMDpoints to a void pointer that is set to the address of the owner of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_setLeafSelectedIcon
Remarks
Required Library: mdlbltin.lib
IconRsc* mdlTreeNode_getLeafSelectedIconRsc ( GuiTreeNodeCP  pNode)

Returns the IconRsc for the icon to be displayed in the Gui Tree item if this node is a selected leaf.

The IconRsc is only returned if the icon was set by one of the ByName functions.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
The IconRsc for SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_setLeafSelectedIconByName
Remarks
Required Library: mdlbltin.lib
int mdlTreeNode_getLevel ( GuiTreeNodeCP  pNode)

Returns the level of a specified GuiTreeNode.

The level is the distance from the root node to this node, represented as a 0-based index.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
The level of the GuiTreeNode, or ERROR if pNode is invalid.
See also
mdlTreeNode_destroy
Remarks
Required Library: mdlbltin.lib
GuiTreeModelP mdlTreeNode_getModel ( GuiTreeNodeCP  pNode)

Returns a pointer to the owning GuiTreeModel.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
A pointer to the owning GuiTreeModel, or NULL if pNode is invalid.
See also
mdlTreeNode_create
Remarks
Required Library: mdlbltin.lib
GuiTreeNodeP mdlTreeNode_getNextChild ( GuiTreeNodeCP  pParentNode,
GuiTreeNodeCP  pInChild 
)

Returns a pointer to the next GuiTreeNode after a given child node in the one level below a parent GuiTreeNode.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
[in]pInChildpoints to the child node to get the next node from
Returns
A pointer to the next child node after a given child node.
See also
mdlTreeNode_getFirstChild mdlTreeNode_getPrevChild mdlTreeNode_getLastChild
Remarks
Required Library: mdlbltin.lib
GuiTreeNodeP mdlTreeNode_getNextDisplayNode ( GuiTreeNodeCP  pNode,
bool  bCheckChildren 
)

Returns the next displayable node in the GuiTreeModel.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]bCheckChildrenwhether to check children for the next displayable node
Returns
The next displayable node in the GuiTreeModel, or NULL if pNode is the last displayable node in the GuiTreeModel.
See also
mdlTreeNode_getPrevDisplayNode
Remarks
Required Library: mdlbltin.lib
GuiTreeNodeP mdlTreeNode_getNextSibling ( GuiTreeNodeCP  pNode)

Returns the next sibling node in the parent's child list.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
The sibling node that immediately follows this node, or NULL if this node is the last in the parent's child list.
See also
mdlTreeNode_destroyc
Remarks
Required Library: mdlbltin.lib
GuiTreeNodeP mdlTreeNode_getParent ( GuiTreeNodeCP  pNode)

Returns a pointer to the tree node that is the parent of the given GuiTreeNode.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
A pointer to the parent GuiTreeNode, or NULL if pNode is invalid.
See also
mdlTreeNode_setParent
Remarks
Required Library: mdlbltin.lib
GuiTreeNodePathCP mdlTreeNode_getPathFromAncestor ( GuiTreeNodeP  pNode,
GuiTreeNodeCP  pAncestor 
)

Builds and returns a GuiTreeNodePath from the ancestor node to the specified GuiTreeNode.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pAncestorAncestor to build path from
Returns
A pointer to the GuiTreeNodePath from the specified ancestor node. This GuiTreeNodePath is maintained by the GuiTreeNode; therefore, the application should not attempt to free the path.
See also
mdlTreeNodePath_ functionsC
Remarks
Required Library: mdlbltin.lib
GuiTreeNodePathCP mdlTreeNode_getPathFromRoot ( GuiTreeNodeP  pNode)

Builds and returns a GuiTreeNodePath from the root node to the specified GuiTreeNode.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
A pointer to the GuiTreeNodePath from the root node. This GuiTreeNodePath is maintained by the GuiTreeNode; therefore, the application should not attempt to free the path.
See also
mdlTreeNodePath_ functionsC
Remarks
Required Library: mdlbltin.lib
GuiTreeNodeP mdlTreeNode_getPrevChild ( GuiTreeNodeCP  pParentNode,
GuiTreeNodeCP  pInChild 
)

Returns a pointer to the previous GuiTreeNode before a given child node in the one level below a parent GuiTreeNode.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
[in]pInChildpoints to the child node to get the previous node from
Returns
A pointer to the next child node after a given child node
See also
mdlTreeNode_getFirstChild mdlTreeNode_getNextChild mdlTreeNode_getLastChild
Remarks
Required Library: mdlbltin.lib
GuiTreeNodeP mdlTreeNode_getPrevDisplayNode ( GuiTreeNodeCP  pNode)

Returns the previous displayable node in the GuiTreeModel.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
The previous displayable node in the GuiTreeModel, or NULL if pNode is the first displayable node in the GuiTreeModel.
See also
mdlTreeNode_getNextDisplayNode
Remarks
Required Library: mdlbltin.lib
GuiTreeNodeP mdlTreeNode_getPrevSibling ( GuiTreeNodeCP  pNode)

Returns the previous sibling node in the parent's child list.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
The sibling node that immediately precedes this node, or NULL if this node is the first in the parent's child list.
See also
mdlTreeNode_destroy
Remarks
Required Library: mdlbltin.lib
int mdlTreeNode_getStatus ( GuiTreeNodeCP  pNode)

Returns the status of a specified GuiTreeNode.

The Tree dialog item uses the status field. Valid values are the TREENODEATTR_... definitions found in dlogitem.h.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
The status of the GuiTreeNode, or ERROR if pNode is invalid.
See also
mdlTreeNode_setStatus
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_getValue ( GuiTreeNodeCP  pNode,
MSValueDescrR  valueDescr 
)

Returns a copy of the internal value descriptor of the GuiTreeCell at index 0 within a specified GuiTreeNode.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in,out]valueDescrpoints to the ValueDescr that will receive a copy of the internal value descriptor
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode or pValueDescr are invalid
See also
mdlTreeNode_setValue
Remarks
Required Library: mdlbltin.lib
int mdlTreeNode_insertChild ( GuiTreeNodeP  pParentNode,
GuiTreeNodeP  pChild,
int  index 
)

Inserts a specified GuiTreeNode into the first level child list of a parent GuiTreeNode before a certain child index.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
[in]pChildpoints to the node to insert into the parent node
[in]indexIndex of the child node to insert before. A value of -1 indicates to append the child node to the end.
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pParentNode is invalid, MDLERR_INSFMEMORY if there was not enough memory to insert the node
See also
mdlTreeNode_addChild mdlTreeNode_removeChild mdlTreeNode_removeChildren
Remarks
Required Library: mdlbltin.lib
GuiTreeNodeP mdlTreeNode_insertData ( GuiTreeNodeP  pParentNode,
MSValueDescrCR  valueDescr,
int  index 
)

Inserts a GuiTreeNode into the first level child list of a parent GuiTreeNode before a certain index with a specified value.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
[in]valueDescrpoints to a value to assign to the cell at index 0
[in]indexIndex of the new child node to insert before. A value of -1 indicates to append the child node to the end.
Returns
A pointer to the new inserted GuiTreeNode
See also
mdlTreeNode_insertString
Remarks
Required Library: mdlbltin.lib
GuiTreeNodeP mdlTreeNode_insertString ( GuiTreeNodeP  pParentNode,
WCharCP  pString,
int  index 
)

Inserts a GuiTreeNode into the first level child list of a parent GuiTreeNode before a certain index with a specified string as the value.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
[in]pStringpoints to a character string value to assign to the cell at index 0
[in]indexIndex of the new child node to insert before. A value of -1 indicates to append the child node to the end.
Returns
A pointer to the new inserted GuiTreeNode
See also
mdlTreeNode_insertData
Remarks
Required Library: mdlbltin.lib
bool mdlTreeNode_isDescendent ( GuiTreeNodeCP  pParentNode,
GuiTreeNodeCP  pNode 
)

Determines is a given node is a descendent of a parent node.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
[in]pNodepoints to the possible descendent node
Returns
true if pNode is a descendent of pParentNode
Remarks
Required Library: mdlbltin.lib
bool mdlTreeNode_isDisplayable ( GuiTreeNodeP  pNode)

Returns true if this GuiTreeNode is displayable in the Gui Tree item.

To be displayable, all the ancestors of the node must be expanded.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
true if this GuiTreeNode is displayable in the Gui Tree item.
See also
mdlTreeNode_expand mdlTreeNode_collapse
Remarks
Required Library: mdlbltin.lib
bool mdlTreeNode_isExpanded ( GuiTreeNodeCP  pNode)

Returns true if this GuiTreeNode is expanded in the Gui Tree item.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
true if this GuiTreeNode is expanded, or false if it is collapsed, not popuplated, or a leaf.
See also
mdlTreeNode_expand mdlTreeNode_collapse
Remarks
Required Library: mdlbltin.lib
bool mdlTreeNode_isLeaf ( GuiTreeNodeCP  pNode)

Returns true if this GuiTreeNode is a leaf node.

A leaf node does not allow children.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
true if this GuiTreeNode is a leaf node, or false if it is a parent node
See also
mdlTreeNode_create mdlTreeNode_setAllowsChildren
Remarks
Required Library: mdlbltin.lib
bool mdlTreeNode_isParent ( GuiTreeNodeCP  pNode)

Returns true if this GuiTreeNode is a parent node.

A parent node allows children.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
true if this GuiTreeNode is a parent node, or false if it is a leaf node
See also
mdlTreeNode_create mdlTreeNode_setAllowsChildren
Remarks
Required Library: mdlbltin.lib
bool mdlTreeNode_isParentPopulated ( GuiTreeNodeCP  pNode)

Returns true if this GuiTreeNode is a parent node and if it is populated with any children.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
true if this GuiTreeNode is a parent node and if it is populated with any children
See also
mdlTreeNode_create mdlTreeNode_setAllowsChildren mdlTreeNode_addChild mdlTreeNode_insertChild
Remarks
Required Library: mdlbltin.lib
bool mdlTreeNode_isRoot ( GuiTreeNodeCP  pNode)

Returns true if this GuiTreeNode is the root node of the owning GuiTreeModel.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
true if this GuiTreeNode is the root node of the owning GuiTreeModel.
See also
mdlTreeNode_create mdlTreeNode_setAllowsChildren mdlTreeNode_addChild mdlTreeNode_insertChild
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_makeDisplayable ( GuiTreeNodeP  pNode)

Makes the GuiTreeNode displayable by expanding all of its ancestors.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_isDisplayable mdlTreeNode_expand
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_moveChildToIndex ( GuiTreeNodeP  pParentNode,
GuiTreeNodeP  pNode,
int  index 
)

Moves a child node to a particular index.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
[in]pNodepoints to the GuiTreeNode to process
[in]indexchild index to insert before; -1 = append
Returns
true if pNode is a descendent of pParentNode
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_moveDown ( GuiTreeNodeP  pNode)

Moves the node down within its parent node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_moveUp
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_moveUp ( GuiTreeNodeP  pNode)

Moves the node up within its parent node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_moveDown
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_removeChild ( GuiTreeNodeP  pParentNode,
GuiTreeNodeP  pChild,
bool  bDestroy 
)

Removes a specified GuiTreeNode from the first level child list of a parent GuiTreeNode and optionally destroys the child node.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
[in]pChildpoints to the node to remove from the parent node
[in]bDestroyIndicates whether to destroy the node after removing it.
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pParentNode is invalid, MDLERR_NOMATCH if the child node is not in the parent
See also
mdlTreeNode_addChild mdlTreeNode_insertChild mdlTreeNode_removeChildren
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_removeChildAtIndex ( GuiTreeNodeP  pParentNode,
int  iNode,
bool  bDestroyNode 
)

Removes a GuiTreeNode at a specified index from the first level child list of a parent GuiTreeNode and optionally destroys the child node.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
[in]iNodeindex of the child node to remove
[in]bDestroyNodeIndicates whether to destroy the node after removing it.
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pParentNode is invalid, MDLERR_BADINDEX if iNode is invalid
See also
mdlTreeNode_addChild mdlTreeNode_insertChild mdlTreeNode_removeChild mdlTreeNode_removeChildren
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_removeChildren ( GuiTreeNodeP  pParentNode,
int  iNode,
int  nNodes,
bool  bDestroy 
)

Removes a certain number of GuiTreeNodes from the first level child list of a parent GuiTreeNode and optionally destroys the child nodes.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
[in]iNodeindex of the first child node to remove
[in]nNodesnumber of nodes to remove. A value of -1 means to remove all nodes to the end from iNode
[in]bDestroytrue if the child nodes should be destroyed after removal
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pParentNode is invalid, MDLERR_BADINDEX if iNode is invalid
See also
mdlTreeNode_addChild mdlTreeNode_insertChild mdlTreeNode_removeChild
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_search ( GuiTreeNodeP  pParentNode,
MSValueDescrCP  pValueDescr,
InfoField *  pInfoFields,
int  startIndex,
int  numToSearch,
int  columnIndex,
bool  bSearchAll,
GuiTreeNodeP *  ppFoundNode 
)

Searches through either the first level child list of a parent GuiTreeNode or optionally all of its descendents for a specified value in a certain column.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
[in]pValueDescrspecifies the format type and value to search for.
[in]pInfoFieldsspecifies any info fields to search for
[in]startIndexIndex of the first level child node to start the search with. A value of 0 indicates to start at the beginning.
[in]numToSearchNumber of first level child nodes to search. A value of -1 indicates to search all child nodes to the end from startIndex.
[in]columnIndexIndex of the column to search in.
[in]bSearchAllIndicates whether to search all descendents as opposed to only the first level child list. When searching descendents, the startIndex and numToSearch parameters are disregarded.
[out]ppFoundNodepoints to a GuiTreeNode pointer which is set to the found node.
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pParentNode is invalid, MDLERR_BADINDEX if startIndex or columnIndex are invalid, MDLERR_NOMATCH if a child node with the specified value is not found
See also
mdlTreeColumn_setSearchFunction
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_searchUsingFunction ( GuiTreeNodeP  pParentNode,
MSValueDescrCP  pValueDescr,
InfoField *  pInfoFields,
int  startIndex,
int  numToSearch,
int  columnIndex,
bool  bSearchAll,
TreeColumnSearchFuncP  pSearchFunc,
MdlDesc pSearchOwnerMD,
GuiTreeNodeP *  ppFoundNode 
)

Searches through either the first level child list of a parent GuiTreeNode or optionally all of its descendents for a specified value in a certain column.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
[in]pValueDescrspecifies the format type and value to search for.
[in]pInfoFieldsspecifies any info fields to search for
[in]startIndexIndex of the first level child node to start the search with. A value of 0 indicates to start at the beginning.
[in]numToSearchNumber of first level child nodes to search. A value of -1 indicates to search all child nodes to the end from startIndex.
[in]columnIndexIndex of the column to search in.
[in]bSearchAllIndicates whether to search all descendents as opposed to only the first level child list. When searching descendents, the startIndex and numToSearch parameters are disregarded.
[in]pSearchFuncspecifies to search function to use for all columns, including secondary columns.
[in]pSearchOwnerMDspecifies to search function's owner Mdl Descriptor.
[out]ppFoundNodepoints to a GuiTreeNode pointer which is set to the found node.
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pParentNode is invalid, MDLERR_BADINDEX if startIndex or columnIndex are invalid, MDLERR_NOMATCH if a child node with the specified value is not found
See also
mdlTreeColumn_setSearchFunction
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setAllowsChildren ( GuiTreeNodeP  pNode,
bool  bAllowsChildren 
)

Sets whether the GuiTreeNode allows children.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]bAllowsChildrenindicates whether this node will allow children and can be a parent of other GuiTreeNodes
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_destroy
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setAppData ( GuiTreeNodeP  pNode,
UserDataP  pAppData 
)

Sets the pointer to application data to be associated with the GuiTreeNode.

Parameters
[in]pNodethe GuiTreeNode to process.
[in]pAppDatapoints to the application data to be associated with the GuiTreeNode.
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
Remarks
The application data must be destroyed by the application.
See also
mdlTreeNode_getAppData
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setBgColorDescr ( GuiTreeNodeP  pNode,
BSIColorDescr *  pDescr 
)

Sets the background color descriptor to use when drawing cells in the specified node.

Parameters
[in]pNodepoints to the GuiTreeNode to process.
[in]pDescrpoints to the ColorDescr to use for the background of the cells.
Returns
SUCCESS if the operation was completed successfully.
See also
mdlTreeNode_setColorDescr mdlTreeNode_getBgColorDescr
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setCollapsedDeselectedIcon ( GuiTreeNodeP  pNode,
RscId  iconRscId,
RscType  iconRscType,
MdlDesc iconOwnerMD 
)

Sets information about the icon to be displayed in the Gui Tree item if this node is a collapsed parent node that is not selected.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]iconRscIdthe icon resource Id
[in]iconRscTypethe icon resource type
[in]iconOwnerMDa void pointer to the owner of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getCollapsedDeselectedIcon
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setCollapsedDeselectedIconByName ( GuiTreeNodeP  pNode,
WCharCP  pIconName,
Point2dCP  pIconSize 
)

Sets the name of the icon to be displayed in the Gui Tree item if this node is a deselected collapsed parent node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pIconNamethe name of the icon
[in]pIconSizethe size of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getCollapsedDeselectedIconRsc
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setCollapsedDeselectedIconRsc ( GuiTreeNodeP  pNode,
IconRsc pIconRsc 
)

Sets the IconRsc of the icon to be displayed in the Gui Tree item if this node is a deselected collapsed parent node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pIconRscthe IconRsc of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getCollapsedDeselectedIconRsc
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setCollapsedIcon ( GuiTreeNodeP  pNode,
RscId  iconRscId,
RscType  iconRscType,
MdlDesc iconOwnerMD 
)

Sets information about the icon to be displayed in the Gui Tree item if this node is a collapsed parent node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]iconRscIdthe icon resource Id
[in]iconRscTypethe icon resource type
[in]iconOwnerMDa void pointer to the owner of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getCollapsedIcon
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setCollapsedIconByName ( GuiTreeNodeP  pNode,
WCharCP  pIconName,
Point2dCP  pIconSize 
)

Sets the name of the icon to be displayed in the Gui Tree item if this node is a collapsed parent node, either selected or not.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pIconNamethe name of the icon
[in]pIconSizethe size of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getCollapsedSelectedIconRsc mdlTreeNode_getCollapsedDeselectedIconRsc
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setCollapsedIconRsc ( GuiTreeNodeP  pNode,
IconRsc pIconRsc 
)

Sets the IconRsc of the icon to be displayed in the Gui Tree item if this node is a collapsed parent node, either selected or not.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pIconRscthe IconRsc of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getCollapsedSelectedIconRsc mdlTreeNode_getCollapsedDeselectedIconRsc
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setCollapsedSelectedIcon ( GuiTreeNodeP  pNode,
RscId  iconRscId,
RscType  iconRscType,
MdlDesc iconOwnerMD 
)

Sets information about the icon to be displayed in the Gui Tree item if this node is a selected collapsed parent node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]iconRscIdthe icon resource Id
[in]iconRscTypethe icon resource type
[in]iconOwnerMDa void pointer to the owner of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getCollapsedSelectedIcon
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setCollapsedSelectedIconByName ( GuiTreeNodeP  pNode,
WCharCP  pIconName,
Point2dCP  pIconSize 
)

Sets the name of the icon to be displayed in the Gui Tree item if this node is a selected collapsed parent node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pIconNamethe name of the icon
[in]pIconSizethe size of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getCollapsedSelectedIconRsc
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setCollapsedSelectedIconRsc ( GuiTreeNodeP  pNode,
IconRsc pIconRsc 
)

Sets the IconRsc of the icon to be displayed in the Gui Tree item if this node is a selected collapsed parent node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pIconRscthe IconRsc of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getCollapsedSelectedIconRsc
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setColorDescr ( GuiTreeNodeP  pNode,
BSIColorDescr *  pDescr 
)

Sets the color descriptor to use when drawing cells in the specified node.

Parameters
[in]pNodepoints to the GuiTreeNode to process.
[in]pDescrpoints to the ColorDescr to use for drawing the cells.
Returns
SUCCESS if the operation was completed successfully.
See also
mdlTreeNode_getColorDescr mdlTreeNode_setBgColorDescr
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setDisplayText ( GuiTreeNodeP  pNode,
WCharCP  pwString 
)

Sets the display text of the GuiTreeCell at index 0 within a GuiTreeNode fromthe given Unicode string.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pwStringpoints to the new display text. The text itself is copied to an internal location in the GuiTreeCell; therefore, the application does not need to maintain the string pointer
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getDisplayText mdlTreeNode_setDisplayText mdlTreeNode_getDisplayText
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setEditor ( GuiTreeNodeP  pNode,
long  editorType,
long  editorId,
MdlDesc editorOwnerMD,
bool  bEditDisplay,
bool  bUpdateDisplay 
)

Sets information about the editor for the specified tree node.

Parameters
[in]pNodethe GuiTreeNode to set the editor information in
[in,out]editorTypethe type of the editor for the specified tree node
[in,out]editorIdthe Id of the editor for the tree node
[in,out]editorOwnerMDthe editor ownerMD
[in,out]bEditDisplayif true, only the display text of the node is editable
[in]bUpdateDisplayif true, the node display text is updated after editing
Returns
SUCCESS if pNode points to a valid tree cell
Remarks
Required Library: mdlbltin.lib
See also
mdlTreeNode_getEditor
StatusInt mdlTreeNode_setExpandedDeselectedIcon ( GuiTreeNodeP  pNode,
RscId  iconRscId,
RscType  iconRscType,
MdlDesc iconOwnerMD 
)

Sets information about the icon to be displayed in the Gui Tree item if this node is an expanded parent node that is not selected.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]iconRscIdthe icon resource Id
[in]iconRscTypethe icon resource type
[in]iconOwnerMDa void pointer to the owner of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getExpandedDeselectedIcon
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setExpandedDeselectedIconByName ( GuiTreeNodeP  pNode,
WCharCP  pIconName,
Point2dCP  pIconSize 
)

Sets the name of the icon to be displayed in the Gui Tree item if this node is a deselected expanded parent node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pIconNamethe name of the icon
[in]pIconSizethe size of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getExpandedDeselectedIconRsc
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setExpandedDeselectedIconRsc ( GuiTreeNodeP  pNode,
IconRsc pIconRsc 
)

Sets the IconRsc of the icon to be displayed in the Gui Tree item if this node is a deselected expanded parent node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pIconRscthe IconRsc of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getExpandedDeselectedIconRsc
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setExpandedIcon ( GuiTreeNodeP  pNode,
RscId  iconRscId,
RscType  iconRscType,
MdlDesc iconOwnerMD 
)

Sets information about the icon to be displayed in the Gui Tree item if this node is an expanded parent node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]iconRscIdthe icon resource Id
[in]iconRscTypethe icon resource type
[in]iconOwnerMDa void pointer to the owner of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getExpandedIcon
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setExpandedIconByName ( GuiTreeNodeP  pNode,
WCharCP  pIconName,
Point2dCP  pIconSize 
)

Sets the name of the icon to be displayed in the Gui Tree item if this node is a expanded parent node, either selected or not.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pIconNamethe name of the icon
[in]pIconSizethe size of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getExpandedSelectedIconRsc mdlTreeNode_getExpandedDeselectedIconRsc
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setExpandedIconRsc ( GuiTreeNodeP  pNode,
IconRsc pIconRsc 
)

Sets the IconRsc of the icon to be displayed in the Gui Tree item if this node is a expanded parent node, either selected or not.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pIconRscthe IconRsc of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getExpandedSelectedIconRsc mdlTreeNode_getExpandedDeselectedIconRsc
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setExpandedSelectedIcon ( GuiTreeNodeP  pNode,
RscId  iconRscId,
RscType  iconRscType,
MdlDesc iconOwnerMD 
)

Sets information about the icon to be displayed in the Gui Tree item if this node is a selected expanded parent node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]iconRscIdthe icon resource Id
[in]iconRscTypethe icon resource type
[in]iconOwnerMDa void pointer to the owner of the icon
Returns
MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getExpandedSelectedIcon
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setExpandedSelectedIconByName ( GuiTreeNodeP  pNode,
WCharCP  pIconName,
Point2dCP  pIconSize 
)

Sets the name of the icon to be displayed in the Gui Tree item if this node is a selected expanded parent node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pIconNamethe name of the icon
[in]pIconSizethe size of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getExpandedSelectedIconRsc
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setExpandedSelectedIconRsc ( GuiTreeNodeP  pNode,
IconRsc pIconRsc 
)

Sets the IconRsc of the icon to be displayed in the Gui Tree item if this node is a selected expanded parent node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pIconRscthe IconRsc of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getExpandedSelectedIconRsc
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setFontIndex ( GuiTreeNodeP  pNode,
int  fontIndex 
)

Sets the font to use when drawing cells in the specified node.

Parameters
[in]pNodepoints to the GuiTreeNode to process.
[in]fontIndexthe index of the font to use.
Returns
SUCCESS if the font index was valid and set successfully.
Remarks
Required Library: mdlbltin.lib
See also
mdlTreeCell_getFontIndex
StatusInt mdlTreeNode_setIcon ( GuiTreeNodeP  pNode,
RscId  iconRscId,
RscType  iconRscType,
MdlDesc iconOwnerMD 
)

Sets information about the icon to be displayed in the Gui Tree item for this node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]iconRscIdthe icon resource Id
[in]iconRscTypethe icon resource type
[in]iconOwnerMDa void pointer to the owner of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getLeafIcon mdlTreeNode_getCollapsedIcon mdlTreeNode_getExpandedIcon
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setIconByName ( GuiTreeNodeP  pNode,
WCharCP  pIconName,
Point2dCP  pIconSize 
)

Sets the name of the icon to be displayed in the Gui Tree item for this node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pIconNamethe name of the icon
[in]pIconSizethe size of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getLeafIconRsc mdlTreeNode_getCollapsedIconRsc mdlTreeNode_getExpandedIconRsc
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setIconRsc ( GuiTreeNodeP  pNode,
IconRsc pIconRsc 
)

Sets the IconRsc for the icon to be displayed in the Gui Tree item for this node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pIconRscthe IconRsc of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getLeafIconRsc mdlTreeNode_getCollapsedIconRsc mdlTreeNode_getExpandedIconRsc
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setLeafDeselectedIcon ( GuiTreeNodeP  pNode,
RscId  iconRscId,
RscType  iconRscType,
MdlDesc iconOwnerMD 
)

Sets information about the icon to be displayed in the Gui Tree item if this node is a leaf node that is not selected.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]iconRscIdthe icon resource Id
[in]iconRscTypethe icon resource type
[in]iconOwnerMDa void pointer to the owner of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getLeafDeselectedIcon
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setLeafDeselectedIconByName ( GuiTreeNodeP  pNode,
WCharCP  pIconName,
Point2dCP  pIconSize 
)

Sets the name of the icon to be displayed in the Gui Tree item if this node is a deselected leaf node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pIconNamethe name of the icon
[in]pIconSizethe size of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getLeafDeselectedIconRsc
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setLeafDeselectedIconRsc ( GuiTreeNodeP  pNode,
IconRsc pIconRsc 
)

Sets the IconRsc of the icon to be displayed in the Gui Tree item if this node is a deselected leaf node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pIconRscthe IconRsc of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getLeafDeselectedIconRsc
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setLeafIcon ( GuiTreeNodeP  pNode,
RscId  iconRscId,
RscType  iconRscType,
MdlDesc iconOwnerMD 
)

Sets information about the icon to be displayed in the Gui Tree item if this node is a leaf node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]iconRscIdthe icon resource Id
[in]iconRscTypethe icon resource type
[in]iconOwnerMDa void pointer to the owner of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getLeafIcon
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setLeafIconByName ( GuiTreeNodeP  pNode,
WCharCP  pIconName,
Point2dCP  pIconSize 
)

Sets the name of the icon to be displayed in the Gui Tree item if this node is a leaf node, either selected or not.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pIconNamethe name of the icon
[in]pIconSizethe size of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getLeafSelectedIconRsc mdlTreeNode_getLeafDeselectedIconRsc
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setLeafIconRsc ( GuiTreeNodeP  pNode,
IconRsc pIconRsc 
)

Sets the IconRsc of the icon to be displayed in the Gui Tree item if this node is a leaf node, either selected or not.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pIconRscthe IconRsc of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getLeafSelectedIconRsc mdlTreeNode_getLeafDeselectedIconRsc
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setLeafSelectedIcon ( GuiTreeNodeP  pNode,
RscId  iconRscId,
RscType  iconRscType,
MdlDesc iconOwnerMD 
)

Sets information about the icon to be displayed in the Gui Tree item if this node is a selected leaf node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]iconRscIdthe icon resource Id
[in]iconRscTypethe icon resource type
[in]iconOwnerMDa void pointer to the owner of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getLeafSelectedIcon
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setLeafSelectedIconByName ( GuiTreeNodeP  pNode,
WCharCP  pIconName,
Point2dCP  pIconSize 
)

Sets the name of the icon to be displayed in the Gui Tree item if this node is a selected leaf node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pIconNamethe name of the icon
[in]pIconSizethe size of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getLeafSelectedIconRsc
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setLeafSelectedIconRsc ( GuiTreeNodeP  pNode,
IconRsc pIconRsc 
)

Sets the IconRsc of the icon to be displayed in the Gui Tree item if this node is a selected leaf node.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pIconRscthe IconRsc of the icon
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_getLeafSelectedIconRsc
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setLevel ( GuiTreeNodeP  pNode,
bool  bSetInDescendents 
)

Sets the level of a specified GuiTreeNode based on its position in the GuiTreeModel.

The level is also optionally set in all of its descendents. The level is the distance from the root node to this node, represented as a 0-based index.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]bSetInDescendentsindicates whether the level should be set in all of the node's descendents
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode is invalid
See also
mdlTreeNode_destroy
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setSelectedBgColorDescr ( GuiTreeNodeP  pNode,
BSIColorDescr *  pDescr 
)

Sets the background color descriptor to use when drawing selected cells in the specified node.

Parameters
[in]pNodepoints to the GuiTreeNode to process.
[in]pDescrpoints to the ColorDescr to use for the background of the cells.
Returns
SUCCESS if the operation was completed successfully.
See also
mdlTreeNode_setColorDescr mdlTreeNode_getBgColorDescr
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setSelectedColorDescr ( GuiTreeNodeP  pNode,
BSIColorDescr *  pDescr 
)

Sets the color descriptor to use when drawing selected cells in the specified node.

Parameters
[in]pNodepoints to the GuiTreeNode to process.
[in]pDescrpoints to the ColorDescr to use for drawing the cells.
Returns
SUCCESS if the operation was completed successfully.
See also
mdlTreeNode_getColorDescr mdlTreeNode_setBgColorDescr
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setStatus ( GuiTreeNodeP  pNode,
int  status 
)

Sets the status of a specified GuiTreeNode.

The Tree dialog item uses the status field. Valid values are the TREENODEATTR_... definitions found in dlogitem.h.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]statusindicates the new status of the GuiTreeNode
Returns
MDLERR_ADDRNOTVALID if pRow is invalid
See also
mdlTreeNode_getStatus
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setStatusInCells ( GuiTreeNodeP  pNode,
int  status 
)

Sets the status in each GuiTreeCell within the GuiTreeNode.

The Tree dialog item uses the status field. Valid values are the TREECELLATTR_... definitions found in dlogitem.h.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]statusindicates the new status to be set in each GuiTreeCell of the GuiTreeNode
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pRow is invalid
See also
mdlTreeNode_getStatus mdlTreeNode_setStatus
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_setValue ( GuiTreeNodeP  pNode,
MSValueDescrCR  pValueDescr,
bool  bSetDisplayText 
)

Sets the internal value descriptor of the GuiTreeCell at index 0 within a specified GuiTreeNode.

Parameters
[in]pNodepoints to the GuiTreeNode to process
[in]pValueDescrpoints to the ValueDescr used to set the internal value descriptor
[in]bSetDisplayTexttrue indicates to also set the display text if the format type of the ValueDescr is FMT_STRING.
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pNode or pValueDescr are invalid
See also
mdlTreeNode_getValue
Remarks
Required Library: mdlbltin.lib
StatusInt mdlTreeNode_sort ( GuiTreeNodeP  pParentNode,
bool  ascending,
int  startIndex,
int  numToSort,
int  columnIndex 
)

Sorts the GuiTreeNodes within the first level child list of a parent GuiTreeNode in ascending or descending order based on values in a specified column index.

Parameters
[in]pParentNodepoints to the parent GuiTreeNode to process
[in]ascendingtrue if sorting in ascending order. false if sorting in descending order.
[in]startIndexIndex of the child node to start the sort with. A value of 0 indicates to start at the beginning.
[in]numToSortNumber of child nodes to sort. A value of -1 indicates to sort all nodes to the end from startIndex.
[in]columnIndexIndex of the column to sort on. Note that a secondary column may be defined for a certain column using the mdlTreeColumn_setSortFunction function.
Returns
SUCCESS, or MDLERR_ADDRNOTVALID if pParentNode is invalid MDLERR_BADINDEX if startIndex or columnIndex are invalid
See also
mdlTreeColumn_setSortFunction
Remarks
Required Library: mdlbltin.lib

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