include/ui-gadget-engine.h

   1 /*
   2  * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * This file is part of the UI Gadget
   5  * Written by Jayoun Lee <airjany@samsung.com>, Jinwoo Nam <jwoo.nam@samsung.com>
   6  *
   7  * PROPRIETARY/CONFIDENTIAL
   8  *
   9  * This software is the confidential and proprietary information of
  10  * SAMSUNG ELECTRONICS (Confidential Information).
  11  * You shall not disclose such Confidential Information and shall
  12  * use it only in accordance with the terms of the license agreement
  13  * you entered into with SAMSUNG ELECTRONICS.  SAMSUNG make no
  14  * representations or warranties about the suitability
  15  * of the software, either express or implied, including but not
  16  * limited to the implied warranties of merchantability, fitness for a particular purpose, or non-
  17  * infringement. SAMSUNG shall not be liable for any damages suffered by licensee as
  18  * a result of using, modifying or distributing this software or its derivatives.
  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, struct ui_gadget *ug, void(*hide_end_cb)(struct ui_gadget *ug));
  55         /** destroy operation */
  56         void (*destroy)(struct ui_gadget *ug, struct ui_gadget *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__ */