Level Lists

Functions
StatusInt	mdlLevelList_getLevelNamesListModel (ListModelP listModel, DgnModelRefP modelRefIn, DgnPlatform::LevelId levelId, UInt attributes)
	Populates the given ListModel with level names. More...
StatusInt	mdlLevelList_getLevelNamesListModelWithLock (ListModelP listModel, DgnModelRefP modelRefIn)
	Populates the given ListModel with the level names and the lock status. More...
StatusInt	mdlLevelList_getLevelNamesWithAttributes (MSDialogP pDb, ListModelP listModelOut, DgnModelRefP modelRefIn)
	Pouplates the given ListModel with the level names, the lock status, and the ByLevel Color. More...
int	mdlLevelList_getColorListModel (ListModelP listModel, MSDialogP pDb, DgnModelRefP modelRefIn, DgnPlatform::LevelId *levelIn, UInt currentColor, UInt options)
	Populates the given ListModel with the level colors. More...
int	mdlLevelList_getStyleListModel (ListModelP listModel, DgnModelRefP modelRefIn, DgnPlatform::LevelId *levelIn, int currentStyleNum, UInt options)
	Populates the given ListModel with the level styles. More...
int	mdlLevelList_getWeightListModel (ListModelP listModel, DgnModelRefP modelRefIn, DgnPlatform::LevelId *levelIn, UInt currentWeight, UInt options)
	Pouplates the given ListModel with the level weights. More...
int	mdlLevelList_getFillListModel (ListModelP listModel, MSDialogP pDb, DgnModelRefP modelRefIn, DgnPlatform::LevelId *levelIn, UInt currentColor, UInt option)
	Populates the given ListModel with the level fill colors. More...
void	mdlLevelList_handleLevelNameSetState (DialogItemMessageP dimP, DgnPlatform::LevelId currentLevel)
	Returns a list model pointer of level names. More...
StatusInt	mdlLevelList_synchronizeColorListModel (ListModelP listModel, MSDialogP pDb, DgnModelRefP modelRefIn, DgnPlatform::LevelId *levelIn)
	Synchronize the "ByLevel" icon in a list model. More...
StatusInt	mdlLevelList_synchronizeFillListModel (ListModelP listModel, MSDialogP pDb, DgnModelRefP modelRefIn, DgnPlatform::LevelId *levelIn)
	Synchronize the "ByLevel" icon in a list model. More...
StatusInt	mdlLevelList_synchronizeWeightListModel (ListModelP listModel, DgnModelRefP modelRefIn, DgnPlatform::LevelId *levelIn)
	Synchronize the "ByLevel" icon in a list model. More...
StatusInt	mdlLevelList_synchronizeStyleListModel (ListModelP listModel, DgnModelRefP modelRefIn, DgnPlatform::LevelId *levelIn)
	Synchronize the "ByLevel" icon in a list model. More...
StatusInt	mdlLevelList_synchronizeStyleHistory (ListModelP listModel, DgnModelRefP modelRefIn)
	Update the history of last used line styles. More...

Detailed Description

Function Documentation

int mdlLevelList_getColorListModel	(	ListModelP	listModel,
		MSDialogP	pDb,
		DgnModelRefP	modelRefIn,
		DgnPlatform::LevelId *	levelIn,
		UInt	currentColor,
		UInt	options
	)

Populates the given ListModel with the level colors.

Parameters

[out]	listModel	contains the level color list model
[out]	pDb	the dialog box pointer the list will be displayed in.
[in]	modelRefIn	model ref
[in]	levelIn	the level to use for the "ByLevel" color. Pass NULL to use the active level.
[in]	currentColor	current color
[in]	options	options

Remarks

NOTE: The list model must be freed by the calling application.

Returns

SUCCESS

See also

mdlLevelList_getStyleListModel mdlLevelList_getWeightListModel mdlLevelList_getFillListModel mdlLevelList_synchronizeColorListModel

int mdlLevelList_getFillListModel	(	ListModelP	listModel,
		MSDialogP	pDb,
		DgnModelRefP	modelRefIn,
		DgnPlatform::LevelId *	levelIn,
		UInt	currentColor,
		UInt	option
	)

Populates the given ListModel with the level fill colors.

