openbox/action_list_run.h

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    action_list_run.h for the Openbox window manager
   4    Copyright (c) 2011        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
  22 #include <glib.h>
  23
  24 typedef struct _ObActionListRun ObActionListRun;
  25
  26 struct _ObActionList;
  27
  28 /*! This structure holds data about the user event which triggers running an
  29   action list and the filters/actions within it.
  30   All action list executions must come from some user event, and this describes
  31   it.
  32 */
  33 struct _ObActionListRun {
  34     ObUserAction user_act;
  35     guint mod_state;
  36
  37     gint pointer_x;
  38     gint pointer_y;
  39     gint pointer_button;
  40     ObFrameContext pointer_context;
  41     struct _ObClient *pointer_over;
  42
  43     struct _ObClient *target;
  44 };
  45
  46 /*! Run an action list.
  47   @acts The list of actions to run.
  48   @state The current state of the keyboard modifiers.
  49   @x The x coordinate of the pointer.
  50   @y The y coordinate of the pointer.
  51   @button The button used to initiate the action list (if a pointer
  52     initiated it).
  53   @con The frame context on which the pointer button was used to initiate the
  54     action list.
  55   @client The client on which the pointer button was used to initiate the
  56     action list.
  57   @return TRUE if an interactive action was started, or FALSE otherwise.
  58 */
  59 gboolean action_list_run(struct _ObActionList *acts,
  60                          ObUserAction uact,
  61                          guint state,
  62                          gint x,
  63                          gint y,
  64                          gint button,
  65                          ObFrameContext con,
  66                          struct _ObClient *client);