Dali 3D User Interface Engine
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes
Dali::Internal::Adaptor::Window Class Reference

Window provides a surface to render onto with orientation & indicator properties. More...

#include <window-impl.h>

Inheritance diagram for Dali::Internal::Adaptor::Window:
Inheritance graph
[legend]
Collaboration diagram for Dali::Internal::Adaptor::Window:
Collaboration graph
[legend]

Public Types

typedef
Dali::Window::IndicatorSignalType 
IndicatorSignalType
 
typedef Signal< void() > SignalType
 

Public Member Functions

void SetAdaptor (Dali::Adaptor &adaptor)
 Pass the adaptor back to the overlay. More...
 
RenderSurface * GetSurface ()
 Get the window surface. More...
 
void ShowIndicator (Dali::Window::IndicatorVisibleMode visibleMode)
 This sets whether the indicator bar should be shown or not. More...
 
void SetIndicatorBgOpacity (Dali::Window::IndicatorBgOpacity opacity)
 This sets the opacity mode of indicator bar. More...
 
void RotateIndicator (Dali::Window::WindowOrientation orientation)
 This sets the orientation of indicator bar. More...
 
void SetClass (std::string name, std::string klass)
 Set the window name and class string. More...
 
void Raise ()
 Raise window to top of window stack. More...
 
void Lower ()
 Lower window to bottom of window stack. More...
 
void Activate ()
 Activate window to top of window stack even it is iconified. More...
 
void AddAvailableOrientation (Dali::Window::WindowOrientation orientation)
 Add an orientation to the list of available orientations. More...
 
void RemoveAvailableOrientation (Dali::Window::WindowOrientation orientation)
 Remove an orientation from the list of available orientations. More...
 
void SetAvailableOrientations (const std::vector< Dali::Window::WindowOrientation > &orientations)
  More...
 
const std::vector
< Dali::Window::WindowOrientation > & 
GetAvailableOrientations ()
  More...
 
void SetPreferredOrientation (Dali::Window::WindowOrientation orientation)
 Set a preferred orientation. More...
 
Dali::Window::WindowOrientation GetPreferredOrientation ()
 Get the preferred orientation. More...
 
Dali::DragAndDropDetector GetDragAndDropDetector () const
 Returns the Drag & drop detector which can be used to receive drag & drop events. More...
 
Dali::Any GetNativeHandle () const
 Get the native handle of the window. More...
 
void RotationDone (int orientation, int width, int height)
 Called from Orientation after the Change signal has been sent. More...
 
IndicatorSignalTypeIndicatorVisibilityChangedSignal ()
 The user should connect to this signal to get a timing when indicator was shown / hidden. More...
 
SignalTypeDeleteRequestSignal ()
 This signal is emitted when the window is requesting to be deleted. More...
 
- Public Member Functions inherited from Dali::BaseObject
template<class T >
bool ConnectSignal (ConnectionTrackerInterface *connectionTracker, const std::string &signalName, const T &functor)
 Connects a void() functor to a specified signal. More...
 
bool DoAction (const std::string &actionName, const Property::Map &attributes)
 Perform action on this object with the given action name and attributes. More...
 
const std::string & GetTypeName () const
 Returns the type name for the Handle. More...
 
bool GetTypeInfo (Dali::TypeInfo &info) const
 Returns the type info for the Handle. More...
 
bool DoConnectSignal (ConnectionTrackerInterface *connectionTracker, const std::string &signalName, FunctorDelegate *functorDelegate)
 Not intended for application developers. More...
 
- Public Member Functions inherited from Dali::RefObject
void Reference ()
 Increment the object's reference count. More...
 
void Unreference ()
 Decrement the object's reference count. More...
 
int ReferenceCount ()
 Retrieve the object's reference count. More...
 

Static Public Member Functions

static WindowNew (const PositionSize &posSize, const std::string &name, const std::string &className, bool isTransparent=false)
 Create a new Window. More...
 

Private Types

typedef std::vector
< IndicatorInterface * > 
DiscardedIndicators
 

Private Member Functions

 Window ()
 Private constructor. More...
 
virtual ~Window ()
 Destructor. More...
 
void Initialize (const PositionSize &posSize, const std::string &name, const std::string &className)
 Second stage initialization. More...
 
void DoShowIndicator (Dali::Window::WindowOrientation lastOrientation)
 Shows / hides the indicator bar. More...
 
void DoRotateIndicator (Dali::Window::WindowOrientation orientation)
 Close current indicator and open a connection onto the new indicator service. More...
 