Parameters

[out]	listModel	contains the level fill list model
[in]	pDb	the dialog box pointer the list will be displayed in.
[in]	modelRefIn	model ref
[in]	levelIn	the level to use for the "ByLevel" fill.
[in]	currentColor	current color
[in]	option	options

Remarks

NOTE: The list model must be freed by the calling application.

Returns

SUCCESS

See also

mdlLevelList_getStyleListModel mdlLevelList_getWeightListModel mdlLevelList_getColorListModel

StatusInt mdlLevelList_getLevelNamesListModel	(	ListModelP	listModel,
		DgnModelRefP	modelRefIn,
		DgnPlatform::LevelId	levelId,
		UInt	attributes
	)

Populates the given ListModel with level names.

The levelId specifies the level whose name will be inserted at the top (after the Active Filter row), if filtered out by the active filter.

The current attributes to apply the level listModel generated are as follows:

Attribute	Property
LEVELLIST_FILTER	Filter the level names with the active filter and add a Filer:[filename] row to the list dynamically.
LEVELLIST_SHOW_LEVEL_LIBRARIES	Add level libraries to the listmodel if present.
LEVELLIST_BOLD_USED	Bold the row of levels which are being used. The COMBOATTR_FONTBYCOLUMN attribute must be present in the ComboBox attribute resource.

Parameters

[out]	listModel	contains the level name list model.
[in]	modelRefIn	modelref to return levels from.
[in]	levelId	this is the level id to always populate in the list.
[in]	attributes	mask describing how the list model is created.

Remarks

NOTE: The list model must be freed by the calling application.

Returns

SUCCESS

See also

mdlLevelList_getLevelNamesListModel mdlLevelList_handleLevelNameSetState

StatusInt mdlLevelList_getLevelNamesListModelWithLock	(	ListModelP	listModel,
		DgnModelRefP	modelRefIn
	)

Populates the given ListModel with the level names and the lock status.

Parameters

[out]	listModel	contains the level name list model
[in]	modelRefIn	model ref

Remarks

NOTE: The list model must be freed by the calling application.

Returns

SUCCESS

See also

mdlLevelList_getLevelNamesListModel

StatusInt mdlLevelList_getLevelNamesWithAttributes	(	MSDialogP	pDb,
		ListModelP	listModelOut,
		DgnModelRefP	modelRefIn
	)

Pouplates the given ListModel with the level names, the lock status, and the ByLevel Color.

There should be at least 1 (one) infofield and 4 columns in the List Box containing the ListModel returned

Parameters

[out]	pDb	the dialog box pointer the list will be displayed in.
[out]	listModelOut	contains the level name list model
[in]	modelRefIn	model ref

Remarks

NOTE: The list model must be freed by the calling application.

Returns

SUCCESS

See also

mdlLevelList_getLevelNamesListModel

int mdlLevelList_getStyleListModel	(	ListModelP	listModel,
		DgnModelRefP	modelRefIn,
		DgnPlatform::LevelId *	levelIn,
		int	currentStyleNum,
		UInt	options
	)

Populates the given ListModel with the level styles.

Parameters

[out]	listModel	contains the level style list model
[in]	modelRefIn	model ref
[in]	levelIn	the level to use for the "ByLevel" style. Pass NULL to use the active level.
[in]	currentStyleNum	current style
[in]	options	options

Remarks

NOTE: The list model must be freed by the calling application.

Returns

SUCCESS

See also

mdlLevelList_getColorListModel mdlLevelList_getWeightListModel mdlLevelList_getFillListModel

int mdlLevelList_getWeightListModel	(	ListModelP	listModel,
		DgnModelRefP	modelRefIn,
		DgnPlatform::LevelId *	levelIn,
		UInt	currentWeight,
		UInt	options
	)

Pouplates the given ListModel with the level weights.

Parameters

[out]	listModel	contains the level weight list model
[in]	modelRefIn	model ref
[in]	levelIn	the level to use for the "ByLevel" weight. Pass NULL to use the active level.
[in]	currentWeight	current weight
[in]	options	options

Remarks

NOTE: The list model must be freed by the calling application.

Returns

SUCCESS

See also

