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