eail/eail_video.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_video.h
  22  *
  23  * @brief Header for EailVideo implementation
  24  */
  25 #ifndef EAIL_VIDEO_H
  26 #define EAIL_VIDEO_H
  27
  28 #include "eail_widget.h"
  29
  30 /**
  31  * @brief Returns a value corresponding to the type of EailVideo class
  32  */
  33 #define EAIL_TYPE_VIDEO             (eail_video_get_type ())
  34
  35 /**
  36  * @brief Macro upcasts an instance (obj) of a subclass to the EailVideo
  37  * type
  38  *
  39  * @param obj an AtkObject
  40  */
  41 #define EAIL_VIDEO(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
  42                                      EAIL_TYPE_VIDEO, EailVideo))
  43
  44 /**
  45  * @brief Macro upcasts a subclass (klass) to the EailVideo class
  46  *
  47  * @param klass subclass object
  48  */
  49 #define EAIL_VIDEO_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), \
  50                                      EAIL_TYPE_VIDEO, EailVideoClass))
  51
  52 /**
  53  * @brief Tests whether object (obj) is an instance of EailVideo class
  54  *
  55  * @param obj an AtkObject
  56  */
  57 #define EAIL_IS_VIDEO(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
  58                                      EAIL_TYPE_VIDEO))
  59
  60 /**
  61  * @brief Tests whether given klass is a subclass of EailVideo
  62  *
  63  * @param klass klass object
  64  */
  65 #define EAIL_IS_VIDEO_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), \
  66                                      EAIL_TYPE_VIDEO))
  67
  68 /**
  69  * @brief Gets EailVideo class structure from an obj (class instance)
  70  *
  71  * @param obj object instance to get EailVideo class from
  72  */
  73 #define EAIL_VIDEO_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), \
  74                                      EAIL_TYPE_VIDEO, EailVideoClass))
  75 #ifdef __cplusplus
  76 extern "C" {
  77 #endif
  78
  79 /** @brief Definition of object structure for Atk EailVideo*/
  80 typedef struct _EailVideo       EailVideo;
  81
  82 /** @brief Definition of object structure for Atk EailVideo*/
  83 typedef struct _EailVideoClass  EailVideoClass;
  84
  85 /** @brief Definition of object structure for Atk EailVideo*/
  86 struct _EailVideo
  87 {
  88     /** @brief Parent widget whose functionality is being extended*/
  89     EailWidget parent;
  90     /** @brief 'forward' action description*/
  91     char *forward_desc;
  92     /** @brief 'next' action descritpion*/
  93     char *next_desc;
  94     /** @brief 'pause' action descirption*/
  95     char *pause_desc;
  96     /** @brief 'play' action description*/
  97     char *play_desc;
  98     /** @brief 'prev' action description*/
  99     char *prev_desc;
 100     /** @brief 'rewind' action description*/
 101     char *rewind_desc;
 102     /** @brief 'stop' action description*/
 103     char *stop_desc;
 104     /** @brief Video file URI*/
 105     char *uri;
 106 };
 107
 108 /** @brief Definition of object structure for Atk EailVideo*/
 109 struct _EailVideoClass
 110 {
 111     EailWidgetClass parent_class;/*!< class that is being extended*/
 112 };
 113
 114 /** @brief Getter for EailVideo GType
 115  *
 116  * @returns GType for EailVideo implementation*/
 117 GType eail_video_get_type (void);
 118
 119 #ifdef __cplusplus
 120 }
 121 #endif
 122
 123 #endif