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