1 files changed, 105 insertions, 38 deletions

diff --git a/src/Keys.hh b/src/Keys.hh
index 3b19aaa..3351668 100644
--- a/src/Keys.hh
+++ b/src/Keys.hh
@@ -1,4 +1,4 @@
-// Key2.hh for Fluxbox - an X11 Window manager
+// Keys.hh for Fluxbox - an X11 Window manager
 // Copyright (c) 2001 Henrik Kinnunen (fluxgen@linuxmail.org)
 //
 // Permission is hereby granted, free of charge, to any person obtaining a
@@ -18,55 +18,112 @@
 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 // DEALINGS IN THE SOFTWARE.
-#ifndef _KEYS_HH_
-#define _KEYS_HH_
+
+// $Id: Keys.hh,v 1.15 2002/08/04 15:55:13 fluxgen Exp $
+
+#ifndef KEYS_HH
+#define KEYS_HH
 
 #include <string>
 #include <vector>
-        
+#include <X11/Xlib.h>
+
 class Keys 
 {
 public:
-enum KeyAction{
-                        grabIconify=0,
-                        grabRaise,
-                        grabLower,
-                        grabClose,
-                        grabAbortKeychain,
-                        grabWorkspace1, grabWorkspace2, grabWorkspace3, grabWorkspace4, grabWorkspace5,
-                        grabWorkspace6, grabWorkspace7, grabWorkspace8, grabWorkspace9, grabWorkspace10,
-                        grabWorkspace11, grabWorkspace12,       grabNextWorkspace, grabPrevWorkspace,
-                        grabLeftWorkspace, grabRightWorkspace,
-                        grabKillWindow, grabNextWindow, grabPrevWindow,
-                        grabNextTab, grabPrevTab,
-                        grabShade, grabMaximize, grabStick, grabExecute,        grabVertMax,
-                        grabHorizMax,   grabNudgeRight, grabNudgeLeft,grabNudgeUp,
-                        grabNudgeDown,  grabBigNudgeRight, grabBigNudgeLeft,
-                        grabBigNudgeUp, grabBigNudgeDown,
-                        grabHorizInc,   grabVertInc, grabHorizDec, grabVertDec,
-                        grabToggleDecor,
-                        lastKeygrab
+        /**
+                Key actions
+        */
+        enum KeyAction{
+                        ICONIFY=0,
+                        RAISE, LOWER,
+                        CLOSE,
+                        ABORTKEYCHAIN,
+                        WORKSPACE,
+                        WORKSPACE1, WORKSPACE2,  WORKSPACE3,  WORKSPACE4,       
+                        WORKSPACE5, WORKSPACE6,  WORKSPACE7,  WORKSPACE8,       
+                        WORKSPACE9, WORKSPACE10, WORKSPACE11, WORKSPACE12,      
+                        SENDTOWORKSPACE, // Send window to a workspace
+                        NEXTWORKSPACE, PREVWORKSPACE,
+                        LEFTWORKSPACE, RIGHTWORKSPACE,
+                        KILLWINDOW, NEXTWINDOW, PREVWINDOW,
+                        NEXTTAB, PREVTAB, FIRSTTAB, LASTTAB, MOVETABPREV, MOVETABNEXT,
+                        SHADE, MAXIMIZE, 
+                        STICK,       // Make Sticky
+                        EXECUTE,        // Run command
+                        VERTMAX,    // Maximize vertical
+                        HORIZMAX,       // Maximize horizontal
+                        NUDGERIGHT, NUDGELEFT,NUDGEUP, NUDGEDOWN,       
+                        BIGNUDGERIGHT, BIGNUDGELEFT, BIGNUDGEUP, BIGNUDGEDOWN,
+                        HORIZINC, VERTINC, HORIZDEC, VERTDEC,
+                        TOGGLEDECOR,// toggle visibility of decor (title, frame, handles)
+                        TOGGLETAB,  // toggle visibilty of tab
+                        ROOTMENU,   // pop up rootmenu
+                        LASTKEYGRAB //mark end of keygrabbs
         };
-        
-        Keys(char *filename);
+        /**
+                Constructor
+                @param display display connection
+                @param filename file to load, default none
+        */
+        Keys(Display *display, const char *filename=0);
+        /// destructor
         ~Keys();
-        bool load(char *filename=0);
+        /**
+                Load configuration from file
+                @return true on success, else false
+        */
+        bool load(const char *filename=0);
+        /**
+                Determine action from XKeyEvent
+                @return KeyAction value
+        */
         KeyAction getAction(XKeyEvent *ke);
-        bool reconfigure(char *filename);
+        /**
+                Reload configuration from filename
+                @return true on success, else false
+        */
+        bool reconfigure(const char *filename);
+        /**
+                Get string value of the KeyAction enum value
+                @return string of action
+        */
         const char *getActionStr(KeyAction action);
-        std::string getExecCommand() { return m_execcmdstring; }
+        /**
+                Get command to execute (key action EXECUTE)
+                @return string to command
+        */
+        const std::string &getExecCommand() { return m_execcmdstring; }
+        /**
+                @return number of parameters
+        */
+        int getParam() const { return m_param; }
+
 private:
         void deleteTree();
-        
+        void ungrabKeys();
         void bindKey(unsigned int key, unsigned int mod);
-        unsigned int getModifier(char *modstr);
-        unsigned int getKey(char *keystr);
+        /**
+                @param modstr modifier string (i.e Mod4, Mod5)
+                @return modifier number that match modstr
+        */
+        unsigned int getModifier(const char *modstr);
+        /**
+                @param keystr a key string (i.e F1, Enter)
+                @return key number that match keystr
+        */
+        unsigned int getKey(const char *keystr);
+        /**
+                grab a key
+                @param key the key
+                @param mod the modifier
+        */
         void grabKey(unsigned int key, unsigned int mod);
         std::string filename;   
         
         class t_key {   
                 public:
-                t_key(unsigned int key, unsigned int mod, KeyAction action_ = lastKeygrab);
+                t_key(unsigned int key, unsigned int mod, KeyAction action_ = Keys::LASTKEYGRAB);
                 t_key(t_key *k);
                 ~t_key();
                 
@@ -94,23 +151,33 @@ private:
                 unsigned int mod;
                 std::vector<t_key *> keylist;
                 std::string execcommand;
+        int param;              // parameter to comands
         };
-        
+        /**
+                merge two linked list
+                @return true on success, else false
+        */
         bool mergeTree(t_key *newtree, t_key *basetree=0);
-        #ifdef DEBUG
-        //debug functions
+
+#ifdef DEBUG
+        /// debug function
         void showTree();
+        /// debug function
         void showKeyTree(t_key *key, unsigned int w=0);
-        #endif //DEBUG
+#endif //DEBUG
+
         struct t_actionstr{
                 const char *string;
                 KeyAction action;
         };      
+        
         static t_actionstr m_actionlist[];
         
         std::vector<t_key *> m_keylist; 
-        t_key *m_abortkey; //abortkey for keygrabbing chain
-        std::string m_execcmdstring; //copy of the execcommandstring
+        t_key *m_abortkey;           ///< abortkey for keygrabbing chain
+        std::string m_execcmdstring; ///< copy of the execcommandstring
+    int m_param;                 ///< copy of the param argument
+        Display *m_display;                      ///< display connection
 };
 
 #endif // _KEYS_HH_