include/minicontrol-monitor.h

   1 /*
   2  * Copyright 2012  Samsung Electronics Co., Ltd
   3  *
   4  * Licensed under the Flora License, Version 1.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.tizenopensource.org/license
   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_MONITOR_H_
  18 #define _MINICTRL_MONITOR_H_
  19
  20 #include <minicontrol-error.h>
  21 #include <minicontrol-type.h>
  22
  23 /**
  24  * @defgroup MINICONTROL_MONITOR_LIBRARY minicontrol monitor library
  25  * @brief This minicontrol monitor library used to manage events triggered by minicontrol provider
  26  */
  27
  28 /**
  29  * @ingroup MINICONTROL_MONITOR_LIBRARY
  30  * @defgroup MINICONTROL_MONITOR_LIBRARY_TYPE minicontrol monitor library type
  31  * @brief minicontrol monitor library type
  32  */
  33
  34 /**
  35  * @addtogroup MINICONTROL_MONITOR_LIBRARY_TYPE
  36  * @{
  37  */
  38
  39   /**
  40  * @brief Called when event is triggered
  41  * @param[in] action The type of fired event
  42  * @param[in] name The name of provider
  43  * @param[in] width The width of provider
  44  * @param[in] height The height of provider
  45  * @param[in] priority The priority of provider
  46  * @param[in] data user data
  47  * @pre minicontrol_monitor_start() used to register this callback
  48  * @see #minicontrol_action_e
  49  * @see #minicontrol_priority_e
  50  */
  51 typedef void (*minicontrol_monitor_cb) (minicontrol_action_e action,
  52                                         const char *name,
  53                                         unsigned int width,
  54                                         unsigned int height,
  55                                         minicontrol_priority_e priority,
  56                                         void *data);
  57
  58 /**
  59  * @addtogroup MINICONTROL_MONITOR_LIBRARY
  60  * @{
  61  */
  62
  63 /**
  64  * @brief Register a callback for events originated by minicontrol provider
  65  * @param[in] callback callback function
  66  * @param[in] data user data
  67  */
  68 minicontrol_error_e minicontrol_monitor_start(minicontrol_monitor_cb callback,
  69                                         void *data);
  70
  71 /**
  72  * @brief Unregister a callback for events originated by minicontrol provider
  73  * @return #MINICONTROL_ERROR_NONE if success, other value if failure
  74  * @see #minicontrol_error_e
  75  */
  76 minicontrol_error_e minicontrol_monitor_stop(void);
  77
  78 #endif /* _MINICTRL_MONITOR_H_ */
  79