include/SLP_SYSPOPUP_PG.h

   1 /*
   2  * syspopup
   3  *
   4  * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Contact: Jayoun Lee <airjany@samsung.com>, Sewook Park <sewook7.park@samsung.com>,
   7  * Jaeho Lee <jaeho81.lee@samsung.com>
   8  *
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  * http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  */
  22
  23
  24 /**
  25
  26  *
  27  * @ingroup   SLP_PG
  28  * @defgroup   SYSPOPUP System Popup
  29
  30 @par SYSPOPUP Programming Guide
  31
  32 <h1 class="pg"> Introduction</h1>
  33 SYSPOPPUP is designed to create popups for system events like low battery, low memory, incoming call etc. Sys-popup (System Popup) Library provides API's for creating system popup applications and launching/destroying the system popup's.
  34 <h1 class="pg"> Scope</h1>
  35 The purpose of this document is to describe how applications can use System Popup Library APIs.\n
  36 This document gives only programming guidelines to system popup application engineers.
  37 The scope of this document is limited to System Popup API usage.
  38
  39 <h1 class="pg"> Syspopup Features</h1>
  40 Syspopup exposes two kinds of API's.
  41 1. Create system popup application.\n
  42 2. Launch System popup application.
  43
  44 <h1 class="pg"> Syspopup Architecture</h1>
  45 \image html syspopup_diag.png "Picture 1. Syspopup Process View"
  46 \image rtf syspopup_diag.png "Picture 1. Syspopup Process View"
  47
  48 Whenever system daemon receives system event for which popup is to be created, it calls syspopup launch API with the required popup name (lowbatt, lowmem etc). Syspopup library finds the appropriate syspopup application to be launched based on the popup name. It then calls the AUL API for launching the syspoup application.
  49 The syspopup application calls syspopup's create API for creating the systempopup. Picture 1 above shows the process view of syspopup.
  50
  51 <h1 class="pg">API list and description</h1>
  52 <ul>
  53         <li>syspopup_create() : Creates System Popup</li>
  54         <li>syspopup_reset() : Reset the created system popup properties</li>
  55         <li>syspopup_has_popup() : Checks system popup is created and is running</li>
  56         <li>syspopup_launch() : Launches system popup application</li>
  57         <li>syspopup_destroy_all() : Destroy all the system popups</li>
  58 </ul>
  59 @}
  60 */
  61