eail/eail_ctxpopup.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_ctxpopup.h
  22  *
  23  *  @brief Header for EailCtxpopup implementation
  24  */
  25
  26 #ifndef EAIL_CTXPOPUP_H
  27 #define EAIL_CTXPOPUP_H
  28
  29 #include "eail_widget.h"
  30 /**
  31  * @brief Returns a value corresponding to the type of EailCtxpopup class
  32  */
  33
  34 #define EAIL_TYPE_CTXPOPUP             (eail_ctxpopup_get_type())
  35 /**
  36  * @brief Macro upcasts an instance (obj) of a subclass to the EailCtxpopup
  37  * type
  38  *
  39  * @param obj AtkObject instance
  40  */
  41 #define EAIL_CTXPOPUP(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), \
  42                                         EAIL_TYPE_CTXPOPUP, EailCtxpopup))
  43 /**
  44  * @brief Macro upcasts a subclass (klass) to the EailCtxpopup class
  45  *
  46  * @param klass subclass object
  47  */
  48 #define EAIL_CTXPOPUP_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), \
  49                                         EAIL_TYPE_CTXPOPUP, EailCtxpopupClass))
  50 /**
  51  * @brief Tests whether object (obj) is an instance of EailCtxpopup class
  52  *
  53  * @param obj AtkObject instance
  54  */
  55 #define EAIL_IS_CTXPOPUP(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
  56                                         EAIL_TYPE_CTXPOPUP))
  57 /**
  58  * @brief Tests whether given klass is a subclass of EailCtxpopup
  59  *
  60  * @param klass klass object
  61  */
  62 #define EAIL_IS_CTXPOPUP_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), \
  63                                         EAIL_TYPE_CTXPOPUP))
  64 /**
  65  * @brief Gets EailCtxpopup class structure from an obj (class instance)
  66  *
  67  * @param obj object instance to get EailCtxpopup class from
  68  */
  69 #define EAIL_CTXPOPUP_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), \
  70                                         EAIL_TYPE_CTXPOPUP, EailCtxpopupClass))
  71
  72 #ifdef __cplusplus
  73 extern "C" {
  74 #endif
  75
  76 /** @brief Definition of object structure for Atk EailCtxpopup*/
  77 typedef struct _EailCtxpopup      EailCtxpopup;
  78
  79 /** @brief Definition of class structure for Atk EailCtxpopup*/
  80 typedef struct _EailCtxpopupClass EailCtxpopupClass;
  81
  82 /** @brief Definition of object structure for Atk EailCtxpopup*/
  83 struct _EailCtxpopup
  84 {
  85    /** @brief Parent widget whose functionality is being extended */
  86    EailWidget parent;
  87    /** @brief "dismiss" action description*/
  88    char *dismiss_description;
  89 };
  90
  91 /** @brief Definition of class structure for Atk EailCtxpopup*/
  92 struct _EailCtxpopupClass
  93 {
  94    /** @brief parent class whose functionality is being extended */
  95    EailWidgetClass parent_class;
  96 };
  97
  98 /** @brief Getter for EailCtxpopup GType
  99  *
 100  * @returns GType for EailCtxpopup implementation*/
 101 GType eail_ctxpopup_get_type(void);
 102
 103 #ifdef __cplusplus
 104 }
 105 #endif
 106
 107 #endif