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 #ifdef __cplusplus
  24 extern "C" {
  25 #endif
  26
  27 /**
  28  * @file minicontrol-monitor.h
  29  * @brief This minicontrol monitor library used to manage events triggered by minicontrol provider
  30  */
  31
  32 /**
  33  * @addtogroup MINICONTROL_MONITOR_MODULE
  34  * @{
  35  */
  36
  37   /**
  38  * @brief Called when event is triggered
  39  * @param[in] action The type of fired event
  40  * @param[in] name The name of provider
  41  * @param[in] width The width of provider
  42  * @param[in] height The height of provider
  43  * @param[in] priority The priority of provider
  44  * @param[in] data user data
  45  * @pre minicontrol_monitor_start() used to register this callback
  46  * @see #minicontrol_action_e
  47  * @see #minicontrol_priority_e
  48  */
  49 typedef void (*minicontrol_monitor_cb) (minicontrol_action_e action,
  50                                         const char *name,
  51                                         unsigned int width,
  52                                         unsigned int height,
  53                                         minicontrol_priority_e priority,
  54                                         void *data);
  55
  56 /**
  57  * @brief Register a callback for events originated by minicontrol provider
  58  * @param[in] callback callback function
  59  * @param[in] data user data
  60  */
  61 minicontrol_error_e minicontrol_monitor_start(minicontrol_monitor_cb callback,
  62                                         void *data);
  63
  64 /**
  65  * @brief Unregister a callback for events originated by minicontrol provider
  66  * @return #MINICONTROL_ERROR_NONE if success, other value if failure
  67  * @see #minicontrol_error_e
  68  */
  69 minicontrol_error_e minicontrol_monitor_stop(void);
  70
  71 /**
  72  * @}
  73  */
  74
  75 #ifdef __cplusplus
  76 }
  77 #endif
  78 #endif /* _MINICTRL_MONITOR_H_ */
  79