openbox/action.h

   1 #ifndef __action_h
   2 #define __action_h
   3
   4 #include "client.h"
   5
   6 /* These have to all have a Client* at the top even if they don't use it, so
   7    that I can set it blindly later on. So every function will have a Client*
   8    available (possibly NULL though) if it wants it.
   9 */
  10
  11 struct AnyAction {
  12     Client *c;
  13 };
  14
  15 struct Execute {
  16     Client *c;
  17     char *path;
  18 };
  19
  20 struct ClientAction {
  21     Client *c;
  22 };
  23
  24 struct MoveResizeRelative {
  25     Client *c;
  26     int delta;
  27 };
  28
  29 struct SendToDesktop {
  30     Client *c;
  31     guint desk;
  32     gboolean follow;
  33 };
  34
  35 struct SendToNextPreviousDesktop {
  36     Client *c;
  37     gboolean wrap;
  38     gboolean follow;
  39 };
  40
  41 struct Desktop {
  42     Client *c;
  43     guint desk;
  44 };
  45
  46 struct NextPreviousDesktop {
  47     Client *c;
  48     gboolean wrap;
  49 };
  50
  51 struct Move {
  52     Client *c;
  53     int x;
  54     int y;
  55     gboolean final;
  56 };
  57
  58 struct Resize {
  59     Client *c;
  60     int x;
  61     int y;
  62     gboolean final;
  63     Corner corner;
  64 };
  65
  66 struct ShowMenu {
  67     Client *c;
  68     char *menuName;
  69 };
  70
  71 struct CycleWindows {
  72     Client *c;
  73     gboolean linear;
  74     gboolean forward;
  75     gboolean final;
  76 };
  77
  78 union ActionData {
  79     struct AnyAction any;
  80     struct Execute execute;
  81     struct ClientAction client;
  82     struct MoveResizeRelative relative;
  83     struct SendToDesktop sendto;
  84     struct SendToNextPreviousDesktop sendtonextprev;
  85     struct Desktop desktop;
  86     struct NextPreviousDesktop nextprevdesktop;
  87     struct Move move;
  88     struct Resize resize;
  89     struct ShowMenu showMenu;
  90     struct CycleWindows cycle;
  91 };
  92
  93 typedef struct {
  94     /* The func member acts like an enum to tell which one of the structs in
  95        the data union are valid.
  96     */
  97     void (*func)(union ActionData *data);
  98     union ActionData data;
  99 } Action;
 100
 101 Action *action_new(void (*func)(union ActionData *data));
 102
 103 /* Creates a new Action from the name of the action
 104    A few action types need data set after making this call still. Check if
 105    the returned action's "func" is one of these.
 106    action_execute - the path needs to be set
 107    action_restart - the path can optionally be set
 108    action_desktop - the destination desktop needs to be set
 109    action_move_relative_horz - the delta
 110    action_move_relative_vert - the delta
 111    action_resize_relative_horz - the delta
 112    action_resize_relative_vert - the delta
 113 */
 114 Action *action_from_string(char *name);
 115 void action_free(Action *a);
 116
 117 /* Execute */
 118 void action_execute(union ActionData *data);
 119 /* ClientAction */
 120 void action_focus(union ActionData *data);
 121 /* ClientAction */
 122 void action_unfocus(union ActionData *data);
 123 /* ClientAction */
 124 void action_iconify(union ActionData *data);
 125 /* ClientAction */
 126 void action_raise(union ActionData *data);
 127 /* ClientAction */
 128 void action_lower(union ActionData *data);
 129 /* ClientAction */
 130 void action_focusraise(union ActionData *data);
 131 /* ClientAction */
 132 void action_close(union ActionData *data);
 133 /* ClientAction */
 134 void action_kill(union ActionData *data);
 135 /* ClientAction */
 136 void action_shade(union ActionData *data);
 137 /* ClientAction */
 138 void action_shadelower(union ActionData *data);
 139 /* ClientAction */
 140 void action_unshaderaise(union ActionData *data);
 141 /* ClientAction */
 142 void action_unshade(union ActionData *data);
 143 /* ClientAction */
 144 void action_toggle_shade(union ActionData *data);
 145 /* ClientAction */
 146 void action_toggle_omnipresent(union ActionData *data);
 147 /* MoveResizeRelative */
 148 void action_move_relative_horz(union ActionData *data);
 149 /* MoveResizeRelative */
 150 void action_move_relative_vert(union ActionData *data);
 151 /* MoveResizeRelative */
 152 void action_resize_relative_horz(union ActionData *data);
 153 /* MoveResizeRelative */
 154 void action_resize_relative_vert(union ActionData *data);
 155 /* ClientAction */
 156 void action_maximize_full(union ActionData *data);
 157 /* ClientAction */
 158 void action_unmaximize_full(union ActionData *data);
 159 /* ClientAction */
 160 void action_toggle_maximize_full(union ActionData *data);
 161 /* ClientAction */
 162 void action_maximize_horz(union ActionData *data);
 163 /* ClientAction */
 164 void action_unmaximize_horz(union ActionData *data);
 165 /* ClientAction */
 166 void action_toggle_maximize_horz(union ActionData *data);
 167 /* ClientAction */
 168 void action_maximize_vert(union ActionData *data);
 169 /* ClientAction */
 170 void action_unmaximize_vert(union ActionData *data);
 171 /* ClientAction */
 172 void action_toggle_maximize_vert(union ActionData *data);
 173 /* SendToDesktop */
 174 void action_send_to_desktop(union ActionData *data);
 175 /* SendToNextPreviousDesktop */
 176 void action_send_to_next_desktop(union ActionData *data);
 177 /* SendToNextPreviousDesktop */
 178 void action_send_to_previous_desktop(union ActionData *data);
 179 /* Desktop */
 180 void action_desktop(union ActionData *data);
 181 /* NextPreviousDesktop */
 182 void action_next_desktop(union ActionData *data);
 183 /* NextPreviousDesktop */
 184 void action_previous_desktop(union ActionData *data);
 185 /* NextPreviousDesktop */
 186 void action_next_desktop_column(union ActionData *data);
 187 /* NextPreviousDesktop */
 188 void action_previous_desktop_column(union ActionData *data);
 189 /* NextPreviousDesktop */
 190 void action_next_desktop_row(union ActionData *data);
 191 /* NextPreviousDesktop */
 192 void action_previous_desktop_row(union ActionData *data);
 193 /* ClientAction */
 194 void action_toggle_decorations(union ActionData *data);
 195 /* Move */
 196 void action_move(union ActionData *data);
 197 /* Resize */
 198 void action_resize(union ActionData *data);
 199 /* Execute */
 200 void action_restart(union ActionData *data);
 201 /* Any */
 202 void action_exit(union ActionData *data);
 203 /* ShowMenu */
 204 void action_showmenu(union ActionData *data);
 205 /* CycleWindows */
 206 void action_cycle_windows(union ActionData *data);
 207 #endif