eail/eail_naviframe_page.h

   1 /*
   2  * Copyright (c) 2013 Samsung Electronics Co., Ltd.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public License
  15  * along with this library; see the file COPYING.LIB.  If not, write to
  16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17  * Boston, MA 02110-1301, USA.
  18 */
  19
  20 /**
  21  * @file eail_naviframe_page.h
  22  *
  23  * @brief Header for EailnaviframePage implementation
  24  */
  25
  26 #ifndef EAIL_NAVIFRAME_PAGE_H
  27 #define EAIL_NAVIFRAME_PAGE_H
  28
  29 #include <Elementary.h>
  30 #include <atk/atk.h>
  31 /**
  32  * @brief Returns a value corresponding to the type of EailNaviframePage class
  33  */
  34 #define EAIL_TYPE_NAVIFRAME_PAGE            (eail_naviframe_page_get_type())
  35 /**
  36  * @brief Macro upcasts an instance (obj) of a subclass to the EailNaviframePage
  37  * type
  38  *
  39  * @param obj AtkObject instance
  40  */
  41 #define EAIL_NAVIFRAME_PAGE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj),\
  42                                              EAIL_TYPE_NAVIFRAME_PAGE, EailNaviframePage))
  43 /**
  44  * @brief Macro upcasts a subclass (klass) to the EailNaviframePage class
  45  *
  46  * @param klass subclass object
  47  */
  48 #define EAIL_NAVIFRAME_PAGE_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), \
  49                                              EAIL_TYPE_NAVIFRAME_PAGE, EailNaviframePageClass))
  50 /**
  51  * @brief Tests whether object (obj) is an instance of EailNaviframePage class
  52  *
  53  * @param obj AtkObject instance
  54  */
  55 #define EAIL_IS_NAVIFRAME_PAGE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj),\
  56                                              EAIL_TYPE_NAVIFRAME_PAGE))
  57 /**
  58  * @brief Tests whether given klass is a subclass of EailNaviframePage
  59  *
  60  * @param klass klass object
  61  */
  62 #define EAIL_IS_NAVIFRAME_PAGE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), \
  63                                              EAIL_TYPE_NAVIFRAME_PAGE))
  64 /**
  65  * @brief Gets EailNaviframePage class structure from an obj (class instance)
  66  *
  67  * @param obj object instance to get EailNaviframePage class from
  68  */
  69 #define EAIL_NAVIFRAME_PAGE_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), \
  70                                              EAIL_TYPE_NAVIFRAME_PAGE, EailNaviframePageClass))
  71
  72 #ifdef __cplusplus
  73 extern "C" {
  74 #endif
  75
  76 /** @brief Definition of object structure for Atk EailNaviframePage*/
  77 typedef struct _EailNaviframePage      EailNaviframePage;
  78 /** @brief Definition of object class for Atk EailNaviframePage*/
  79 typedef struct _EailNaviframePageClass EailNaviframePageClass;
  80
  81 /** @brief Definition of object structure for Atk EailNaviframePage*/
  82 struct _EailNaviframePage
  83 {
  84    /** @brief Parent AtkObject whose functionality is being extended*/
  85    AtkObject parent;
  86    /** @brief EailNaviframe which page belongs to*/
  87    AtkObject *parent_naviframe;
  88    /** @brief elm_naviframe instance*/
  89    Evas_Object *naviframe;
  90    /** @brief elm_naviframe_item instance*/
  91    Elm_Object_Item *page;
  92    /** @brief Holds the content of a page*/
  93    Evas_Object *content[4];
  94    /** @brief Number of children*/
  95    gint child_count;
  96    /** @brief Title of the page*/
  97    const char *name;
  98 };
  99
 100 /** @brief Definition of object class for Atk EailNaviframePage*/
 101 struct _EailNaviframePageClass
 102 {
 103    AtkObjectClass parent_class; /*!< EailNaviframPage parent class*/
 104 };
 105
 106 /**
 107  * @brief Getter for EailNaviframePage GType
 108  * @returns GType for EailNaviframePage implementation
 109  */
 110 GType eail_naviframe_page_get_type(void);
 111
 112 /**
 113  * @brief Creates new EailNaviframPage object
 114  *
 115  * @param naviframe EailNaviframe parent
 116  * @param navi_tab_item item in parent naviframe object
 117  *
 118  * @returns new EailNaviframePage object
 119  */
 120 AtkObject *eail_naviframe_page_new(AtkObject *naviframe,
 121                                    Elm_Object_Item *navi_tab_item);
 122
 123 #ifdef __cplusplus
 124 }
 125 #endif
 126
 127 #endif