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