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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
|
#ifndef ROFI_VIEW_H
#define ROFI_VIEW_H
#include "xkb.h"
/**
* @defgroup View View
*
* The rofi Menu view.
*
* @defgroup ViewHandle ViewHandle
* @ingroup View
*
* @{
*/
typedef struct RofiViewState RofiViewState;
typedef enum
{
/** Create a menu for entering text */
MENU_NORMAL = 0,
/** Create a menu for entering passwords */
MENU_PASSWORD = 1,
/** Create amanaged window. */
MENU_NORMAL_WINDOW = 2,
/** ERROR dialog */
MENU_ERROR_DIALOG = 4,
/** INDICATOR */
MENU_INDICATOR = 8,
/** Show column */
MENU_PROMPT_COLON = 16,
} MenuFlags;
/**
* @param sw the Mode to show.
* @param input A pointer to a string where the inputted data is placed.
* @param message Extra message to display.
* @param flags Flags indicating state of the menu.
* @param finalize the finailze callback
*
* Main menu callback.
*
* @returns The command issued (see MenuReturn)
*/
RofiViewState *rofi_view_create ( Mode *sw, const char *input, const char *message, MenuFlags flags, void ( *finalize )( RofiViewState * ) );
/**
* @param state The Menu Handle
*
* Check if a finalize function is set, and if sets executes it.
*/
void rofi_view_finalize ( RofiViewState *state );
/**
* @param state the Menu handle
*
* Get the return value associated to the users action.
*
* @returns the return value
*/
MenuReturn rofi_view_get_return_value ( const RofiViewState *state );
/**
* @param state the Menu handle
*
* Returns the index of the next visible position.
*
* @return the next position.
*/
unsigned int rofi_view_get_next_position ( const RofiViewState *state );
/**
* @param state the Menu handle
* @param event the event to handle
* @param xkb the keyboard handle
*
* Process an Xevent.
*/
void rofi_view_itterrate ( RofiViewState *state, xcb_generic_event_t *event, xkb_stuff *xkb );
/**
* @param state the Menu handle
*
* @returns returns if this state is completed.
*/
unsigned int rofi_view_get_completed ( const RofiViewState *state );
/**
* @param state the Menu handle
*
* @returns the raw user input.
*/
const char * rofi_view_get_user_input ( const RofiViewState *state );
/**
* @param state The Menu Handle
* @param selected_line The line to select.
*
* Select a line.
*/
void rofi_view_set_selected_line ( RofiViewState *state, unsigned int selected_line );
/**
* @param state The Menu Handle
*
* Get the selected line.
*
* @returns the selected line or UINT32_MAX if none selected.
*/
unsigned int rofi_view_get_selected_line ( const RofiViewState *state );
/**
* @param state The Menu Handle
*
* Restart the menu so it can be displayed again.
* Resets RofiViewState::quit and RofiViewState::retv.
*/
void rofi_view_restart ( RofiViewState *state );
/**
* @param state The handle to the view
* @param action The keyboard action
*
* @returns TRUE if action was handled.
*/
gboolean rofi_view_trigger_action ( RofiViewState *state, KeyBindingAction action );
/**
* @param state The handle to the view
*
* Free's the memory allocated for this handle.
* After a call to this function, state is invalid and can no longer be used.
*/
void rofi_view_free ( RofiViewState *state );
/** @} */
/**
* @defgroup ViewGlobal ViewGlobal
* @ingroup View
*
* Global menu view functions.
* These do not work on the view itself but modifies the global state.
* @{
*/
/**
* Get the current active view Handle.
*
* @returns the active view handle or NULL
*/
RofiViewState * rofi_view_get_active ( void );
/**
* @param state the new active view handle, NULL to clear.
*
* Set the current active view Handle.
*
*/
void rofi_view_set_active ( RofiViewState *state );
/**
* @param msg The error message to show.
* @param markup The error message uses pango markup.
*
* The error message to show.
*/
int rofi_view_error_dialog ( const char *msg, int markup );
/**
* Queue a redraw.
* This triggers a X11 Expose Event.
*/
void rofi_view_queue_redraw ( void );
/**
* Cleanup internal data of the view.
*/
void rofi_view_cleanup ( void );
/**
* @param state The handle to the view
*
* Get the mode currently displayed by the view.
*
* @returns the mode currently displayed by the view
*/
Mode * rofi_view_get_mode ( RofiViewState *state );
/**
* Unmap the current view.
*/
void rofi_view_hide ( void );
/**
* Indicate the current view needs to reload its data.
* This can only be done when *more* information is available.
*
* The reloading happens 'lazy', multiple calls might be handled at once.
*/
void rofi_view_reload ( void );
/**
* @param state The handle to the view
* @param mode The new mode to display
*
* Change the current view to show a different mode.
*/
void rofi_view_switch_mode ( RofiViewState *state, Mode *mode );
/**
* @param state The handle to the view
* @param text An UTF-8 encoded character array with the text to overlay.
*
* Overlays text over the current view. Passing NULL for text hides the overlay.
*/
void rofi_view_set_overlay ( RofiViewState *state, const char *text );
/**
* @param state The handle to the view.
*
* Clears the user entry box, set selected to 0.
*/
void rofi_view_clear_input ( RofiViewState *state );
/**
* @param menu_flags The state of the new window.
*
* Creates the internal 'Cached' window that gets reused between views.
* TODO: Internal call to view exposed.
*/
void __create_window ( MenuFlags menu_flags );
/**
* Get the handle of the main window.
*
* @returns the xcb_window_t for rofi's view or XCB_WINDOW_NONE.
*/
xcb_window_t rofi_view_get_window ( void );
/** @} */
/***
* @defgroup ViewThreadPool ViewThreadPool
* @ingroup View
*
* The view can (optionally) keep a set of worker threads around to parallize work.
* This includes filtering and sorting.
*
* @{
*/
/**
* Initialize the threadpool
*/
void rofi_view_workers_initialize ( void );
/**
* Stop all threads and free the resources used by the threadpool
*/
void rofi_view_workers_finalize ( void );
/**@}*/
#endif
|