eail/eail_popup.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_POPUP_H
  21 #define EAIL_POPUP_H
  22
  23 /**
  24  * @file eail_popup.h
  25  *
  26  * @brief Header for EailPopup implementation
  27  */
  28
  29 #include "eail_notify.h"
  30 /**
  31  * @brief Returns a value corresponding to the type of EailPopup class
  32  */
  33 #define EAIL_TYPE_POPUP             (eail_popup_get_type())
  34 /**
  35  * @brief Macro upcasts an instance (obj) of a subclass to the EailPopup
  36  * type
  37  *
  38  * @param obj AtkObject instance
  39  */
  40 #define EAIL_POPUP(obj)             (G_TYPE_POPUP_INSTANCE_CAST((obj), \
  41                                             EAIL_TYPE_POPUP, \
  42                                             EailPopup))
  43 /**
  44  * @brief Macro upcasts a subclass (klass) to the EailPopup class
  45  *
  46  * @param klass subclass object
  47  */
  48 #define EAIL_POPUP_CLASS(klass)     (G_TYPE_POPUP_CLASS_CAST((klass), \
  49                                             EAIL_TYPE_POPUP, \
  50                                             EailPopupClass))
  51 /**
  52  * @brief Tests whether object (obj) is an instance of EailPopup class
  53  *
  54  * @param obj AtkObject instance
  55  */
  56 #define EAIL_IS_POPUP(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
  57                                             EAIL_TYPE_POPUP))
  58 /**
  59  * @brief Tests whether given klass is a subclass of EailPopup
  60  *
  61  * @param klass klass object
  62  */
  63 #define EAIL_IS_POPUP_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), \
  64                                             EAIL_TYPE_POPUP))
  65 /**
  66  * @brief Gets EailPopup class structure from an obj (class instance)
  67  *
  68  * @param obj object instance to get EailPopup class from
  69  */
  70 #define EAIL_POPUP_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), \
  71                                             EAIL_TYPE_POPUP, \
  72                                             EailPopupClass))
  73
  74 #ifdef __cplusplus
  75 extern "C" {
  76 #endif
  77
  78 /** @brief Definition of object structure for Atk EailPopup*/
  79 typedef struct _EailPopup EailPopup;
  80 /** @brief Definition of object class for Atk EailPopup*/
  81 typedef struct _EailPopupClass EailPopupClass;
  82
  83 /** @brief Definition of object structure for Atk EailPopup*/
  84 struct _EailPopup
  85 {
  86    /** @brief Parent widget whose functionality is being extended*/
  87    EailNotify parent;
  88 };
  89
  90 /** @brief Definition of object class for Atk EailPopup*/
  91 struct _EailPopupClass
  92 {
  93    /** @brief Parent object that functionality is being extended*/
  94    EailNotifyClass parent_class;
  95 };
  96
  97 /** @brief Getter for EailPopup GType
  98  *
  99  * @returns GType for EailPopup implementation*/
 100 GType eail_popup_get_type(void);
 101
 102 #ifdef __cplusplus
 103 }
 104 #endif
 105
 106 #endif
 107