Tizen Native API
6.5
|
Minicontrol Provider APIs.
Required Header
#include <minicontrol-provider.h>
Overview
It provides functions for creating EFL socket window.
Functions | |
Evas_Object * | minicontrol_create_window (const char *name, minicontrol_target_viewer_e target_viewer, minicontrol_event_cb callback) |
Creates a window for minicontrol. | |
int | minicontrol_send_event (Evas_Object *minicontrol, minicontrol_provider_event_e event, bundle *event_arg) |
Sends a event to the viewer. | |
Typedefs | |
typedef void(* | minicontrol_event_cb )(minicontrol_viewer_event_e event_type, bundle *event_arg) |
Called when a event comes from viewer. |
Typedef Documentation
typedef void(* minicontrol_event_cb)(minicontrol_viewer_event_e event_type, bundle *event_arg) |
Called when a event comes from viewer.
- Since :
- 2.4
- Remarks:
- The event_arg should not be released.
- Parameters:
-
[in] event_type The type of fired event [in] event_arg Argument of the event The event_arg can be used only in the callback. To use outside, make a copy.
- Precondition:
- minicontrol_viewer_register_event_callback() used to register this callback.
Function Documentation
Evas_Object* minicontrol_create_window | ( | const char * | name, |
minicontrol_target_viewer_e | target_viewer, | ||
minicontrol_event_cb | callback | ||
) |
Creates a window for minicontrol.
- Since :
- 2.4
- Remarks:
- The specific error code can be obtained using the gat_last_result() method. Error codes are described in Exception section. The returned value should be released using evas_object_del().
- Parameters:
-
[in] name Name of minicontrol socket window [in] target_viewer Target viewer for minicontrol. You can select multiple viewers by using bitwise OR operator [in] callback A callback function for events originated by minicontrol viewer
- Returns:
- Evas object of minicontrol. NULL on error
- Exceptions:
-
MINICONTROL_ERROR_NONE Success MINICONTROL_ERROR_NOT_SUPPORTED Not supported MINICONTROL_ERROR_INVALID_PARAMETER Invalid argument MINICONTROL_ERROR_ELM_FAILURE Some error occurred when creating a minicontrol window MINICONTROL_ERROR_OUT_OF_MEMORY Out of memory
int minicontrol_send_event | ( | Evas_Object * | minicontrol, |
minicontrol_provider_event_e | event, | ||
bundle * | event_arg | ||
) |
Sends a event to the viewer.
- Since :
- 2.4
- Remarks:
- When a viewer doesn't handle some events, it can be ignored.
- Parameters:
-
[in] minicontrol Minicontrol window [in] event Type of the event [in] event_arg Bundle argument of the event
- Returns:
- MINICONTROL_ERROR_NONE on success, otherwise an error code on failure
- Return values:
-
MINICONTROL_ERROR_NONE Success MINICONTROL_ERROR_NOT_SUPPORTED Not supported MINICONTROL_ERROR_INVALID_PARAMETER Invalid argument