openbox/actions.h

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    actions.h for the Openbox window manager
   4    Copyright (c) 2007        Dana 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 #include "misc.h"
  20 #include "frame.h"
  21 #include "obt/xml.h"
  22
  23 #include <glib.h>
  24 #include <X11/Xlib.h>
  25
  26 typedef struct _ObActionsDefinition   ObActionsDefinition;
  27 typedef struct _ObActionsAct          ObActionsAct;
  28 typedef struct _ObActionsData         ObActionsData;
  29 typedef struct _ObActionsAnyData      ObActionsAnyData;
  30 typedef struct _ObActionsGlobalData   ObActionsGlobalData;
  31 typedef struct _ObActionsClientData   ObActionsClientData;
  32 typedef struct _ObActionsSelectorData ObActionsSelectorData;
  33
  34 typedef void     (*ObActionsDataFreeFunc)(gpointer options);
  35 typedef gboolean (*ObActionsRunFunc)(ObActionsData *data,
  36                                      gpointer options);
  37 typedef gpointer (*ObActionsDataSetupFunc)(xmlNodePtr node);
  38
  39 /* functions for interactive actions */
  40 /* return TRUE if the action is going to be interactive, or false to change
  41    your mind and make it not */
  42 typedef gboolean (*ObActionsIPreFunc)(guint initial_state, gpointer options);
  43 typedef void     (*ObActionsIPostFunc)(gpointer options);
  44 typedef gboolean (*ObActionsIInputFunc)(guint initial_state,
  45                                                   XEvent *e,
  46                                                   gpointer options,
  47                                                   gboolean *used);
  48 typedef void     (*ObActionsICancelFunc)(gpointer options);
  49 typedef gpointer (*ObActionsIDataSetupFunc)(xmlNodePtr node,
  50                                             ObActionsIPreFunc *pre,
  51                                             ObActionsIInputFunc *input,
  52                                             ObActionsICancelFunc *cancel,
  53                                             ObActionsIPostFunc *post);
  54
  55 struct _ObActionsData {
  56     ObUserAction uact;
  57     guint state;
  58     gint x;
  59     gint y;
  60     gint button;
  61
  62     struct _ObClient *client;
  63     ObFrameContext context;
  64 };
  65
  66 void actions_startup(gboolean reconfigure);
  67 void actions_shutdown(gboolean reconfigure);
  68
  69 /*! Use this if the actions created from this name may be interactive */
  70 gboolean actions_register_i(const gchar *name,
  71                             ObActionsIDataSetupFunc setup,
  72                             ObActionsDataFreeFunc free,
  73                             ObActionsRunFunc run);
  74
  75 gboolean actions_register(const gchar *name,
  76                           ObActionsDataSetupFunc setup,
  77                           ObActionsDataFreeFunc free,
  78                           ObActionsRunFunc run);
  79
  80 ObActionsAct* actions_parse(xmlNodePtr node);
  81 ObActionsAct* actions_parse_string(const gchar *name);
  82
  83 gboolean actions_act_is_interactive(ObActionsAct *act);
  84
  85 void actions_act_ref(ObActionsAct *act);
  86 void actions_act_unref(ObActionsAct *act);
  87
  88 /*! When this is true, an XAllowEvents with ReplayPointer will be called
  89   if an action is going to maybe try moving windows around on screen (or
  90   map/unmap windows)
  91 */
  92 void actions_set_need_pointer_replay_before_move(gboolean replay);
  93 /*! Returns if a ReplayPointer is still needed.  If it was called while running
  94   actions then this will be false */
  95 gboolean actions_get_need_pointer_replay_before_move(void);
  96
  97 /*! Pass in a GSList of ObActionsAct's to be run. */
  98 void actions_run_acts(GSList *acts,
  99                       ObUserAction uact,
 100                       guint state,
 101                       gint x,
 102                       gint y,
 103                       gint button,
 104                       ObFrameContext con,
 105                       struct _ObClient *client);
 106
 107 gboolean actions_interactive_act_running(void);
 108 void actions_interactive_cancel_act(void);
 109
 110 gboolean actions_interactive_input_event(XEvent *e);
 111
 112 /*! Function for actions to call when they are moving a client around */
 113 void actions_client_move(ObActionsData *data, gboolean start);