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