Tizen Native API  4.0
Functions | Typedefs
Viewer
Minicontrol

Minicontrol Viewer APIs.

Required Header

#include <minicontrol-viewer.h>

Overview

It provides functions for displaying EFL socket window.

Functions

Evas_Object * minicontrol_viewer_add (Evas_Object *parent, const char *minicontrol_name)
 Adds minicontrol named as "minicontrol_name" to a given parent evas object and returns it.
int minicontrol_viewer_send_event (const char *minicontrol_name, minicontrol_viewer_event_e event, bundle *event_arg)
 Sends a event to the provider.
int minicontrol_viewer_set_event_cb (minicontrol_viewer_event_cb callback, void *user_data)
 Registers a callback for events originated by minicontrol provider.
int minicontrol_viewer_unset_event_cb (void)
 Unregisters a callback for events originated by minicontrol provider.

Typedefs

typedef void(* minicontrol_viewer_event_cb )(minicontrol_event_e event, const char *minicontrol_name, bundle *event_arg, void *data)
 Called when a event comes from the provider.

Typedef Documentation

typedef void(* minicontrol_viewer_event_cb)(minicontrol_event_e event, const char *minicontrol_name, bundle *event_arg, void *data)

Called when a event comes from the provider.

Since :
2.4
Parameters:
[in]eventThe type of fired event
[in]minicontrol_nameThe name of the minicontrol window
[in]event_argA bundle of arguments
[in]dataUser data
See also:
minicontrol_viewer_set_event_cb

Function Documentation

Evas_Object* minicontrol_viewer_add ( Evas_Object *  parent,
const char *  minicontrol_name 
)

Adds minicontrol named as "minicontrol_name" to a given parent evas object and returns it.

Since :
2.4
Remarks:
The specific error code can be obtained using the gat_last_result() method. Error codes are described in Exception section.
Parameters:
[in]parentMinicontrol object will be added to this parent evas object
[in]minicontrol_nameName of minicontrol
Returns:
Evas object of minicontrol. NULL on error
Exceptions:
MINICONTROL_ERROR_NONESuccess
MINICONTROL_ERROR_INVALID_PARAMETERInvalid argument
MINICONTROL_ERROR_ELM_FAILURESome error occurred when creating a minicontrol window
MINICONTROL_ERROR_NOT_SUPPORTEDNot supported
See also:
get_last_result()
int minicontrol_viewer_send_event ( const char *  minicontrol_name,
minicontrol_viewer_event_e  event,
bundle *  event_arg 
)

Sends a event to the provider.

Since :
2.4
Parameters:
[in]minicontrol_nameThe name of the minicontrol window
[in]eventType of the event
[in]event_argA bundle of arguments
Returns:
MINICONTROL_ERROR_NONE on success, otherwise an error code on failure
Return values:
MINICONTROL_ERROR_INVALID_PARAMETERInvalid argument
MINICONTROL_ERROR_NOT_SUPPORTEDNot supported
See also:
minicontrol_viewer_event_e
int minicontrol_viewer_set_event_cb ( minicontrol_viewer_event_cb  callback,
void *  user_data 
)

Registers a callback for events originated by minicontrol provider.

Since :
2.4
Parameters:
[in]callbackCallback function
[in]user_dataUser data
Returns:
MINICONTROL_ERROR_NONE on success, otherwise an error code on failure
Return values:
MINICONTROL_ERROR_INVALID_PARAMETERInvalid argument
MINICONTROL_ERROR_IPC_FAILUREIPC failure
MINICONTROL_ERROR_OUT_OF_MEMORYOut of memory
MINICONTROL_ERROR_NOT_SUPPORTEDNot supported
See also:
minicontrol_viewer_unset_event_cb
minicontrol_viewer_event_cb
int minicontrol_viewer_unset_event_cb ( void  )

Unregisters a callback for events originated by minicontrol provider.

Since :
2.4
Returns:
MINICONTROL_ERROR_NONE if success, other value if failure
Return values:
MINICONTROL_ERROR_NOT_SUPPORTEDNot supported
See also:
minicontrol_viewer_set_event_cb