TreeCells

Functions
int	mdlTreeCell_getStatus (GuiTreeCellCP pCell)
	Returns the status of the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_setStatus (GuiTreeCellP pCell, int status)
	Sets the status in the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_setEnabled (GuiTreeCellP pCell, bool enabled)
	Sets the Enabled status in the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_getDisplayText (GuiTreeCellCP pCell, WCharCP *ppwString)
	Returns the display text of the specified GuiTreeCell in a Unicode string. More...
StatusInt	mdlTreeCell_setDisplayText (GuiTreeCellP pCell, WCharCP pwString)
	Sets the display text of the specified GuiTreeCell from the given Unicode string. More...
GuiTreeNodeP	mdlTreeCell_getNode (GuiTreeCellCP pCell)
	Returns the pointer to the parent GuiTreeNode of the specified GuiTreeCell. More...
GuiTreeColumnP	mdlTreeCell_getColumn (GuiTreeCellCP pCell)
	Returns the pointer to the parent GuiTreeColumn of the specified GuiTreeCell. More...
int	mdlTreeCell_getId (GuiTreeCellCP pCell)
	Returns the Id of the specified GuiTreeCell. More...
BSIColorDescr *	mdlTreeCell_getColorDescr (GuiTreeCellCP pCell)
	Returns the color descriptor to use when drawing the text from the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_setColorDescr (GuiTreeCellP pCell, BSIColorDescr *pDescr)
	Sets the color descriptor to use when drawing the specified GuiTreeCell. More...
BSIColorDescr *	mdlTreeCell_getBgColorDescr (GuiTreeCellCP pCell)
	Retrieves the color descriptor that specifies the background color of the given tree cell. More...
StatusInt	mdlTreeCell_setBgColorDescr (GuiTreeCellP pCell, BSIColorDescr *pDescr)
	Sets the color descriptor that specifies the background color of the given tree cell. More...
int	mdlTreeCell_getFontIndex (GuiTreeCellCP pCell)
	Returns the font index to use when drawing the text from the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_setFontIndex (GuiTreeCellP pCell, int fontIndex)
	Sets the font index to use when drawing the text from the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_getIcon (GuiTreeCellCP pCell, RscId *pIconRscId, RscType *pIconRscType, MdlDesc **ppIconOwnerMD)
	Returns information about the icon to use when drawing the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_setIcon (GuiTreeCellP pCell, RscId iconRscId, RscType iconRscType, MdlDesc *iconOwnerMD)
	Sets information about the icon to use when drawing the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_getIconRsc (GuiTreeCellCP pCell, IconRsc **ppIconRsc)
	Retrieves the IconRsc associated with the icon to use when drawing the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_setIconRsc (GuiTreeCellP pCell, IconRsc *pIconRsc)
	Sets the IconRsc of the icon to use when drawing the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_setIconByName (GuiTreeCellP pCell, WCharCP pIconName, Point2dCP pIconSize)
	Sets the icon to use when drawing the specified GuiTreeCell based on icon name. More...
StatusInt	mdlTreeCell_getIconColorOverrides (GuiTreeCellCP pCell, BSIColorDescr **ppFgColor, BSIColorDescr **ppBgColor)
	Returns the color descriptors to use when drawing the icons from the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_setIconColorOverrides (GuiTreeCellP pCell, BSIColorDescr *pFgColor, BSIColorDescr *pBgColor)
	Sets the color descriptors to use when drawing the icons from the specified GuiTreeCell. More...
