Functions
int	mdlListCell_getStatus (ListCellCP pCell)
	Returns the status of the specified ListCell. More...

StatusInt	mdlListCell_setStatus (ListCellP pCell, int status)
	Sets the status in the specified ListCell. More...

StatusInt	mdlListCell_getDisplayText (ListCellCP pCell, WCharCP *ppwString)
	Returns the display text of the specified ListCell in a WChar string. More...

StatusInt	mdlListCell_setDisplayText (ListCellP pCell, WCharCP pwString)
	Sets the display text of the specified ListCell from the given WChar. More...

StatusInt	mdlListCell_getDisplayTextWString (ListCellCP pCell, WStringR wString)
	Returns the display text of the specified ListCell in a WString. More...

ListRowP	mdlListCell_getRow (ListCellCP pCell)
	Returns the pointer to the parent ListRow for the specified ListCell. More...

ListColumnP	mdlListCell_getColumn (ListCellCP pCell)
	Returns the pointer to the parent ListColumn for the specified ListCell. More...

int	mdlListCell_getId (ListCellCP pCell)
	Returns the Id of the specified ListCell. More...

WCharCP	mdlListCell_getName (ListCellCP pCell)
	Gets the name of the specified ListCell. More...

BSIColorDescr *	mdlListCell_getColorDescr (ListCellCP pCell)
	Returns the color descriptor to use when drawing the text from the specified ListCell. More...

StatusInt	mdlListCell_setColorDescr (ListCellP pCell, BSIColorDescr *pDescr)
	Sets the color descriptor to use when drawing the specified ListCell. More...

BSIColorDescr *	mdlListCell_getBgColorDescr (ListCellCP pCell)
	Gets a pointer to the background color descriptor that is set for the specified ListCell. More...

StatusInt	mdlListCell_setBgColorDescr (ListCellP pCell, BSIColorDescr *pDescr)
	Sets the background color descriptor for the specified ListCell. More...

BSIColorDescr *	mdlListCell_getSelectedColorDescr (ListCellCP pCell)
	Returns the color descriptor to use when drawing the text from the specified ListCell when selected. More...

StatusInt	mdlListCell_setSelectedColorDescr (ListCellP pCell, BSIColorDescr *pDescr)
	Sets the color descriptor to use when drawing the specified ListCell when selected. More...

BSIColorDescr *	mdlListCell_getSelectedBgColorDescr (ListCellCP pCell)
	Gets a pointer to the background color descriptor that is set for the specified ListCell when selected. More...

StatusInt	mdlListCell_setSelectedBgColorDescr (ListCellP pCell, BSIColorDescr *pDescr)
	Sets the background color descriptor for the specified ListCell when selected. More...

int	mdlListCell_getFontIndex (ListCellCP pCell)
	Returns the font index to use when drawing the text from the specified ListCell. More...

StatusInt	mdlListCell_setFontIndex (ListCellP pCell, int fontIndex)
	Sets the font index to use when drawing the text from the specified ListCell. More...

StatusInt	mdlListCell_getIcon (ListCellCP pCell, RscId pIconRscId, RscType pIconRscType, MdlDescP *ppIconOwnerMD)
	Returns information about the icon to use when drawing the specified ListCell. More...

StatusInt	mdlListCell_setIcon (ListCellP pCell, RscId iconRscId, RscType iconRscType, MdlDescP iconOwnerMD)
	Sets information about the icon to use when drawing the specified ListCell. More...

StatusInt	mdlListCell_getIconRsc (ListCellCP pCell, IconRsc **ppIconRsc)
	Returns a pointer to the icon resource data to use when drawing the specified ListCell. More...

StatusInt	mdlListCell_setIconRsc (ListCellP pCell, IconRsc *pIconRsc)
	Sets the icon resource data to use when drawing the specified ListCell. More...

StatusInt	mdlListCell_setCompositeIconRsc (ListCellP pCell, IconRsc *pIconRsc, RscId iconRscId, RscType iconRscType, MdlDescP iconOwnerMD)
	Sets a composite icon resource data to use when drawing the specified ListCell. More...

