include/notification_status.h

   1 /*
   2  *  libnotification
   3  *
   4  * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Contact: Seungtaek Chung <seungtaek.chung@samsung.com>, Mi-Ju Lee <miju52.lee@samsung.com>, Xi Zhichan <zhichan.xi@samsung.com>
   7  *
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  *
  20  */
  21
  22 #ifndef __NOTIFICATION_STATUS_DEF_H__
  23 #define __NOTIFICATION_STATUS_DEF_H__
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif /* __cplusplus */
  28
  29 /**
  30  * @ingroup NOTIFICATION_LIBRARY
  31  * @defgroup NOTIFICATION_STATUS_LIBRARY notification status library
  32  * @brief This notification status library used to display simple plain message on small popup
  33  */
  34
  35 /**
  36  * @ingroup NOTIFICATION_STATUS_LIBRARY
  37  * @defgroup NOTIFICATION_STATUS_LIBRARY_TYPE notification status library type
  38  * @brief type used by notification status library
  39  */
  40
  41 /**
  42  * @addtogroup NOTIFICATION_STATUS_LIBRARY_TYPE
  43  * @{
  44  */
  45
  46 /**
  47 * @brief Called when new message is posted
  48 * @param[in] message The message posted
  49 * @param[in] data user data
  50 * @pre notification_status_monitor_message_cb_set() used to register this callback
  51 * @see notification_status_monitor_message_cb_set()
  52 */
  53 typedef void (*notification_status_message_cb)(const char *message, void *data);
  54
  55 /**
  56  * @}
  57  */
  58
  59 /**
  60  * @addtogroup NOTIFICATION_STATUS_LIBRARY
  61  * @{
  62  */
  63
  64 /**
  65 * @brief register callback for receiving message
  66 * @param[in] callback The callback function
  67 * @param[in] data user_data
  68 */
  69 int notification_status_monitor_message_cb_set(notification_status_message_cb callback, void *user_data);
  70
  71 /**
  72 * @brief unregister callback for receiving message
  73 * @param[in] callback The callback function
  74 * @param[in] data user_data
  75 */
  76 int notification_status_monitor_message_cb_unset(void);
  77
  78 /**
  79  * @brief This function send string(message) to notification status monitor
  80  * @details Send the message to notification status monitor.
  81  * @param[in] message messages you want to post
  82  * @return #NOTIFICATION_ERROR_NONE if success, other value if failure
  83  * @see #notification_error_e
  84  */
  85 int notification_status_message_post(const char *message);
  86
  87 /**
  88  * @}
  89  */
  90
  91 #ifdef __cplusplus
  92 }
  93 #endif /* __cplusplus */
  94 #endif /* __NOTIFICATION_STATUS_DEF_H__ */