Minicontrol Viewer APIs.

Required Header

#include <minicontrol-viewer.h>

Overview

It provides functions for displaying EFL socket window.

Related Features

This API is related with the following features:

http://tizen.org/feature/minicontrol

It is recommended to design feature related codes in your application for reliability.
You can check if a device supports the related features for this API by using System Information, thereby controlling the procedure of your application.
To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.
More details on featuring your application can be found from Feature Element.

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)
	Sets a callback for events originated by minicontrol provider.
int	minicontrol_viewer_unset_event_cb (void)
	Unsets 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 *user_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 *user_data)

Called when a event comes from the provider.

Since :: 2.4

Remarks:: The event_arg should not be released.

Parameters:

[in]	event	The type of fired event
[in]	minicontrol_name	The name of the minicontrol window The minicontrol_name can be used only in the callback. To use outside, make a copy.
[in]	event_arg	A bundle of arguments The event_arg can be used only in the callback. To use outside, make a copy.
[in]	user_data	User 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 get_last_result() method. Error codes are described in Exception section. The returned value should be released using evas_object_del().

Parameters:

[in]	parent	Minicontrol object will be added to this parent evas object
[in]	minicontrol_name	Name of minicontrol

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

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_name	The name of the minicontrol window
[in]	event	Type of the event
[in]	event_arg	A bundle of arguments

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

See also:: minicontrol_viewer_event_e

int minicontrol_viewer_set_event_cb	(	minicontrol_viewer_event_cb	callback,
		void *	user_data
	)

Sets a callback for events originated by minicontrol provider.

Since :: 2.4

Parameters:

[in]	callback	Callback function
[in]	user_data	User data

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
MINICONTROL_ERROR_IPC_FAILURE	IPC failure
MINICONTROL_ERROR_OUT_OF_MEMORY	Out of memory

See also:: minicontrol_viewer_unset_event_cb; minicontrol_viewer_event_cb

int minicontrol_viewer_unset_event_cb ( void )

Unsets 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_SUPPORTED Not supported

See also:: minicontrol_viewer_set_event_cb

Required Header

Overview

Related Features

Functions

Typedefs

Typedef Documentation

Function Documentation