StatusInt	mdlListCell_setIconByName (ListCellP pCell, WCharCP pIconName, Point2dCP pIconSize)
	Sets the name of the icon to use when drawing the specified ListCell. More...

StatusInt	mdlListCell_getIconColorOverrides (ListCellCP pCell, BSIColorDescr ppFgColor, BSIColorDescr ppBgColor)
	Returns the color descriptors to use when drawing the icons from the specified ListCell. More...

StatusInt	mdlListCell_setIconColorOverrides (ListCellP pCell, BSIColorDescr pFgColor, BSIColorDescr pBgColor)
	Sets the color descriptors to use when drawing the icons from the specified ListCell. More...

int	mdlListCell_getPixelIndent (ListCellCP pCell)
	Returns the number of pixels to indent before drawing the icon or text from the specified ListCell. More...

StatusInt	mdlListCell_setPixelIndent (ListCellP pCell, int pixelIndent)
	Sets the number of pixels to indent before drawing the icon or text from the specified ListCell. More...

StatusInt	mdlListCell_getValue (ListCellCP pCell, MSValueDescrR valueDescr)
	Returns a copy of the internal value descriptor of the specified ListCell. More...

StatusInt	mdlListCell_setValue (ListCellP pCell, MSValueDescrCR valueDescr, bool bSetDisplayText)
	Sets the internal value descriptor of the specified ListCell. More...

StatusInt	mdlListCell_getStringValue (ListCellCP pCell, WCharCP *ppwString)
	Returns the string value of the specified ListCell to the specified WChar. More...

StatusInt	mdlListCell_getStringValueWString (WStringR wString, ListCellCP pCell)
	Returns the string value of the specified ListCell to a WString. More...

StatusInt	mdlListCell_setStringValue (ListCellP pCell, WCharCP pwString, bool bSetDisplayText)
	Sets the internal value descriptor to the given WChar string in the specified ListCell. More...

StatusInt	mdlListCell_getLongValue (ListCellCP pCell, long *pValue)
	Returns the long value of the specified ListCell. More...

StatusInt	mdlListCell_setLongValue (ListCellP pCell, long value)
	Sets the internal value descriptor to a long in the specified ListCell. More...

StatusInt	mdlListCell_getUInt32Value (ListCellCP pCell, UInt32 *pValue)
	Returns the unsigned unsigned Int32 value of the specified ListCell. More...

StatusInt	mdlListCell_setUInt32Value (ListCellP pCell, UInt32 value)
	Sets the internal value descriptor to a unsigned Int32 in the specified ListCell. More...

StatusInt	mdlListCell_getPointerValue (ListCellCP pCell, UserDataP *ppValue)
	Returns the void pointer value of the specified ListCell. More...

StatusInt	mdlListCell_setPointerValue (ListCellP pCell, UserDataP value)
	Sets the internal value descriptor to a void pointer in the specified ListCell. More...

StatusInt	mdlListCell_getDoubleValue (ListCellCP pCell, double *pValue)
	Returns the double value of the specified ListCell. More...

StatusInt	mdlListCell_setDoubleValue (ListCellP pCell, double value)
	Sets the internal value descriptor to a double in the specified ListCell. More...

StatusInt	mdlListCell_getUInt64Value (ListCellCP pCell, UInt64 *pValue)
	Returns the UInt64 value of the specified ListCell. More...

StatusInt	mdlListCell_setUInt64Value (ListCellP pCell, UInt64 value)
	Sets the internal value descriptor to a UInt64 in the specified ListCell. More...

int	mdlListCell_getInfoFieldCount (ListCellCP pCell)
	Returns the number of info fields in a ListCell. More...

InfoField	mdlListCell_getInfoFieldInt64 (ListCellCP pCell, int index, StatusInt *pStatus)
	Returns the info field at a specified index in a ListCell as a 64-bit integer value. More...

Int32	mdlListCell_getInfoFieldInt32 (ListCellCP pCell, int index, StatusInt *pStatus)
	Returns the info field at a specified index in a ListCell as a 32-bit integer value. More...

void *	mdlListCell_getInfoFieldPointer (ListCellCP pCell, int index, StatusInt *pStatus)
	Returns the info field at a specified index in a ListCell as a pointer value. More...

StatusInt	mdlListCell_setInfoFieldInt64 (ListCellP pCell, int index, InfoField value)
	Sets the information field at a specified index in a ListCell as a 64-bit integer. More...

StatusInt	mdlListCell_setInfoFieldInt32 (ListCellP pCell, int index, Int32 value)
	Sets the information field at a specified index in a ListCell as a 32-bit integer. More...

StatusInt	mdlListCell_setInfoFieldPointer (ListCellP pCell, int index, void const *value)
	Sets the information field at a specified index in a ListCell as a pointer value. More...

StatusInt	mdlListCell_getEditor (ListCellCP pCell, long pEditorType, long pEditorId, MdlDescP pEditorOwnerMD, bool pbEditDisplay, bool *pbUpdateDisplay)
	Gets information about the editor of the cell. More...

StatusInt	mdlListCell_setEditor (ListCellP pCell, long editorType, long editorId, MdlDescP editorOwnerMD, bool bEditDisplay, bool bUpdateDisplay)
	Sets information about the editor of the cell. More...

StatusInt	mdlListCell_setDisplayTextFromEditor (ListCell pCell, RawItemHdr parentRiP)
	Sets the display text for the cell based on the current value of the cell editor. More...

StatusInt	mdlListCell_setIconFromEditor (ListCell pCell, RawItemHdr parentRiP)
	Sets the icon for the cell based on the current value of the cell editor. More...

StatusInt	mdlListCell_getBalloonText (WStringR wString, ListCellCP pCell)
	Returns the balloon text set in ListCell as a WString. More...

StatusInt	mdlListCell_setBalloonText (ListCellP pCell, WCharCP pwText)
	Sets the balloon text in the specified ListCell. More...

WCharCP	mdlTreeCell_getName (GuiTreeCellCP pCell)
	Gets the name of the specified GuiTreeCell. More...

BSIColorDescr *	mdlTreeCell_getSelectedColorDescr (GuiTreeCellCP pCell)
	Returns the color descriptor to use when drawing the text from the specified GuiTreeCell when selected. More...

StatusInt	mdlTreeCell_setSelectedColorDescr (GuiTreeCellP pCell, BSIColorDescr *pDescr)
	Sets the color descriptor to use when drawing the specified GuiTreeCell when selected. More...

BSIColorDescr *	mdlTreeCell_getSelectedBgColorDescr (GuiTreeCellCP pCell)
	Gets a pointer to the background color descriptor that is set for the specified GuiTreeCell when selected. More...

StatusInt	mdlTreeCell_setSelectedBgColorDescr (GuiTreeCellP pCell, BSIColorDescr *pDescr)
	Sets the background color descriptor for the specified GuiTreeCell when selected. More...

Detailed Description

Function Documentation

StatusInt mdlListCell_getBalloonText	(	WStringR	wString,
		ListCellCP	pCell
	)

Returns the balloon text set in ListCell as a WString.

Parameters

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

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_setBalloonText

BSIColorDescr* mdlListCell_getBgColorDescr ( ListCellCP pCell )

Gets a pointer to the background color descriptor that is set for the specified ListCell.

Parameters

[in] pCell points to the ListCell to obtain the background color descriptor for.

Returns: A pointer to the BSIColorDescr.

See also: mdlListCell_setBgColorDescr mdlListCell_getColorDescr

BSIColorDescr* mdlListCell_getColorDescr ( ListCellCP pCell )

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

Parameters

[in] pCell points to the ListCell to process

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

See also: mdlListCell_setColorDescr

ListColumnP mdlListCell_getColumn ( ListCellCP pCell )

Returns the pointer to the parent ListColumn for the specified ListCell.

Parameters

[in] pCell points to the ListCell to process

