Tizen Native API  6.0
Minicontrol

Overview

API Description
Provider Provides functions for creating EFL socket window. Application developers can make a minicontrol by composing ELF objects on this socket window
Viewer Provides functions for displaying EFL socket window.
Minicontrol holders calls this functions to attach minicontrols on UI area.

Typedefs

typedef enum _minicontrol_error minicontrol_error_e
 Enumeration for describing error code of minicontrol library.

Typedef Documentation

Enumeration for describing error code of minicontrol library.

Since :
2.4

Enumeration Type Documentation

Enumeration for describing error code of minicontrol library.

Since :
2.4
Enumerator:
MINICONTROL_ERROR_NONE 

MiniControl error none

MINICONTROL_ERROR_INVALID_PARAMETER 

Invalid parameter

MINICONTROL_ERROR_OUT_OF_MEMORY 

Out of memory

MINICONTROL_ERROR_PERMISSION_DENIED 

Permission denied

MINICONTROL_ERROR_IPC_FAILURE 

IPC error

MINICONTROL_ERROR_NOT_SUPPORTED 

This function is not supported

MINICONTROL_ERROR_ELM_FAILURE 

Some error occurred when creating a minicontrol window

MINICONTROL_ERROR_UNKNOWN 

Unknown error

Enumeration for describing types of events originated by a minicontrol provider.

Events

Event TypeOriginated by Argument 1 KeyArgument 1 Type Argument 2 KeyArgument 2 Type Argument 3 KeyArgument 3 Type
MINICONTROL_EVENT_STARTprovider minicontrol_namestring widthinteger heightinteger
MINICONTROL_EVENT_STOPprovider
MINICONTROL_EVENT_RESIZEprovider minicontrol_namestring widthinteger heightinteger
MINICONTROL_EVENT_REQUEST_HIDEprovider
MINICONTROL_EVENT_REQUEST_ANGLEprovider
MINICONTROL_EVENT_REPORT_ANGLEviewer anglestring
MINICONTROL_VIEWER_EVENT_SHOWviewer
MINICONTROL_VIEWER_EVENT_HIDEviewer
Since :
2.4
Enumerator:
MINICONTROL_EVENT_START 

A minicontrol object is created

MINICONTROL_EVENT_STOP 

A minicontrol object is deleted

MINICONTROL_EVENT_RESIZE 

A minicontrol object is resized

MINICONTROL_EVENT_REQUEST_HIDE 

Requests that the minicontrol viewer(s) close the provider's minicontrol

MINICONTROL_EVENT_REQUEST_ANGLE 

Requests the current angle of the minicontrol viewer

MINICONTROL_EVENT_REPORT_ANGLE 

Reports the current angle of the minicontrol viewer

Enumeration for types of events which will be sent by minicontrol_send_event.

Since :
2.4
Enumerator:
MINICONTROL_PROVIDER_EVENT_REQUEST_HIDE 

Requests that the minicontrol viewer(s) close the provider's minicontrol. Required bundle argument : NULL.

MINICONTROL_PROVIDER_EVENT_REQUEST_ANGLE 

Requests the current angle of the minicontrol viewer. Required bundle argument : NULL.

Enumeration for selecting target viewers.

Since :
2.4
Enumerator:
MINICONTROL_TARGET_VIEWER_QUICK_PANEL 

Request to place the minicontrol on the quickpanel

MINICONTROL_TARGET_VIEWER_STOCK_LOCK_SCREEN 

Request to place the minicontrol on the stock lock screen

MINICONTROL_TARGET_VIEWER_CUSTOM_LOCK_SCREEN 

Request to place the minicontrol on a lock screen replacement application

Enumeration for types of events which will be sent by minicontrol_viewer_send_event.

Since :
2.4
Enumerator:
MINICONTROL_VIEWER_EVENT_REPORT_ANGLE 

Reports the current angle of the minicontrol viewer. Required argument : Angle of minicontrol viewer, Bundle Key : "angle", Bundle Value Type : string.

MINICONTROL_VIEWER_EVENT_SHOW 

The minicontrol viewer is shown. Required argument : NULL.

MINICONTROL_VIEWER_EVENT_HIDE 

The minicontrol viewer is hidden. Required argument : NULL.