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