adtf::base::giant::cPropertyVariable Class Reference

#include <configuration.h>

Inherits adtf::base::ant::cPropertyVariable.

Inherited by adtf::base::giant::property_variable< T >.

Public Member Functions
	cPropertyVariable ()
	cPropertyVariable (const cPropertyVariable &oOther)
	cPropertyVariable (cPropertyVariable &&oOther)
cPropertyVariable &	operator= (const cPropertyVariable &oOther)
cPropertyVariable &	operator= (cPropertyVariable &&oOther)
	~cPropertyVariable () override
const ant::IProperties &	GetSubProperties () const
void	SetDisplayName (const char *strDisplayName)
void	SetDescription (const char *strDescription)
void	SetFilenameExtensionFilter (const char *strFilenameExtensionFilter)
void	SetFilenameOpenForWriting (bool bWriteMode)
tVoid	SetResolveMacros (tBool bResolveMacros)
Public Member Functions inherited from adtf::base::ant::cPropertyVariable
void	SetUnregister (IMemberPropertyUnregister &oUnregister)
virtual tResult	GetType (IString &&strType) const =0
virtual const IPropertyValue *	GetValue () const =0
Public Member Functions inherited from adtf::base::ant::IPropertyObserver
virtual void	Notify (const IProperty &oProperty)=0

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

Protected Attributes
std::unique_ptr< cImplementation >	m_pImplementation

Detailed Description

Base class for property_variable.

Constructor & Destructor Documentation

cPropertyVariable() [1/3]

adtf::base::giant::cPropertyVariable::cPropertyVariable

(

)

The default constructor.

cPropertyVariable() [2/3]

adtf::base::giant::cPropertyVariable::cPropertyVariable

(

const cPropertyVariable &

oOther

)

Copy constructor.

Parameters

[in]

oOther

The moved instance.

cPropertyVariable() [3/3]

adtf::base::giant::cPropertyVariable::cPropertyVariable

(

cPropertyVariable &&

oOther

)

Move constructor.

Parameters

[in]

oOther

The moved instance.

~cPropertyVariable()

adtf::base::giant::cPropertyVariable::~cPropertyVariable ( )

overridevirtual

Destructor.

Reimplemented from adtf::base::ant::cPropertyVariable.

Member Function Documentation

GetSubProperties() [1/2]

ant::IProperties & adtf::base::giant::cPropertyVariable::GetSubProperties ( )

protected

Returns

non-const reference to the Sub-Properties.

GetSubProperties() [2/2]

const ant::IProperties & adtf::base::giant::cPropertyVariable::GetSubProperties

(

)

const

Returns

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

operator=() [1/2]

cPropertyVariable & adtf::base::giant::cPropertyVariable::operator=

(

const cPropertyVariable &

oOther

)

Assignment operator

Parameters

[in]

oOther

The moved instance.

Returns

Reference to the Property Variable

operator=() [2/2]

cPropertyVariable & adtf::base::giant::cPropertyVariable::operator=

(

cPropertyVariable &&

oOther

)

Move assignment operator

Parameters

[in]

oOther

The moved instance.

Returns

Reference to the Property Variable

SetDescription()

void adtf::base::giant::cPropertyVariable::SetDescription

(

const char *

strDescription

)

Sets the description text associated with the Property.

Parameters

[in]

strDescription

The Description.

SetDisplayName()

void adtf::base::giant::cPropertyVariable::SetDisplayName

(

const char *

strDisplayName

)

Sets the name that tools should display.

Parameters

[in]

strDisplayName

The display name.

SetFilenameExtensionFilter()

void adtf::base::giant::cPropertyVariable::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 adtf::base::giant::cPropertyVariable::SetFilenameOpenForWriting

(

bool

bWriteMode

)

Sets the write mode for the file property. Configuration Editor will create a save file dialog for those properties.

SetResolveMacros()

tVoid adtf::base::giant::cPropertyVariable::SetResolveMacros

(

tBool

bResolveMacros

)

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

Parameters

[in]

bResolveMacros

Default is true.

---

The documentation for this class was generated from the following file:

• src/libraries/base/include/adtfbase/configuration.h