include/minicontrol-viewer.h

   1 /*
   2  * Copyright (c)  2013-2015 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef _MINICTRL_VIEWER_H_
  18 #define _MINICTRL_VIEWER_H_
  19
  20 #include <Evas.h>
  21 #include "minicontrol-error.h"
  22 #include "minicontrol-type.h"
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 /**
  29  * @file minicontrol-viewer.h
  30  * @brief This minicontrol viewer library used to display minicontrol which created by minicontrol provider.
  31  */
  32
  33 /**
  34  * @addtogroup MINICONTROL_VIEWER_MODULE
  35  * @{
  36  */
  37
  38 /**
  39  * @brief Adds minicontrol named as "svr_name" to a given parent evas object and returns it.
  40  * @param[in] parent Minicontrol object will be added to this parent evas object
  41  * @param[in] svr_name Name of minicontrol
  42  * @return Evas object of minicontrol
  43  */
  44 Evas_Object *minicontrol_viewer_add(Evas_Object *parent, const char *svr_name);
  45
  46 /**
  47  * @brief Gets the basic evas image object from given minicontrol object.
  48  * @param[in] obj Minicontrol object
  49  * @return Basic evas image object of minicontrol object
  50  */
  51 Evas_Object *minicontrol_viewer_image_object_get(const Evas_Object *obj);
  52
  53 /**
  54  * @brief Requests various actions to the provider.
  55  * @param[in] minicontrol Evas object of socket window
  56  * @param[in] action Type of action
  57  * @return Evas object of socket window
  58  */
  59 minicontrol_error_e minicontrol_viewer_request(const char *appid, minicontrol_request_e request, int value);
  60
  61 /**
  62  * @}
  63  */
  64
  65 #ifdef __cplusplus
  66 }
  67 #endif
  68 #endif /* _MINICTRL_VIEWER_H_ */
  69