openbox/action.h

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    action.h for the Openbox window manager
   4    Copyright (c) 2006        Mikael Magnusson
   5    Copyright (c) 2003-2007   Dana Jansens
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    See the COPYING file for a copy of the GNU General Public License.
  18 */
  19
  20 #ifndef __action_h
  21 #define __action_h
  22
  23 #include "misc.h"
  24 #include "frame.h"
  25 #include "parser/parse.h"
  26
  27 struct _ObClient;
  28
  29 typedef struct _ObAction ObAction;
  30
  31 /* These have to all have a Client* at the top even if they don't use it, so
  32    that I can set it blindly later on. So every function will have a Client*
  33    available (possibly NULL though) if it wants it.
  34 */
  35
  36 typedef enum
  37 {
  38     OB_CLIENT_ACTION_NO,
  39     OB_CLIENT_ACTION_OPTIONAL,
  40     OB_CLIENT_ACTION_ALWAYS
  41 } ObClientActionReq;
  42
  43 struct AnyAction {
  44     ObClientActionReq client_action;
  45     struct _ObClient *c;
  46     ObFrameContext context;
  47     gboolean interactive;
  48     gint x;
  49     gint y;
  50     gint button;
  51     Time time;
  52 };
  53
  54 struct InteractiveAction {
  55     struct AnyAction any;
  56     gboolean final;
  57     gboolean cancel;
  58 };
  59
  60 struct InterDirectionalAction{
  61     struct InteractiveAction inter;
  62     ObDirection direction;
  63     gboolean dialog;
  64     gboolean dock_windows;
  65 };
  66
  67 struct DirectionalAction{
  68     struct AnyAction any;
  69     ObDirection direction;
  70     gboolean hang;
  71 };
  72
  73 struct Execute {
  74     struct AnyAction any;
  75     gchar *path;
  76     gboolean startupnotify;
  77     gchar *name;
  78     gchar *icon_name;
  79 };
  80
  81 struct ClientAction {
  82     struct AnyAction any;
  83 };
  84
  85 struct Activate {
  86     struct AnyAction any;
  87     gboolean here; /* bring it to the current desktop */
  88 };
  89
  90 struct MoveResizeRelative {
  91     struct AnyAction any;
  92     gint deltax;
  93     gint deltay;
  94     gint deltaxl;
  95     gint deltayu;
  96 };
  97
  98 struct SendToDesktop {
  99     struct AnyAction any;
 100     guint desk;
 101     gboolean follow;
 102 };
 103
 104 struct SendToDesktopDirection {
 105     struct InteractiveAction inter;
 106     ObDirection dir;
 107     gboolean wrap;
 108     gboolean linear;
 109     gboolean follow;
 110 };
 111
 112 struct Desktop {
 113     struct InteractiveAction inter;
 114     guint desk;
 115 };
 116
 117 struct Layer {
 118     struct AnyAction any;
 119     gint layer; /* < 0 = below, 0 = normal, > 0 = above */
 120 };
 121
 122 struct DesktopDirection {
 123     struct InteractiveAction inter;
 124     ObDirection dir;
 125     gboolean wrap;
 126     gboolean linear;
 127 };
 128
 129 struct MoveResize {
 130     struct AnyAction any;
 131     gboolean move;
 132     gboolean keyboard;
 133 };
 134
 135 struct ShowMenu {
 136     struct AnyAction any;
 137     gchar *name;
 138 };
 139
 140 struct CycleWindows {
 141     struct InteractiveAction inter;
 142     gboolean linear;
 143     gboolean forward;
 144     gboolean dialog;
 145     gboolean dock_windows;
 146     gboolean all_desktops;
 147 };
 148
 149 struct Stacking {
 150     struct AnyAction any;
 151 };
 152
 153 union ActionData {
 154     struct AnyAction any;
 155     struct InteractiveAction inter;
 156     struct InterDirectionalAction interdiraction;
 157     struct DirectionalAction diraction;
 158     struct Execute execute;
 159     struct ClientAction client;
 160     struct Activate activate;
 161     struct MoveResizeRelative relative;
 162     struct SendToDesktop sendto;
 163     struct SendToDesktopDirection sendtodir;
 164     struct Desktop desktop;
 165     struct DesktopDirection desktopdir;
 166     struct MoveResize moveresize;
 167     struct ShowMenu showmenu;
 168     struct CycleWindows cycle;
 169     struct Layer layer;
 170     struct Stacking stacking;
 171 };
 172
 173 struct _ObAction {
 174     guint ref;
 175
 176     /* The func member acts like an enum to tell which one of the structs in
 177        the data union are valid.
 178     */
 179     void (*func)(union ActionData *data);
 180     union ActionData data;
 181 };
 182
 183 /* Creates a new Action from the name of the action
 184    A few action types need data set after making this call still. Check if
 185    the returned action's "func" is one of these.
 186    action_execute - the path needs to be set
 187    action_restart - the path can optionally be set
 188    action_desktop - the destination desktop needs to be set
 189    action_send_to_desktop - the destination desktop needs to be set
 190    action_move_relative_horz - the delta
 191    action_move_relative_vert - the delta
 192    action_resize_relative_horz - the delta
 193    action_resize_relative_vert - the delta
 194    action_move_relative - the deltas
 195    action_resize_relative - the deltas
 196 */
 197
 198 ObAction* action_from_string(const gchar *name, ObUserAction uact);
 199 ObAction* action_parse(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
 200                        ObUserAction uact);
 201 void action_ref(ObAction *a);
 202 void action_unref(ObAction *a);
 203
 204 ObAction* action_copy(const ObAction *a);
 205
 206 /*! Executes a list of actions.
 207   @param c The client associated with the action. Can be NULL.
 208   @param state The keyboard modifiers state at the time the user action occured
 209   @param button The mouse button used to execute the action.
 210   @param x The x coord at which the user action occured.
 211   @param y The y coord at which the user action occured.
 212   @param cancel If the action is cancelling an interactive action. This only
 213          affects interactive actions, but should generally always be FALSE.
 214   @param done If the action is completing an interactive action. This only
 215          affects interactive actions, but should generally always be FALSE.
 216 */
 217 void action_run_list(GSList *acts, struct _ObClient *c, ObFrameContext context,
 218                      guint state, guint button, gint x, gint y, Time time,
 219                      gboolean cancel, gboolean done);
 220
 221 #define action_run_mouse(a, c, n, s, b, x, y, t) \
 222     action_run_list(a, c, n, s, b, x, y, t, FALSE, FALSE)
 223
 224 #define action_run_interactive(a, c, s, t, n, d) \
 225     action_run_list(a, c, OB_FRAME_CONTEXT_NONE, s, 0, -1, -1, t, n, d)
 226
 227 #define action_run_key(a, c, s, x, y, t) \
 228     action_run_list(a, c, OB_FRAME_CONTEXT_NONE, s, 0, x, y, t, FALSE, FALSE)
 229
 230 #define action_run(a, c, s, t) \
 231     action_run_list(a, c, OB_FRAME_CONTEXT_NONE, s, 0, -1, -1, t, FALSE, FALSE)
 232
 233 void action_run_string(const gchar *name, struct _ObClient *c, Time time);
 234
 235 /* Execute */
 236 void action_execute(union ActionData *data);
 237 /* ActivateAction */
 238 void action_activate(union ActionData *data);
 239 /* ClientAction */
 240 void action_focus(union ActionData *data);
 241 /* ClientAction */
 242 void action_unfocus(union ActionData *data);
 243 /* ClientAction */
 244 void action_iconify(union ActionData *data);
 245 /* ClientAction */
 246 void action_focus_order_to_bottom(union ActionData *data);
 247 /* ClientAction */
 248 void action_raiselower(union ActionData *data);
 249 /* ClientAction */
 250 void action_raise(union ActionData *data);
 251 /* ClientAction */
 252 void action_lower(union ActionData *data);
 253 /* ClientAction */
 254 void action_close(union ActionData *data);
 255 /* ClientAction */
 256 void action_kill(union ActionData *data);
 257 /* ClientAction */
 258 void action_shade(union ActionData *data);
 259 /* ClientAction */
 260 void action_shadelower(union ActionData *data);
 261 /* ClientAction */
 262 void action_unshaderaise(union ActionData *data);
 263 /* ClientAction */
 264 void action_unshade(union ActionData *data);
 265 /* ClientAction */
 266 void action_toggle_shade(union ActionData *data);
 267 /* ClientAction */
 268 void action_toggle_omnipresent(union ActionData *data);
 269 /* MoveResizeRelative */
 270 void action_move_relative_horz(union ActionData *data);
 271 /* MoveResizeRelative */
 272 void action_move_relative_vert(union ActionData *data);
 273 /* MoveResizeRelative */
 274 void action_move_relative(union ActionData *data);
 275 /* MoveResizeRelative */
 276 void action_resize_relative(union ActionData *data);
 277 /* ClientAction */
 278 void action_move_to_center(union ActionData *data);
 279 /* MoveResizeRelative */
 280 void action_resize_relative_horz(union ActionData *data);
 281 /* MoveResizeRelative */
 282 void action_resize_relative_vert(union ActionData *data);
 283 /* ClientAction */
 284 void action_maximize_full(union ActionData *data);
 285 /* ClientAction */
 286 void action_unmaximize_full(union ActionData *data);
 287 /* ClientAction */
 288 void action_toggle_maximize_full(union ActionData *data);
 289 /* ClientAction */
 290 void action_maximize_horz(union ActionData *data);
 291 /* ClientAction */
 292 void action_unmaximize_horz(union ActionData *data);
 293 /* ClientAction */
 294 void action_toggle_maximize_horz(union ActionData *data);
 295 /* ClientAction */
 296 void action_maximize_vert(union ActionData *data);
 297 /* ClientAction */
 298 void action_unmaximize_vert(union ActionData *data);
 299 /* ClientAction */
 300 void action_toggle_maximize_vert(union ActionData *data);
 301 /* ClientAction */
 302 void action_toggle_fullscreen(union ActionData *data);
 303 /* SendToDesktop */
 304 void action_send_to_desktop(union ActionData *data);
 305 /* SendToDesktopDirection */
 306 void action_send_to_desktop_dir(union ActionData *data);
 307 /* Desktop */
 308 void action_desktop(union ActionData *data);
 309 /* DesktopDirection */
 310 void action_desktop_dir(union ActionData *data);
 311 /* Any */
 312 void action_desktop_last(union ActionData *data);
 313 /* ClientAction */
 314 void action_toggle_decorations(union ActionData *data);
 315 /* MoveResize */
 316 void action_moveresize(union ActionData *data);
 317 /* Any */
 318 void action_reconfigure(union ActionData *data);
 319 /* Execute */
 320 void action_restart(union ActionData *data);
 321 /* Any */
 322 void action_exit(union ActionData *data);
 323 /* ShowMenu */
 324 void action_showmenu(union ActionData *data);
 325 /* CycleWindows */
 326 void action_cycle_windows(union ActionData *data);
 327 /* InterDirectionalAction */
 328 void action_directional_focus(union ActionData *data);
 329 /* DirectionalAction */
 330 void action_movetoedge(union ActionData *data);
 331 /* DirectionalAction */
 332 void action_growtoedge(union ActionData *data);
 333 /* Layer */
 334 void action_send_to_layer(union ActionData *data);
 335 /* Layer */
 336 void action_toggle_layer(union ActionData *data);
 337 /* Any */
 338 void action_toggle_dockautohide(union ActionData *data);
 339 /* Any */
 340 void action_toggle_show_desktop(union ActionData *data);
 341 /* Any */
 342 void action_show_desktop(union ActionData *data);
 343 /* Any */
 344 void action_unshow_desktop(union ActionData *data);
 345 /* Any */
 346 void action_break_chroot(union ActionData *data);
 347
 348 #endif