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