int	mdlTreeCell_getPixelIndent (GuiTreeCellCP pCell)
	Returns the number of pixels to indent before drawing the icon or text from the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_setPixelIndent (GuiTreeCellP pCell, int pixelIndent)
	Sets the number of pixels to indent before drawing the icon or text from the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_getValue (GuiTreeCellCP pCell, MSValueDescrR valueDescr)
	Returns a copy of the internal value descriptor of the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_setValue (GuiTreeCellP pCell, MSValueDescrCR valueDescr, bool bSetDisplayText)
	Sets the internal value descriptor of the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_getStringValue (GuiTreeCellCP pCell, WCharCP *ppWString)
	Returns the Unicode string value of the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_getStringValueWString (WStringR wString, GuiTreeCellCP Cell)
	Returns the Unicode string value of the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_setStringValue (GuiTreeCellP pCell, WCharCP pwString, bool bSetDisplayText)
	Sets the internal value descriptor to a Unicode text string in the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_getLongValue (GuiTreeCellCP pCell, long *pValue)
	Returns the long value of the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_setLongValue (GuiTreeCellP pCell, long value)
	Sets the internal value descriptor to a long in the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_getUInt32Value (GuiTreeCellCP pCell, UInt32 *pValue)
	Returns the unsigned long value of the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_setUInt32Value (GuiTreeCellP pCell, UInt32 value)
	Sets the internal value descriptor to an unsigned long in the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_getPointerValue (GuiTreeCellCP pCell, void **ppValue)
	Returns the void pointer value of the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_setPointerValue (GuiTreeCellP pCell, void *value)
	Sets the internal value descriptor to a void pointer in the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_getDoubleValue (GuiTreeCellCP pCell, double *pValue)
	Returns the double value of the specified GuiTreeCell. More...
StatusInt	mdlTreeCell_setDoubleValue (GuiTreeCellP pCell, double value)
	Sets the internal value descriptor to a double in the specified GuiTreeCell. More...
int	mdlTreeCell_getInfoFieldCount (GuiTreeCellCP pCell)
	Returns the number of info fields in a GuiTreeCell. More...
InfoField	mdlTreeCell_getInfoFieldInt64 (GuiTreeCellCP pCell, int index, StatusInt *pStatus)
	Returns the info field at a specified index in a GuiTreeCell as a 64-bit integer value. More...
Int32	mdlTreeCell_getInfoFieldInt32 (GuiTreeCellCP pCell, int index, StatusInt *pStatus)
	Returns the info field at a specified index in a GuiTreeCell as a 32-bit integer value. More...
void *	mdlTreeCell_getInfoFieldPointer (GuiTreeCellCP pCell, int index, StatusInt *pStatus)
	Returns the info field at a specified index in a GuiTreeCell as a pointer value. More...
StatusInt	mdlTreeCell_setInfoFieldInt64 (GuiTreeCellP pCell, int index, InfoField value)
	Sets the information field at a specified index in a GuiTreeCell as a 64-bit integer value. More...
StatusInt	mdlTreeCell_setInfoFieldInt32 (GuiTreeCellP pCell, int index, Int32 value)
	Sets the information field at a specified index in a GuiTreeCell as a 32-bit integer value. More...
StatusInt	mdlTreeCell_setInfoFieldPointer (GuiTreeCellP pCell, int index, void *value)
	Sets the information field at a specified index in a GuiTreeCell as a pointer value. More...
StatusInt	mdlTreeCell_getEditor (GuiTreeCellCP pCell, long *pEditorType, long *pEditorId, MdlDesc **pEditorOwnerMD, bool *pbEditDisplay, bool *pbUpdateDisplay)
	Gets information about the editor for the specified tree cell. More...
StatusInt	mdlTreeCell_setEditor (GuiTreeCellP pCell, long editorType, long editorId, MdlDesc *editorOwnerMD, bool bEditDisplay, bool bUpdateDisplay)
	Sets information about the editor for the specified tree cell. More...
StatusInt	mdlTreeCell_setDisplayTextFromEditor (GuiTreeCellP pCell, RawItemHdr *parentRiP)
	Sets the display text for the cell based on the current value of the cell editor. More...
StatusInt	mdlTreeCell_setIconFromEditor (GuiTreeCellP pCell, RawItemHdr *parentRiP)
	Sets the icon for the cell based on the current value of the cell editor. More...
StatusInt	mdlTreeCell_getBalloonText (WStringR wString, GuiTreeCellP pCell)
	Returns the balloon text set in GuiTreeCell as a WString. More...
StatusInt	mdlTreeCell_setBalloonText (GuiTreeCellP pCell, WCharCP pwText)
	Sets the balloon text in the specified GuiTreeCell. More...

Detailed Description

Function Documentation

StatusInt mdlTreeCell_getBalloonText	(	WStringR	wString,
		GuiTreeCellP	pCell
	)

Returns the balloon text set in GuiTreeCell as a WString.

Parameters

[in,out]	wString	reference to the WString that will receive the balloon text
[in]	pCell	points to the GuiTreeCell to process

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_setBalloonText

Remarks

Required Library: mdlbltin.lib

BSIColorDescr* mdlTreeCell_getBgColorDescr

(

GuiTreeCellCP

pCell

)

Retrieves the color descriptor that specifies the background color of the given tree cell.

Parameters

[in]

pCell

points to the tree cell for which the background color descriptor is returned.

Returns

A Color Descriptor pointer specifying the background color

Remarks

Required Library: mdlbltin.lib

See also

mdlTreeCell_setBgColorDescr

BSIColorDescr* mdlTreeCell_getColorDescr

(

GuiTreeCellCP

pCell

)

Returns the color descriptor to use when drawing the text from the specified GuiTreeCell.

Parameters

[in]

pCell

points to the GuiTreeCell to process

Returns

A pointer to the BSIColorDescr to use when drawing the text, or ERROR if pCell is invalid.

See also

mdlTreeCell_setColorDescr

Remarks

Required Library: mdlbltin.lib

GuiTreeColumnP mdlTreeCell_getColumn

(

GuiTreeCellCP

pCell

)

Returns the pointer to the parent GuiTreeColumn of the specified GuiTreeCell.

Parameters

[in]

pCell

points to the GuiTreeCell to process.

Returns

The pointer to the parent GuiTreeColumn.

See also

mdlTreeNode_create

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_getDisplayText	(	GuiTreeCellCP	pCell,
		WCharCP *	ppwString
	)

Returns the display text of the specified GuiTreeCell in a Unicode string.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in,out]	ppwString	points to the Unicode pointer that will receive the address of the display text

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_setDisplayText

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_getDoubleValue	(	GuiTreeCellCP	pCell,
		double *	pValue
	)

Returns the double value of the specified GuiTreeCell.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in,out]	pValue	points to the double that will receive the value

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_setDoubleValue

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_getEditor	(	GuiTreeCellCP	pCell,
		long *	pEditorType,
		long *	pEditorId,
		MdlDesc **	pEditorOwnerMD,
		bool *	pbEditDisplay,
		bool *	pbUpdateDisplay
	)

Gets information about the editor for the specified tree cell.

Parameters

[in]	pCell	the GuiTreeCell to get the editor information from
[in,out]	pEditorType	the type of the editor for the specified tree cell
[in,out]	pEditorId	the Id of the editor for the tree cell
[in,out]	pEditorOwnerMD	the editor ownerMD
[in,out]	pbEditDisplay	if true, only the display text of the cell is editable
[in]	pbUpdateDisplay	if true, the cell display text is updated after editing

Returns

SUCCESS if pCell points to a valid tree cell

Remarks

Required Library: mdlbltin.lib

See also

mdlTreeCell_setEditor

int mdlTreeCell_getFontIndex

(

GuiTreeCellCP

pCell

)

Returns the font index to use when drawing the text from the specified GuiTreeCell.

Parameters

[in]

pCell

points to the GuiTreeCell to process.

Returns

The font index to use when drawing the text, or ERROR if pCell is invalid. Possible font index values are the FONT_INDEX_... values in msdefs.h.

See also

mdlTreeCell_setFontIndex

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_getIcon	(	GuiTreeCellCP	pCell,
		RscId *	pIconRscId,
		RscType *	pIconRscType,
		MdlDesc **	ppIconOwnerMD
	)

Returns information about the icon to use when drawing the specified GuiTreeCell.

Parameters

[in]	pCell	points to the GuiTreeCell 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

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_setIcon

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_getIconColorOverrides	(	GuiTreeCellCP	pCell,
		BSIColorDescr **	ppFgColor,
		BSIColorDescr **	ppBgColor
	)

Returns the color descriptors to use when drawing the icons from the specified GuiTreeCell.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in,out]	ppFgColor	points to the BSIColorDescr pointer that will receive the address of the internal color descriptor to use as the foreground color when drawing a MonoColor icon and the secondary foreground color when drawing a Fixed Color icon.
[in,out]	ppBgColor	points to the BSIColorDescr pointer that will receive the address of the internal color descriptor to use as the background color when drawing a MonoColor icon and the secondary background color when drawing a Fixed Color icon.

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_setIconColorOverrides

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_getIconRsc	(	GuiTreeCellCP	pCell,
		IconRsc **	ppIconRsc
	)

