1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
/*
* Copyright (C) 2012 Samsung Electronics
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* @file ewk_popup_menu_item.h
* @brief Describes the Ewk Popup Menu Item API.
*/
#ifndef ewk_popup_menu_item_h
#define ewk_popup_menu_item_h
#include "ewk_view.h"
#include <Eina.h>
#ifdef __cplusplus
extern "C" {
#endif
/** Enum values containing type of popup menu item. */
typedef enum {
EWK_POPUP_MENU_SEPARATOR,
EWK_POPUP_MENU_ITEM,
EWK_POPUP_MENU_UNKNOWN = -1
} Ewk_Popup_Menu_Item_Type;
/** Creates a type name for Ewk_Popup_Menu_Item */
typedef struct EwkPopupMenuItem Ewk_Popup_Menu_Item;
/**
* Returns type of the popup menu item.
*
* @param item the popup menu item instance
*
* @return the type of the @a item or @c EWK_POPUP_MENU_UNKNOWN in case of error.
*/
EAPI Ewk_Popup_Menu_Item_Type ewk_popup_menu_item_type_get(const Ewk_Popup_Menu_Item *item);
/**
* Returns text of the popup menu item.
*
* @param item the popup menu item instance
*
* @return the text of the @a item or @c NULL in case of error. This pointer is
* guaranteed to be eina_stringshare, so whenever possible
* save yourself some cpu cycles and use
* eina_stringshare_ref() instead of eina_stringshare_add() or
* strdup()
*/
EAPI const char *ewk_popup_menu_item_text_get(const Ewk_Popup_Menu_Item *item);
/**
* Returns text direction of the popup menu item.
*
* @param item the popup menu item instance
*
* @return the text direction of the @a item.
*/
EAPI Ewk_Text_Direction ewk_popup_menu_item_text_direction_get(const Ewk_Popup_Menu_Item *item);
/**
* Returns whether the popup menu item has text direction override.
*
* @param item the popup menu item instance
*
* @return @c EINA_TRUE if the popup menu item has text direction override,
* @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool ewk_popup_menu_item_text_direction_override_get(const Ewk_Popup_Menu_Item *item);
/**
* Returns tooltip of the popup menu item.
*
* @param item the popup menu item instance
*
* @return the tooltip of the @a item or @c NULL in case of error. This pointer is
* guaranteed to be eina_stringshare, so whenever possible
* save yourself some cpu cycles and use
* eina_stringshare_ref() instead of eina_stringshare_add() or
* strdup()
*/
EAPI const char *ewk_popup_menu_item_tooltip_get(const Ewk_Popup_Menu_Item *item);
/**
* Returns accessibility text of the popup menu item.
*
* @param item the popup menu item instance
*
* @return the accessibility text of the @a item or @c NULL in case of error.
* This pointer is guaranteed to be eina_stringshare, so whenever
* possible save yourself some cpu cycles and use
* eina_stringshare_ref() instead of eina_stringshare_add() or
* strdup()
*/
EAPI const char *ewk_popup_menu_item_accessibility_text_get(const Ewk_Popup_Menu_Item *item);
/**
* Returns whether the popup menu item is enabled or not.
*
* @param item the popup menu item instance
*
* @return @c EINA_TRUE if ther popup menu item is enabled, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool ewk_popup_menu_item_enabled_get(const Ewk_Popup_Menu_Item *item);
/**
* Returns whether the popup menu item is label or not.
*
* @param item the popup menu item instance
*
* @return @c EINA_TRUE if the popup menu item is label, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool ewk_popup_menu_item_is_label_get(const Ewk_Popup_Menu_Item *item);
/**
* Returns whether the popup menu item is selected or not.
*
* @param item the popup menu item instance
*
* @return @c EINA_TRUE if the popup menu item is selected, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool ewk_popup_menu_item_selected_get(const Ewk_Popup_Menu_Item *item);
#ifdef __cplusplus
}
#endif
#endif // ewk_popup_menu_item_h
|
