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