Retrieves the IconRsc associated with the icon to use when drawing the specified GuiTreeCell.

The IconRsc is only retrieved if the icon has been set using mdlTreeCell_setIconRsc or mdlTreeCell_setIconByName.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in,out]	ppIconRsc	points to a void pointer that is set to the address of the icon resource data.

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_setIconByName

Remarks

Required Library: mdlbltin.lib

int mdlTreeCell_getId

(

GuiTreeCellCP

pCell

)

Returns the Id of the specified GuiTreeCell.

The Id of a Cell is the Id of the parent Column.

Parameters

[in]

pCell

points to the GuiTreeCell to process.

Returns

The Id of the GuiTreeCell, or ERROR if pCell is invalid.

See also

mdlTreeColumn_setId

Remarks

Required Library: mdlbltin.lib

int mdlTreeCell_getInfoFieldCount

(

GuiTreeCellCP

pCell

)

Returns the number of info fields in a GuiTreeCell.

Parameters

[in]

pCell

points to the GuiTreeCell to process.

Returns

The number of info fields in a GuiTreeCell, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_getInfoField mdlTreeColumn_setInfoFieldCount

Remarks

Required Library: mdlbltin.lib

Int32 mdlTreeCell_getInfoFieldInt32	(	GuiTreeCellCP	pCell,
		int	index,
		StatusInt *	pStatus
	)

Returns the info field at a specified index in a GuiTreeCell as a 32-bit integer value.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	index	index of the info field to retrieve
[in,out]	pStatus	status of the function call. SUCCESS, MDLERR_ADDRNOTVALID if pCell is invalid, or MDLERR_BADINDEX if index is invalid.

Remarks

The InfoField type is 64 bits wide. To get an info field as a long type, use mdlTreeCell_getInfoFieldInt32. To get an info field as a pointer type, use mdlTreeCell_getInfoFieldPointer.

Returns

The info field value as a 32-bit integer

See also

mdlTreeCell_setInfoFieldInt32 mdlTreeCell_getInfoFieldInt64 mdlTreeCell_getInfoFieldPointer

Remarks

Required Library: mdlbltin.lib

InfoField mdlTreeCell_getInfoFieldInt64	(	GuiTreeCellCP	pCell,
		int	index,
		StatusInt *	pStatus
	)

Returns the info field at a specified index in a GuiTreeCell as a 64-bit integer value.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	index	index of the info field to retrieve
[in,out]	pStatus	status of the function call. SUCCESS, MDLERR_ADDRNOTVALID if pCell is invalid, or MDLERR_BADINDEX if index is invalid.

Remarks

The InfoField type is 64 bits wide. To get an info field as a long type, use mdlTreeCell_getInfoFieldInt32. To get an info field as a pointer type, use mdlTreeCell_getInfoFieldPointer.

Returns

The info field value as a 64-bit integer

See also

mdlTreeCell_setInfoFieldInt64 mdlTreeCell_getInfoFieldInt32 mdlTreeCell_getInfoFieldPointer

Remarks

Required Library: mdlbltin.lib

void* mdlTreeCell_getInfoFieldPointer	(	GuiTreeCellCP	pCell,
		int	index,
		StatusInt *	pStatus
	)

Returns the info field at a specified index in a GuiTreeCell as a pointer value.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	index	index of the info field to retrieve
[in,out]	pStatus	status of the function call. SUCCESS, MDLERR_ADDRNOTVALID if pCell is invalid, or MDLERR_BADINDEX if index is invalid.

Remarks

The InfoField type is 64 bits wide. To get an info field as a long type, use mdlTreeCell_getInfoFieldInt32. To get an info field as a pointer type, use mdlTreeCell_getInfoFieldPointer.

Returns

The info field value as a pointer value

See also

mdlTreeCell_setInfoFieldPointer mdlTreeCell_getInfoFieldInt32 mdlTreeCell_getInfoFieldInt64

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_getLongValue	(	GuiTreeCellCP	pCell,
		long *	pValue
	)

Returns the long value of the specified GuiTreeCell.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	pValue	points to the long that will receive the value

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_setLongValue

Remarks

Required Library: mdlbltin.lib

GuiTreeNodeP mdlTreeCell_getNode

(

GuiTreeCellCP

pCell

)

Returns the pointer to the parent GuiTreeNode of the specified GuiTreeCell.

