comparison finch/libgnt/gntwm.h @ 21161:e119edfc0fb0

applied changes from 172a59b41412c4630834d66f2e7ec3be970cc36b through 365b126365cc18309aea7f8eef0e9b2a19e6bda8 And others.
author Sadrul Habib Chowdhury <imadil@gmail.com>
date Wed, 07 Nov 2007 14:07:52 +0000
parents bddf964880cf
children
comparison
equal deleted inserted replaced
21160:45e550db32ab 21161:e119edfc0fb0
111 * 'event_stack' will be set to TRUE when a user-event, ie. a mouse-click 111 * 'event_stack' will be set to TRUE when a user-event, ie. a mouse-click
112 * or a key-press is being processed. This variable will be used to determine 112 * or a key-press is being processed. This variable will be used to determine
113 * whether to give focus to a new window. 113 * whether to give focus to a new window.
114 */ 114 */
115 gboolean event_stack; 115 gboolean event_stack;
116 116
117 GntKeyPressMode mode; 117 GntKeyPressMode mode;
118 118
119 GHashTable *positions; 119 GHashTable *positions;
120 120
121 void *res1; 121 void *res1;
182 }; 182 };
183 183
184 G_BEGIN_DECLS 184 G_BEGIN_DECLS
185 185
186 /** 186 /**
187 * 187 * @return GType for GntWM.
188 *
189 * @return
190 */ 188 */
191 GType gnt_wm_get_gtype(void); 189 GType gnt_wm_get_gtype(void);
192 190
191 /**
192 * Add a workspace.
193 * @param wm The window-manager.
194 * @param ws The workspace to add.
195 */
193 void gnt_wm_add_workspace(GntWM *wm, GntWS *ws); 196 void gnt_wm_add_workspace(GntWM *wm, GntWS *ws);
194 197
198 /**
199 * Switch to a workspace.
200 * @param wm The window-manager.
201 * @param n Index of the workspace to switch to.
202 *
203 * @return @c TRUE if the switch was successful.
204 */
195 gboolean gnt_wm_switch_workspace(GntWM *wm, gint n); 205 gboolean gnt_wm_switch_workspace(GntWM *wm, gint n);
206
207 /**
208 * Switch to the previous workspace from the current one.
209 * @param wm The window-manager.
210 */
196 gboolean gnt_wm_switch_workspace_prev(GntWM *wm); 211 gboolean gnt_wm_switch_workspace_prev(GntWM *wm);
212
213 /**
214 * Switch to the next workspace from the current one.
215 * @param wm The window-manager.
216 */
197 gboolean gnt_wm_switch_workspace_next(GntWM *wm); 217 gboolean gnt_wm_switch_workspace_next(GntWM *wm);
218
219 /**
220 * Move a window to a specific workspace.
221 * @param wm The window manager.
222 * @param neww The new workspace.
223 * @param widget The widget to move.
224 */
198 void gnt_wm_widget_move_workspace(GntWM *wm, GntWS *neww, GntWidget *widget); 225 void gnt_wm_widget_move_workspace(GntWM *wm, GntWS *neww, GntWidget *widget);
226
227 /**
228 * Set the list of workspaces .
229 * @param wm The window manager.
230 * @param workspaces The list of workspaces.
231 */
199 void gnt_wm_set_workspaces(GntWM *wm, GList *workspaces); 232 void gnt_wm_set_workspaces(GntWM *wm, GList *workspaces);
233
234 /**
235 * Find the workspace that contains a specific widget.
236 * @param wm The window-manager.
237 * @param widget The widget to find.
238 * @return The workspace that has the widget.
239 */
200 GntWS *gnt_wm_widget_find_workspace(GntWM *wm, GntWidget *widget); 240 GntWS *gnt_wm_widget_find_workspace(GntWM *wm, GntWidget *widget);
201 241
202 /** 242 /**
203 * 243 * Process a new window.
204 * @param wm 244 *
205 * @param widget 245 * @param wm The window-manager.
246 * @param widget The new window.
206 */ 247 */
207 void gnt_wm_new_window(GntWM *wm, GntWidget *widget); 248 void gnt_wm_new_window(GntWM *wm, GntWidget *widget);
208 249
209 /** 250 /**
210 * 251 * Decorate a window.
211 * @param wm 252 * @param wm The window-manager.
212 * @param widget 253 * @param widget The widget to decorate.
213 */ 254 */
214 void gnt_wm_window_decorate(GntWM *wm, GntWidget *widget); 255 void gnt_wm_window_decorate(GntWM *wm, GntWidget *widget);
215 256
216 /** 257 /**
217 * 258 * Close a window.
218 * @param wm 259 * @param wm The window-manager.
219 * @param widget 260 * @param widget The window to close.
220 */ 261 */
221 void gnt_wm_window_close(GntWM *wm, GntWidget *widget); 262 void gnt_wm_window_close(GntWM *wm, GntWidget *widget);
222 263
223 /** 264 /**
224 * 265 * Process input.
225 * @param wm 266 *
226 * @param string 267 * @param wm The window-manager.
227 * 268 * @param string The input string to process.
228 * @return 269 *
270 * @return @c TRUE of the string was processed, @c FALSE otherwise.
229 */ 271 */
230 gboolean gnt_wm_process_input(GntWM *wm, const char *string); 272 gboolean gnt_wm_process_input(GntWM *wm, const char *string);
231 273
232 /** 274 /**
233 * 275 * Process a click event.
234 * @param wm 276 * @param wm The window manager.
235 * @param event 277 * @param event The mouse event.
236 * @param x 278 * @param x The x-coordinate of the mouse.
237 * @param y 279 * @param y The y-coordinate of the mouse.
238 * @param widget 280 * @param widget The widget under the mouse.
239 * 281 *
240 * @return 282 * @return @c TRUE if the event was handled, @c FALSE otherwise.
241 */ 283 */
242 gboolean gnt_wm_process_click(GntWM *wm, GntMouseEvent event, int x, int y, GntWidget *widget); 284 gboolean gnt_wm_process_click(GntWM *wm, GntMouseEvent event, int x, int y, GntWidget *widget);
243 285
244 /** 286 /**
245 * 287 * Resize a window.
246 * @param wm 288 * @param wm The window manager.
247 * @param widget 289 * @param widget The window to resize.
248 * @param width 290 * @param width The desired width of the window.
249 * @param height 291 * @param height The desired height of the window.
250 */ 292 */
251 void gnt_wm_resize_window(GntWM *wm, GntWidget *widget, int width, int height); 293 void gnt_wm_resize_window(GntWM *wm, GntWidget *widget, int width, int height);
252 294
253 /** 295 /**
254 * 296 * Move a window.
255 * @param wm 297 * @param wm The window manager.
256 * @param widget 298 * @param widget The window to move.
257 * @param x 299 * @param x The desired x-coordinate of the window.
258 * @param y 300 * @param y The desired y-coordinate of the window.
259 */ 301 */
260 void gnt_wm_move_window(GntWM *wm, GntWidget *widget, int x, int y); 302 void gnt_wm_move_window(GntWM *wm, GntWidget *widget, int x, int y);
261 303
262 /** 304 /**
263 * 305 * Update a window.
264 * @param wm 306 * @param wm The window-manager.
265 * @param widget 307 * @param widget The window to update.
266 */ 308 */
267 void gnt_wm_update_window(GntWM *wm, GntWidget *widget); 309 void gnt_wm_update_window(GntWM *wm, GntWidget *widget);
268 310
269 /** 311 /**
270 * 312 * Raise a window.
271 * @param wm 313 * @param wm The window-manager.
272 * @param widget 314 * @param widget The window to raise.
273 */ 315 */
274 void gnt_wm_raise_window(GntWM *wm, GntWidget *widget); 316 void gnt_wm_raise_window(GntWM *wm, GntWidget *widget);
275 317
276 /** 318 /**
277 * 319 * @internal
278 * @param wm
279 * @param set
280 */ 320 */
281 void gnt_wm_set_event_stack(GntWM *wm, gboolean set); 321 void gnt_wm_set_event_stack(GntWM *wm, gboolean set);
282 322
323 /**
324 * @internal
325 */
283 void gnt_wm_copy_win(GntWidget *widget, GntNode *node); 326 void gnt_wm_copy_win(GntWidget *widget, GntNode *node);
284 327
285 /** 328 /**
286 * 329 * @return The idle time of the user.
287 *
288 * @return
289 */ 330 */
290 time_t gnt_wm_get_idle_time(void); 331 time_t gnt_wm_get_idle_time(void);
291 332
292 G_END_DECLS 333 G_END_DECLS
293 #endif 334 #endif