cPropertyVariable

Base class for property_variable. More...

Inheritance diagram for cPropertyVariable:

Public Member Functions
	cPropertyVariable ()
	The default constructor.
	cPropertyVariable (const cPropertyVariable &oOther)
	Copy constructor. More...
	cPropertyVariable (cPropertyVariable &&oOther)
	Move constructor. More...
cPropertyVariable &	operator= (const cPropertyVariable &oOther)
	Assignment operator. More...
cPropertyVariable &	operator= (cPropertyVariable &&oOther)
	Move assignment operator. More...
	~cPropertyVariable () override
	Destructor.
const ant::IProperties &	GetSubProperties () const
void	SetDisplayName (const char *strDisplayName)
	Sets the name that tools should display. More...
void	SetDescription (const char *strDescription)
	Sets the description text associated with the Property. More...
void	SetFilenameExtensionFilter (const char *strFilenameExtensionFilter)
	Sets optional file filters for Configuration Editor FileDialogs of cFilename and cFilenameList properties e.g. More...
void	SetFilenameOpenForWriting (bool bWriteMode)
	Sets the write mode for the file property. More...
tVoid	SetResolveMacros (tBool bResolveMacros)
	Sets whether or not macros should be resolved by the session manager or not. More...
Public Member Functions inherited from cPropertyVariable
void	SetUnregister (IMemberPropertyUnregister &oUnregister)
virtual tResult	GetType (IString &&strType) const =0
	Returns the identifier of the type. More...
virtual const IPropertyValue *	GetValue () const =0
Public Member Functions inherited from IPropertyObserver
virtual void	Notify (const IProperty &oProperty)=0
	Implements the observer pattern. More...

Protected Member Functions
ant::IProperties &	GetSubProperties ()
Protected Member Functions inherited from IPropertyObserver
	~IPropertyObserver ()=default
	Protected destructor.

Protected Attributes
std::unique_ptr< cImplementation >	m_pImplementation

Detailed Description

Base class for property_variable.

Definition at line 510 of file configuration.h.

Constructor & Destructor Documentation

cPropertyVariable() [1/2]

cPropertyVariable

(

const cPropertyVariable &

oOther

)

Copy constructor.

Parameters

[in]

oOther

The moved instance.

cPropertyVariable() [2/2]

cPropertyVariable

(

cPropertyVariable &&

oOther

)

Move constructor.

Parameters

[in]

oOther

The moved instance.

Member Function Documentation

GetSubProperties() [1/2]

ant::IProperties& GetSubProperties ( )

protected

Returns

non-const reference to the Sub-Properties.

GetSubProperties() [2/2]

const ant::IProperties& GetSubProperties

(

)

const

Returns

The Sub-Properties that should be set on the associated Property.

Referenced by property_variable< T >::SetValidRange(), and property_variable< T >::SetValueList().

operator=() [1/2]

cPropertyVariable& operator=

(

const cPropertyVariable &

oOther

)

Assignment operator.

Parameters

[in]

oOther

The moved instance.

Returns

Reference to the Property Variable

operator=() [2/2]

cPropertyVariable& operator=

(

cPropertyVariable &&

oOther

)

Move assignment operator.

Parameters

[in]

oOther

The moved instance.

Returns

Reference to the Property Variable

SetDescription()

void SetDescription

(

const char *

strDescription

)

Sets the description text associated with the Property.

Parameters

[in]

strDescription

The Description.

SetDisplayName()

void SetDisplayName

(

const char *

strDisplayName

)

Sets the name that tools should display.

Parameters

[in]

strDisplayName

The display name.

SetFilenameExtensionFilter()

void SetFilenameExtensionFilter

(

const char *

strFilenameExtensionFilter

)

Sets optional file filters for Configuration Editor FileDialogs of cFilename and cFilenameList properties e.g.

SetFilenameExtensionFilter("ADTF DAT files (*.dat *.adtfdat),ADTF Media Description files (*.description)").

Parameters

[in]

strFilenameExtensionFilter

Comma seperated list of filename extensions to filter

SetFilenameOpenForWriting()

void SetFilenameOpenForWriting

(

bool

bWriteMode

)

Sets the write mode for the file property.

Configuration Editor will create a save file dialog for those properties.

SetResolveMacros()

tVoid SetResolveMacros

(

tBool

bResolveMacros

)

Sets whether or not macros should be resolved by the session manager or not.

Parameters

[in]

bResolveMacros

Default is true.