stopwatch/include/stopwatch_lib.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://floralicense.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 __DEF_STOPWATCH_LIB_H__
  18 #define __DEF_STOPWATCH_LIB_H__
  19
  20 #include <Elementary.h>
  21
  22 typedef int (*stopwatch_controlbar_visible) (Eina_Bool);
  23
  24 /**
  25 * @name           stopwatch_view_add
  26 * @decription     To create and show view for stopwatch.
  27 * @param          parent, [in], a layout in which to create and show view.
  28 * @param          cb, [in], a variable to indicate whether controlbar should by shown.
  29 * @return          Evas_object*, a pointer to the created view. If failed to create view, it is NULL.
  30 *
  31 * @remark         N/A
  32 * @version        1.1
  33 * @author           Zhou Jinhua
  34 * @part              Aquila_1
  35 * @group            Mobile SW1
  36 * @company        SCRC
  37 * @date              August 2010
  38 */
  39 EAPI Evas_Object *stopwatch_view_add(Evas_Object *parent, Evas_Object *win,
  40                                      stopwatch_controlbar_visible cb);
  41
  42 /**
  43 * @name           stopwatch_view_free
  44 * @decription     To delete objects and free memory used by stopwatch.
  45 * @param          obj, [in], the view that will be distroyed.
  46 * @return          void
  47 *
  48 * @remark         N/A
  49 * @version        1.1
  50 * @author           Zhou Jinhua
  51 * @part              Aquila_1
  52 * @group            Mobile SW1
  53 * @company        SCRC
  54 * @date              August 2010
  55 */
  56 EAPI void stopwatch_view_free(Evas_Object *obj);
  57
  58 /**
  59 * @name           stopwatch_view_reload
  60 * @decription     To reset LCD power off principle when stopwatch is on top level.
  61 * @return          void
  62 *
  63 * @remark         N/A
  64 * @version        1.1
  65 * @author           Zhou Jinhua
  66 * @part              Aquila_1
  67 * @group            Mobile SW1
  68 * @company        SCRC
  69 * @date              August 2010
  70 */
  71 EAPI void stopwatch_view_reload();
  72
  73 /**
  74 * @name           stopwatch_view_unload
  75 * @decription     To restore normal LCD power off principle of other applications when stopwatch is out of focus.
  76 * @return          void
  77 *
  78 * @remark         N/A
  79 * @version        1.1
  80 * @author           Zhou Jinhua
  81 * @part              Aquila_1
  82 * @group            Mobile SW1
  83 * @company        SCRC
  84 * @date              August 2010
  85 */
  86 EAPI void stopwatch_view_unload();
  87
  88 EAPI void stopwatch_app_pause();
  89
  90 EAPI void stopwatch_app_resume(Eina_Bool bCurrentView);
  91
  92 #endif                          /* __DEF_STOPWATCH_LIB_H__ */