void SetIndicatorActorRotation ()
 Change the indicator actor's rotation to match the current orientation. More...
 
void SetIndicatorProperties (bool isShown, Dali::Window::WindowOrientation lastOrientation)
 Set the indicator properties on the window. More...
 
virtual void IndicatorTypeChanged (IndicatorInterface::Type type)
 Notify the observer if the indicator type changes. More...
 
virtual void IndicatorClosed (IndicatorInterface *indicator)
 Notify the observer when the upload has completed. More...
 
virtual void IndicatorVisibilityChanged (bool isVisible)
 Notify the observer when the indicator visible status is changed. More...
 
virtual void OnStart ()
  More...
 
virtual void OnPause ()
  More...
 
virtual void OnResume ()
  More...
 
virtual void OnStop ()
  More...
 
virtual void OnDestroy ()
  More...
 

Private Attributes

RenderSurface * mSurface
 
Dali::Window::IndicatorVisibleMode mIndicatorVisible
 public state More...
 
bool mIndicatorIsShown:1
 private state More...
 
bool mShowRotatedIndicatorOnClose:1
 
bool mStarted:1
 
bool mIsTransparent:1
 
bool mWMRotationAppSet:1
 
bool mEcoreEventHander:1
 
IndicatorInterfacemIndicator
 
Dali::Window::WindowOrientation mIndicatorOrientation
 
Dali::Window::WindowOrientation mNextIndicatorOrientation
 
Dali::Window::IndicatorBgOpacity mIndicatorOpacityMode
 
Integration::SystemOverlaymOverlay
 
AdaptormAdaptor
 
Dali::DragAndDropDetector mDragAndDropDetector
 
EventHandlermEventHandler
 
OrientationPtr mOrientation
 
std::vector
< Dali::Window::WindowOrientation
mAvailableOrientations
 
Dali::Window::WindowOrientation mPreferredOrientation
 
IndicatorSignalType mIndicatorVisibilityChangedSignal
 
SignalType mDeleteRequestSignal
 

Additional Inherited Members

- Protected Member Functions inherited from Dali::BaseObject
 BaseObject ()
 Default constructor. More...
 
virtual ~BaseObject ()
 A reference counted object may only be deleted by calling Unreference(). More...
 
void RegisterObject ()
 Registers the object as created with the Object registry. More...
 
void UnregisterObject ()
 Unregisters the object from Object registry. More...
 
- Protected Member Functions inherited from Dali::Internal::Adaptor::LifeCycleObserver
 LifeCycleObserver ()
 Constructor. More...
 
virtual ~LifeCycleObserver ()
 Virtual destructor. More...
 

Detailed Description

Window provides a surface to render onto with orientation & indicator properties.

Definition at line 57 of file window-impl.h.

Member Typedef Documentation

Definition at line 262 of file window-impl.h.

Definition at line 60 of file window-impl.h.

Definition at line 61 of file window-impl.h.

Constructor & Destructor Documentation

Dali::Internal::Adaptor::Window::Window ( )
private

Private constructor.

See Also
Window::New()
virtual Dali::Internal::Adaptor::Window::~Window ( )
privatevirtual

Destructor.

Member Function Documentation

void Dali::Internal::Adaptor::Window::Activate ( )

Activate window to top of window stack even it is iconified.

.0

void Dali::Internal::Adaptor::Window::AddAvailableOrientation ( Dali::Window::WindowOrientation  orientation)

Add an orientation to the list of available orientations.

.0

SignalType& Dali::Internal::Adaptor::Window::DeleteRequestSignal ( )
inline

This signal is emitted when the window is requesting to be deleted.

Definition at line 258 of file window-impl.h.

References mDeleteRequestSignal.

void Dali::Internal::Adaptor::Window::DoRotateIndicator ( Dali::Window::WindowOrientation  orientation)
private

Close current indicator and open a connection onto the new indicator service.

Effect may not be synchronous if waiting for an indicator update on existing connection.

void Dali::Internal::Adaptor::Window::DoShowIndicator ( Dali::Window::WindowOrientation  lastOrientation)
private

Shows / hides the indicator bar.

Handles close/open if rotation changes whilst hidden

const std::vector<Dali::Window::WindowOrientation>& Dali::Internal::Adaptor::Window::GetAvailableOrientations ( )

Dali::DragAndDropDetector Dali::Internal::Adaptor::Window::GetDragAndDropDetector ( ) const

Returns the Drag & drop detector which can be used to receive drag & drop events.