Returns: The pointer to the parent ListColumn.

See also: mdlListRow_create

StatusInt mdlListCell_getDisplayText	(	ListCellCP	pCell,
		WCharCP *	ppwString
	)

Returns the display text of the specified ListCell in a WChar string.

Parameters

[in]	pCell	points to the ListCell to process
[in,out]	ppwString	points to the wide character pointer that will receive the address of the display text

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_setDisplayText

StatusInt mdlListCell_getDisplayTextWString	(	ListCellCP	pCell,
		WStringR	wString
	)

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

Parameters

[in,out]	wString	the WString object that will receive the display text
[in]	pCell	points to the ListCell to process

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_setDisplayTextA mdlListCell_setDisplayText

StatusInt mdlListCell_getDoubleValue	(	ListCellCP	pCell,
		double *	pValue
	)

Returns the double value of the specified ListCell.

Parameters

[in]	pCell	points to the ListCell 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: mdlListCell_setDoubleValue

StatusInt mdlListCell_getEditor	(	ListCellCP	pCell,
		long *	pEditorType,
		long *	pEditorId,
		MdlDescP *	pEditorOwnerMD,
		bool *	pbEditDisplay,
		bool *	pbUpdateDisplay
	)

Gets information about the editor of the cell.

Parameters

[in]	pCell	points to the ListCell to process
[in,out]	pEditorType	resource type of the editor
[in,out]	pEditorId	resource id of the editor
[in,out]	pEditorOwnerMD	owner MdlDesc of the editor
[in,out]	pbEditDisplay	receives value of "edit display text only" flag
[in,out]	pbUpdateDisplay	receives value of "update display text after editing" flag

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_setEditor

int mdlListCell_getFontIndex ( ListCellCP pCell )

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

Parameters

[in] pCell points to the ListCell 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: mdlListCell_setFontIndex

StatusInt mdlListCell_getIcon	(	ListCellCP	pCell,
		RscId *	pIconRscId,
		RscType *	pIconRscType,
		MdlDescP *	ppIconOwnerMD
	)

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

Parameters

[in]	pCell	points to the ListCell 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: mdlListCell_setIcon

StatusInt mdlListCell_getIconColorOverrides	(	ListCellCP	pCell,
		BSIColorDescr **	ppFgColor,
		BSIColorDescr **	ppBgColor
	)

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

Parameters

[in]	pCell	points to the ListCell 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: mdlListCell_setIconColorOverrides

StatusInt mdlListCell_getIconRsc	(	ListCellCP	pCell,
		IconRsc **	ppIconRsc
	)

Returns a pointer to the icon resource data to use when drawing the specified ListCell.

Parameters

[in]	pCell	points to the ListCell 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: mdlListCell_setIconRsc

int mdlListCell_getId ( ListCellCP pCell )

Returns the Id of the specified ListCell.

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

Parameters

[in] pCell points to the ListCell to process

Returns: The Id of the ListCell, or ERROR if pCell is invalid.

See also: mdlListCell_setId

int mdlListCell_getInfoFieldCount ( ListCellCP pCell )

Returns the number of info fields in a ListCell.

Parameters

[in] pCell points to the ListCell to process

Returns: The number of info fields in a ListCell, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListColumn_setInfoFieldCount

Int32 mdlListCell_getInfoFieldInt32	(	ListCellCP	pCell,
		int	index,
		StatusInt *	pStatus
	)

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

Parameters

[in]	pCell	points to the ListCell 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 mdlListCell_getInfoFieldInt32. To get an info field as a pointer type, use mdlListCell_getInfoFieldPointer.

Returns: The info field value as a 64-bit integer

See also: mdlListCell_setInfoFieldInt32 mdlListCell_getInfoFieldInt64 mdlListCell_getInfoFieldPointer

InfoField mdlListCell_getInfoFieldInt64	(	ListCellCP	pCell,
		int	index,
		StatusInt *	pStatus
	)

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

Parameters

