libs/gtkutil/accelerator.h

   1 /*
   2    Copyright (C) 2001-2006, William Joseph.
   3    All Rights Reserved.
   4
   5    This file is part of GtkRadiant.
   6
   7    GtkRadiant is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    GtkRadiant is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with GtkRadiant; if not, write to the Free Software
  19    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20  */
  21
  22 #if !defined( INCLUDED_GTKUTIL_ACCELERATOR_H )
  23 #define INCLUDED_GTKUTIL_ACCELERATOR_H
  24
  25 #include <gdk/gdktypes.h>
  26 #include <gdk/gdkkeysyms.h>
  27 #include <gdk/gdkkeys.h>
  28
  29 #include "generic/callback.h"
  30
  31 // ignore numlock
  32 #define ALLOWED_MODIFIERS ( ~( GDK_MOD2_MASK | GDK_LOCK_MASK | GDK_MOD3_MASK | GDK_MOD4_MASK | GDK_MOD5_MASK ) )
  33
  34 struct Accelerator
  35 {
  36         Accelerator( guint _key )
  37                 : key( gdk_keyval_to_upper( _key ) ), modifiers( ( GdkModifierType ) 0 ){
  38         }
  39         Accelerator( guint _key, GdkModifierType _modifiers )
  40                 : key( gdk_keyval_to_upper( _key ) ), modifiers( ( GdkModifierType )( _modifiers & ALLOWED_MODIFIERS ) ){
  41         }
  42         Accelerator( const Accelerator &src )
  43                 : key( gdk_keyval_to_upper( src.key ) ), modifiers( ( GdkModifierType )( src.modifiers & ALLOWED_MODIFIERS ) ){
  44         }
  45         bool operator<( const Accelerator& other ) const {
  46                 guint k1 = key;
  47                 guint k2 = other.key;
  48                 int mod1 = modifiers & ALLOWED_MODIFIERS;
  49                 int mod2 = other.modifiers & ALLOWED_MODIFIERS;
  50                 return k1 < k2 || ( !( k2 < k1 ) && mod1 < mod2 );
  51         }
  52         bool operator==( const Accelerator& other ) const {
  53                 guint k1 = key;
  54                 guint k2 = other.key;
  55                 int mod1 = modifiers & ALLOWED_MODIFIERS;
  56                 int mod2 = other.modifiers & ALLOWED_MODIFIERS;
  57                 return k1 == k2 && mod1 == mod2;
  58         }
  59         Accelerator &operator=( const Accelerator& other ){
  60                 key = other.key;
  61                 modifiers = (GdkModifierType) ( other.modifiers & ALLOWED_MODIFIERS );
  62                 return *this;
  63         }
  64         guint key;
  65         GdkModifierType modifiers;
  66 };
  67
  68 inline Accelerator accelerator_null(){
  69         return Accelerator( 0, (GdkModifierType)0 );
  70 }
  71
  72 const char* global_keys_find( unsigned int key );
  73 unsigned int global_keys_find( const char* name );
  74
  75 class TextOutputStream;
  76 void accelerator_write( const Accelerator& accelerator, TextOutputStream& ostream );
  77
  78 template<typename TextOutputStreamType>
  79 TextOutputStreamType& ostream_write( TextOutputStreamType& ostream, const Accelerator& accelerator ){
  80         accelerator_write( accelerator, ostream );
  81         return ostream;
  82 }
  83
  84 void keydown_accelerators_add( Accelerator accelerator, const Callback& callback );
  85 void keydown_accelerators_remove( Accelerator accelerator );
  86 void keyup_accelerators_add( Accelerator accelerator, const Callback& callback );
  87 void keyup_accelerators_remove( Accelerator accelerator );
  88
  89 typedef struct _GtkWidget GtkWidget;
  90 typedef struct _GtkWindow GtkWindow;
  91 void global_accel_connect_window( GtkWindow* window );
  92 void global_accel_disconnect_window( GtkWindow* window );
  93
  94 void GlobalPressedKeys_releaseAll();
  95
  96 typedef struct _GtkAccelGroup GtkAccelGroup;
  97 extern GtkAccelGroup* global_accel;
  98 void global_accel_init();
  99 void global_accel_destroy();
 100
 101 GClosure* global_accel_group_find( Accelerator accelerator );
 102
 103 void global_accel_group_connect( const Accelerator& accelerator, const Callback& callback );
 104 void global_accel_group_disconnect( const Accelerator& accelerator, const Callback& callback );
 105
 106
 107 class Command
 108 {
 109 public:
 110 Callback m_callback;
 111 const Accelerator& m_accelerator;
 112 Command( const Callback& callback, const Accelerator& accelerator ) : m_callback( callback ), m_accelerator( accelerator ){
 113 }
 114 };
 115
 116 class Toggle
 117 {
 118 public:
 119 Command m_command;
 120 BoolExportCallback m_exportCallback;
 121 Toggle( const Callback& callback, const Accelerator& accelerator, const BoolExportCallback& exportCallback ) : m_command( callback, accelerator ), m_exportCallback( exportCallback ){
 122 }
 123 };
 124
 125 class KeyEvent
 126 {
 127 public:
 128 const Accelerator& m_accelerator;
 129 Callback m_keyDown;
 130 Callback m_keyUp;
 131 KeyEvent( const Accelerator& accelerator, const Callback& keyDown, const Callback& keyUp ) : m_accelerator( accelerator ), m_keyDown( keyDown ), m_keyUp( keyUp ){
 132 }
 133 };
 134
 135
 136
 137 struct PressedButtons;
 138 typedef struct _GtkWidget GtkWidget;
 139 void PressedButtons_connect( PressedButtons& pressedButtons, GtkWidget* widget );
 140
 141 extern PressedButtons g_pressedButtons;
 142
 143 #endif