The window class is used internally for drawing. More...

Inheritance diagram for Dali::Window:

Public Types
enum	WindowOrientation
	Orientation of the window. More...
enum	IndicatorBgOpacity
	Opacity of the indicator. More...
enum	IndicatorVisibleMode
	Visible mode of the indicator. More...
typedef Signal< void(bool) >	IndicatorSignalType
	Indicator signal callback type.
Public Member Functions
	Window ()
	Create an uninitalized handle.
	~Window ()
	Destructor.
	Window (const Window &handle)
	This copy constructor is required for (smart) pointer semantics.
Window &	operator= (const Window &rhs)
	This assignment operator is required for (smart) pointer semantics.
void	ShowIndicator (IndicatorVisibleMode visibleMode)
	This sets whether the indicator bar should be shown or not.
void	SetIndicatorBgOpacity (IndicatorBgOpacity opacity)
	This sets the opacity mode of indicator bar.
void	RotateIndicator (WindowOrientation orientation)
	This sets the orientation of indicator bar.
void	SetClass (std::string name, std::string klass)
	Set the window name and class string.
void	Raise ()
	Raise window to top of window stack.
void	Lower ()
	Lower window to bottom of window stack.
void	Activate ()
	Activate window to top of window stack even it is iconified.
void	AddAvailableOrientation (WindowOrientation orientation)
	Add an orientation to the list of available orientations.
void	RemoveAvailableOrientation (WindowOrientation orientation)
	Remove an orientation from the list of available orientations.
void	SetPreferredOrientation (WindowOrientation orientation)
	Set a preferred orientation.
WindowOrientation	GetPreferredOrientation ()
	Get the preferred orientation.
DragAndDropDetector	GetDragAndDropDetector () const
	Returns the Drag & drop detector which can be used to receive drag & drop events.
Any	GetNativeHandle () const
	Get the native handle of the window.
IndicatorSignalType &	IndicatorVisibilityChangedSignal ()
	The user should connect to this signal to get a timing when indicator was shown / hidden.
Static Public Member Functions
static Window	New (PositionSize windowPosition, const std::string &name, bool isTransparent=false)
	Create an initialized handle to a new Window.
static Window	New (PositionSize windowPosition, const std::string &name, const std::string &className, bool isTransparent=false)
	Create an initialized handle to a new Window.

Detailed Description

The window class is used internally for drawing.

A Window has an orientation and indicator properties. You can get a valid Window handle by calling Dali::Application::GetWindow().

Since :: 2.4

Member Typedef Documentation

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

Indicator signal callback type.

Since :: 2.4

Member Enumeration Documentation

enum Dali::Window::IndicatorBgOpacity

Opacity of the indicator.

Since :: 2.4

Enumerator:

OPAQUE

Fully opaque indicator Bg.

Since :: 2.4

TRANSLUCENT

Semi translucent indicator Bg.

Since :: 2.4

TRANSPARENT

Fully transparent indicator Bg.

Since :: 2.4

enum Dali::Window::IndicatorVisibleMode

Visible mode of the indicator.

Since :: 2.4

Enumerator:

INVISIBLE

Hide indicator.

Since :: 2.4

VISIBLE

Show indicator.

Since :: 2.4

AUTO

Hide in default, will show when necessary.

Since :: 2.4

enum Dali::Window::WindowOrientation

Orientation of the window.

Since :: 2.4

Enumerator:

PORTRAIT	Portrait orientation. Since : 2.4
LANDSCAPE	Landscape orientation. Since : 2.4
PORTRAIT_INVERSE	Portrait inverse orientation. Since : 2.4
LANDSCAPE_INVERSE	Landscape inverse orientation. Since : 2.4

Constructor & Destructor Documentation

Dali::Window::Window ( )

Create an uninitalized handle.

This can be initialized using Dali::Window::New()

Since :: 2.4

Dali::Window::~Window ( )

Destructor.

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

Since :: 2.4

Dali::Window::Window ( const Window & handle )

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

Since :: 2.4

Parameters:

[in] handle A reference to the copied handle

Member Function Documentation

void Dali::Window::Activate ( )

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

Since :: 2.4

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

Add an orientation to the list of available orientations.

Since :: 2.4

DragAndDropDetector Dali::Window::GetDragAndDropDetector ( ) const

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

Since :: 2.4

Returns:: A handle to the DragAndDropDetector.

Any Dali::Window::GetNativeHandle ( ) const

Get the native handle of the window.

Since :: 2.4

Returns:: The native handle of the window or an empty handle.

WindowOrientation Dali::Window::GetPreferredOrientation ( )

Get the preferred orientation.

Since :: 2.4

Returns:: The preferred orientation if previously set, or none.

IndicatorSignalType& Dali::Window::IndicatorVisibilityChangedSignal ( )

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

Since :: 2.4

void Dali::Window::Lower ( )

Lower window to bottom of window stack.

Since :: 2.4

static Window Dali::Window::New	(	PositionSize	windowPosition,
		const std::string &	name,
		bool	isTransparent = `false`
	)		`[static]`

Create an initialized handle to a new Window.

Since :: 2.4

Parameters:

[in]	windowPosition	The position and size of the window
[in]	name	The window title
[in]	isTransparent	Whether window is transparent

Returns:: A new window

static Window Dali::Window::New	(	PositionSize	windowPosition,
		const std::string &	name,
		const std::string &	className,
		bool	isTransparent = `false`
	)		`[static]`

Create an initialized handle to a new Window.

Since :: 2.4

Parameters:

[in]	windowPosition	The position and size of the window
[in]	name	The window title
[in]	className	The window class name
[in]	isTransparent	Whether window is transparent

Returns:: A new window

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

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

Since :: 2.4

Parameters:

[in] rhs A reference to the copied handle

Returns:: A reference to this

void Dali::Window::Raise ( )

Raise window to top of window stack.

Since :: 2.4

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

Remove an orientation from the list of available orientations.

Since :: 2.4

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

This sets the orientation of indicator bar.

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

Since :: 2.4

Parameters:

[in] orientation The orientation

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

Set the window name and class string.

Since :: 2.4

Parameters:

[in]	name	The name of the window
[in]	klass	The class of the window

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

This sets the opacity mode of indicator bar.

Since :: 2.4

Parameters:

[in] opacity The opacity mode

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

Set a preferred orientation.

Since :: 2.4

Parameters:

[in] orientation The preferred orientation

Precondition:: Orientation is in the list of available orientations

void Dali::Window::ShowIndicator ( IndicatorVisibleMode visibleMode )

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

Since :: 2.4

Parameters:

[in] visibleMode Visible mode for indicator bar, VISIBLE in default

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation