comparison: finch/libgnt/gntwm.h
finch/libgnt/gntwm.h
- branch
- soc.2013.gobjectification.plugins
- changeset 37017
- 8e2b68c79fa1
- parent 32206
- a2c62b07ae5a
- child 37021
- 04c99b24db84
equal
deleted
inserted
replaced
| 37016:48f85579cc4c | 37017:8e2b68c79fa1 |
|---|---|
| 182 }; | 182 }; |
| 183 | 183 |
| 184 G_BEGIN_DECLS | 184 G_BEGIN_DECLS |
| 185 | 185 |
| 186 /** | 186 /** |
| 187 * @return GType for GntWM. | 187 * Returns: GType for GntWM. |
| 188 */ | 188 */ |
| 189 GType gnt_wm_get_gtype(void); | 189 GType gnt_wm_get_gtype(void); |
| 190 | 190 |
| 191 /** | 191 /** |
| 192 * Add a workspace. | 192 * Add a workspace. |
| 193 * @param wm The window-manager. | 193 * @wm: The window-manager. |
| 194 * @param ws The workspace to add. | 194 * @ws: The workspace to add. |
| 195 */ | 195 */ |
| 196 void gnt_wm_add_workspace(GntWM *wm, GntWS *ws); | 196 void gnt_wm_add_workspace(GntWM *wm, GntWS *ws); |
| 197 | 197 |
| 198 /** | 198 /** |
| 199 * Switch to a workspace. | 199 * Switch to a workspace. |
| 200 * @param wm The window-manager. | 200 * @wm: The window-manager. |
| 201 * @param n Index of the workspace to switch to. | 201 * @param n Index of the workspace to switch to. |
| 202 * | 202 * |
| 203 * @return @c TRUE if the switch was successful. | 203 * Returns: @c TRUE if the switch was successful. |
| 204 */ | 204 */ |
| 205 gboolean gnt_wm_switch_workspace(GntWM *wm, gint n); | 205 gboolean gnt_wm_switch_workspace(GntWM *wm, gint n); |
| 206 | 206 |
| 207 /** | 207 /** |
| 208 * Switch to the previous workspace from the current one. | 208 * Switch to the previous workspace from the current one. |
| 209 * @param wm The window-manager. | 209 * @wm: The window-manager. |
| 210 */ | 210 */ |
| 211 gboolean gnt_wm_switch_workspace_prev(GntWM *wm); | 211 gboolean gnt_wm_switch_workspace_prev(GntWM *wm); |
| 212 | 212 |
| 213 /** | 213 /** |
| 214 * Switch to the next workspace from the current one. | 214 * Switch to the next workspace from the current one. |
| 215 * @param wm The window-manager. | 215 * @wm: The window-manager. |
| 216 */ | 216 */ |
| 217 gboolean gnt_wm_switch_workspace_next(GntWM *wm); | 217 gboolean gnt_wm_switch_workspace_next(GntWM *wm); |
| 218 | 218 |
| 219 /** | 219 /** |
| 220 * Move a window to a specific workspace. | 220 * Move a window to a specific workspace. |
| 221 * @param wm The window manager. | 221 * @wm: The window manager. |
| 222 * @param neww The new workspace. | 222 * @neww: The new workspace. |
| 223 * @param widget The widget to move. | 223 * @widget: The widget to move. |
| 224 */ | 224 */ |
| 225 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 | 226 |
| 227 /** | 227 /** |
| 228 * Set the list of workspaces . | 228 * Set the list of workspaces . |
| 229 * @param wm The window manager. | 229 * @wm: The window manager. |
| 230 * @param workspaces The list of workspaces. | 230 * @workspaces: The list of workspaces. |
| 231 */ | 231 */ |
| 232 void gnt_wm_set_workspaces(GntWM *wm, GList *workspaces); | 232 void gnt_wm_set_workspaces(GntWM *wm, GList *workspaces); |
| 233 | 233 |
| 234 /** | 234 /** |
| 235 * Find the workspace that contains a specific widget. | 235 * Find the workspace that contains a specific widget. |
| 236 * @param wm The window-manager. | 236 * @wm: The window-manager. |
| 237 * @param widget The widget to find. | 237 * @widget: The widget to find. |
| 238 * @return The workspace that has the widget. | 238 * Returns: The workspace that has the widget. |
| 239 */ | 239 */ |
| 240 GntWS *gnt_wm_widget_find_workspace(GntWM *wm, GntWidget *widget); | 240 GntWS *gnt_wm_widget_find_workspace(GntWM *wm, GntWidget *widget); |
| 241 | 241 |
| 242 /** | 242 /** |
| 243 * Process a new window. | 243 * Process a new window. |
| 244 * | 244 * |
| 245 * @param wm The window-manager. | 245 * @wm: The window-manager. |
| 246 * @param widget The new window. | 246 * @widget: The new window. |
| 247 */ | 247 */ |
| 248 void gnt_wm_new_window(GntWM *wm, GntWidget *widget); | 248 void gnt_wm_new_window(GntWM *wm, GntWidget *widget); |
| 249 | 249 |
| 250 /** | 250 /** |
| 251 * Decorate a window. | 251 * Decorate a window. |
| 252 * @param wm The window-manager. | 252 * @wm: The window-manager. |
| 253 * @param widget The widget to decorate. | 253 * @widget: The widget to decorate. |
| 254 */ | 254 */ |
| 255 void gnt_wm_window_decorate(GntWM *wm, GntWidget *widget); | 255 void gnt_wm_window_decorate(GntWM *wm, GntWidget *widget); |
| 256 | 256 |
| 257 /** | 257 /** |
| 258 * Close a window. | 258 * Close a window. |
| 259 * @param wm The window-manager. | 259 * @wm: The window-manager. |
| 260 * @param widget The window to close. | 260 * @widget: The window to close. |
| 261 */ | 261 */ |
| 262 void gnt_wm_window_close(GntWM *wm, GntWidget *widget); | 262 void gnt_wm_window_close(GntWM *wm, GntWidget *widget); |
| 263 | 263 |
| 264 /** | 264 /** |
| 265 * Process input. | 265 * Process input. |
| 266 * | 266 * |
| 267 * @param wm The window-manager. | 267 * @wm: The window-manager. |
| 268 * @param string The input string to process. | 268 * @string: The input string to process. |
| 269 * | 269 * |
| 270 * @return @c TRUE of the string was processed, @c FALSE otherwise. | 270 * Returns: @c TRUE of the string was processed, @c FALSE otherwise. |
| 271 */ | 271 */ |
| 272 gboolean gnt_wm_process_input(GntWM *wm, const char *string); | 272 gboolean gnt_wm_process_input(GntWM *wm, const char *string); |
| 273 | 273 |
| 274 /** | 274 /** |
| 275 * Process a click event. | 275 * Process a click event. |
| 276 * @param wm The window manager. | 276 * @wm: The window manager. |
| 277 * @param event The mouse event. | 277 * @event: The mouse event. |
| 278 * @param x The x-coordinate of the mouse. | 278 * @param x The x-coordinate of the mouse. |
| 279 * @param y The y-coordinate of the mouse. | 279 * @param y The y-coordinate of the mouse. |
| 280 * @param widget The widget under the mouse. | 280 * @widget: The widget under the mouse. |
| 281 * | 281 * |
| 282 * @return @c TRUE if the event was handled, @c FALSE otherwise. | 282 * Returns: @c TRUE if the event was handled, @c FALSE otherwise. |
| 283 */ | 283 */ |
| 284 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); |
| 285 | 285 |
| 286 /** | 286 /** |
| 287 * Resize a window. | 287 * Resize a window. |
| 288 * @param wm The window manager. | 288 * @wm: The window manager. |
| 289 * @param widget The window to resize. | 289 * @widget: The window to resize. |
| 290 * @param width The desired width of the window. | 290 * @width: The desired width of the window. |
| 291 * @param height The desired height of the window. | 291 * @height: The desired height of the window. |
| 292 */ | 292 */ |
| 293 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); |
| 294 | 294 |
| 295 /** | 295 /** |
| 296 * Move a window. | 296 * Move a window. |
| 297 * @param wm The window manager. | 297 * @wm: The window manager. |
| 298 * @param widget The window to move. | 298 * @widget: The window to move. |
| 299 * @param x The desired x-coordinate of the window. | 299 * @param x The desired x-coordinate of the window. |
| 300 * @param y The desired y-coordinate of the window. | 300 * @param y The desired y-coordinate of the window. |
| 301 */ | 301 */ |
| 302 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); |
| 303 | 303 |
| 304 /** | 304 /** |
| 305 * Update a window. | 305 * Update a window. |
| 306 * @param wm The window-manager. | 306 * @wm: The window-manager. |
| 307 * @param widget The window to update. | 307 * @widget: The window to update. |
| 308 */ | 308 */ |
| 309 void gnt_wm_update_window(GntWM *wm, GntWidget *widget); | 309 void gnt_wm_update_window(GntWM *wm, GntWidget *widget); |
| 310 | 310 |
| 311 /** | 311 /** |
| 312 * Raise a window. | 312 * Raise a window. |
| 313 * @param wm The window-manager. | 313 * @wm: The window-manager. |
| 314 * @param widget The window to raise. | 314 * @widget: The window to raise. |
| 315 */ | 315 */ |
| 316 void gnt_wm_raise_window(GntWM *wm, GntWidget *widget); | 316 void gnt_wm_raise_window(GntWM *wm, GntWidget *widget); |
| 317 | 317 |
| 318 /** | 318 /** |
| 319 * @internal | 319 * @internal |
| 324 * @internal | 324 * @internal |
| 325 */ | 325 */ |
| 326 void gnt_wm_copy_win(GntWidget *widget, GntNode *node); | 326 void gnt_wm_copy_win(GntWidget *widget, GntNode *node); |
| 327 | 327 |
| 328 /** | 328 /** |
| 329 * @return The idle time of the user. | 329 * Returns: The idle time of the user. |
| 330 */ | 330 */ |
| 331 time_t gnt_wm_get_idle_time(void); | 331 time_t gnt_wm_get_idle_time(void); |
| 332 | 332 |
| 333 G_END_DECLS | 333 G_END_DECLS |
| 334 #endif | 334 #endif |
