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