[in]	pCell	points to the ListCell 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 mdlListCell_getInfoFieldInt32. To get an info field as a pointer type, use mdlListCell_getInfoFieldPointer.

Returns: The info field value as a 64-bit integer

See also: mdlListCell_setInfoFieldInt64 mdlListCell_getInfoFieldInt32 mdlListCell_getInfoFieldPointer

void* mdlListCell_getInfoFieldPointer	(	ListCellCP	pCell,
		int	index,
		StatusInt *	pStatus
	)

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

Parameters

[in]	pCell	points to the ListCell 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 mdlListCell_getInfoFieldInt32. To get an info field as a pointer type, use mdlListCell_getInfoFieldPointer.

Returns: The info field value as a 64-bit integer

See also: mdlListCell_setInfoFieldPointer mdlListCell_getInfoFieldInt64 mdlListCell_getInfoFieldInt32

StatusInt mdlListCell_getLongValue	(	ListCellCP	pCell,
		long *	pValue
	)

Returns the long value of the specified ListCell.

Parameters

[in]	pCell	points to the ListCell to process
[in,out]	pValue	points to the long that will receive the value

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_setLongValue

WCharCP mdlListCell_getName ( ListCellCP pCell )

Gets the name of the specified ListCell.

The Name of a Cell is the name of the parent Column.

Parameters

[in] pCell points to the ListCell from which the name string is obtained.

Returns: A pointer to the name string of the ListCell.

See also: mdlListCell_getId

int mdlListCell_getPixelIndent ( ListCellCP pCell )

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

Parameters

[in] pCell points to the ListCell to process

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

See also: mdlListCell_setColorDescr

StatusInt mdlListCell_getPointerValue	(	ListCellCP	pCell,
		UserDataP *	ppValue
	)

Returns the void pointer value of the specified ListCell.

Parameters

[in]	pCell	points to the ListCell to process
[in,out]	ppValue	points to the void* that will receive the value

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

ListRowP mdlListCell_getRow ( ListCellCP pCell )

Returns the pointer to the parent ListRow for the specified ListCell.

Parameters

[in] pCell points to the ListCell to process

Returns: The pointer to the parent ListRow.

See also: mdlListRow_create

BSIColorDescr* mdlListCell_getSelectedBgColorDescr ( ListCellCP pCell )

Gets a pointer to the background color descriptor that is set for the specified ListCell when selected.

Parameters

[in] pCell points to the ListCell to obtain the background color descriptor for.

Returns: A pointer to the BSIColorDescr.

See also: mdlListCell_setBgColorDescr mdlListCell_getColorDescr

BSIColorDescr* mdlListCell_getSelectedColorDescr ( ListCellCP pCell )

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

Parameters

[in] pCell points to the ListCell to process

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

See also: mdlListCell_setColorDescr

int mdlListCell_getStatus ( ListCellCP pCell )

Returns the status of the specified ListCell.

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

Parameters

[in] pCell points to the ListCell to process

Returns: The status of the ListCell, or ERROR if pCell is invalid

See also: mdlListCell_setStatus

StatusInt mdlListCell_getStringValue	(	ListCellCP	pCell,
		WCharCP *	ppwString
	)

Returns the string value of the specified ListCell to the specified WChar.

Parameters

[in]	pCell	points to the ListCell to process
[in,out]	ppwString	points to the character pointer that will receive the address of the string value

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_setStringValue

StatusInt mdlListCell_getStringValueWString	(	WStringR	wString,
		ListCellCP	pCell
	)

Returns the string value of the specified ListCell to a WString.

Parameters

[in,out]	wString	reference to the WString that will receive the string value
[in]	pCell	points to the ListCell to process

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_setStringValue mdlListCell_setStringValue

StatusInt mdlListCell_getUInt32Value	(	ListCellCP	pCell,
		UInt32 *	pValue
	)

Returns the unsigned unsigned Int32 value of the specified ListCell.

Parameters

[in]	pCell	points to the ListCell to process
[in,out]	pValue	points to the unsigned long that will receive the value

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_setLongValue

