eail/eail_panel.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 #ifndef EAIL_PANEL_H
  21 #define EAIL_PANEL_H
  22
  23 /**
  24  * @file eail_panel.h
  25  *
  26  * @brief Header for EailPanel implementation
  27  */
  28
  29 #include "eail_action_widget.h"
  30 /**
  31  * @brief Returns a value corresponding to the type of EailPanel class
  32  */
  33 #define EAIL_TYPE_PANEL             (eail_panel_get_type())
  34 /**
  35  * @brief Macro upcasts an instance (obj) of a subclass to the EailPanel
  36  * type
  37  *
  38  * @param obj AtkObject instance
  39  */
  40 #define EAIL_PANEL(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), \
  41                                      EAIL_TYPE_PANEL, EailPanel))
  42 /**
  43  * @brief Macro upcasts a subclass (klass) to the EailPanel class
  44  *
  45  * @param klass subclass object
  46  */
  47 #define EAIL_PANEL_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), \
  48                                      EAIL_TYPE_PANEL, EailPanelClass))
  49 /**
  50  * @brief Tests whether object (obj) is an instance of EailPanel class
  51  *
  52  * @param obj AtkObject instance
  53  */
  54 #define EAIL_IS_PANEL(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
  55                                      EAIL_TYPE_PANEL))
  56 /**
  57  * @brief Tests whether given klass is a subclass of EailPanel
  58  *
  59  * @param klass klass object
  60  */
  61 #define EAIL_IS_PANEL_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), \
  62                                      EAIL_TYPE_PANEL))
  63 /**
  64  * @brief Gets EailPanel class structure from an obj (class instance)
  65  *
  66  * @param obj object instance to get EailPanel class from
  67  */
  68 #define EAIL_PANEL_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), \
  69                                      EAIL_TYPE_PANEL, EailPanelClass))
  70
  71 #ifdef __cplusplus
  72 extern "C" {
  73 #endif
  74
  75 /** @brief Definition of object structure for Atk EailPanel*/
  76 typedef struct _EailPanel EailPanel;
  77 /** @brief Definition of object class for Atk EailPanel*/
  78 typedef struct _EailPanelClass EailPanelClass;
  79
  80 /** @brief Definition of object structure for Atk EailPanel*/
  81 struct _EailPanel
  82 {
  83    EailActionWidget parent;/**< @brief Parent widget whose functionality is being extended*/
  84    char *toggle_description;/**< @brief Description of "toggle" action */
  85 };
  86
  87 /** @brief Definition of object class for Atk EailPanel*/
  88 struct _EailPanelClass
  89 {
  90    EailActionWidgetClass parent_class;/**< @brief class that is being extended*/
  91 };
  92
  93 /**
  94  * @brief Getter for panel GType
  95  *
  96  * @returns GType for EailPanel implementation
  97  */
  98 GType eail_panel_get_type(void);
  99
 100 #ifdef __cplusplus
 101 }
 102 #endif
 103
 104 #endif