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... | |
| 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. More... | |
| 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. More... | |
| 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. 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... | |
| 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. More... | |
| 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. 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... | |
| 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. More... | |
| 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. 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... | |
| StatusInt mdlTreeCell_getDisplayTextWString | ( | GuiTreeCellCP | pCell, |
| WStringR | wString | ||
| ) |
Returns the display text of the specified GuiTreeCell in a WString.
| [in,out] | wString | the WString object that will receive the display text |
| [in] | pCell | points to the GuiTreeCell to process |
| int mdlTreeNode_addChild | ( | GuiTreeNodeP | pParentNode, |
| GuiTreeNodeP | pChild | ||
| ) |
Adds a specified GuiTreeNode to the end of a parent GuiTreeNode.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| [in] | pChild | points to the node to add as a child to the end of the parent node |
| StatusInt mdlTreeNode_collapse | ( | GuiTreeNodeP | pParentNode, |
| bool | bCollapseDescendents | ||
| ) |
Collapses a parent node and optionally collapses its descendent parent nodes.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| [in] | bCollapseDescendents | Indicates whether to collapse the descendents that are themselves parents |
| 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.
| [in] | pModel | points to the GuiTreeModel. |
| [in] | bAllowsChildren | indicates whether this node can be a parent of other GuiTreeNodes |
| 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.
| [in] | pNode | points to the GuiTreeNode to destroy |
| 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.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| [in] | iNode | index of the child node to destroy |
| int mdlTreeNode_expand | ( | GuiTreeNodeP | pParentNode | ) |
Expands a parent node.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| bool mdlTreeNode_getAllowsChildren | ( | GuiTreeNodeCP | pNode | ) |
Returns whether the GuiTreeNode allows children.
| [in] | pNode | points to the GuiTreeNode to process |
| GuiTreeNodeP mdlTreeNode_getAncestorAtLevel | ( | GuiTreeNodeCP | pNode, |
| int | level | ||
| ) |
Returns the ancestor GuiTreeNode at a certain level up from a specified child GuiTreeNode.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | level | indicates the level of the ancestor to get |
| UserDataP mdlTreeNode_getAppData | ( | GuiTreeNodeCP | pNode | ) |
Returns a pointer to application data associated with the GuiTreeNode.
| [in] | pNode | the GuiTreeNode to process. |
| GuiTreeCellP mdlTreeNode_getCellAtIndex | ( | GuiTreeNodeCP | pNode, |
| int | colIndex | ||
| ) |
Returns a pointer to the GuiTreeCell at the specified column index within the GuiTreeNode.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | colIndex | column index of the cell to get |
| GuiTreeCellP mdlTreeNode_getCellById | ( | GuiTreeNodeCP | pNode, |
| int | cellId | ||
| ) |
Returns a pointer to the GuiTreeCell with the specified Id within the GuiTreeNode.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | cellId | Id of the GuiTreeCell |
| GuiTreeCellP mdlTreeNode_getCellByName | ( | GuiTreeNodeCP | pNode, |
| WCharCP | pwName | ||
| ) |
Returns a pointer to the GuiTreeCell with the specified name contained within the given GuiTreeNode.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | pwName | Name of the GuiTreeCell to get |
| 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.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| [in] | index | Index of the child to get |
| 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.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| [in] | childIndex | Child index of the cell to get |
| [in] | columnIndex | Column index of the cell to get |
| int mdlTreeNode_getChildCount | ( | GuiTreeNodeCP | pParentNode | ) |
Returns the number of children in the one level below a parent GuiTreeNode.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| int mdlTreeNode_getChildIndex | ( | GuiTreeNodeCP | pParentNode, |
| GuiTreeNodeCP | pChild | ||
| ) |
Returns the index of the specified GuiTreeNode within the first level child list of a parent GuiTreeNode.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| [in] | pChild | points to the child node to find |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in,out] | pIconRscId | points to an integer that receives the icon resource Id |
| [in,out] | pIconRscType | points to an integer that receives the icon resource type |
| [in,out] | ppIconOwnerMD | points to a void pointer that is set to the address of the owner of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in,out] | pIconRscId | points to an integer that receives the icon resource Id |
| [in,out] | pIconRscType | points to an integer that receives the icon resource type |
| [in,out] | ppIconOwnerMD | points to a void pointer that is set to the address of the owner of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in,out] | pIconRscId | points to an integer that receives the icon resource Id |
| [in,out] | pIconRscType | points to an integer that receives the icon resource type |
| [in,out] | ppIconOwnerMD | points to a void pointer that is set to the address of the owner of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in,out] | pIconRscId | points to an integer that receives the icon resource Id |
| [in,out] | pIconRscType | points to an integer that receives the icon resource type |
| [in,out] | ppIconOwnerMD | points to a void pointer that is set to the address of the owner of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| int mdlTreeNode_getDescendentCount | ( | GuiTreeNodeCP | pParentNode | ) |
Returns the number of descendents in all levels below a parent GuiTreeNode.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| int mdlTreeNode_getDisplayableDescendentCount | ( | GuiTreeNodeCP | pParentNode | ) |
Returns the number of displayable descendents in all levels below a parent GuiTreeNode.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| StatusInt mdlTreeNode_getDisplayText | ( | GuiTreeNodeCP | pNode, |
| WCharCP * | pwString | ||
| ) |
Returns a Unicode string with the display text of the GuiTreeCell at index 0 within a GuiTreeNode.
| [in] | pNode | points to the GuiTreeNode to process |
| [in,out] | pwString | points to the Unicode pointer that will receive the address of the display text |
| StatusInt mdlTreeNode_getDisplayTextWString | ( | GuiTreeNodeCP | pNode, |
| WStringR | wString | ||
| ) |
Returns the display text of the specified GuiTreeNode in a WString.
| [in,out] | wString | the WString object that will receive the display text |
| [in] | pNode | points to the GuiTreeNode to process |
| 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.
| [in] | pNode | the GuiTreeNode to get the editor information from |
| [in,out] | pEditorType | the type of the editor for the specified tree node |
| [in,out] | pEditorId | the Id of the editor for the tree node |
| [in,out] | pEditorOwnerMD | the editor ownerMD |
| [in,out] | pbEditDisplay | if true, only the display text of the node is editable |
| [in,out] | pbUpdateDisplay | if true, the node display text is updated after editing |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in,out] | pIconRscId | points to an integer that receives the icon resource Id |
| [in,out] | pIconRscType | points to an integer that receives the icon resource type |
| [in,out] | ppIconOwnerMD | points to a void pointer that is set to the address of the owner of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in,out] | pIconRscId | points to an integer that receives the icon resource Id |
| [in,out] | pIconRscType | points to an integer that receives the icon resource type |
| [in,out] | ppIconOwnerMD | points to a void pointer that is set to the address of the owner of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in,out] | pIconRscId | points to an integer that receives the icon resource Id |
| [in,out] | pIconRscType | points to an integer that receives the icon resource type |
| [in,out] | ppIconOwnerMD | points to a void pointer that is set to the address of the owner of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| GuiTreeNodeP mdlTreeNode_getFirstChild | ( | GuiTreeNodeCP | pParentNode | ) |
Returns a pointer to the first GuiTreeNode in the one level below a parent GuiTreeNode.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| GuiTreeNodeP mdlTreeNode_getLastChild | ( | GuiTreeNodeCP | pParentNode | ) |
Returns a pointer to the last GuiTreeNode in the one level below a parent GuiTreeNode.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in,out] | pIconRscId | points to an integer that receives the icon resource Id |
| [in,out] | pIconRscType | points to an integer that receives the icon resource type |
| [in,out] | ppIconOwnerMD | points to a void pointer that is set to the address of the owner of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in,out] | pIconRscId | points to an integer that receives the icon resource Id |
| [in,out] | pIconRscType | points to an integer that receives the icon resource type |
| [in,out] | ppIconOwnerMD | points to a void pointer that is set to the address of the owner of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in,out] | pIconRscId | points to an integer that receives the icon resource Id |
| [in,out] | pIconRscType | points to an integer that receives the icon resource type |
| [in,out] | ppIconOwnerMD | points to a void pointer that is set to the address of the owner of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| GuiTreeModelP mdlTreeNode_getModel | ( | GuiTreeNodeCP | pNode | ) |
Returns a pointer to the owning GuiTreeModel.
| [in] | pNode | points to the GuiTreeNode to process |
| 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.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| [in] | pInChild | points to the child node to get the next node from |
| GuiTreeNodeP mdlTreeNode_getNextDisplayNode | ( | GuiTreeNodeCP | pNode, |
| bool | bCheckChildren | ||
| ) |
Returns the next displayable node in the GuiTreeModel.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | bCheckChildren | whether to check children for the next displayable node |
| GuiTreeNodeP mdlTreeNode_getNextSibling | ( | GuiTreeNodeCP | pNode | ) |
Returns the next sibling node in the parent's child list.
| [in] | pNode | points to the GuiTreeNode to process |
| GuiTreeNodeP mdlTreeNode_getParent | ( | GuiTreeNodeCP | pNode | ) |
Returns a pointer to the tree node that is the parent of the given GuiTreeNode.
| [in] | pNode | points to the GuiTreeNode to process |
| GuiTreeNodePathCP mdlTreeNode_getPathFromAncestor | ( | GuiTreeNodeP | pNode, |
| GuiTreeNodeCP | pAncestor | ||
| ) |
Builds and returns a GuiTreeNodePath from the ancestor node to the specified GuiTreeNode.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | pAncestor | Ancestor to build path from |
| GuiTreeNodePathCP mdlTreeNode_getPathFromRoot | ( | GuiTreeNodeP | pNode | ) |
Builds and returns a GuiTreeNodePath from the root node to the specified GuiTreeNode.
| [in] | pNode | points to the GuiTreeNode to process |
| 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.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| [in] | pInChild | points to the child node to get the previous node from |
| GuiTreeNodeP mdlTreeNode_getPrevDisplayNode | ( | GuiTreeNodeCP | pNode | ) |
Returns the previous displayable node in the GuiTreeModel.
| [in] | pNode | points to the GuiTreeNode to process |
| GuiTreeNodeP mdlTreeNode_getPrevSibling | ( | GuiTreeNodeCP | pNode | ) |
Returns the previous sibling node in the parent's child list.
| [in] | pNode | points to the GuiTreeNode to process |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in,out] | valueDescr | points to the ValueDescr that will receive a copy of the internal value descriptor |
| 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.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| [in] | pChild | points to the node to insert into the parent node |
| [in] | index | Index of the child node to insert before. A value of -1 indicates to append the child node to the end. |
| 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.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| [in] | valueDescr | points to a value to assign to the cell at index 0 |
| [in] | index | Index of the new child node to insert before. A value of -1 indicates to append the child node to the end. |
| 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.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| [in] | pString | points to a character string value to assign to the cell at index 0 |
| [in] | index | Index of the new child node to insert before. A value of -1 indicates to append the child node to the end. |
| bool mdlTreeNode_isDescendent | ( | GuiTreeNodeCP | pParentNode, |
| GuiTreeNodeCP | pNode | ||
| ) |
Determines is a given node is a descendent of a parent node.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| [in] | pNode | points to the possible descendent node |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| bool mdlTreeNode_isExpanded | ( | GuiTreeNodeCP | pNode | ) |
Returns true if this GuiTreeNode is expanded in the Gui Tree item.
| [in] | pNode | points to the GuiTreeNode to process |
| bool mdlTreeNode_isLeaf | ( | GuiTreeNodeCP | pNode | ) |
Returns true if this GuiTreeNode is a leaf node.
A leaf node does not allow children.
| [in] | pNode | points to the GuiTreeNode to process |
| bool mdlTreeNode_isParent | ( | GuiTreeNodeCP | pNode | ) |
Returns true if this GuiTreeNode is a parent node.
A parent node allows children.
| [in] | pNode | points to the GuiTreeNode to process |
| bool mdlTreeNode_isParentPopulated | ( | GuiTreeNodeCP | pNode | ) |
Returns true if this GuiTreeNode is a parent node and if it is populated with any children.
| [in] | pNode | points to the GuiTreeNode to process |
| bool mdlTreeNode_isRoot | ( | GuiTreeNodeCP | pNode | ) |
Returns true if this GuiTreeNode is the root node of the owning GuiTreeModel.
| [in] | pNode | points to the GuiTreeNode to process |
| StatusInt mdlTreeNode_makeDisplayable | ( | GuiTreeNodeP | pNode | ) |
Makes the GuiTreeNode displayable by expanding all of its ancestors.
| [in] | pNode | points to the GuiTreeNode to process |
| StatusInt mdlTreeNode_moveChildToIndex | ( | GuiTreeNodeP | pParentNode, |
| GuiTreeNodeP | pNode, | ||
| int | index | ||
| ) |
Moves a child node to a particular index.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | index | child index to insert before; -1 = append |
| StatusInt mdlTreeNode_moveDown | ( | GuiTreeNodeP | pNode | ) |
Moves the node down within its parent node.
| [in] | pNode | points to the GuiTreeNode to process |
| StatusInt mdlTreeNode_moveUp | ( | GuiTreeNodeP | pNode | ) |
Moves the node up within its parent node.
| [in] | pNode | points to the GuiTreeNode to process |
| 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.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| [in] | pChild | points to the node to remove from the parent node |
| [in] | bDestroy | Indicates whether to destroy the node after removing it. |
| 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.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| [in] | iNode | index of the child node to remove |
| [in] | bDestroyNode | Indicates whether to destroy the node after removing it. |
| 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.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| [in] | iNode | index of the first child node to remove |
| [in] | nNodes | number of nodes to remove. A value of -1 means to remove all nodes to the end from iNode |
| [in] | bDestroy | true if the child nodes should be destroyed after removal |
| 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.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| [in] | pValueDescr | specifies the format type and value to search for. |
| [in] | pInfoFields | specifies any info fields to search for |
| [in] | startIndex | Index of the first level child node to start the search with. A value of 0 indicates to start at the beginning. |
| [in] | numToSearch | Number of first level child nodes to search. A value of -1 indicates to search all child nodes to the end from startIndex. |
| [in] | columnIndex | Index of the column to search in. |
| [in] | bSearchAll | Indicates 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] | ppFoundNode | points to a GuiTreeNode pointer which is set to the found node. |
| 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.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| [in] | pValueDescr | specifies the format type and value to search for. |
| [in] | pInfoFields | specifies any info fields to search for |
| [in] | startIndex | Index of the first level child node to start the search with. A value of 0 indicates to start at the beginning. |
| [in] | numToSearch | Number of first level child nodes to search. A value of -1 indicates to search all child nodes to the end from startIndex. |
| [in] | columnIndex | Index of the column to search in. |
| [in] | bSearchAll | Indicates 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] | pSearchFunc | specifies to search function to use for all columns, including secondary columns. |
| [in] | pSearchOwnerMD | specifies to search function's owner Mdl Descriptor. |
| [out] | ppFoundNode | points to a GuiTreeNode pointer which is set to the found node. |
| StatusInt mdlTreeNode_setAllowsChildren | ( | GuiTreeNodeP | pNode, |
| bool | bAllowsChildren | ||
| ) |
Sets whether the GuiTreeNode allows children.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | bAllowsChildren | indicates whether this node will allow children and can be a parent of other GuiTreeNodes |
| StatusInt mdlTreeNode_setAppData | ( | GuiTreeNodeP | pNode, |
| UserDataP | pAppData | ||
| ) |
Sets the pointer to application data to be associated with the GuiTreeNode.
| [in] | pNode | the GuiTreeNode to process. |
| [in] | pAppData | points to the application data to be associated with the GuiTreeNode. |
| StatusInt mdlTreeNode_setBgColorDescr | ( | GuiTreeNodeP | pNode, |
| BSIColorDescr * | pDescr | ||
| ) |
Sets the background color descriptor to use when drawing cells in the specified node.
| [in] | pNode | points to the GuiTreeNode to process. |
| [in] | pDescr | points to the ColorDescr to use for the background of the cells. |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | iconRscId | the icon resource Id |
| [in] | iconRscType | the icon resource type |
| [in] | iconOwnerMD | a void pointer to the owner of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | pIconName | the name of the icon |
| [in] | pIconSize | the size of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | pIconRsc | the IconRsc of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | iconRscId | the icon resource Id |
| [in] | iconRscType | the icon resource type |
| [in] | iconOwnerMD | a void pointer to the owner of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | pIconName | the name of the icon |
| [in] | pIconSize | the size of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | pIconRsc | the IconRsc of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | iconRscId | the icon resource Id |
| [in] | iconRscType | the icon resource type |
| [in] | iconOwnerMD | a void pointer to the owner of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | pIconName | the name of the icon |
| [in] | pIconSize | the size of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | pIconRsc | the IconRsc of the icon |
| StatusInt mdlTreeNode_setColorDescr | ( | GuiTreeNodeP | pNode, |
| BSIColorDescr * | pDescr | ||
| ) |
Sets the color descriptor to use when drawing cells in the specified node.
| [in] | pNode | points to the GuiTreeNode to process. |
| [in] | pDescr | points to the ColorDescr to use for drawing the cells. |
| StatusInt mdlTreeNode_setDisplayText | ( | GuiTreeNodeP | pNode, |
| WCharCP | pwString | ||
| ) |
Sets the display text of the GuiTreeCell at index 0 within a GuiTreeNode fromthe given Unicode string.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | pwString | points 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 |
| 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.
| [in] | pNode | the GuiTreeNode to set the editor information in |
| [in,out] | editorType | the type of the editor for the specified tree node |
| [in,out] | editorId | the Id of the editor for the tree node |
| [in,out] | editorOwnerMD | the editor ownerMD |
| [in,out] | bEditDisplay | if true, only the display text of the node is editable |
| [in] | bUpdateDisplay | if true, the node display text is updated after editing |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | iconRscId | the icon resource Id |
| [in] | iconRscType | the icon resource type |
| [in] | iconOwnerMD | a void pointer to the owner of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | pIconName | the name of the icon |
| [in] | pIconSize | the size of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | pIconRsc | the IconRsc of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | iconRscId | the icon resource Id |
| [in] | iconRscType | the icon resource type |
| [in] | iconOwnerMD | a void pointer to the owner of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | pIconName | the name of the icon |
| [in] | pIconSize | the size of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | pIconRsc | the IconRsc of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | iconRscId | the icon resource Id |
| [in] | iconRscType | the icon resource type |
| [in] | iconOwnerMD | a void pointer to the owner of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | pIconName | the name of the icon |
| [in] | pIconSize | the size of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | pIconRsc | the IconRsc of the icon |
| StatusInt mdlTreeNode_setFontIndex | ( | GuiTreeNodeP | pNode, |
| int | fontIndex | ||
| ) |
Sets the font to use when drawing cells in the specified node.
| [in] | pNode | points to the GuiTreeNode to process. |
| [in] | fontIndex | the index of the font to use. |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | iconRscId | the icon resource Id |
| [in] | iconRscType | the icon resource type |
| [in] | iconOwnerMD | a void pointer to the owner of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | pIconName | the name of the icon |
| [in] | pIconSize | the size of the icon |
| StatusInt mdlTreeNode_setIconRsc | ( | GuiTreeNodeP | pNode, |
| IconRsc * | pIconRsc | ||
| ) |
Sets the IconRsc for the icon to be displayed in the Gui Tree item for this node.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | pIconRsc | the IconRsc of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | iconRscId | the icon resource Id |
| [in] | iconRscType | the icon resource type |
| [in] | iconOwnerMD | a void pointer to the owner of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | pIconName | the name of the icon |
| [in] | pIconSize | the size of the icon |
| StatusInt mdlTreeNode_setLeafDeselectedIconRsc | ( | GuiTreeNodeP | pNode, |
| IconRsc * | pIconRsc | ||
| ) |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | iconRscId | the icon resource Id |
| [in] | iconRscType | the icon resource type |
| [in] | iconOwnerMD | a void pointer to the owner of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | pIconName | the name of the icon |
| [in] | pIconSize | the size of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | pIconRsc | the IconRsc of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | iconRscId | the icon resource Id |
| [in] | iconRscType | the icon resource type |
| [in] | iconOwnerMD | a void pointer to the owner of the icon |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | pIconName | the name of the icon |
| [in] | pIconSize | the size of the icon |
| StatusInt mdlTreeNode_setLeafSelectedIconRsc | ( | GuiTreeNodeP | pNode, |
| IconRsc * | pIconRsc | ||
| ) |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | bSetInDescendents | indicates whether the level should be set in all of the node's descendents |
| StatusInt mdlTreeNode_setSelectedBgColorDescr | ( | GuiTreeNodeP | pNode, |
| BSIColorDescr * | pDescr | ||
| ) |
Sets the background color descriptor to use when drawing selected cells in the specified node.
| [in] | pNode | points to the GuiTreeNode to process. |
| [in] | pDescr | points to the ColorDescr to use for the background of the cells. |
| StatusInt mdlTreeNode_setSelectedColorDescr | ( | GuiTreeNodeP | pNode, |
| BSIColorDescr * | pDescr | ||
| ) |
Sets the color descriptor to use when drawing selected cells in the specified node.
| [in] | pNode | points to the GuiTreeNode to process. |
| [in] | pDescr | points to the ColorDescr to use for drawing the cells. |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | status | indicates the new status of the GuiTreeNode |
| 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.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | status | indicates the new status to be set in each GuiTreeCell of the GuiTreeNode |
| StatusInt mdlTreeNode_setValue | ( | GuiTreeNodeP | pNode, |
| MSValueDescrCR | pValueDescr, | ||
| bool | bSetDisplayText | ||
| ) |
Sets the internal value descriptor of the GuiTreeCell at index 0 within a specified GuiTreeNode.
| [in] | pNode | points to the GuiTreeNode to process |
| [in] | pValueDescr | points to the ValueDescr used to set the internal value descriptor |
| [in] | bSetDisplayText | true indicates to also set the display text if the format type of the ValueDescr is FMT_STRING. |
| 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.
| [in] | pParentNode | points to the parent GuiTreeNode to process |
| [in] | ascending | true if sorting in ascending order. false if sorting in descending order. |
| [in] | startIndex | Index of the child node to start the sort with. A value of 0 indicates to start at the beginning. |
| [in] | numToSort | Number of child nodes to sort. A value of -1 indicates to sort all nodes to the end from startIndex. |
| [in] | columnIndex | Index of the column to sort on. Note that a secondary column may be defined for a certain column using the mdlTreeColumn_setSortFunction function. |