mdlLevelList_getStyleListModel mdlLevelList_getColorListModel mdlLevelList_getFillListModel

void mdlLevelList_handleLevelNameSetState	(	DialogItemMessageP	dimP,
		DgnPlatform::LevelId	currentLevel
	)

Returns a list model pointer of level names.

Use this function if using the ~?mdlLevelList_getLevelNamesListModel function.

Parameters

[in]	dimP	DialogItemMessage passed to the users combo box hook.
[in]	currentLevel	The level to make sure is always visible in the list, even if filtered out.

Returns

SUCCESS

See also

mdlLevelList_getLevelNamesListModel

StatusInt mdlLevelList_synchronizeColorListModel	(	ListModelP	listModel,
		MSDialogP	pDb,
		DgnModelRefP	modelRefIn,
		DgnPlatform::LevelId *	levelIn
	)

Synchronize the "ByLevel" icon in a list model.

This function is called when the level used in the list model changes, so the color icon will be updated correctly. For instance, if the list model is showing the currently available colors, then this function should be called when the active level changes or is modified.

Parameters

[in,out]	listModel	List model created with mdlLevelList_getColorListModel.
[in]	pDb	The dialog box containing the list model, to set the correct background color.
[in]	modelRefIn	The model ref which contains pLevelIn.
[in]	levelIn	The level to consider to be active. Pass NULL to use the current active level.

Returns

SUCCESS

See also

mdlLevelList_getColorListModel

StatusInt mdlLevelList_synchronizeFillListModel	(	ListModelP	listModel,
		MSDialogP	pDb,
		DgnModelRefP	modelRefIn,
		DgnPlatform::LevelId *	levelIn
	)

Synchronize the "ByLevel" icon in a list model.

This function is called when the level used in the list model changes, so the fill color icon will be updated correctly. For instance, if the list model is showing the currently available colors, then this function should be called when the active level changes or is modified.

Parameters

[in,out]	listModel	List model created with mdlLevelList_getFillListModel.
[in]	pDb	The dialog box containing the list model, to set the correct background color.
[in]	modelRefIn	The model ref which contains pLevelIn.
[in]	levelIn	The level to consider to be active. Pass NULL to use the current active level.

Returns

SUCCESS

See also

mdlLevelList_getFillListModel

StatusInt mdlLevelList_synchronizeStyleHistory	(	ListModelP	listModel,
		DgnModelRefP	modelRefIn
	)

Update the history of last used line styles.

This is the same history that is used by the active line style chooser in the attributes tool bar.

Parameters

[in,out]	listModel	List model created with mdlLevelList_getStyleListModel.
[in]	modelRefIn	The model ref which contains the line styles; usually ACTIVEMODEL.

Returns

SUCCESS

See also

mdlLevelList_getStyleListModel

StatusInt mdlLevelList_synchronizeStyleListModel	(	ListModelP	listModel,
		DgnModelRefP	modelRefIn,
		DgnPlatform::LevelId *	levelIn
	)

Synchronize the "ByLevel" icon in a list model.

This function is called when the level used in the list model changes, so the line style icon will be updated correctly. For instance, if the list model is showing the currently available line styles, then this function should be called when the active level changes or is modified.

Parameters

[in,out]	listModel	List model created with mdlLevelList_getStyleListModel.
[in]	modelRefIn	The model ref which contains pLevelIn.
[in]	levelIn	The level to consider to be active. Pass NULL to use the current active level.

Returns

SUCCESS

See also

mdlLevelList_getStyleListModel

StatusInt mdlLevelList_synchronizeWeightListModel	(	ListModelP	listModel,
		DgnModelRefP	modelRefIn,
		DgnPlatform::LevelId *	levelIn
	)

Synchronize the "ByLevel" icon in a list model.

This function is called when the level used in the list model changes, so the weight icon will be updated correctly. For instance, if the list model is showing the currently available weights, then this function should be called when the active level changes or is modified.

Parameters

[in,out]	listModel	List model created with mdlLevelList_getWeightListModel.
[in]	modelRefIn	The model ref which contains pLevelIn.
[in]	levelIn	The level to consider to be active. Pass NULL to use the current active level.

Returns

SUCCESS

See also

mdlLevelList_getWeightListModel