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