eail/eail_scroller.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_SCROLLER_H
  21 #define EAIL_SCROLLER_H
  22
  23 /**
  24  * @file eail_scroller.h
  25  *
  26  * @brief Header for EailScrollableWidget implementation
  27  */
  28
  29 #include "eail_scrollable_widget.h"
  30 /**
  31  * @brief Returns a value corresponding to the type of EailScroller class
  32  */
  33 #define EAIL_TYPE_SCROLLER              (eail_scroller_get_type())
  34 /**
  35  * @brief Macro upcasts an instance (obj) of a subclass to the EailScroller
  36  * type
  37  *
  38  * @param obj AtkObject instance
  39  */
  40 #define EAIL_SCROLLER(obj)              (G_TYPE_CHECK_INSTANCE_CAST((obj), \
  41                                          EAIL_TYPE_SCROLLER, EailScroller))
  42 /**
  43  * @brief Macro upcasts a subclass (klass) to the EailScroller class
  44  *
  45  * @param klass subclass object
  46  */
  47 #define EAIL_SCROLLER_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST((klass), \
  48                                          EAIL_TYPE_SCROLLER, EailScrollerClass))
  49 /**
  50  * @brief Tests whether object (obj) is an instance of EailScroller class
  51  *
  52  * @param obj AtkObject instance
  53  */
  54 #define EAIL_IS_SCROLLER(obj)           (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
  55                                          EAIL_TYPE_SCROLLER))
  56 /**
  57  * @brief Tests whether given klass is a subclass of EailScroller
  58  *
  59  * @param klass klass object
  60  */
  61 #define EAIL_IS_SCROLLER_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE((klass), \
  62                                          EAIL_TYPE_SCROLLER))
  63 /**
  64  * @brief Gets EailScroller class structure from an obj (class instance)
  65  *
  66  * @param obj object instance to get EailScroller class from
  67  */
  68 #define EAIL_SCROLLER_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS((obj), \
  69                                          EAIL_TYPE_SCROLLER, EailScrollerClass))
  70 #ifdef __cplusplus
  71 extern "C" {
  72 #endif
  73
  74 /** @brief Definition of object structure for Atk EailScroller*/
  75 typedef struct _EailScroller      EailScroller;
  76 /** @brief Definition of object class for Atk EailScroller*/
  77 typedef struct _EailScrollerClass EailScrollerClass;
  78
  79 /** @brief Definition of object structure for Atk EailScroller*/
  80 struct _EailScroller
  81 {
  82    /** @brief Parent widget whose functionality is being extended*/
  83     EailScrollableWidget parent;
  84 };
  85
  86 /** @brief Definition of object class for Atk EailScroller*/
  87 struct _EailScrollerClass
  88 {
  89    /** @brief Parent object that functionality is being extended*/
  90    EailScrollableWidgetClass parent_class;
  91 };
  92
  93 /** @brief Getter for EailScroller GType
  94  *
  95  * @returns GType for EailScroller implementation*/
  96 GType   eail_scroller_get_type  (void);
  97
  98 #ifdef __cplusplus
  99 }
 100 #endif
 101
 102 #endif