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