StatusInt mdlListCell_getUInt64Value	(	ListCellCP	pCell,
		UInt64 *	pValue
	)

Returns the UInt64 value of the specified ListCell.

Parameters

[in]	pCell	points to the ListCell to process
[in,out]	pValue	points to the UInt64 that will receive the value

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_setUInt64Value

StatusInt mdlListCell_getValue	(	ListCellCP	pCell,
		MSValueDescrR	valueDescr
	)

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

Parameters

[in]	pCell	points to the ListCell 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 is invalid

See also: mdlListCell_setValue

StatusInt mdlListCell_setBalloonText	(	ListCellP	pCell,
		WCharCP	pwText
	)

Sets the balloon text in the specified ListCell.

Parameters

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

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_getBalloonText

StatusInt mdlListCell_setBgColorDescr	(	ListCellP	pCell,
		BSIColorDescr *	pDescr
	)

Sets the background color descriptor for the specified ListCell.

Parameters

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

Returns: SUCCESS if the operation is completed successfully.

See also: mdlListCell_getBgColorDescr mdlListCell_setColorDescr

StatusInt mdlListCell_setColorDescr	(	ListCellP	pCell,
		BSIColorDescr *	pDescr
	)

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

Parameters

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

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_getColorDescr

StatusInt mdlListCell_setCompositeIconRsc	(	ListCellP	pCell,
		IconRsc *	pIconRsc,
		RscId	iconRscId,
		RscType	iconRscType,
		MdlDescP	iconOwnerMD
	)

Sets a composite icon resource data to use when drawing the specified ListCell.

Parameters

[in]	pCell	points to the ListCell to process
[in]	pIconRsc	points to the icon resource data.
[in]	iconRscId	the icon resource Id
[in]	iconRscType	the icon resource type
[in]	iconOwnerMD	a void pointer to the owner of the icon

Remarks: The resource data pointed to must be maintained by the application. When the icon is no longer needed, mdlResource_free should be called. The ListBox resource attributes must include LISTATTR_DRAWPREFIXICON to display icons. A Composite Icon needs the iconRscId, iconRscType, and IconOwnerMD because it looks up additional icons when the composite icon is drawn.

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_getIcon

StatusInt mdlListCell_setDisplayText	(	ListCellP	pCell,
		WCharCP	pwString
	)

Sets the display text of the specified ListCell from the given WChar.

Parameters

[in]	pCell	points to the ListCell to process
[in]	pwString	points to the new display text. The text itself is copied to an internal location in the ListCell; therefore, the application does not need to maintain the string pointer.

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_getDisplayTextA

StatusInt mdlListCell_setDisplayTextFromEditor	(	ListCell *	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	points to the ListCell to process
[in]	parentRiP	the RawItemHdr pointer of the dialog item, such as a ListBox, to use the ListModel

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_setEditor

StatusInt mdlListCell_setDoubleValue	(	ListCellP	pCell,
		double	value
	)

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

Parameters

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

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

Remarks: This function does not set the display value.

See also: mdlListCell_getDoubleValue

StatusInt mdlListCell_setEditor	(	ListCellP	pCell,
		long	editorType,
		long	editorId,
		MdlDescP	editorOwnerMD,
		bool	bEditDisplay,
		bool	bUpdateDisplay
	)

Sets information about the editor of the cell.

Parameters

[in]	pCell	points to the ListCell to process
[in]	editorType	resource type of the editor. Supported types are: RTYPE_ComboBox RTYPE_OptionButton RTYPE_Text RTYPE_ToggleButton RTYPE_Container - may contain any type of dialog item
[in]	editorId	resource id of the editor
[in]	editorOwnerMD	owner MdlDesc of the editor
[in]	bEditDisplay	indicates whether to edit display text only
[in]	bUpdateDisplay	indicates whether to update display text after editing

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

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);

See also: mdlListCell_getEditor

StatusInt mdlListCell_setFontIndex	(	ListCellP	pCell,
		int	fontIndex
	)

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

Parameters

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

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_getFontIndex

