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