Dogcows Code - chaz/openbox/blob - util/epist/keytree.hh

   1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
   2 // keytree.hh for Epistrophy - a key handler for NETWM/EWMH window managers.
   3 // Copyright (c) 2002 - 2002 Ben Jansens <ben at orodu.net>
   4 //
   5 // Permission is hereby granted, free of charge, to any person obtaining a
   6 // copy of this software and associated documentation files (the "Software"),
   7 // to deal in the Software without restriction, including without limitation
   8 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9 // and/or sell copies of the Software, and to permit persons to whom the
  10 // Software is furnished to do so, subject to the following conditions:
  11 //
  12 // The above copyright notice and this permission notice shall be included in
  13 // all copies or substantial portions of the Software.
  14 //
  15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21 // DEALINGS IN THE SOFTWARE.
  22
  23 #ifndef _keytree_hh
  24 #define _keytree_hh
  25
  26 #include <list>
  27 #include "../../src/Timer.hh"
  28 #include "actions.hh"
  29 #include "screen.hh"
  30
  31 struct keynode; // forward declaration
  32 typedef std::list<keynode *> ChildList;
  33
  34 struct keynode {
  35   Action *action;
  36   keynode *parent;
  37   ChildList children;
  38 };
  39
  40 class keytree : public TimeoutHandler {
  41 public:
  42   keytree(Display *, epist *);
  43   virtual ~keytree();
  44
  45   void grabDefaults(screen *);
  46   void ungrabDefaults(screen *);
  47   const Action * getAction(const XEvent&, unsigned int, screen *);
  48   void unloadBindings();
  49   void timeout();
  50
  51 private:
  52   // only mister parser needs to know about our sekrets (BUMMY)
  53   friend class parser;
  54
  55   void grabChildren(keynode *, screen *);
  56   void ungrabChildren(keynode *, screen *);
  57
  58   void addAction(Action::ActionType, unsigned int, std::string, std::string);
  59   void advanceOnNewNode();
  60   void retract();
  61   void setCurrentNodeProps(Action::ActionType, unsigned int, std::string, std::string);
  62   void initialize();
  63
  64   void reset()
  65   { _current = _head; }
  66
  67   bool isLeaf(keynode *node)
  68   { return node->children.empty(); }
  69
  70   void clearTree(keynode *);
  71
  72   keynode *_head;
  73   keynode *_current;
  74   Display *_display;
  75   screen *_timeout_screen;
  76   BTimer *_timer;
  77   epist *_epist;
  78 };
  79
  80 #endif // _keytree_hh