include/ui-gadget-engine.h

   1 /*
   2  *  UI Gadget
   3  *
   4  * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Contact: Jayoun Lee <airjany@samsung.com>, Jinwoo Nam <jwoo.nam@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 __UI_GADGET_ENGINE_H__
  23 #define __UI_GADGET_ENGINE_H__
  24
  25 /**
  26  * @defgroup    UI_Gadget_For_Developer Developer API Reference Guide
  27  * @ingroup     UI_Gadget
  28  * @brief       A engine to develop a UI gadget. Callees (UI gadgets) uses this engines and APIs. (callee -> caller)
  29  *
  30  * @section Header To Use Them:
  31  * @code
  32  * #include <ui-gadget-engine.h>
  33  * @endcode
  34  */
  35
  36 /**
  37  * @addtogroup UI_Gadget_For_Developer
  38  * @{
  39  */
  40
  41 #include <bundle.h>
  42 #include "ui-gadget.h"
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 /**
  49  * UI gadget engine operation type
  50  * @see @ref lifecycle_sec
  51  */
  52 struct ug_engine_ops {
  53         /** create operation */
  54         void *(*create)(void *win, ui_gadget_h ug, void(*hide_end_cb)(ui_gadget_h ug));
  55         /** destroy operation */
  56         void (*destroy)(ui_gadget_h ug, ui_gadget_h fv_top);
  57         /** reserved operations */
  58         void *reserved[4];
  59 };
  60
  61 #ifdef __cplusplus
  62 }
  63 #endif
  64
  65 /**
  66  * @}
  67  */
  68
  69 #endif /* __UI_GADGET_ENGINE_H__ */