StatusInt mdlListCell_setIcon	(	ListCellP	pCell,
		RscId	iconRscId,
		RscType	iconRscType,
		MdlDescP	iconOwnerMD
	)

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

When setting the icon information in this manner, as opposed to using the mdlListCell_setIconRsc function, the ListModel is responsible for maintaining the icon resource data internally. The ListBox resource attributes must include LISTATTR_DRAWPREFIXICON to display icons.

Parameters

[in]	pCell	points to the ListCell 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: mdlListCell_getIcon

StatusInt mdlListCell_setIconByName	(	ListCellP	pCell,
		WCharCP	pIconName,
		Point2dCP	pIconSize
	)

Sets the name of the icon to use when drawing the specified ListCell.

Parameters

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

Remarks: The ListBox resource attributes must include LISTATTR_DRAWPREFIXICON to display icons. mdlListCell_getIconRsc is used to get the IconRsc associated with the name.

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_getIconRsc

StatusInt mdlListCell_setIconColorOverrides	(	ListCellP	pCell,
		BSIColorDescr *	pFgColor,
		BSIColorDescr *	pBgColor
	)

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

Parameters

[in]	pCell	points to the ListCell 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 ListCell; therefore, the application must maintain these pointers and associated BSIColorDescrs.

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_getIconColorOverrides