Parameters

[in]

pCell

points to the GuiTreeCell to process.

Returns

The pointer to the parent GuiTreeNode.

See also

mdlTreeNode_create

Remarks

Required Library: mdlbltin.lib

int mdlTreeCell_getPixelIndent

(

GuiTreeCellCP

pCell

)

Returns the number of pixels to indent before drawing the icon or text from the specified GuiTreeCell.

Parameters

[in]

pCell

points to the GuiTreeCell to process

Returns

The number of pixels to indent before drawing the icon or text, or ERROR if pCell is invalid.

See also

mdlTreeCell_setPixelIndent

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_getPointerValue	(	GuiTreeCellCP	pCell,
		void **	ppValue
	)

Returns the void pointer value of the specified GuiTreeCell.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	ppValue	points to the void* that will receive the value

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

Remarks

Required Library: mdlbltin.lib

int mdlTreeCell_getStatus

(

GuiTreeCellCP

pCell

)

Returns the status of the specified GuiTreeCell.

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

Parameters

[in]

pCell

points to the GuiTreeCell to process

Returns

The status of the GuiTreeCell, or ERROR if pCell is invalid

See also

mdlTreeCell_setStatus

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_getStringValue	(	GuiTreeCellCP	pCell,
		WCharCP *	ppWString
	)

Returns the Unicode string value of the specified GuiTreeCell.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in,out]	ppWString	points to the Unicode pointer that will receive the address of the string value

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_setStringValueA mdlTreeCell_setStringValue

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_getStringValueWString	(	WStringR	wString,
		GuiTreeCellCP	Cell
	)

Returns the Unicode string value of the specified GuiTreeCell.

Parameters

[in,out]	wString	the reference of a WString that will receive the string value
[in]	Cell	points to the GuiTreeCell to process

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_setStringValueA mdlTreeCell_setStringValue

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_getUInt32Value	(	GuiTreeCellCP	pCell,
		UInt32 *	pValue
	)

Returns the unsigned long value of the specified GuiTreeCell.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	pValue	points to the unsigned long that will receive the value

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_setLongValue

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_getValue	(	GuiTreeCellCP	pCell,
		MSValueDescrR	valueDescr
	)

Returns a copy of the internal value descriptor of the specified GuiTreeCell.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in,out]	valueDescr	points to the ValueDescr that will receive a copy of the internal value descriptor

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell or pValueDescr are invalid

See also

mdlTreeCell_setValue

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setBalloonText	(	GuiTreeCellP	pCell,
		WCharCP	pwText
	)

Sets the balloon text in the specified GuiTreeCell.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	pwText	points to the balloon text string

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_getBalloonText

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setBgColorDescr	(	GuiTreeCellP	pCell,
		BSIColorDescr *	pDescr
	)

Sets the color descriptor that specifies the background color of the given tree cell.

Parameters

[in]	pCell	points to the tree cell for which the background color descriptor is set.
[in]	pDescr	points to the color descriptor to use for the background

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

Remarks

Required Library: mdlbltin.lib

See also

mdlTreeCell_getBgColorDescr

StatusInt mdlTreeCell_setColorDescr	(	GuiTreeCellP	pCell,
		BSIColorDescr *	pDescr
	)

Sets the color descriptor to use when drawing the specified GuiTreeCell.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	pDescr	points to the BSIColorDescr to use. The BSIColorDescr pointer is copied into the GuiTreeCell; therefore, the application must maintain this pointer and associated BSIColorDescr.

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_getColorDescr

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setDisplayText	(	GuiTreeCellP	pCell,
		WCharCP	pwString
	)

Sets the display text of the specified GuiTreeCell from the given Unicode string.

Parameters

[in]	pCell	points to the GuiTreeCell 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

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_getDisplayText

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setDisplayTextFromEditor	(	GuiTreeCellP	pCell,
		RawItemHdr *	parentRiP
	)

Sets the display text for the cell based on the current value of the cell editor.

The editor type should be a ComboBox, OptionButton or Text.

Parameters

[in]	pCell	the GuiTreeCell to process
[in]	parentRiP	the RawItemHdr pointer of the dialog item, such as a Tree, to use the GuiTreeModel

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_setEditor

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setDoubleValue	(	GuiTreeCellP	pCell,
		double	value
	)

