Tizen Native API  3.0

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

Inheritance diagram for Dali::Window:
Dali::BaseHandle

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.
Windowoperator= (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.
IndicatorSignalTypeIndicatorVisibilityChangedSignal ()
 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:
2.4, DALi version 1.0.0

Member Enumeration Documentation

Enumeration for opacity of the indicator.

Since:
2.4, DALi version 1.0.0
Enumerator:
OPAQUE 

Fully opaque indicator Bg.

Since:
2.4, DALi version 1.0.0
TRANSLUCENT 

Semi translucent indicator Bg.

Since:
2.4, DALi version 1.0.0
TRANSPARENT 

Fully transparent indicator Bg.

Since:
2.4, DALi version 1.0.0

Enumeration for visible mode of the indicator.

Since:
2.4, DALi version 1.0.0
Enumerator:
INVISIBLE 

Hide indicator.

Since:
2.4, DALi version 1.0.0
VISIBLE 

Show indicator.

Since:
2.4, DALi version 1.0.0
AUTO 

Hide in default, will show when necessary.

Since:
2.4, DALi version 1.0.0

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

Since:
2.4, DALi version 1.0.0
Enumerator:
PORTRAIT 

Portrait orientation. The height of the display area is greater than the width.

Since:
2.4, DALi version 1.0.0
LANDSCAPE 

Landscape orientation. A wide view area is needed.

Since:
2.4, DALi version 1.0.0
PORTRAIT_INVERSE 

Portrait inverse orientation.

Since:
2.4, DALi version 1.0.0
LANDSCAPE_INVERSE 

Landscape inverse orientation.

Since:
2.4, DALi version 1.0.0

Constructor & Destructor Documentation

Creates an uninitialized handle.

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

Since:
2.4, DALi version 1.0.0

Destructor.

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

Since:
2.4, DALi version 1.0.0
Dali::Window::Window ( const Window handle)

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

Since:
2.4, DALi version 1.0.0
Parameters:
[in]handleA reference to the copied handle

Member Function Documentation

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

Since:
2.4, DALi version 1.0.0

Adds an orientation to the list of available orientations.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]orientationThe 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:
2.4, DALi version 1.0.0
Returns:
A handle to the DragAndDropDetector

Gets the native handle of the window.

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

Since:
2.4, DALi version 1.0.0
Returns:
The native handle of the Window or an empty handle

Gets the preferred orientation.

Since:
2.4, DALi version 1.0.0
Returns:
The preferred orientation if previously set, or none

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

Since:
2.4, DALi version 1.0.0
Returns:
The signal to connect to

Lowers window to the bottom of Window stack.

Since:
2.4, 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:
2.4, DALi version 1.0.0
Parameters:
[in]windowPositionThe position and size of the Window
[in]nameThe Window title
[in]isTransparentWhether 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:
2.4, DALi version 1.0.0
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 new Window
Window& Dali::Window::operator= ( const Window rhs)

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

Since:
2.4, DALi version 1.0.0
Parameters:
[in]rhsA reference to the copied handle
Returns:
A reference to this

Raises window to the top of Window stack.

Since:
2.4, DALi version 1.0.0

Removes an orientation from the list of available orientations.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]orientationThe available orientation to remove

This sets the orientation of indicator bar.

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

Since:
2.4, DALi version 1.0.0
Parameters:
[in]orientationThe orientation
void Dali::Window::SetClass ( std::string  name,
std::string  klass 
)

Sets the window name and class string.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]nameThe name of the window
[in]klassThe class of the window

This sets the opacity mode of indicator bar.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]opacityThe opacity mode

Sets a preferred orientation.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]orientationThe preferred orientation
Precondition:
Orientation is in the list of available orientations.

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

Since:
2.4, DALi version 1.0.0
Parameters:
[in]visibleModeVisible mode for indicator bar, VISIBLE in default