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

Inheritance diagram for Dali::Window:

Public Types
enum	WindowOrientation
	Enumeration for orientation of the window is the way in which a rectangular page is oriented for normal viewing. More...
enum	IndicatorBgOpacity
	Enumeration for opacity of the indicator. More...
enum	IndicatorVisibleMode
	Enumeration for visible mode of the indicator. More...
Public Member Functions
	Window ()
	Creates an uninitialized 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)
	Sets the window name and class string.
void	Raise ()
	Raises window to the top of Window stack.
void	Lower ()
	Lowers window to the bottom of Window stack.
void	Activate ()
	Activates window to the top of Window stack even it is iconified.
void	AddAvailableOrientation (WindowOrientation orientation)
	Adds an orientation to the list of available orientations.
void	RemoveAvailableOrientation (WindowOrientation orientation)
	Removes an orientation from the list of available orientations.
void	SetPreferredOrientation (WindowOrientation orientation)
	Sets a preferred orientation.
WindowOrientation	GetPreferredOrientation ()
	Gets the preferred orientation.
DragAndDropDetector	GetDragAndDropDetector () const
	Returns the Drag & drop detector which can be used to receive drag & drop events.
Any	GetNativeHandle () const
	Gets 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)
	Creates an initialized handle to a new Window.
static Window	New (PositionSize windowPosition, const std::string &name, const std::string &className, bool isTransparent=false)
	Creates 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:: 3.0, DALi version 1.0.0

Member Enumeration Documentation

enum Dali::Window::IndicatorBgOpacity

Enumeration for opacity of the indicator.

Since:: 3.0, DALi version 1.0.0

Enumerator:

OPAQUE

Fully opaque indicator Bg.

Since:: 3.0, DALi version 1.0.0

TRANSLUCENT

Semi translucent indicator Bg.

Since:: 3.0, DALi version 1.0.0

TRANSPARENT

Fully transparent indicator Bg.

Since:: 3.0, DALi version 1.0.0

enum Dali::Window::IndicatorVisibleMode

Enumeration for visible mode of the indicator.

Since:: 3.0, DALi version 1.0.0

Enumerator:

INVISIBLE

Hide indicator.

Since:: 3.0, DALi version 1.0.0

VISIBLE

Show indicator.

Since:: 3.0, DALi version 1.0.0

AUTO

Hide in default, will show when necessary.

Since:: 3.0, DALi version 1.0.0

enum Dali::Window::WindowOrientation

Enumeration for orientation of the window is the way in which a rectangular page is oriented for normal viewing.

Since:: 3.0, DALi version 1.0.0

Enumerator:

PORTRAIT	Portrait orientation. The height of the display area is greater than the width. Since: 3.0, DALi version 1.0.0
LANDSCAPE	Landscape orientation. A wide view area is needed. Since: 3.0, DALi version 1.0.0
PORTRAIT_INVERSE	Portrait inverse orientation. Since: 3.0, DALi version 1.0.0
LANDSCAPE_INVERSE	Landscape inverse orientation. Since: 3.0, DALi version 1.0.0

Constructor & Destructor Documentation

Dali::Window::Window ( )

Creates an uninitialized handle.

This can be initialized using Dali::Application::GetWindow() or Dali::Window::New().

Since:: 3.0, DALi version 1.0.0

Dali::Window::~Window ( )

Destructor.

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

Since:: 3.0, DALi version 1.0.0

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

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

Since:: 3.0, DALi version 1.0.0

Parameters:

[in] handle A reference to the copied handle

Member Function Documentation

void Dali::Window::Activate ( )

Activates window to the top of Window stack even it is iconified.

Since:: 3.0, DALi version 1.0.0

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

Adds an orientation to the list of available orientations.

Since:: 3.0, DALi version 1.0.0

Parameters:

[in] orientation The available orientation to add

DragAndDropDetector Dali::Window::GetDragAndDropDetector ( ) const

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

Note:: Not intended for application developers.

Since:: 3.0, DALi version 1.0.0

Returns:: A handle to the DragAndDropDetector

Any Dali::Window::GetNativeHandle ( ) const

Gets the native handle of the window.

When users call this function, it wraps the actual type used by the underlying window system.

Since:: 3.0, DALi version 1.0.0

Returns:: The native handle of the Window or an empty handle

WindowOrientation Dali::Window::GetPreferredOrientation ( )

Gets the preferred orientation.

Since:: 3.0, DALi version 1.0.0

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:: 3.0, DALi version 1.0.0

Returns:: The signal to connect to

void Dali::Window::Lower ( )

Lowers window to the bottom of Window stack.

Since:: 3.0, DALi version 1.0.0

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

Creates an initialized handle to a new Window.

Since:: 3.0, DALi version 1.0.0

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]`

Creates an initialized handle to a new Window.

Since:: 3.0, DALi version 1.0.0

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:: 3.0, DALi version 1.0.0

Parameters:

[in] rhs A reference to the copied handle

Returns:: A reference to this

void Dali::Window::Raise ( )

Raises window to the top of Window stack.

Since:: 3.0, DALi version 1.0.0

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

Removes an orientation from the list of available orientations.

Since:: 3.0, DALi version 1.0.0

Parameters:

[in] orientation The available orientation to remove

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:: 3.0, DALi version 1.0.0

Parameters:

[in] orientation The orientation

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

Sets the window name and class string.

Since:: 3.0, DALi version 1.0.0

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:: 3.0, DALi version 1.0.0

Parameters:

[in] opacity The opacity mode

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

Sets a preferred orientation.

Since:: 3.0, DALi version 1.0.0

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:: 3.0, DALi version 1.0.0

Parameters:

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

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation