Dali 3D User Interface Engine
List of all members | Public Member Functions | Private Member Functions | Private Attributes
Dali::Integration::SystemOverlay Class Reference

Use this interface to draw content for system-level indicators, dialogs etc. More...

#include <system-overlay.h>

Collaboration diagram for Dali::Integration::SystemOverlay:
Collaboration graph
[legend]

Public Member Functions

 ~SystemOverlay ()
 Non-virtual destructor. More...
 
void Add (Actor actor)
 Add an Actor to the SystemOverlay. More...
 
void Remove (Actor actor)
 Remove an Actor that was added to the SystemOverlay. More...
 
RenderTaskList GetOverlayRenderTasks ()
 Retrieve the list of render-tasks for system-level overlays. More...
 
 SystemOverlay (Internal::SystemOverlay *impl)
 Create the SystemOverlay entrance. More...
 
Internal::SystemOverlayGetImpl ()
 Retreive the internal implementation; this is not intended for adaptor implementors. More...
 

Private Member Functions

 SystemOverlay (const SystemOverlay &core)
 
SystemOverlayoperator= (const SystemOverlay &rhs)
 

Private Attributes

Dali::Internal::SystemOverlaymImpl
 

Detailed Description

Use this interface to draw content for system-level indicators, dialogs etc.

The SystemOverlay is accessible using Dali::Integration::Core::GetSystemOverlay().

Definition at line 42 of file system-overlay.h.

Constructor & Destructor Documentation

Dali::Internal::SystemOverlay::~SystemOverlay ( )

Non-virtual destructor.

SystemOverlay is not intended as a base class.

Definition at line 33 of file system-overlay.cpp.

References mImpl.

Dali::Integration::SystemOverlay::SystemOverlay ( Internal::SystemOverlay impl)

Create the SystemOverlay entrance.

This is not intended for adaptor implementors; see also Dali::Integration::Core::GetSystemOverlay().

Parameters
[in]implThe SystemOverlay implementation.

Definition at line 53 of file system-overlay.cpp.

Referenced by Dali::Internal::SystemOverlay::New().

Here is the caller graph for this function:

Dali::Integration::SystemOverlay::SystemOverlay ( const SystemOverlay core)
private

Member Function Documentation

void Dali::Integration::SystemOverlay::Add ( Actor  actor)

Add an Actor to the SystemOverlay.

Precondition
The actor handle is not empty.
Parameters
[in]actorA handle to the actor to add.
Postcondition
The actor will be referenced.

Definition at line 38 of file system-overlay.cpp.

References Add(), Dali::GetImplementation(), and mImpl.

Referenced by Add(), and Dali::Internal::SystemOverlay::CreateDefaultCameraActor().

Here is the call graph for this function:

Here is the caller graph for this function:

Internal::SystemOverlay * Dali::Integration::SystemOverlay::GetImpl ( )

Retreive the internal implementation; this is not intended for adaptor implementors.

Returns
The SystemOverlay implementation.

Definition at line 58 of file system-overlay.cpp.

References mImpl.

Referenced by Dali::Internal::Stage::GetSystemOverlay(), Dali::Internal::Stage::GetSystemOverlayInternal(), and Dali::Internal::Stage::SetSize().

Here is the caller graph for this function:

RenderTaskList & Dali::Internal::SystemOverlay::GetOverlayRenderTasks ( )
SystemOverlay& Dali::Integration::SystemOverlay::operator= ( const SystemOverlay rhs)
private
void Dali::Integration::SystemOverlay::Remove ( Actor  actor)

Remove an Actor that was added to the SystemOverlay.

Precondition
The actor handle is not empty.
Parameters
[in]actorA handle to the actor to remove.
Postcondition
The actor will be unreferenced.

Definition at line 43 of file system-overlay.cpp.

References Dali::GetImplementation(), mImpl, and Remove().

Referenced by Remove().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

Dali::Internal::SystemOverlay* Dali::Integration::SystemOverlay::mImpl
private

Definition at line 97 of file system-overlay.h.

Referenced by Add(), GetImpl(), GetOverlayRenderTasks(), Remove(), and ~SystemOverlay().


The documentation for this class was generated from the following files:
Dali Docs Home
Read more about Dali