Tizen Native API
5.5
|
The window class is used internally for drawing. More...
Classes | |
struct | NotificationLevel |
An enum of screen mode. More... | |
struct | ScreenOffMode |
An enum of screen mode. More... | |
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... | |
enum | Type |
An enum of Window types. More... | |
typedef Uint16Pair | WindowSize |
Window size type. | |
typedef Uint16Pair | WindowPosition |
Window position type. | |
typedef Signal< void(bool) > | IndicatorSignalType |
Indicator state signal type. | |
typedef Signal< void(bool) > | FocusSignalType |
Window focus signal type. | |
typedef Signal< void(WindowSize) > | ResizedSignalType |
Window resized signal type. | |
typedef Signal< void(Window, bool) > | FocusChangeSignalType |
Window focus signal type. | |
typedef Signal< void(Window, WindowSize) > | ResizeSignalType |
Window resized signal type. | |
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 | Add (Actor actor) |
Adds a child Actor to the Window. | |
void | Remove (Actor actor) |
Removes a child Actor from the Window. | |
void | SetBackgroundColor (const Vector4 &color) |
Sets the background color of the Window. | |
Vector4 | GetBackgroundColor () const |
Gets the background color of the Window. | |
Layer | GetRootLayer () const |
Returns the root Layer of the Window. | |
uint32_t | GetLayerCount () const |
Queries the number of on-scene layers in the Window. | |
Layer | GetLayer (uint32_t depth) const |
Retrieves the layer at a specified depth in the Window. | |
void | ShowIndicator (IndicatorVisibleMode visibleMode) DALI_DEPRECATED_API |
This sets whether the indicator bar should be shown or not. | |
void | SetIndicatorBgOpacity (IndicatorBgOpacity opacity) DALI_DEPRECATED_API |
This sets the opacity mode of indicator bar. | |
void | RotateIndicator (WindowOrientation orientation) DALI_DEPRECATED_API |
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 DALI_DEPRECATED_API |
Returns an empty handle. | |
Any | GetNativeHandle () const |
Gets the native handle of the window. | |
void | SetAcceptFocus (bool accept) |
Sets whether window accepts focus or not. | |
bool | IsFocusAcceptable () const |
Returns whether window accepts focus or not. | |
void | Show () |
Shows the window if it is hidden. | |
void | Hide () |
Hides the window if it is showing. | |
bool | IsVisible () const |
Returns whether the window is visible or not. | |
unsigned int | GetSupportedAuxiliaryHintCount () const |
Gets the count of supported auxiliary hints of the window. | |
std::string | GetSupportedAuxiliaryHint (unsigned int index) const |
Gets the supported auxiliary hint string of the window. | |
unsigned int | AddAuxiliaryHint (const std::string &hint, const std::string &value) |
Creates an auxiliary hint of the window. | |
bool | RemoveAuxiliaryHint (unsigned int id) |
Removes an auxiliary hint of the window. | |
bool | SetAuxiliaryHintValue (unsigned int id, const std::string &value) |
Changes a value of the auxiliary hint. | |
std::string | GetAuxiliaryHintValue (unsigned int id) const |
Gets a value of the auxiliary hint. | |
unsigned int | GetAuxiliaryHintId (const std::string &hint) const |
Gets a ID of the auxiliary hint string. | |
void | SetInputRegion (const Rect< int > &inputRegion) |
Sets a region to accept input events. | |
void | SetType (Type type) |
Sets a window type. | |
Type | GetType () const |
Gets a window type. | |
bool | SetNotificationLevel (NotificationLevel::Type level) |
Sets a priority level for the specified notification window. | |
NotificationLevel::Type | GetNotificationLevel () const |
Gets a priority level for the specified notification window. | |
void | SetOpaqueState (bool opaque) |
Sets a transparent window's visual state to opaque. | |
bool | IsOpaqueState () const |
Returns whether a transparent window's visual state is opaque or not. | |
bool | SetScreenOffMode (ScreenOffMode::Type screenOffMode) |
Sets a window's screen off mode. | |
ScreenOffMode::Type | GetScreenOffMode () const |
Gets a screen off mode of the window. | |
bool | SetBrightness (int brightness) |
Sets preferred brightness of the window. | |
int | GetBrightness () const |
Gets preferred brightness of the window. | |
void | SetSize (WindowSize size) |
Sets a size of the window. | |
WindowSize | GetSize () const |
Gets a size of the window. | |
void | SetPosition (WindowPosition position) |
Sets a position of the window. | |
WindowPosition | GetPosition () const |
Gets a position of the window. | |
void | SetTransparency (bool transparent) |
Sets whether the window is transparent or not. | |
IndicatorSignalType & | IndicatorVisibilityChangedSignal () DALI_DEPRECATED_API |
The user should connect to this signal to get a timing when indicator was shown / hidden. | |
FocusSignalType & | FocusChangedSignal () DALI_DEPRECATED_API |
The user should connect to this signal to get a timing when window gains focus or loses focus. | |
ResizedSignalType & | ResizedSignal () DALI_DEPRECATED_API |
This signal is emitted when the window is resized. | |
FocusChangeSignalType & | FocusChangeSignal () |
The user should connect to this signal to get a timing when window gains focus or loses focus. | |
ResizeSignalType & | ResizeSignal () |
This signal is emitted when the window is resized. | |
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. |
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().
typedef Signal< void (Window,bool) > Dali::Window::FocusChangeSignalType |
Window focus signal type.
typedef Signal< void (bool) > Dali::Window::FocusSignalType |
Window focus signal type.
typedef Signal< void (bool) > Dali::Window::IndicatorSignalType |
Indicator state signal type.
typedef Signal< void (WindowSize) > Dali::Window::ResizedSignalType |
Window resized signal type.
typedef Signal< void (Window,WindowSize) > Dali::Window::ResizeSignalType |
Window resized signal type.
Window position type.
typedef Uint16Pair Dali::Window::WindowSize |
Window size type.
Enumeration for opacity of the indicator.
OPAQUE |
Fully opaque indicator Bg.
|
TRANSLUCENT |
Semi translucent indicator Bg.
|
TRANSPARENT |
Fully transparent indicator Bg.
|
Enumeration for visible mode of the indicator.
INVISIBLE |
Hide indicator.
|
VISIBLE |
Show indicator.
|
AUTO |
Hide in default, will show when necessary.
|
enum Dali::Window::Type |
An enum of Window types.
Enumeration for orientation of the window is the way in which a rectangular page is oriented for normal viewing.
This Enumeration is used the available orientation APIs and the preferred orientation.
Creates an uninitialized handle.
This can be initialized using Dali::Application::GetWindow() or Dali::Window::New().
Destructor.
This is non-virtual since derived Handle types must not contain data or virtual methods.
Dali::Window::Window | ( | const Window & | handle | ) |
This copy constructor is required for (smart) pointer semantics.
[in] | handle | A reference to the copied handle |
void Dali::Window::Activate | ( | ) |
Activates window to the top of Window stack even it is iconified.
void Dali::Window::Add | ( | Actor | actor | ) |
unsigned int Dali::Window::AddAuxiliaryHint | ( | const std::string & | hint, |
const std::string & | value | ||
) |
Creates an auxiliary hint of the window.
[in] | hint | The auxiliary hint string. |
[in] | value | The value string. |
0
on failure. void Dali::Window::AddAvailableOrientation | ( | WindowOrientation | orientation | ) |
Adds an orientation to the list of available orientations.
[in] | orientation | The available orientation to add |
The user should connect to this signal to get a timing when window gains focus or loses focus.
A callback of the following type may be connected:
void YourCallbackName( bool focusIn );
The parameter is true if window gains focus, otherwise false.
The user should connect to this signal to get a timing when window gains focus or loses focus.
A callback of the following type may be connected:
void YourCallbackName( Window window, bool focusIn );
The parameter is true if window gains focus, otherwise false. and window means this signal was called from what window
unsigned int Dali::Window::GetAuxiliaryHintId | ( | const std::string & | hint | ) | const |
Gets a ID of the auxiliary hint string.
[in] | hint | The auxiliary hint string. |
0
if none exists. std::string Dali::Window::GetAuxiliaryHintValue | ( | unsigned int | id | ) | const |
Gets a value of the auxiliary hint.
[in] | id | The auxiliary hint ID. |
Vector4 Dali::Window::GetBackgroundColor | ( | ) | const |
Gets the background color of the Window.
int Dali::Window::GetBrightness | ( | ) | const |
Gets preferred brightness of the window.
DragAndDropDetector Dali::Window::GetDragAndDropDetector | ( | ) | const |
Returns an empty handle.
Layer Dali::Window::GetLayer | ( | uint32_t | depth | ) | const |
Retrieves the layer at a specified depth in the Window.
[in] | depth | The depth |
uint32_t Dali::Window::GetLayerCount | ( | ) | const |
Queries the number of on-scene layers in the Window.
Note that a default layer is always provided (count >= 1).
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.
Gets a priority level for the specified notification window.
WindowPosition Dali::Window::GetPosition | ( | ) | const |
Gets a position of the window.
Gets the preferred orientation.
Layer Dali::Window::GetRootLayer | ( | ) | const |
Gets a screen off mode of the window.
WindowSize Dali::Window::GetSize | ( | ) | const |
Gets a size of the window.
std::string Dali::Window::GetSupportedAuxiliaryHint | ( | unsigned int | index | ) | const |
Gets the supported auxiliary hint string of the window.
[in] | index | The index of the supported auxiliary hint lists |
unsigned int Dali::Window::GetSupportedAuxiliaryHintCount | ( | ) | const |
Gets the count of supported auxiliary hints of the window.
Type Dali::Window::GetType | ( | ) | const |
Gets a window type.
void Dali::Window::Hide | ( | ) |
Hides the window if it is showing.
The user should connect to this signal to get a timing when indicator was shown / hidden.
bool Dali::Window::IsFocusAcceptable | ( | ) | const |
Returns whether window accepts focus or not.
bool Dali::Window::IsOpaqueState | ( | ) | const |
Returns whether a transparent window's visual state is opaque or not.
bool Dali::Window::IsVisible | ( | ) | const |
Returns whether the window is visible or not.
void Dali::Window::Lower | ( | ) |
Lowers window to the bottom of Window stack.
static Window Dali::Window::New | ( | PositionSize | windowPosition, |
const std::string & | name, | ||
bool | isTransparent = false |
||
) | [static] |
Creates an initialized handle to a new Window.
[in] | windowPosition | The position and size of the Window |
[in] | name | The Window title |
[in] | isTransparent | Whether Window is transparent |
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.
[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 |
This assignment operator is required for (smart) pointer semantics.
[in] | rhs | A reference to the copied handle |
void Dali::Window::Raise | ( | ) |
Raises window to the top of Window stack.
void Dali::Window::Remove | ( | Actor | actor | ) |
bool Dali::Window::RemoveAuxiliaryHint | ( | unsigned int | id | ) |
Removes an auxiliary hint of the window.
[in] | id | The ID of the auxiliary hint. |
void Dali::Window::RemoveAvailableOrientation | ( | WindowOrientation | orientation | ) |
Removes an orientation from the list of available orientations.
[in] | orientation | The available orientation to remove |
This signal is emitted when the window is resized.
A callback of the following type may be connected:
void YourCallbackName( int width, int height );
The parameters are the resized width and height.
This signal is emitted when the window is resized.
A callback of the following type may be connected:
void YourCallbackName( Window window, int width, int height );
The parameters are the resized width and height. and window means this signal was called from what window
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.
[in] | orientation | The orientation |
void Dali::Window::SetAcceptFocus | ( | bool | accept | ) |
Sets whether window accepts focus or not.
[in] | accept | If focus is accepted or not. Default is true. |
bool Dali::Window::SetAuxiliaryHintValue | ( | unsigned int | id, |
const std::string & | value | ||
) |
Changes a value of the auxiliary hint.
[in] | id | The auxiliary hint ID. |
[in] | value | The value string to be set. |
void Dali::Window::SetBackgroundColor | ( | const Vector4 & | color | ) |
Sets the background color of the Window.
[in] | color | The new background color |
bool Dali::Window::SetBrightness | ( | int | brightness | ) |
Sets preferred brightness of the window.
This API is useful when the application needs to change the brightness of the screen when it is appeared on the screen. If the brightness has been set and the window is shown, the window manager requests the display system to change the brightness to the provided value. If the window is no longer shown, then the window manager requests the display system to go back to default brightness. A value less than 0 results in default brightness and a value greater than 100 results in maximum brightness.
[in] | brightness | The preferred brightness (0 to 100). |
void Dali::Window::SetClass | ( | std::string | name, |
std::string | klass | ||
) |
Sets the window name and class string.
[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.
[in] | opacity | The opacity mode |
void Dali::Window::SetInputRegion | ( | const Rect< int > & | inputRegion | ) |
Sets a region to accept input events.
[in] | inputRegion | The region to accept input events. |
bool Dali::Window::SetNotificationLevel | ( | NotificationLevel::Type | level | ) |
Sets a priority level for the specified notification window.
[in] | level | The notification window level. |
void Dali::Window::SetOpaqueState | ( | bool | opaque | ) |
Sets a transparent window's visual state to opaque.
If a visual state of a transparent window is opaque, then the window manager could handle it as an opaque window when calculating visibility.
[in] | opaque | Whether the window's visual state is opaque. |
void Dali::Window::SetPosition | ( | WindowPosition | position | ) |
Sets a position of the window.
[in] | position | The new window position |
void Dali::Window::SetPreferredOrientation | ( | WindowOrientation | orientation | ) |
Sets a preferred orientation.
[in] | orientation | The preferred orientation |
bool Dali::Window::SetScreenOffMode | ( | ScreenOffMode::Type | screenOffMode | ) |
Sets a window's screen off mode.
This API is useful when the application needs to keep the display turned on. If the application sets the screen mode to #Dali::Window::ScreenOffMode::NEVER to its window and the window is shown, the window manager requests the display system to keep the display on as long as the window is shown. If the window is no longer shown, then the window manager requests the display system to go back to normal operation.
[in] | screenOffMode | The screen mode. |
void Dali::Window::SetSize | ( | WindowSize | size | ) |
Sets a size of the window.
[in] | size | The new window size |
void Dali::Window::SetTransparency | ( | bool | transparent | ) |
Sets whether the window is transparent or not.
[in] | transparent | Whether the window is transparent |
void Dali::Window::SetType | ( | Type | type | ) |
Sets a window type.
[in] | type | The window type. |
void Dali::Window::Show | ( | ) |
Shows the window if it is hidden.
void Dali::Window::ShowIndicator | ( | IndicatorVisibleMode | visibleMode | ) |
This sets whether the indicator bar should be shown or not.
[in] | visibleMode | Visible mode for indicator bar, VISIBLE in default |