Functions
ListRowP	mdlListRow_create (ListModelCP pModel)
	Creates a ListRow with the specified ListModel as an owner. More...

ListRowP	mdlListRow_copy (ListRowCP pRow)
	Copies a ListRow and all of its ListCells. More...

StatusInt	mdlListRow_destroy (ListRowP pRow)
	Destroys a ListRow and all of its ListCells. More...

ListModelP	mdlListRow_getModel (ListRowCP pRow)
	Returns a pointer to the ListModel containing the specified ListRow. More...

int	mdlListRow_getStatus (ListRowCP pRow)
	Returns the status of a specified ListRow. More...

StatusInt	mdlListRow_setStatus (ListRowP pRow, int inStatus)
	Sets the status of a specified ListRow. More...

UserDataP	mdlListRow_getAppData (ListRowCP pRow)
	Returns a pointer to application data associated with the ListRow. More...

StatusInt	mdlListRow_setAppData (ListRowP pRow, UserDataP pAppData)
	Sets the pointer to application data to be associated with the ListRow. More...

ListCellP	mdlListRow_getCellAtIndex (ListRowCP pRow, int colIndex)
	Returns a pointer to the ListCell at the specified column index within the ListRow. More...

ListCellP	mdlListRow_getCellById (ListRowCP pRow, int cellId)
	Returns a pointer to the ListCell with the specified column Id within the ListRow. More...

ListCellP	mdlListRow_getCellByName (ListRowCP pRow, WCharCP pwName)
	Returns a pointer to the ListCell with the specified name contained within the given ListRow. More...

StatusInt	mdlListRow_setStatusInCells (ListRowP pRow, int status)
	Sets the status in each ListCell within the ListRow. More...

StatusInt	mdlListRow_setFontIndex (ListRowP pRow, int fontIndex)
	Sets the font to use when drawing cells in the specified row. More...

StatusInt	mdlListRow_setColorDescr (ListRowP pRow, BSIColorDescr *pDescr)
	Sets the color descriptor to use when drawing cells in the specified row. More...

StatusInt	mdlListRow_setBgColorDescr (ListRowP pRow, BSIColorDescr *pDescr)
	Sets the background color descriptor to use when drawing cells in the specified row. More...

StatusInt	mdlListRow_setSelectedColorDescr (ListRowP pRow, BSIColorDescr *pDescr)
	Sets the color descriptor to use when drawing selected cells in the specified row. More...

StatusInt	mdlListRow_setSelectedBgColorDescr (ListRowP pRow, BSIColorDescr *pDescr)
	Sets the background color descriptor to use when drawing selected cells in the specified row. More...

StatusInt	mdlListRow_moveUp (ListRowP pRow)
	Moves the row up. More...

StatusInt	mdlListRow_moveDown (ListRowP pRow)
	Moves the row down. More...

Detailed Description

Function Documentation

ListRowP mdlListRow_copy ( ListRowCP pRow )

Copies a ListRow and all of its ListCells.

Parameters

[in] pRow points to the ListRow to copy

Returns: A pointer to the copy of the ListRow.

See also: mdlListRow_destroy

ListRowP mdlListRow_create ( ListModelCP pModel )

Creates a ListRow with the specified ListModel as an owner.

A ListCell for each ListColumn in the ListModel is also created, containing the number info.

Parameters

[in] pModel points to the ListModel

Returns: A pointer to the ListRow created.

See also: mdlListModel_create mdlListRow_destroy

StatusInt mdlListRow_destroy ( ListRowP pRow )

Destroys a ListRow and all of its ListCells.

The ListRow should have been removed from any ListModel beforehand.

Parameters

[in] pRow points to the ListRow to destroy

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pRow is invalid

See also: mdlListRow_create

UserDataP mdlListRow_getAppData ( ListRowCP pRow )

Returns a pointer to application data associated with the ListRow.

Parameters

[in] pRow the ListRow to process.

Returns: A pointer to the application data associated with the ListRow.

See also: mdlListRow_setAppData

ListCellP mdlListRow_getCellAtIndex	(	ListRowCP	pRow,
		int	colIndex
	)

Returns a pointer to the ListCell at the specified column index within the ListRow.

Parameters

[in]	pRow	points to the ListRow to process
[in]	colIndex	column index of the cell to get

Returns: A pointer to the desired ListCell, or NULL if pRow or colIndex are invalid.

See also: mdlListRow_getCellById

ListCellP mdlListRow_getCellById	(	ListRowCP	pRow,
		int	cellId
	)

Returns a pointer to the ListCell with the specified column Id within the ListRow.

Parameters

[in]	pRow	points to the ListRow to process
[in]	cellId	Id of the ListCell

Returns: A pointer to the desired ListCell, or NULL if pRow or cellId are invalid

See also: mdlListRow_getCellAtIndex

ListCellP mdlListRow_getCellByName	(	ListRowCP	pRow,
		WCharCP	pwName
	)

Returns a pointer to the ListCell with the specified name contained within the given ListRow.

Parameters

[in]	pRow	points to the ListRow to process
[in]	pwName	Name of the ListCell to get

Returns: A pointer to the ListCell.

See also: mdlListRow_getCellAtIndex

ListModelP mdlListRow_getModel ( ListRowCP pRow )

Returns a pointer to the ListModel containing the specified ListRow.

Parameters

[in] pRow points to the ListRow to get the ListModel from.

Returns: A pointer to the ListModel.

int mdlListRow_getStatus ( ListRowCP pRow )

Returns the status of a specified ListRow.

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

Parameters

[in] pRow points to the ListRow to process

Returns: The status of the ListRow, or ERROR if pRow is invalid

See also: mdlListRow_setStatus

StatusInt mdlListRow_moveDown ( ListRowP pRow )

Moves the row down.

Parameters

[in] pRow points to the ListRow to process

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pRow is invalid

See also: mdlListRow_moveUp

StatusInt mdlListRow_moveUp ( ListRowP pRow )

Moves the row up.

Parameters

[in] pRow points to the ListRow to process

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pRow is invalid

See also: mdlListRow_moveDown

StatusInt mdlListRow_setAppData	(	ListRowP	pRow,
		UserDataP	pAppData
	)

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

Parameters

[in]	pRow	the ListRow to process.
[in]	pAppData	points to the application data to be associated with the ListRow.

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pRow is invalid

Remarks: The application data must be destroyed by the application.

See also: mdlListRow_getAppData

StatusInt mdlListRow_setBgColorDescr	(	ListRowP	pRow,
		BSIColorDescr *	pDescr
	)

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

Parameters

[in]	pRow	points to the ListRow to process.
[in]	pDescr	points to the ColorDescr to use for the background of the cells.

Returns: SUCCESS if the operation was completed successfully.

See also: mdlListRow_setColorDescr mdlListRow_getBgColorDescr

StatusInt mdlListRow_setColorDescr	(	ListRowP	pRow,
		BSIColorDescr *	pDescr
	)

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

Parameters

[in]	pRow	points to the ListRow to process.
[in]	pDescr	points to the ColorDescr to use for drawing the cells.

Returns: SUCCESS if the operation was completed successfully.

See also: mdlListRow_getColorDescr mdlListRow_setBgColorDescr

StatusInt mdlListRow_setFontIndex	(	ListRowP	pRow,
		int	fontIndex
	)

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

Parameters

[in]	pRow	points to the ListRow to process.
[in]	fontIndex	the index of the font to use.

Returns: SUCCESS if the font index was valid and set successfully.

See also: mdlListCell_getFontIndex

StatusInt mdlListRow_setSelectedBgColorDescr	(	ListRowP	pRow,
		BSIColorDescr *	pDescr
	)

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

Parameters

[in]	pRow	points to the ListRow to process.
[in]	pDescr	points to the ColorDescr to use for the background of the cells.

Returns: SUCCESS if the operation was completed successfully.

See also: mdlListRow_setColorDescr mdlListRow_getBgColorDescr

StatusInt mdlListRow_setSelectedColorDescr	(	ListRowP	pRow,
		BSIColorDescr *	pDescr
	)

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

Parameters

[in]	pRow	points to the ListRow to process.
[in]	pDescr	points to the ColorDescr to use for drawing the cells.

Returns: SUCCESS if the operation was completed successfully.

See also: mdlListRow_getColorDescr mdlListRow_setBgColorDescr

StatusInt mdlListRow_setStatus	(	ListRowP	pRow,
		int	inStatus
	)

Sets the status of a specified ListRow.

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

Parameters

[in]	pRow	points to the ListRow to process
[in]	inStatus	indicates the new status of the ListRow

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pRow is invalid

See also: mdlListRow_getStatus

StatusInt mdlListRow_setStatusInCells	(	ListRowP	pRow,
		int	status
	)

Sets the status in each ListCell within the ListRow.

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

Parameters

[in]	pRow	points to the ListRow to process
[in]	status	indicates the new status to be set in each ListCell of the ListRow

Returns: SUCCESS, or MDLERR_ADDRNOTVALID if pRow is invalid

See also: mdlListCell_getStatus mdlListCell_setStatus

Functions

Detailed Description

Function Documentation