This is used to issue a notification upon a condition of the property being met. More...

Inheritance diagram for Dali::PropertyNotification:

Public Types
enum	NotifyMode
	Enumeration for description of how to check condition. More...
Public Member Functions
	PropertyNotification ()
	Creates an uninitialized PropertyNotification; this can be initialized with PropertyNotification::New().
	~PropertyNotification ()
	Destructor.
	PropertyNotification (const PropertyNotification &handle)
	This copy constructor is required for (smart) pointer semantics.
PropertyNotification &	operator= (const PropertyNotification &rhs)
	This assignment operator is required for (smart) pointer semantics.
PropertyCondition	GetCondition ()
	Gets the condition of this notification.
const PropertyCondition &	GetCondition () const
	Gets the condition of this notification.
Dali::Handle	GetTarget () const
	Gets the target handle that this notification is observing.
Property::Index	GetTargetProperty () const
	Gets the target handle's property index that this notification is observing.
void	SetNotifyMode (NotifyMode mode)
	Sets the Notification mode.
NotifyMode	GetNotifyMode ()
	Retrieves the current Notification mode.
bool	GetNotifyResult () const
	Gets the result of the last condition check that caused a signal emit, useful when using NotifyOnChanged mode and need to know what it changed to.
PropertyNotifySignalType &	NotifySignal ()
	Connects to this signal to be notified when the notification has occurred.
Static Public Member Functions
static PropertyNotification	DownCast (BaseHandle handle)
	Downcasts a handle to PropertyNotification handle.

Detailed Description

This is used to issue a notification upon a condition of the property being met.

For example checking if Actor::POSITION_X > 100.0.

Since:: 2.4, DALi version 1.0.0

See also:: Dali::PropertyCondition

Member Enumeration Documentation

enum Dali::PropertyNotification::NotifyMode

Enumeration for description of how to check condition.

Since:: 2.4, DALi version 1.0.0

Enumerator:

Disabled	Don't notify, regardless of result of Condition. Since: 2.4, DALi version 1.0.0
NotifyOnTrue	Notify whenever condition changes from false to true. Since: 2.4, DALi version 1.0.0
NotifyOnFalse	Notify whenever condition changes from true to false. Since: 2.4, DALi version 1.0.0
NotifyOnChanged	Notify whenever condition changes (false to true, and true to false) Since: 2.4, DALi version 1.0.0

Constructor & Destructor Documentation

Dali::PropertyNotification::PropertyNotification ( )

Creates an uninitialized PropertyNotification; this can be initialized with PropertyNotification::New().

Calling member functions with an uninitialized Dali::Object is not allowed.

Since:: 2.4, DALi version 1.0.0

Dali::PropertyNotification::~PropertyNotification ( )

Destructor.

This is non-virtual since derived Handle types must not contain data or virtual methods.

Since:: 2.4, DALi version 1.0.0

Dali::PropertyNotification::PropertyNotification ( const PropertyNotification & handle )

This copy constructor is required for (smart) pointer semantics.

Since:: 2.4, DALi version 1.0.0

Parameters:

[in] handle A reference to the copied handle

Member Function Documentation

static PropertyNotification Dali::PropertyNotification::DownCast ( BaseHandle handle ) [static]

Downcasts a handle to PropertyNotification handle.

If handle points to a PropertyNotification object, the downcast produces valid handle. If not, the returned handle is left uninitialized.

Since:: 2.4, DALi version 1.0.0

Parameters:

[in] handle to An object

Returns:: handle to a PropertyNotification object or an uninitialized handle

PropertyCondition Dali::PropertyNotification::GetCondition ( )

Gets the condition of this notification.

Since:: 2.4, DALi version 1.0.0

Returns:: The condition is returned

const PropertyCondition& Dali::PropertyNotification::GetCondition ( ) const

Gets the condition of this notification.

Since:: 2.4, DALi version 1.0.0

Returns:: The condition is returned

NotifyMode Dali::PropertyNotification::GetNotifyMode ( )

Retrieves the current Notification mode.

Since:: 2.4, DALi version 1.0.0

Returns:: Notification mode

bool Dali::PropertyNotification::GetNotifyResult ( ) const

Gets the result of the last condition check that caused a signal emit, useful when using NotifyOnChanged mode and need to know what it changed to.

Since:: 2.4, DALi version 1.0.0

Returns:: whether condition result that triggered last emit was true or false

Dali::Handle Dali::PropertyNotification::GetTarget ( ) const

Gets the target handle that this notification is observing.

Since:: 2.4, DALi version 1.0.0

Returns:: The target handle

Property::Index Dali::PropertyNotification::GetTargetProperty ( ) const

Gets the target handle's property index that this notification is observing.

Since:: 2.4, DALi version 1.0.0

Returns:: The target property

PropertyNotifySignalType& Dali::PropertyNotification::NotifySignal ( )

Connects to this signal to be notified when the notification has occurred.

Since:: 2.4, DALi version 1.0.0

Returns:: A signal object to Connect() with

PropertyNotification& Dali::PropertyNotification::operator= ( const PropertyNotification & rhs )

This assignment operator is required for (smart) pointer semantics.

Since:: 2.4, DALi version 1.0.0

Parameters:

[in] rhs A reference to the copied handle

Returns:: A reference to this

void Dali::PropertyNotification::SetNotifyMode ( NotifyMode mode )

Sets the Notification mode.

This determines how the property notification should respond to the result of a condition.

Since:: 2.4, DALi version 1.0.0

Parameters:

[in] mode Notification mode (Default is PropertyNotification::NotifyOnTrue)

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation