Tizen Native API  5.5
Functions | Typedefs
Tizen WS Shell
UI

The Tizen WS Shell (tzsh) provides APIs to communicate with the window manager.

Required Header

#include <tzsh.h>

Overview

The Tizen WS Shell API provides functions to create/destroy the tzsh instance to communicate the window manager.

Functions

tzsh_h tzsh_create (tzsh_toolkit_type_e type)
 Creates a tzsh_h instance.
int tzsh_destroy (tzsh_h tzsh)
 Destroys the given tzsh_h instance.

Typedefs

typedef struct _tzsh_s * tzsh_h
 Handle for the Tizen shell.
typedef unsigned int tzsh_window
 The window handle for native window.

Typedef Documentation

typedef struct _tzsh_s* tzsh_h

Handle for the Tizen shell.

Since :
3.0
typedef unsigned int tzsh_window

The window handle for native window.

This is abstract window type for native window handle.

Since :
3.0

Enumeration Type Documentation

enum tzsh_error_e

Enumeration for Tizen shell error.

Since :
3.0
Enumerator:
TZSH_ERROR_NONE 

Successful

TZSH_ERROR_OUT_OF_MEMORY 

Out of memory

TZSH_ERROR_INVALID_PARAMETER 

Invalid parameter

TZSH_ERROR_PERMISSION_DENIED 

Permission denied

TZSH_ERROR_NOT_SUPPORTED 

Not supported

TZSH_ERROR_NO_SERVICE 

Service does not exist

enum tzsh_toolkit_type_e

Enumeration for toolkit type.

Since :
3.0
Enumerator:
TZSH_TOOLKIT_TYPE_UNKNOWN 

Unknown type

TZSH_TOOLKIT_TYPE_EFL 

Use EFL toolkit

Function Documentation

tzsh_h tzsh_create ( tzsh_toolkit_type_e  type)

Creates a tzsh_h instance.

Since :
3.0
Remarks:
The returned handle should be released using tzsh_destroy(). The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
Parameters:
[in]typeThe toolkit type
Returns:
tzsh_h instance on success, NULL otherwise
Exceptions:
TZSH_ERROR_NONESuccessful
TZSH_ERROR_INVALID_PARAMETERInvalid parameter
TZSH_ERROR_OUT_OF_MEMORYOut of memory
See also:
tzsh_destroy()
int tzsh_destroy ( tzsh_h  tzsh)

Destroys the given tzsh_h instance.

Since :
3.0
Parameters:
[in]tzshThe tzsh_h instance to be destroyed
Returns:
0 on success, otherwise a negative error value
Return values:
TZSH_ERROR_NONESuccessful
TZSH_ERROR_INVALID_PARAMETERInvalid parameter
See also:
tzsh_create()