Dali 3D User Interface Engine
List of all members | Classes | Public Types | Public Member Functions
Dali::Internal::Adaptor::IndicatorInterface Class Referenceabstract

The Indicator interface. More...

#include <indicator-interface.h>

Classes

class  Observer
 observer for listening to indicator events More...
 

Public Types

enum  Type { INDICATOR_TYPE_UNKNOWN, INDICATOR_TYPE_1, INDICATOR_TYPE_2 }
 Type of indiciator. More...
 

Public Member Functions

 IndicatorInterface ()
 constructor More...
 
virtual ~IndicatorInterface ()
 Virtual Destructor. More...
 
virtual void SetAdaptor (Adaptor *adaptor)=0
 assign the adaptor to this object More...
 
virtual Dali::Actor GetActor ()=0
 Get the actor which contains the indicator image. More...
 
virtual void Open (Dali::Window::WindowOrientation orientation)=0
 Opens a new connection for the required orientation. More...
 
virtual void Close ()=0
 Close the current connection. More...
 
virtual void SetOpacityMode (Dali::Window::IndicatorBgOpacity mode)=0
 Set the opacity mode of the indicator background. More...
 
virtual void SetVisible (Dali::Window::IndicatorVisibleMode visibleMode, bool forceUpdate=false)=0
 Set whether the indicator is visible or not. More...
 
virtual bool IsConnected ()=0
 Check whether the indicator is connected to the indicator service. More...
 
virtual bool SendMessage (int messageDomain, int messageId, const void *data, int size)=0
 Send message to the indicator service. More...
 

Detailed Description

The Indicator interface.

Can be used to draw an indicator graphic generated from the platform as an overlay on top of DALi scene contents.

Definition at line 41 of file indicator-interface.h.

Member Enumeration Documentation

Type of indiciator.

Enumerator
INDICATOR_TYPE_UNKNOWN 
INDICATOR_TYPE_1 
INDICATOR_TYPE_2 

Definition at line 48 of file indicator-interface.h.

Constructor & Destructor Documentation

Dali::Internal::Adaptor::IndicatorInterface::IndicatorInterface ( )
inline

constructor

Definition at line 89 of file indicator-interface.h.

virtual Dali::Internal::Adaptor::IndicatorInterface::~IndicatorInterface ( )
inlinevirtual

Virtual Destructor.

Definition at line 94 of file indicator-interface.h.

Member Function Documentation

virtual void Dali::Internal::Adaptor::IndicatorInterface::Close ( )
pure virtual

Close the current connection.

Will respond with Observer::IndicatorClosed() when done.

Note
, IndicatorClosed() will be called synchronously if there's no update in progress, or asychronously if waiting for SignalUploaded )
virtual Dali::Actor Dali::Internal::Adaptor::IndicatorInterface::GetActor ( )
pure virtual

Get the actor which contains the indicator image.

Ensure that the handle is released when no longer needed. Changes from the indicator service will modify the image and resize the actor appropriately.

Returns
The indicator actor.
virtual bool Dali::Internal::Adaptor::IndicatorInterface::IsConnected ( )
pure virtual

Check whether the indicator is connected to the indicator service.

Returns
whether the indicator is connected or not.
virtual void Dali::Internal::Adaptor::IndicatorInterface::Open ( Dali::Window::WindowOrientation  orientation)
pure virtual

Opens a new connection for the required orientation.

Parameters
[in]orientationThe new orientation
virtual bool Dali::Internal::Adaptor::IndicatorInterface::SendMessage ( int  messageDomain,
int  messageId,
const void *  data,
int  size 
)
pure virtual

Send message to the indicator service.

Parameters
[in]messageDomainMessage Reference number
[in]messageIdReference number of the message this message refers to
[in]dataThe data to send as part of the message
[in]sizeLength of the data, in bytes, to send
Returns
whether the message is sent successfully or not
virtual void Dali::Internal::Adaptor::IndicatorInterface::SetAdaptor ( Adaptor adaptor)
pure virtual

assign the adaptor to this object

Parameters
[in]adaptor
virtual void Dali::Internal::Adaptor::IndicatorInterface::SetOpacityMode ( Dali::Window::IndicatorBgOpacity  mode)
pure virtual

Set the opacity mode of the indicator background.

Parameters
[in]modeopacity mode
virtual void Dali::Internal::Adaptor::IndicatorInterface::SetVisible ( Dali::Window::IndicatorVisibleMode  visibleMode,
bool  forceUpdate = false 
)
pure virtual

Set whether the indicator is visible or not.

Parameters
[in]visibleModevisible mode for indicator bar.
[in]forceUpdatetrue if want to change visible mode forcely

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