Merge "custom eail widget implementation" into tizen
[platform/core/uifw/eail.git] / eail / eail_progressbar.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_progressbar.h
22  *
23  * @brief Header for EailProgressbar implementation
24  */
25
26 #ifndef EAIL_PROGRESSBAR_H
27 #define EAIL_PROGRESSBAR_H
28
29 #include "eail_widget.h"
30 /**
31  * @brief Returns a value corresponding to the type of EailProgressbar class
32  */
33
34 #define EAIL_TYPE_PROGRESSBAR             (eail_progressbar_get_type())
35 /**
36  * @brief Macro upcasts an instance (obj) of a subclass to the EailProgressbar
37  * type
38  *
39  * @param obj AtkObject instance
40  */
41 #define EAIL_PROGRESSBAR(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), \
42                                            EAIL_TYPE_PROGRESSBAR, EailProgressbar))
43 /**
44  * @brief Macro upcasts a subclass (klass) to the EailProgressbar class
45  *
46  * @param klass subclass object
47  */
48 #define EAIL_PROGRESSBAR_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), \
49                                            EAIL_TYPE_PROGRESSBAR, EailProgressbarClass))
50 /**
51  * @brief Tests whether object (obj) is an instance of EailProgressbar class
52  *
53  * @param obj AtkObject instance
54  */
55 #define EAIL_IS_PROGRESSBAR(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
56                                            EAIL_TYPE_PROGRESSBAR))
57 /**
58  * @brief Tests whether given klass is a subclass of EailProgressbar
59  *
60  * @param klass klass object
61  */
62 #define EAIL_IS_PROGRESSBAR_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), \
63                                            EAIL_TYPE_PROGRESSBAR))
64 /**
65  * @brief Gets EailProgressbar class structure from an obj (class instance)
66  *
67  * @param obj object instance to get EailProgressbar class from
68  */
69 #define EAIL_PROGRESSBAR_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), \
70                                            EAIL_TYPE_PROGRESSBAR, EailProgressbarClass))
71
72 #ifdef __cplusplus
73 extern "C" {
74 #endif
75
76 /** @brief Definition of object structure for Atk EailProgressbar*/
77 typedef struct _EailProgressbar      EailProgressbar;
78 /** @brief Definition of object class for Atk EailProgressbar*/
79 typedef struct _EailProgressbarClass EailProgressbarClass;
80
81 /** @brief Definition of object structure for Atk EailProgressbar*/
82 struct _EailProgressbar
83 {
84    /** @brief Parent widget whose functionality is being extended*/
85    EailWidget parent;
86 };
87
88 /** @brief Definition of object class for Atk EailProgressbar*/
89 struct _EailProgressbarClass
90 {
91    /** @brief Parent class whose functionality is being extended*/
92    EailWidgetClass parent_class;
93 };
94
95 /** @brief Getter for EailProgressbar GType
96  *
97  * @returns GType for EailProgressbar implementation*/
98 GType eail_progressbar_get_type(void);
99
100 #ifdef __cplusplus
101 }
102 #endif
103
104 #endif