eail/eail_radio_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 #ifndef EAIL_RADIO_BUTTON_H
  21 #define EAIL_RADIO_BUTTON_H
  22
  23 /**
  24  * @file eail_radio_button.h
  25  *
  26  * @brief Header for EailRadioButton implementation
  27  */
  28
  29 #include "eail_button.h"
  30 /**
  31  * @brief Returns a value corresponding to the type of EailRadiobutton class
  32  */
  33 #define EAIL_TYPE_RADIO_BUTTON              (eail_radio_button_get_type ())
  34 /**
  35  * @brief Macro upcasts an instance (obj) of a subclass to the EailRadiobutton
  36  * type
  37  *
  38  * @param obj AtkObject instance
  39  */
  40 #define EAIL_RADIO_BUTTON(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj),\
  41                                              EAIL_TYPE_RADIO_BUTTON, \
  42                                              EailRadioButton))
  43 /**
  44  * @brief Macro upcasts a subclass (klass) to the EailRadiobutton class
  45  *
  46  * @param klass subclass object
  47  */
  48 #define EAIL_RADIO_BUTTON_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), \
  49                                              EAIL_TYPE_RADIO_BUTTON, \
  50                                              EailRadioButtonClass))
  51 /**
  52  * @brief Tests whether object (obj) is an instance of EailRadiobutton class
  53  *
  54  * @param obj AtkObject instance
  55  */
  56 #define EAIL_IS_RADIO_BUTTON(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj),\
  57                                              EAIL_TYPE_RADIO_BUTTON))
  58 /**
  59  * @brief Tests whether given klass is a subclass of EailRadiobutton
  60  *
  61  * @param klass klass object
  62  */
  63 #define EAIL_IS_RADIO_BUTTON_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), \
  64                                              EAIL_TYPE_RADIO_BUTTON))
  65 /**
  66  * @brief Gets EailRadiobutton class structure from an obj (class instance)
  67  *
  68  * @param obj object instance to get EailRadiobutton class from
  69  */
  70 #define EAIL_RADIO_BUTTON_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), \
  71                                              EAIL_TYPE_RADIO_BUTTON, \
  72                                              EailRadioButtonClass))
  73
  74 #ifdef __cplusplus
  75 extern "C" {
  76 #endif
  77
  78 /** @brief Definition of object structure for Atk EailRadiobutton*/
  79 typedef struct _EailRadioButton EailRadioButton;
  80 /** @brief Definition of object class for Atk EailRadiobutton*/
  81 typedef struct _EailRadioButtonClass EailRadioButtonClass;
  82
  83 /** @brief Definition of object structure for Atk EailRadiobutton*/
  84 struct _EailRadioButton
  85 {
  86    /** @brief Parent widget whose functionality is being extended*/
  87    EailButton parent;
  88    char *click_description; /*!< @brief 'click' action description*/
  89    Eina_Bool state; /*!< @brief State of object (selected/unselected)*/
  90 };
  91
  92 /** @brief Definition of object class for Atk EailRadiobutton*/
  93 struct _EailRadioButtonClass
  94 {
  95    /** @brief Parent class whose functionality is being extended*/
  96    EailButtonClass parent_class;
  97 };
  98
  99 /** @brief Getter for EailRadioButton GType
 100  *
 101  * @returns GType for EailRadiobutton implementation*/
 102 GType eail_radio_button_get_type(void);
 103
 104 #ifdef __cplusplus
 105 }
 106 #endif
 107
 108 #endif