.0

Returns
A handle to the DragAndDropDetector.
Dali::Any Dali::Internal::Adaptor::Window::GetNativeHandle ( ) const

Get the native handle of the window.

.0

Returns
The native handle of the window or an empty handle.
Dali::Window::WindowOrientation Dali::Internal::Adaptor::Window::GetPreferredOrientation ( )

Get the preferred orientation.

.0

Returns
The preferred orientation if previously set, or none.
RenderSurface* Dali::Internal::Adaptor::Window::GetSurface ( )

Get the window surface.

Returns
The render surface

Referenced by Dali::Internal::Adaptor::Adaptor::New(), and Dali::Internal::Adaptor::Application::ReplaceWindow().

Here is the caller graph for this function:

virtual void Dali::Internal::Adaptor::Window::IndicatorClosed ( IndicatorInterface indicator)
privatevirtual

Notify the observer when the upload has completed.

Parameters
[in]indicatorThe indicator that has finished uploading.

Implements Dali::Internal::Adaptor::IndicatorInterface::Observer.

virtual void Dali::Internal::Adaptor::Window::IndicatorTypeChanged ( IndicatorInterface::Type  type)
privatevirtual

Notify the observer if the indicator type changes.

Parameters
[in]typeThe new indicator type

Implements Dali::Internal::Adaptor::IndicatorInterface::Observer.

virtual void Dali::Internal::Adaptor::Window::IndicatorVisibilityChanged ( bool  isVisible)
privatevirtual

Notify the observer when the indicator visible status is changed.

Parameters
[in]isShowingWhether the indicator is visible.

Implements Dali::Internal::Adaptor::IndicatorInterface::Observer.

IndicatorSignalType& Dali::Internal::Adaptor::Window::IndicatorVisibilityChangedSignal ( )
inline

The user should connect to this signal to get a timing when indicator was shown / hidden.

Definition at line 253 of file window-impl.h.

References mIndicatorVisibilityChangedSignal.

void Dali::Internal::Adaptor::Window::Initialize ( const PositionSize posSize,
const std::string &  name,
const std::string &  className 
)
private

Second stage initialization.

void Dali::Internal::Adaptor::Window::Lower ( )

Lower window to bottom of window stack.

.0

static Window* Dali::Internal::Adaptor::Window::New ( const PositionSize posSize,
const std::string &  name,
const std::string &  className,
bool  isTransparent = false 
)
static

Create a new Window.

This should only be called once by the Application class

Parameters
[in]windowPositionThe position and size of the window
[in]nameThe window title
[in]classNameThe window class name
[in]isTransparentWhether window is transparent
Returns
A newly allocated Window

Referenced by Dali::Window::New().

Here is the caller graph for this function:

virtual void Dali::Internal::Adaptor::Window::OnDestroy ( )
privatevirtual
virtual void Dali::Internal::Adaptor::Window::OnPause ( )
privatevirtual
virtual void Dali::Internal::Adaptor::Window::OnResume ( )
privatevirtual
virtual void Dali::Internal::Adaptor::Window::OnStart ( )
privatevirtual
virtual void Dali::Internal::Adaptor::Window::OnStop ( )
privatevirtual
void Dali::Internal::Adaptor::Window::Raise ( )

Raise window to top of window stack.

.0

void Dali::Internal::Adaptor::Window::RemoveAvailableOrientation ( Dali::Window::WindowOrientation  orientation)

Remove an orientation from the list of available orientations.

.0

void Dali::Internal::Adaptor::Window::RotateIndicator ( Dali::Window::WindowOrientation  orientation)

This sets the orientation of indicator bar.

It does not implicitly show the indicator if it is currently hidden. .0

Parameters
[in]orientationThe orientation
void Dali::Internal::Adaptor::Window::RotationDone ( int  orientation,
int  width,
int  height 
)

Called from Orientation after the Change signal has been sent.

Referenced by Dali::Internal::Adaptor::Orientation::OnRotationRequest().

Here is the caller graph for this function:

void Dali::Internal::Adaptor::Window::SetAdaptor ( Dali::Adaptor &  adaptor)

Pass the adaptor back to the overlay.

This allows the window to access Core's overlay.

Parameters
[in]adaptorAn initialized adaptor

Referenced by Dali::Internal::Adaptor::Adaptor::New(), and Dali::Internal::Adaptor::Application::ReplaceWindow().

Here is the caller graph for this function:

void Dali::Internal::Adaptor::Window::SetAvailableOrientations ( const std::vector< Dali::Window::WindowOrientation > &  orientations)

void Dali::Internal::Adaptor::Window::SetClass ( std::string  name,
std::string  klass 
)

Set the window name and class string.

.0

Parameters
[in]nameThe name of the window
[in]klassThe class of the window
void Dali::Internal::Adaptor::Window::SetIndicatorActorRotation ( )
private

Change the indicator actor's rotation to match the current orientation.

void Dali::Internal::Adaptor::Window::SetIndicatorBgOpacity ( Dali::Window::IndicatorBgOpacity  opacity)

This sets the opacity mode of indicator bar.

.0

Parameters
[in]opacity- The opacity mode
void Dali::Internal::Adaptor::Window::SetIndicatorProperties ( bool  isShown,
Dali::Window::WindowOrientation  lastOrientation 
)
private

Set the indicator properties on the window.

void Dali::Internal::Adaptor::Window::SetPreferredOrientation ( Dali::Window::WindowOrientation  orientation)

Set a preferred orientation.

.0

Parameters
[in]orientationThe preferred orientation
Precondition
orientation is in the list of available orientations
void Dali::Internal::Adaptor::Window::ShowIndicator ( Dali::Window::IndicatorVisibleMode  visibleMode)

This sets whether the indicator bar should be shown or not.

.0

Parameters
[in]visibleModevisible mode for indicator bar, VISIBLE in default

Member Data Documentation

Adaptor* Dali::Internal::Adaptor::Window::mAdaptor
private

Definition at line 277 of file window-impl.h.

std::vector<Dali::Window::WindowOrientation> Dali::Internal::Adaptor::Window::mAvailableOrientations
private

Definition at line 284 of file window-impl.h.

SignalType Dali::Internal::Adaptor::Window::mDeleteRequestSignal
private

Definition at line 289 of file window-impl.h.

Referenced by DeleteRequestSignal().

Dali::DragAndDropDetector Dali::Internal::Adaptor::Window::mDragAndDropDetector
private

Definition at line 278 of file window-impl.h.

bool Dali::Internal::Adaptor::Window::mEcoreEventHander
private

Definition at line 271 of file window-impl.h.

EventHandler* Dali::Internal::Adaptor::Window::mEventHandler
private

Definition at line 280 of file window-impl.h.

IndicatorInterface* Dali::Internal::Adaptor::Window::mIndicator
private

Definition at line 272 of file window-impl.h.

bool Dali::Internal::Adaptor::Window::mIndicatorIsShown
private

private state

Definition at line 266 of file window-impl.h.

Dali::Window::IndicatorBgOpacity Dali::Internal::Adaptor::Window::mIndicatorOpacityMode
private

Definition at line 275 of file window-impl.h.

Dali::Window::WindowOrientation Dali::Internal::Adaptor::Window::mIndicatorOrientation
private

Definition at line 273 of file window-impl.h.

IndicatorSignalType Dali::Internal::Adaptor::Window::mIndicatorVisibilityChangedSignal
private

Definition at line 288 of file window-impl.h.

Referenced by IndicatorVisibilityChangedSignal().

Dali::Window::IndicatorVisibleMode Dali::Internal::Adaptor::Window::mIndicatorVisible
private

public state

Definition at line 265 of file window-impl.h.

bool Dali::Internal::Adaptor::Window::mIsTransparent
private

Definition at line 269 of file window-impl.h.

Dali::Window::WindowOrientation Dali::Internal::Adaptor::Window::mNextIndicatorOrientation
private

Definition at line 274 of file window-impl.h.

OrientationPtr Dali::Internal::Adaptor::Window::mOrientation
private

Definition at line 283 of file window-impl.h.

Integration::SystemOverlay* Dali::Internal::Adaptor::Window::mOverlay
private

Definition at line 276 of file window-impl.h.

Dali::Window::WindowOrientation Dali::Internal::Adaptor::Window::mPreferredOrientation
private

Definition at line 285 of file window-impl.h.

bool Dali::Internal::Adaptor::Window::mShowRotatedIndicatorOnClose
private

Definition at line 267 of file window-impl.h.

bool Dali::Internal::Adaptor::Window::mStarted
private

Definition at line 268 of file window-impl.h.

RenderSurface* Dali::Internal::Adaptor::Window::mSurface
private

Definition at line 264 of file window-impl.h.

bool Dali::Internal::Adaptor::Window::mWMRotationAppSet
private

Definition at line 270 of file window-impl.h.


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