DescriptionPropertyCustomGui Class Reference

#include <customgui_descproperty.h>

Inheritance diagram for DescriptionPropertyCustomGui:

Detailed Description

Description property custom GUI (CUSTOMGUI_DESCRIPTIONPROPERTY).
Here are the settings: DESCRIPTIONPROPERTY_CUSTOMGUISETTINGS
The following custom parent message IDs are sent: BFM_ACTION_DP

Public Member Functions
void	SetDescID (const DescID &id)
void	SetState (DESCPROP flags)
DESCPROP	GetState ()
Int32	GetPartCount ()
void	GetPartInfo (Int32 part, maxon::String &str, DescID &id, Bool &onoff)
void	SetSelection (const DescID &id, Bool onoff)
void	ChangeSettings (const BaseContainer &settings)
Public Member Functions inherited from BaseCustomGui< 1000485 >
Int32	GetWidth ()
Int32	GetHeight ()
void	Redraw ()
Bool	LayoutChanged ()
Bool	Activate ()
Bool	SetDefaultForResEdit ()
Bool	SetData (const TriState< GeData > &tristate)
TriState< GeData >	GetData ()
void	SetLayoutMode (Int32 mode)
Int32	GetLayoutMode ()
Bool	SupportLayoutSwitch ()
Public Member Functions inherited from _BaseCustomGui
Int32	GetWidth (Int32 plugid)
Int32	GetHeight (Int32 plugid)
void	Redraw (Int32 plugid)
Bool	LayoutChanged (Int32 plugid)
Bool	Activate (Int32 plugid)
Bool	SetDefaultForResEdit (Int32 plugid)
Bool	SetData (Int32 plugid, const TriState< GeData > &tristate)
TriState< GeData >	GetData (Int32 plugid)
void	SetLayoutMode (Int32 plugid, Int32 mode)
Int32	GetLayoutMode (Int32 plugid)
Bool	SupportLayoutSwitch (Int32 plugid)

Private Member Functions
	DescriptionPropertyCustomGui ()
	~DescriptionPropertyCustomGui ()

Additional Inherited Members
Static Public Attributes inherited from BaseCustomGui< 1000485 >
static constexpr Int32	VALUE

Constructor & Destructor Documentation

DescriptionPropertyCustomGui()

DescriptionPropertyCustomGui ( )

private

~DescriptionPropertyCustomGui()

~DescriptionPropertyCustomGui ( )

private

Member Function Documentation

SetDescID()

void SetDescID

(

const DescID &

id

)

Sets the description ID to display.

Note

The name of the element must have as many parts, separated by ~!~, as id.GetDepth(). These are displayed separated by dots.

Parameters

[in]

id

The description ID.

SetState()

void SetState

(

DESCPROP

flags

)

Sets the display flags.

Parameters

[in]

flags

A combination of these flags: DESCPROP

GetState()

DESCPROP GetState

(

)

Gets the display flags.

Returns

A combination of these flags: DESCPROP

GetPartCount()

Int32 GetPartCount

(

)

Gets the number of parts. (For instance "Foo . Bar" has 2 parts.)

Returns

The number of parts.

GetPartInfo()

void GetPartInfo	(	Int32	part,
		maxon::String &	str,
		DescID &	id,
		Bool &	onoff
	)

Gets information for each part.

Parameters

[in]	part	The part index: 0 <= part < GetPartCount()
[in]	str	The part title.
[in]	id	The part ID.
[in]	onoff	The selection state.

SetSelection()

void SetSelection	(	const DescID &	id,
		Bool	onoff
	)

Sets the selection state.

Parameters

[in]	id	The description ID to set the state for.
[in]	onoff	The new selection state.

ChangeSettings()

void ChangeSettings

(

const BaseContainer &

settings

)

Sets the description property settings.

Parameters

[in]

settings

The new settings: DESCRIPTIONPROPERTY_CUSTOMGUISETTINGS