StatusInt mdlListCell_setIconFromEditor	(	ListCell *	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	points to the ListCell to process
[in]	parentRiP	the RawItemHdr pointer of the dialog item, such as a ListBox, to use the ListModel

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_setEditor

StatusInt mdlListCell_setIconRsc	(	ListCellP	pCell,
		IconRsc *	pIconRsc
	)

Sets the icon resource data to use when drawing the specified ListCell.

Parameters

[in]	pCell	points to the ListCell to process
[in]	pIconRsc	points to the icon resource data. The resource data pointed to must be maintained by the application. When the icon is no longer needed, mdlResource_free should be called. The ListBox resource attributes must include LISTATTR_DRAWPREFIXICON to display icons.

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_getIcon

StatusInt mdlListCell_setInfoFieldInt32	(	ListCellP	pCell,
		int	index,
		Int32	value
	)

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

Parameters

[in]	pCell	points to the ListCell 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 mdlListCell_setInfoFieldInt64. To get an info field as a pointer type, use mdlListCell_setInfoFieldPointer.

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_getInfoFieldInt32 mdlListCell_setInfoFieldInt32 mdlListCell_setInfoFieldPointer

StatusInt mdlListCell_setInfoFieldInt64	(	ListCellP	pCell,
		int	index,
		InfoField	value
	)

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

Parameters

[in]	pCell	points to the ListCell 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 mdlListCell_setInfoFieldInt32. To get an info field as a pointer type, use mdlListCell_setInfoFieldPointer.

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_getInfoFieldInt64 mdlListCell_setInfoFieldInt32 mdlListCell_setInfoFieldPointer

StatusInt mdlListCell_setInfoFieldPointer	(	ListCellP	pCell,
		int	index,
		void const *	value
	)

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

Parameters

[in]	pCell	points to the ListCell 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 mdlListCell_setInfoFieldInt64. To get an info field as a 32-bit integer, use mdlListCell_setInfoFieldInt32.

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_getInfoFieldPointer mdlListCell_setInfoFieldInt64 mdlListCell_setInfoFieldInt32

StatusInt mdlListCell_setLongValue	(	ListCellP	pCell,
		long	value
	)

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

Parameters

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

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

Remarks: This function does not set the display value.

See also: mdlListCell_getLongValue

StatusInt mdlListCell_setPixelIndent	(	ListCellP	pCell,
		int	pixelIndent
	)

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

Parameters

[in]	pCell	points to the ListCell 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: mdlListCell_getPixelIndent

StatusInt mdlListCell_setPointerValue	(	ListCellP	pCell,
		UserDataP	value
	)

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

Parameters

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

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

Remarks: This function does not set the display value.

StatusInt mdlListCell_setSelectedBgColorDescr	(	ListCellP	pCell,
		BSIColorDescr *	pDescr
	)

Sets the background color descriptor for the specified ListCell when selected.

Parameters

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

Returns: SUCCESS if the operation is completed successfully.

See also: mdlListCell_getBgColorDescr mdlListCell_setColorDescr

StatusInt mdlListCell_setSelectedColorDescr	(	ListCellP	pCell,
		BSIColorDescr *	pDescr
	)

Sets the color descriptor to use when drawing the specified ListCell when selected.

Parameters

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

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_getColorDescr

StatusInt mdlListCell_setStatus	(	ListCellP	pCell,
		int	status
	)

Sets the status in the specified ListCell.

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

Parameters

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

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_getStatus

StatusInt mdlListCell_setStringValue	(	ListCellP	pCell,
		WCharCP	pwString,
		bool	bSetDisplayText
	)

Sets the internal value descriptor to the given WChar string in the specified ListCell.

Parameters

[in]	pCell	points to the ListCell to process
[in]	pwString	points to the wide character string to set as the new internal value. The text itself is copied to an internal location in the ListCell; therefore, the ListCell 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: mdlListCell_getStringValue

StatusInt mdlListCell_setUInt32Value	(	ListCellP	pCell,
		UInt32	value
	)

Sets the internal value descriptor to a unsigned Int32 in the specified ListCell.

Parameters

[in]	pCell	points to the ListCell to process
[in]	value	a UInt32 to set as the new internal value.

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

Remarks: This function does not set the display value.

See also: mdlListCell_getLongValue

StatusInt mdlListCell_setUInt64Value	(	ListCellP	pCell,
		UInt64	value
	)

Sets the internal value descriptor to a UInt64 in the specified ListCell.

Parameters

[in]	pCell	points to the ListCell to process
[in]	value	a UInt64 to set as the new internal value.

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

Remarks: This function does not set the display value.

See also: mdlListCell_getUInt64Value

StatusInt mdlListCell_setValue	(	ListCellP	pCell,
		MSValueDescrCR	valueDescr,
		bool	bSetDisplayText
	)

Sets the internal value descriptor of the specified ListCell.

Parameters

[in]	pCell	points to the ListCell 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_STRG or FMT_WCHAR.

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pCell is invalid

See also: mdlListCell_getValue

WCharCP mdlTreeCell_getName ( GuiTreeCellCP pCell )

Gets the name of the specified GuiTreeCell.

The Name of a Cell is the name of the parent Column.

Parameters

[in] pCell points to the ListCell from which the name string is obtained.

Returns: A pointer to the name string of the GuiTreeCell.

See also: mdlTreeColumn_getId

Remarks: Required Library: mdlbltin.lib

BSIColorDescr* mdlTreeCell_getSelectedBgColorDescr ( GuiTreeCellCP pCell )

Gets a pointer to the background color descriptor that is set for the specified GuiTreeCell when selected.

Parameters

[in] pCell points to the GuiTreeCell to obtain the background color descriptor for.

Returns: A pointer to the BSIColorDescr.

See also: mdlTreeCell_setBgColorDescr mdlTreeCell_getColorDescr

Remarks: Required Library: mdlbltin.lib

BSIColorDescr* mdlTreeCell_getSelectedColorDescr ( GuiTreeCellCP pCell )

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

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

StatusInt mdlTreeCell_setSelectedBgColorDescr	(	GuiTreeCellP	pCell,
		BSIColorDescr *	pDescr
	)

Sets the background color descriptor for the specified GuiTreeCell when selected.

Parameters

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

Returns: SUCCESS if the operation is completed successfully.

See also: mdlTreeCell_getBgColorDescr mdlTreeCell_setColorDescr

Remarks: Required Library: mdlbltin.lib

StatusInt mdlTreeCell_setSelectedColorDescr	(	GuiTreeCellP	pCell,
		BSIColorDescr *	pDescr
	)

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

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

Functions

Detailed Description

Function Documentation