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 dx;
  27     int dy;
  28 };
  29
  30 struct SendToDesktop {
  31     Client *c;
  32     guint desktop;
  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 union ActionData {
  67     struct AnyAction any;
  68     struct Execute execute;
  69     struct ClientAction client;
  70     struct MoveResizeRelative relative;
  71     struct SendToDesktop sendto;
  72     struct SendToNextPreviousDesktop sendtonextprev;
  73     struct Desktop desktop;
  74     struct NextPreviousDesktop nextprevdesktop;
  75     struct Move move;
  76     struct Resize resize;
  77 };
  78
  79 typedef struct {
  80     /* The func member acts like an enum to tell which one of the structs in
  81        the data union are valid.
  82     */
  83     void (*func)(union ActionData *data);
  84     union ActionData data;
  85 } Action;
  86
  87 Action *action_new(void (*func)(union ActionData *data));
  88
  89 /* Creates a new Action from the name of the action
  90    A few action types need data set after making this call still. Check if
  91    the returned action's "func" is one of these.
  92    action_execute - the path needs to be set
  93    action_restart - the path can optionally be set
  94    action_desktop - the destination desktop needs to be set
  95 */
  96 Action *action_from_string(char *name);
  97 void action_free(Action *a);
  98
  99 /* Execute */
 100 void action_execute(union ActionData *data);
 101 /* ClientAction */
 102 void action_focus(union ActionData *data);
 103 /* ClientAction */
 104 void action_unfocus(union ActionData *data);
 105 /* ClientAction */
 106 void action_iconify(union ActionData *data);
 107 /* ClientAction */
 108 void action_raise(union ActionData *data);
 109 /* ClientAction */
 110 void action_lower(union ActionData *data);
 111 /* ClientAction */
 112 void action_focusraise(union ActionData *data);
 113 /* ClientAction */
 114 void action_close(union ActionData *data);
 115 /* ClientAction */
 116 void action_kill(union ActionData *data);
 117 /* ClientAction */
 118 void action_shade(union ActionData *data);
 119 /* ClientAction */
 120 void action_unshade(union ActionData *data);
 121 /* ClientAction */
 122 void action_toggle_shade(union ActionData *data);
 123 /* ClientAction */
 124 void action_toggle_omnipresent(union ActionData *data);
 125 /* MoveResizeRelative */
 126 void action_move_relative(union ActionData *data);
 127 /* MoveResizeRelative */
 128 void action_resize_relative(union ActionData *data);
 129 /* ClientAction */
 130 void action_maximize_full(union ActionData *data);
 131 /* ClientAction */
 132 void action_unmaximize_full(union ActionData *data);
 133 /* ClientAction */
 134 void action_toggle_maximize_full(union ActionData *data);
 135 /* ClientAction */
 136 void action_maximize_horz(union ActionData *data);
 137 /* ClientAction */
 138 void action_unmaximize_horz(union ActionData *data);
 139 /* ClientAction */
 140 void action_toggle_maximize_horz(union ActionData *data);
 141 /* ClientAction */
 142 void action_maximize_vert(union ActionData *data);
 143 /* ClientAction */
 144 void action_unmaximize_vert(union ActionData *data);
 145 /* ClientAction */
 146 void action_toggle_maximize_vert(union ActionData *data);
 147 /* SendToDesktop */
 148 void action_send_to_desktop(union ActionData *data);
 149 /* SendToNextPreviousDesktop */
 150 void action_send_to_next_desktop(union ActionData *data);
 151 /* SendToNextPreviousDesktop */
 152 void action_send_to_previous_desktop(union ActionData *data);
 153 /* Desktop */
 154 void action_desktop(union ActionData *data);
 155 /* NextPreviousDesktop */
 156 void action_next_desktop(union ActionData *data);
 157 /* NextPreviousDesktop */
 158 void action_previous_desktop(union ActionData *data);
 159 /* NextPreviousDesktop */
 160 void action_next_desktop_column(union ActionData *data);
 161 /* NextPreviousDesktop */
 162 void action_previous_desktop_column(union ActionData *data);
 163 /* NextPreviousDesktop */
 164 void action_next_desktop_row(union ActionData *data);
 165 /* NextPreviousDesktop */
 166 void action_previous_desktop_row(union ActionData *data);
 167 /* ClientAction */
 168 void action_toggle_decorations(union ActionData *data);
 169 /* Move */
 170 void action_move(union ActionData *data);
 171 /* Resize */
 172 void action_resize(union ActionData *data);
 173 /* Execute */
 174 void action_restart(union ActionData *data);
 175 /* Any */
 176 void action_exit(union ActionData *data);
 177
 178 #endif