eail/eail_button.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_button.h
  22  *
  23  * @brief Header for EailButton implementation
  24  */
  25
  26 #ifndef EAIL_BUTTON_H
  27 #define EAIL_BUTTON_H
  28
  29 #include "eail_action_widget.h"
  30
  31 /**
  32  * @brief Returns a value corresponding to the type of EailButton class
  33  */
  34 #define EAIL_TYPE_BUTTON             (eail_button_get_type())
  35
  36 /**
  37  * @brief Macro upcasts an instance (obj) of a subclass to the EailButton
  38  * type
  39  *
  40  * @param obj AtkObject instance
  41  */
  42 #define EAIL_BUTTON(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), \
  43                                       EAIL_TYPE_BUTTON, EailButton))
  44
  45 /**
  46  * @brief Macro upcasts a subclass (klass) to the EailButton class
  47  *
  48  * @param klass subclass object
  49  */
  50 #define EAIL_BUTTON_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), \
  51                                       EAIL_TYPE_BUTTON, EailButtonClass))
  52
  53 /**
  54  * @brief Tests whether object (obj) is an instance of EailButton class
  55  *
  56  * @param obj AtkObject instance
  57  */
  58 #define EAIL_IS_BUTTON(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
  59                                       EAIL_TYPE_BUTTON))
  60
  61 /**
  62  * @brief Tests whether given klass is a subclass of EailButton
  63  *
  64  * @param klass klass object
  65  */
  66 #define EAIL_IS_BUTTON_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), \
  67                                       EAIL_TYPE_BUTTON))
  68 /**
  69  * @brief Gets EailButton class structure from an obj (class instance)
  70  *
  71  * @param obj object instance to get EailButton class from
  72  */
  73 #define EAIL_BUTTON_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), \
  74                                       EAIL_TYPE_BUTTON, EailButtonClass))
  75
  76 #ifdef __cplusplus
  77 extern "C" {
  78 #endif
  79
  80 /** @brief Definition of object structure for Atk EailButton*/
  81 typedef struct _EailButton      EailButton;
  82
  83 /** @brief Definition of class structure for Atk EailButton*/
  84 typedef struct _EailButtonClass EailButtonClass;
  85
  86 /** @brief Definition of object structure for Atk EailButton*/
  87 struct _EailButton
  88 {
  89    /** @brief Parent widget whose functionality is being extended */
  90    EailActionWidget parent;
  91 };
  92
  93 /** @brief Definition of class structure for Atk EailButton*/
  94 struct _EailButtonClass
  95 {
  96    /** @brief parent class whose functionality is being extended */
  97    EailActionWidgetClass parent_class;
  98 };
  99
 100 /**
 101  * @brief Getter for EailButton GType
 102  * @return GType for EailButton implementation
 103  */
 104 GType eail_button_get_type(void);
 105
 106 #ifdef __cplusplus
 107 }
 108 #endif
 109
 110 #endif