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