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        Ben 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 };
  65
  66 struct DirectionalAction{
  67     struct AnyAction any;
  68     ObDirection direction;
  69     gboolean hang;
  70 };
  71
  72 struct Execute {
  73     struct AnyAction any;
  74     gchar *path;
  75     gboolean startupnotify;
  76     gchar *name;
  77     gchar *icon_name;
  78 };
  79
  80 struct ClientAction {
  81     struct AnyAction any;
  82 };
  83
  84 struct Activate {
  85     struct AnyAction any;
  86     gboolean here; /* bring it to the current desktop */
  87 };
  88
  89 struct MoveResizeRelative {
  90     struct AnyAction any;
  91     gint deltax;
  92     gint deltay;
  93     gint deltaxl;
  94     gint deltayu;
  95 };
  96
  97 struct SendToDesktop {
  98     struct AnyAction any;
  99     guint desk;
 100     gboolean follow;
 101 };
 102
 103 struct SendToDesktopDirection {
 104     struct InteractiveAction inter;
 105     ObDirection dir;
 106     gboolean wrap;
 107     gboolean linear;
 108     gboolean follow;
 109 };
 110
 111 struct Desktop {
 112     struct InteractiveAction inter;
 113     guint desk;
 114 };
 115
 116 struct Layer {
 117     struct AnyAction any;
 118     gint layer; /* < 0 = below, 0 = normal, > 0 = above */
 119 };
 120
 121 struct DesktopDirection {
 122     struct InteractiveAction inter;
 123     ObDirection dir;
 124     gboolean wrap;
 125     gboolean linear;
 126 };
 127
 128 struct MoveResize {
 129     struct AnyAction any;
 130     gboolean move;
 131     gboolean keyboard;
 132 };
 133
 134 struct ShowMenu {
 135     struct AnyAction any;
 136     gchar *name;
 137 };
 138
 139 struct CycleWindows {
 140     struct InteractiveAction inter;
 141     gboolean linear;
 142     gboolean forward;
 143     gboolean dialog;
 144 };
 145
 146 struct Stacking {
 147     struct AnyAction any;
 148     gboolean group;
 149 };
 150
 151 union ActionData {
 152     struct AnyAction any;
 153     struct InteractiveAction inter;
 154     struct InterDirectionalAction interdiraction;
 155     struct DirectionalAction diraction;
 156     struct Execute execute;
 157     struct ClientAction client;
 158     struct Activate activate;
 159     struct MoveResizeRelative relative;
 160     struct SendToDesktop sendto;
 161     struct SendToDesktopDirection sendtodir;
 162     struct Desktop desktop;
 163     struct DesktopDirection desktopdir;
 164     struct MoveResize moveresize;
 165     struct ShowMenu showmenu;
 166     struct CycleWindows cycle;
 167     struct Layer layer;
 168     struct Stacking stacking;
 169 };
 170
 171 struct _ObAction {
 172     guint ref;
 173
 174     /* The func member acts like an enum to tell which one of the structs in
 175        the data union are valid.
 176     */
 177     void (*func)(union ActionData *data);
 178     union ActionData data;
 179 };
 180
 181 /* Creates a new Action from the name of the action
 182    A few action types need data set after making this call still. Check if
 183    the returned action's "func" is one of these.
 184    action_execute - the path needs to be set
 185    action_restart - the path can optionally be set
 186    action_desktop - the destination desktop needs to be set
 187    action_send_to_desktop - the destination desktop needs to be set
 188    action_move_relative_horz - the delta
 189    action_move_relative_vert - the delta
 190    action_resize_relative_horz - the delta
 191    action_resize_relative_vert - the delta
 192    action_move_relative - the deltas
 193    action_resize_relative - the deltas
 194 */
 195
 196 ObAction* action_from_string(const gchar *name, ObUserAction uact);
 197 ObAction* action_parse(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
 198                        ObUserAction uact);
 199 void action_ref(ObAction *a);
 200 void action_unref(ObAction *a);
 201
 202 ObAction* action_copy(const ObAction *a);
 203
 204 /*! Executes a list of actions.
 205   @param c The client associated with the action. Can be NULL.
 206   @param state The keyboard modifiers state at the time the user action occured
 207   @param button The mouse button used to execute the action.
 208   @param x The x coord at which the user action occured.
 209   @param y The y coord at which the user action occured.
 210   @param cancel If the action is cancelling an interactive action. This only
 211          affects interactive actions, but should generally always be FALSE.
 212   @param done If the action is completing an interactive action. This only
 213          affects interactive actions, but should generally always be FALSE.
 214 */
 215 void action_run_list(GSList *acts, struct _ObClient *c, ObFrameContext context,
 216                      guint state, guint button, gint x, gint y, Time time,
 217                      gboolean cancel, gboolean done);
 218
 219 #define action_run_mouse(a, c, n, s, b, x, y, t) \
 220     action_run_list(a, c, n, s, b, x, y, t, FALSE, FALSE)
 221
 222 #define action_run_interactive(a, c, s, t, n, d) \
 223     action_run_list(a, c, OB_FRAME_CONTEXT_NONE, s, 0, -1, -1, t, n, d)
 224
 225 #define action_run_key(a, c, s, x, y, t) \
 226     action_run_list(a, c, OB_FRAME_CONTEXT_NONE, s, 0, x, y, t, FALSE, FALSE)
 227
 228 #define action_run(a, c, s, t) \
 229     action_run_list(a, c, OB_FRAME_CONTEXT_NONE, s, 0, -1, -1, t, FALSE, FALSE)
 230
 231 void action_run_string(const gchar *name, struct _ObClient *c, Time time);
 232
 233 /* Execute */
 234 void action_execute(union ActionData *data);
 235 /* ActivateAction */
 236 void action_activate(union ActionData *data);
 237 /* ClientAction */
 238 void action_focus(union ActionData *data);
 239 /* ClientAction */
 240 void action_unfocus(union ActionData *data);
 241 /* ClientAction */
 242 void action_iconify(union ActionData *data);
 243 /* ClientAction */
 244 void action_focus_order_to_bottom(union ActionData *data);
 245 /* ClientAction */
 246 void action_raiselower(union ActionData *data);
 247 /* ClientAction */
 248 void action_raise(union ActionData *data);
 249 /* ClientAction */
 250 void action_lower(union ActionData *data);
 251 /* ClientAction */
 252 void action_close(union ActionData *data);
 253 /* ClientAction */
 254 void action_kill(union ActionData *data);
 255 /* ClientAction */
 256 void action_shade(union ActionData *data);
 257 /* ClientAction */
 258 void action_shadelower(union ActionData *data);
 259 /* ClientAction */
 260 void action_unshaderaise(union ActionData *data);
 261 /* ClientAction */
 262 void action_unshade(union ActionData *data);
 263 /* ClientAction */
 264 void action_toggle_shade(union ActionData *data);
 265 /* ClientAction */
 266 void action_toggle_omnipresent(union ActionData *data);
 267 /* MoveResizeRelative */
 268 void action_move_relative_horz(union ActionData *data);
 269 /* MoveResizeRelative */
 270 void action_move_relative_vert(union ActionData *data);
 271 /* MoveResizeRelative */
 272 void action_move_relative(union ActionData *data);
 273 /* MoveResizeRelative */
 274 void action_resize_relative(union ActionData *data);
 275 /* ClientAction */
 276 void action_move_to_center(union ActionData *data);
 277 /* MoveResizeRelative */
 278 void action_resize_relative_horz(union ActionData *data);
 279 /* MoveResizeRelative */
 280 void action_resize_relative_vert(union ActionData *data);
 281 /* ClientAction */
 282 void action_maximize_full(union ActionData *data);
 283 /* ClientAction */
 284 void action_unmaximize_full(union ActionData *data);
 285 /* ClientAction */
 286 void action_toggle_maximize_full(union ActionData *data);
 287 /* ClientAction */
 288 void action_maximize_horz(union ActionData *data);
 289 /* ClientAction */
 290 void action_unmaximize_horz(union ActionData *data);
 291 /* ClientAction */
 292 void action_toggle_maximize_horz(union ActionData *data);
 293 /* ClientAction */
 294 void action_maximize_vert(union ActionData *data);
 295 /* ClientAction */
 296 void action_unmaximize_vert(union ActionData *data);
 297 /* ClientAction */
 298 void action_toggle_maximize_vert(union ActionData *data);
 299 /* ClientAction */
 300 void action_toggle_fullscreen(union ActionData *data);
 301 /* SendToDesktop */
 302 void action_send_to_desktop(union ActionData *data);
 303 /* SendToDesktopDirection */
 304 void action_send_to_desktop_dir(union ActionData *data);
 305 /* Desktop */
 306 void action_desktop(union ActionData *data);
 307 /* DesktopDirection */
 308 void action_desktop_dir(union ActionData *data);
 309 /* Any */
 310 void action_desktop_last(union ActionData *data);
 311 /* ClientAction */
 312 void action_toggle_decorations(union ActionData *data);
 313 /* MoveResize */
 314 void action_moveresize(union ActionData *data);
 315 /* Any */
 316 void action_reconfigure(union ActionData *data);
 317 /* Execute */
 318 void action_restart(union ActionData *data);
 319 /* Any */
 320 void action_exit(union ActionData *data);
 321 /* ShowMenu */
 322 void action_showmenu(union ActionData *data);
 323 /* CycleWindows */
 324 void action_cycle_windows(union ActionData *data);
 325 /* InterDirectionalAction */
 326 void action_directional_focus(union ActionData *data);
 327 /* DirectionalAction */
 328 void action_movetoedge(union ActionData *data);
 329 /* DirectionalAction */
 330 void action_growtoedge(union ActionData *data);
 331 /* Layer */
 332 void action_send_to_layer(union ActionData *data);
 333 /* Layer */
 334 void action_toggle_layer(union ActionData *data);
 335 /* Any */
 336 void action_toggle_dockautohide(union ActionData *data);
 337 /* Any */
 338 void action_toggle_show_desktop(union ActionData *data);
 339 /* Any */
 340 void action_show_desktop(union ActionData *data);
 341 /* Any */
 342 void action_unshow_desktop(union ActionData *data);
 343
 344 #endif