Base class to store a weak pointer to an internal DALi object. More...
Public Member Functions | |
WeakHandleBase () | |
Default constructor which provides an uninitialized Dali::WeakHandleBase. | |
WeakHandleBase (Handle &handle) | |
This constructor creates a weak handle of the DALi object. | |
~WeakHandleBase () | |
Destructor to free resources. | |
WeakHandleBase (const WeakHandleBase &handle) | |
Copy constructor. | |
WeakHandleBase & | operator= (const WeakHandleBase &rhs) |
Assignment operator. | |
bool | operator== (const WeakHandleBase &rhs) const |
Equality operator overload. | |
bool | operator!= (const WeakHandleBase &rhs) const |
Inequality operator overload. | |
Handle | GetBaseHandle () const |
Gets the handle to the DALi object. | |
void | Reset () |
Resets this weak handle to not point to any DALi object. |
Detailed Description
Base class to store a weak pointer to an internal DALi object.
The handle to the object can be accessed if the object exists, and such access is not reference counted. When the object is deleted, the weak pointer will be set to NULL, and any further attempt to access to a deleted object will return an empty handle.
- Since:
- 4.0, DALi version 1.2.60
Constructor & Destructor Documentation
Default constructor which provides an uninitialized Dali::WeakHandleBase.
- Since:
- 4.0, DALi version 1.2.60
Dali::WeakHandleBase::WeakHandleBase | ( | Handle & | handle | ) |
This constructor creates a weak handle of the DALi object.
- Since:
- 4.0, DALi version 1.2.60
- Parameters:
-
[in] handle A reference to the handle of the DALi object
Destructor to free resources.
- Since:
- 4.0, DALi version 1.2.60
Dali::WeakHandleBase::WeakHandleBase | ( | const WeakHandleBase & | handle | ) |
Copy constructor.
- Since:
- 4.0, DALi version 1.2.60
- Parameters:
-
[in] handle A reference to the copied WeakHandleBase
Member Function Documentation
Handle Dali::WeakHandleBase::GetBaseHandle | ( | ) | const |
Gets the handle to the DALi object.
- Since:
- 4.0, DALi version 1.2.60
- Returns:
- The handle of the DALi object pointed by this WeakHandleBase or an empty handle if the DALi object doesn't exist
bool Dali::WeakHandleBase::operator!= | ( | const WeakHandleBase & | rhs | ) | const |
Inequality operator overload.
- Since:
- 4.0, DALi version 1.2.60
- Parameters:
-
[in] rhs A reference to the compared WeakHandleBase
- Returns:
- true if the handle points to the different DALi resources
WeakHandleBase& Dali::WeakHandleBase::operator= | ( | const WeakHandleBase & | rhs | ) |
Assignment operator.
It makes this WeakHandleBase point to the same internal DALi object as the copied WeakHandleBase
- Since:
- 4.0, DALi version 1.2.60
- Parameters:
-
[in] rhs A reference to the copied WeakHandleBase
- Returns:
- A reference to this WeakHandleBase
bool Dali::WeakHandleBase::operator== | ( | const WeakHandleBase & | rhs | ) | const |
Equality operator overload.
- Since:
- 4.0, DALi version 1.2.60
- Parameters:
-
[in] rhs A reference to the compared WeakHandleBase
- Returns:
- true if the handle points to the same DALi resource, or if both are uninitialized
void Dali::WeakHandleBase::Reset | ( | ) |
Resets this weak handle to not point to any DALi object.
- Since:
- 4.0, DALi version 1.2.60