Sets the internal value descriptor to a double in the specified GuiTreeCell.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	value	a double to set as the new internal value

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_getDoubleValue

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setEditor	(	GuiTreeCellP	pCell,
		long	editorType,
		long	editorId,
		MdlDesc *	editorOwnerMD,
		bool	bEditDisplay,
		bool	bUpdateDisplay
	)

Sets information about the editor for the specified tree cell.

Parameters

[in]	pCell	the GuiTreeCell to set the editor information in
[in]	editorType	the type of the editor for the specified tree cell. Supported types are: RTYPE_ComboBox RTYPE_OptionButton RTYPE_Text RTYPE_ToggleButton RTYPE_Container - may contain any type of dialog item
[in]	editorId	the Id of the editor for the tree cell
[in]	editorOwnerMD	the editor ownerMD
[in]	bEditDisplay	if true, only the display text of the cell is editable
[in]	bUpdateDisplay	if true, the cell display text is updated after editing

Returns

SUCCESS if pCell points to a valid tree cell

Remarks

When using a Container as the editorType, the popped container should be closed using the code below. The DITEM_MESSAGE processed will depend on the type of item. Possible messages are DITEM_MESSAGE_STATECHANGED and DITEM_MESSAGE_BUTTON with dimP->u.button.buttonTrans == BUTTONTRANS_UP.

mdlDialog_lastActionTypeSet (dimP->db, ACTIONBUTTON_OK);
mdlWindow_hide ((MSWindow *)dimP->db, false, true);
mdlDialog_closeCommandQueue (dimP->db);

Required Library: mdlbltin.lib

See also

mdlTreeCell_getEditor

StatusInt mdlTreeCell_setEnabled	(	GuiTreeCellP	pCell,
		bool	enabled
	)

Sets the Enabled status in the specified GuiTreeCell.

The Tree dialog item uses the TREECELLATTR_DISABLED status field, which is found in dlogitem.h.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	enabled	indicates the new Enabled status of the GuiTreeCell

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_getStatus

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setFontIndex	(	GuiTreeCellP	pCell,
		int	fontIndex
	)

Sets the font index to use when drawing the text from the specified GuiTreeCell.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	fontIndex	the font index to use when drawing the text. Possible values are the FONT_INDEX_... values in msdefs.h.

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_getFontIndex

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setIcon	(	GuiTreeCellP	pCell,
		RscId	iconRscId,
		RscType	iconRscType,
		MdlDesc *	iconOwnerMD
	)

Sets information about the icon to use when drawing the specified GuiTreeCell.

Parameters

[in]	pCell	points to the GuiTreeCell 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

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_getIcon

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setIconByName	(	GuiTreeCellP	pCell,
		WCharCP	pIconName,
		Point2dCP	pIconSize
	)

Sets the icon to use when drawing the specified GuiTreeCell based on icon name.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	pIconName	the name of the icon
[in]	pIconSize	the size of the icon

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_getIconRsc

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setIconColorOverrides	(	GuiTreeCellP	pCell,
		BSIColorDescr *	pFgColor,
		BSIColorDescr *	pBgColor
	)

Sets the color descriptors to use when drawing the icons from the specified GuiTreeCell.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	pFgColor	points to the BSIColorDescr to use as the foreground color when drawing a MonoColor icon. When drawing a Fixed Color icon, this color is used to draw the secondary foreground color.
[in]	pBgColor	points to the BSIColorDescr to use as the background color when drawing a MonoColor icon. When drawing a Fixed Color icon, this color is used to draw the secondary background color.

Remarks

The BSIColorDescr pointers are copied into the GuiTreeCell; therefore, the application must maintain these pointers and associated BSIColorDescrs.

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_getIconColorOverrides

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setIconFromEditor	(	GuiTreeCellP	pCell,
		RawItemHdr *	parentRiP
	)

Sets the icon for the cell based on the current value of the cell editor.

The editor type should be a ToggleButton.

Parameters

[in]	pCell	the GuiTreeCell to process
[in]	parentRiP	the RawItemHdr pointer of the dialog item, such as a Tree, to use the GuiTreeModel

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_setEditor

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setIconRsc	(	GuiTreeCellP	pCell,
		IconRsc *	pIconRsc
	)

Sets the IconRsc of the icon to use when drawing the specified GuiTreeCell.

The resource data pointed to must be maintained by the application. When the icon is no longer needed, mdlResource_free should be called.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	pIconRsc	points to the IconRsc to use when drawing the specified GuiTreeCell

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_getIconRsc

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setInfoFieldInt32	(	GuiTreeCellP	pCell,
		int	index,
		Int32	value
	)

Sets the information field at a specified index in a GuiTreeCell as a 32-bit integer value.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	index	index of the information field to set
[in]	value	new value of the information field

Remarks

The InfoField type is 64 bits wide. To set an info field as a 64-bit value, use mdlTreeCell_setInfoFieldInt64. To get an info field as a pointer type, use mdlTreeCell_setInfoFieldPointer.

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_getInfoFieldInt32 mdlTreeCell_setInfoFieldInt64 mdlTreeCell_setInfoFieldPointer

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setInfoFieldInt64	(	GuiTreeCellP	pCell,
		int	index,
		InfoField	value
	)

Sets the information field at a specified index in a GuiTreeCell as a 64-bit integer value.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	index	index of the information field to set
[in]	value	new value of the information field

Remarks

The InfoField type is 64 bits wide. To set an info field as a long type, use mdlTreeCell_setInfoFieldInt32. To get an info field as a pointer type, use mdlTreeCell_setInfoFieldPointer.

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_getInfoFieldInt64 mdlTreeCell_setInfoFieldInt32 mdlTreeCell_setInfoFieldPointer

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setInfoFieldPointer	(	GuiTreeCellP	pCell,
		int	index,
		void *	value
	)

Sets the information field at a specified index in a GuiTreeCell as a pointer value.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	index	index of the information field to set
[in]	value	new value of the information field

Remarks

The InfoField type is 64 bits wide. To set an info field as a 64-bit integer, use mdlTreeCell_setInfoFieldInt64. To get an info field as a 32-bit integer, use mdlTreeCell_setInfoFieldInt32.

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_getInfoFieldPointer mdlTreeCell_setInfoFieldInt32 mdlTreeCell_setInfoFieldInt64

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setLongValue	(	GuiTreeCellP	pCell,
		long	value
	)

Sets the internal value descriptor to a long in the specified GuiTreeCell.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	value	a long to set as the new internal value.

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_getLongValue

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setPixelIndent	(	GuiTreeCellP	pCell,
		int	pixelIndent
	)

Sets the number of pixels to indent before drawing the icon or text from the specified GuiTreeCell.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	pixelIndent	the number of pixels to indent before drawing the icon or text

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_getPixelIndent

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setPointerValue	(	GuiTreeCellP	pCell,
		void *	value
	)

Sets the internal value descriptor to a void pointer in the specified GuiTreeCell.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	value	a void* to set as the new internal value.

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setStatus	(	GuiTreeCellP	pCell,
		int	status
	)

Sets the status in the specified GuiTreeCell.

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

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	status	indicates the new status of the GuiTreeCell

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_getStatus

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setStringValue	(	GuiTreeCellP	pCell,
		WCharCP	pwString,
		bool	bSetDisplayText
	)

Sets the internal value descriptor to a Unicode text string in the specified GuiTreeCell.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	pwString	points to the text string to set as the new internal value. The text itself is copied to an internal location in the GuiTreeCell; therefore, the GuiTreeCell maintains its own text field.
[in]	bSetDisplayText	true indicates to also set the display text to the input text string.

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_getStringValue mdlTreeCell_setStringValueA

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setUInt32Value	(	GuiTreeCellP	pCell,
		UInt32	value
	)

Sets the internal value descriptor to an unsigned long in the specified GuiTreeCell.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	value	an unsigned long to set as the new internal value.

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also

mdlTreeCell_getLongValue

Remarks

Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setValue	(	GuiTreeCellP	pCell,
		MSValueDescrCR	valueDescr,
		bool	bSetDisplayText
	)

Sets the internal value descriptor of the specified GuiTreeCell.

Parameters

[in]	pCell	points to the GuiTreeCell to process
[in]	valueDescr	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.

Returns

SUCCESS, or MDLERR_ADDRNOTVALID if pCell or pValueDescr are invalid

See also

mdlTreeCell_getValue

Remarks

Required Library: mdlbltin.lib