added EventMask for keynotifiers. eg., a mask on which type of keyevents

(press and/or release) the keyconfig makes an action

2 files changed, 88 insertions, 4 deletions

diff --git a/libopie2/opiecore/okeyconfigmanager.cpp b/libopie2/opiecore/okeyconfigmanager.cpp
index e6055e0..18740ef 100644
--- a/libopie2/opiecore/okeyconfigmanager.cpp
+++ b/libopie2/opiecore/okeyconfigmanager.cpp
@@ -220,514 +220,526 @@ bool OKeyPair::operator!=( const OKeyPair& pair)const  {
 OKeyConfigItem::OKeyConfigItem( const QString& text, const QCString& config_key,
                                 const QPixmap& pix, int id, const OKeyPair& def,
                                 QObject *caller,
                                 const char* slot )
     : m_text( text ), m_config( config_key ), m_pix( pix ),
       m_id( id ), m_def( def ),
       m_obj( caller ), m_str( slot ) {}
 
 /**
  * A special Constructor for converting from an Opie::Core::ODeviceButton
  * delivered by Opie::Core::ODevice::buttons()
  * There is no Config Key set and both default key and key are set
  * to Opie::Core::ODeviceButton::keycode() and 0 to modifier
  *
  * @see Opie::Core::ODevice
  * @see Opie::Core::ODeviceButton
  * @see Opie::Core::ODevice::buttons()
  */
 OKeyConfigItem::OKeyConfigItem( const Opie::Core::ODeviceButton& b )
     : m_text( b.userText() ), m_pix( b.pixmap() ), m_id( -1 ),
       m_key( OKeyPair( b.keycode(), 0 ) ), m_def( OKeyPair( b.keycode(), 0 ) )
 {}
 
 
 /**
  * Destructor
  */
 OKeyConfigItem::~OKeyConfigItem() {}
 
 
 /**
  * The text exposed to the user
  *
  * @see setText
  */
 QString OKeyConfigItem::text()const {
     return m_text;
 }
 
 /**
  * The pixmap shown to the user for your action/key
  *
  * @see setPixmap
  */
 QPixmap OKeyConfigItem::pixmap()const {
     return m_pix;
 }
 
 /**
  * Return the OKeyPair this OKeyConfigItem is configured for.
  *
  * @see setKeyPair
  */
 OKeyPair OKeyConfigItem::keyPair()const {
     return m_key;
 }
 
 /**
  * Return the default OKeyPair
  * @see setDefaultKeyPair
  */
 OKeyPair OKeyConfigItem::defaultKeyPair()const {
     return m_def;
 }
 
 
 /**
  * Return the Id you assigned to this item.
  * setting is only possible by the constructor
  */
 int OKeyConfigItem::id()const{
     return m_id;
 }
 
 /**
  * reutrn the Config Key. Setting it is only possible
  * by the constructor
  */
 QCString OKeyConfigItem::configKey()const {
     return m_config;
 }
 
 /**
  * @internal
  */
 QObject* OKeyConfigItem::object()const{
     return m_obj;
 }
 
 /**
  * @internal
  */
 QCString OKeyConfigItem::slot()const {
     return m_str;
 }
 
 /**
  * Set the text
  *
  * @param text Set the Text of this Action to text
  * @see text()
  */
 void OKeyConfigItem::setText( const QString& text ) {
     m_text = text;
 }
 
 /**
  * Set the pixmap of this action
  *
  * @param pix The Pixmap to set
  * @see pixmap()
  */
 void OKeyConfigItem::setPixmap( const QPixmap& pix ) {
     m_pix = pix;
 }
 
 /**
  * Set the KeyPair the OKeyConfigItem uses.
  * Your set Key could get overwritten if you use
  * the manager or GUI to configure the key
  *
  * @param key Set the OKeyPair used
  * @see keyPair()
  */
 void OKeyConfigItem::setKeyPair( const OKeyPair& key) {
     m_key = key;
 }
 
 /**
  * Set the default KeyPair.
  *
  * @param key The default keypair
  * @see defaultKeyPair()
  */
 void OKeyConfigItem::setDefaultKeyPair( const OKeyPair& key ) {
     m_def = key;
 }
 
 /**
  * @internal
  */
 void OKeyConfigItem::setConfigKey( const QCString& str) {
     m_config = str;
     m_config.detach();
 }
 
 /**
  * @internal
  */
 void OKeyConfigItem::setId( int id ) {
     m_id = id;
 }
 
 /**
  * If the item is not configured isEmpty() will return true
  * It is empty if no text is present and no default
  * and no configured key
  */
 bool OKeyConfigItem::isEmpty()const {
     if ( !m_def.isEmpty()  ) return false;
     if ( !m_key.isEmpty()  ) return false;
     if ( !m_text.isEmpty() ) return false;
     if ( m_id != -1       ) return false;
 
     return true;
 }
 
 /**
  * Check if the KeyPairs are the same
  */
 bool OKeyConfigItem::operator==( const OKeyConfigItem& conf )const {
 /*    if ( isEmpty() == conf.isEmpty() ) return true;
     else if ( isEmpty() != conf.isEmpty() ) return false;
     else if ( !isEmpty()!= conf.isEmpty() ) return false;
 */
 
     if ( m_id != conf.m_id )     return false;
     if ( m_obj != conf.m_obj )   return false;
     if ( m_text != conf.m_text ) return false;
     if ( m_key != conf.m_key )   return false;
     if ( m_def != conf.m_def )   return false;
 
 
 
     return true;
 
 }
 
 bool OKeyConfigItem::operator!=( const OKeyConfigItem& conf )const {
     return !( *this == conf );
 }
 
+/*! \enum OKeyConfigManager::EventMask
+     <a name="Eventmask flags"></a>
+     This enum is used to tell OKeyConfigManager which type of key events should inspected.
+
+     <ul>
+         <li>\c MaskPressed When a key is pressed an action performs
+         <li>\c MaskReleased When a key is released an action performs
+     </ul>
+*/
+
 /**
  * \brief c'tor
  * The Constructor for a OKeyConfigManager
  *
  * You can use this manager in multiple ways. Either make it handle
- * QKeyEvents
+ * QKeyEvents. The EventMask is set to OKeyConfigManager::MaskReleased by default.
  *
  * \code
  * Opie::Core::Config conf = oApp->config();
  * Opie::Core::OKeyPairList blackList;
  * blackList.append(Opie::Core::OKeyPair::leftArrowKey());
  * blackList.append(Opie::Core::OKeyPair::rightArrowKey());
  * Opie::Core::OKeyConfigManager *manager = new Opie::Core::OKeyConfigManager(conf,"key_actions",blackList,
  *                                                                        false);
  * QListView *view = new QListView();
  * manager->handleWidget(view);
  * manager->addKeyConfig( Opie::Core::OKeyPair::returnKey());
  * manager->load();
  *
  * connect(manager,SIGNAL(actionActivated(QWidget*,QKeyEvent*,const Opie::Core::OKeyConfigItem&)),
  *         this,SLOT(slotHandleKey(QWidget*,QKeyEvent*,const Opie::Core::OKeyConfigItem&)));
  *
  * ....
  *
  * void update(){
  *  QDialog diag(true);
  *  QHBoxLayout *lay = new QHBoxLayout(&diag);
  *  Opie::Ui::OKeyConfigWidget *wid = new Opie::Ui::OKeyConfigWidget(manager,&diag);
  *  wid->setChangeMode(Opie::Ui::OKeyConfigWidget::Queu);
  *  lay->addWidget(wid);
  *  if(QPEApplication::execDialog( &diag)== QDialog::Accepted){
  *        wid->save();
  *  }
  * }
  *
  * ....
  * MyListView::keyPressEvent( QKeyEvent* e ){
  *     Opie::Ui::OKeyConfigItem item = manager->handleKeyEvent(e);
  *     if(!item.isEmpty() ){
  *         switch(item.id()){
  *           case My_Delete_Key:
  *             break;
  *         }
  *     }
  * }
  *
  * \endcode
  *
  * @param conf The Config where the KeySetting should be stored
  * @param group The group where the KeySetting will be stored
  * @param black Which keys shouldn't be allowed to handle
  * @param grabkeyboard Calls QPEApplication::grabKeyboard to allow handling of DeviceButtons
  * @param par The parent/owner of this manager
  * @param name The name of this object
  */
 OKeyConfigManager::OKeyConfigManager( Opie::Core::OConfig* conf,
                                       const QString& group,
                                       const OKeyPair::List& black,
                                       bool grabkeyboard, QObject* par,
                                       const char* name)
     : QObject( par, name ), m_conf( conf ), m_group( group ),
       m_blackKeys( black ), m_grab( grabkeyboard ), m_map( 0 ){
     if ( m_grab )
         QPEApplication::grabKeyboard();
+    m_event_mask = OKeyConfigManager::MaskReleased;
 }
 
 
 /**
  * Destructor
  */
 OKeyConfigManager::~OKeyConfigManager() {
     if ( m_grab )
         QPEApplication::ungrabKeyboard();
 }
 
 /**
  * Load the Configuration  from the OConfig
  * If a Key is restricted but was in the config we will
  * make it be the empty key paur
  * We will change the group but restore to the previous.
  *
  * @see OKeyPair::emptyKey
  */
 void OKeyConfigManager::load() {
     Opie::Core::OConfigGroupSaver( m_conf, m_group );
 
     /*
      * Read each item
      */
     int key, mod;
     for( OKeyConfigItem::List::Iterator it = m_keys.begin(); it != m_keys.end(); ++it ) {
         key = m_conf->readNumEntry( (*it).configKey()+"key", (*it).defaultKeyPair().keycode()  );
         mod = m_conf->readNumEntry( (*it).configKey()+"mod", (*it).defaultKeyPair().modifier() );
         OKeyPair okey( key, mod );
 
         if (  !m_blackKeys.contains( okey ) && key != -1  && mod != -1 )
             (*it).setKeyPair( OKeyPair(key, mod) );
         else
             (*it).setKeyPair( OKeyPair::emptyKey() );
     }
     delete m_map; m_map = 0;
 }
 
 /**
  * We will save the current configuration
  * to the OConfig. We will change the group but restore
  * to the previous
  */
 void OKeyConfigManager::save() {
     Opie::Core::OConfigGroupSaver( m_conf, m_group );
 
     /*
      * Write each item
      */
     for( OKeyConfigItem::List::Iterator it = m_keys.begin();it != m_keys.end(); ++it ) {
         /* skip empty items */
         if ( (*it).isEmpty() )
             continue;
         OKeyPair pair = (*it).keyPair();
         OKeyPair deft = (*it).defaultKeyPair();
         /*
          * don't write if it is the default setting
          * FIXME allow to remove Keys from config
         if (  (pair.keycode() == deft.keycode()) &&
               (pair.modifier()== deft.modifier() ) )
             return;
         */
 
         m_conf->writeEntry((*it).configKey()+"key", pair.keycode()  );
         m_conf->writeEntry((*it).configKey()+"mod", pair.modifier() );
     }
     m_conf->write();
 }
 
 /**
  * This is function uses a QMap internally  but you can have the same keycode
  * with different modifier key. The behaviour is undefined if you add a OKeyConfigItem
  * with same keycode and modifier key. The GUI takes care that a user can't
  * cofigure two keys.
  *
  * Make sure you call e->ignore if you don't want to handle this event
  */
 OKeyConfigItem OKeyConfigManager::handleKeyEvent( QKeyEvent* e ) {
    /*
     * Fix Up issues with Qt/E, my keybard, and virtual input
     * methods
     * First my Keyboard delivers 256,512,1024 for shift/ctrl/alt instead of the button state
     * Also key() on virtual inputmethods are zero and only ascii. We need to fix upper and lower
     * case ascii
     */
     int key, mod;
     Opie::Core::Internal::fixupKeys( key, mod, e );
 
     OKeyConfigItem::List _keyList =  keyList( key );
     if ( _keyList.isEmpty() )
         return OKeyConfigItem();
 
     OKeyConfigItem item;
     for ( OKeyConfigItem::List::Iterator it = _keyList.begin(); it != _keyList.end();
           ++it ) {
         if ( (*it).keyPair().modifier() == mod ) {
             item = *it;
             break;
         }
 
     }
 
     return item;
 }
 
 /**
  * Return the associated id of the item or -1 if no item
  * matched the key
  *
  * @see handleKeyEvent
  */
 int OKeyConfigManager::handleKeyEventId( QKeyEvent* ev) {
     return handleKeyEvent( ev ).id();
 }
 
 /**
  * Add Key Config to the List of items
  */
 void OKeyConfigManager::addKeyConfig( const OKeyConfigItem& item ) {
     m_keys.append( item );
     delete m_map; m_map = 0;
 }
 
 /**
  * Remove the Key from the Config. Internal lists will be destroyed
  * and rebuild on demand later
  */
 void OKeyConfigManager::removeKeyConfig( const OKeyConfigItem& item ) {
     m_keys.remove( item );
     delete m_map; m_map = 0;
 }
 
 /**
  * Clears the complete list
  */
 void OKeyConfigManager::clearKeyConfig() {
     m_keys.clear();
     delete m_map; m_map = 0;
 }
 
 /**
  *
  */
 Opie::Core::OKeyConfigItem::List OKeyConfigManager::keyConfigList()const{
     return m_keys;
 }
 
 /**
  * Add this OKeyPair to the blackList.
  * Internal lists will be destroyed
  */
 void OKeyConfigManager::addToBlackList( const OKeyPair& key) {
     m_blackKeys.append( key );
     delete m_map; m_map = 0;
 }
 
 
 /**
  * Remove this OKeyPair from the black List
  * Internal lists will be destroyed
  */
 void OKeyConfigManager::removeFromBlackList( const OKeyPair& key ) {
     m_blackKeys.remove( key );
     delete m_map; m_map = 0;
 }
 
 
 /**
  * Clear the blackList
  */
 void OKeyConfigManager::clearBlackList() {
     m_blackKeys.clear();
     delete m_map; m_map = 0;
 }
 
 
 /**
  * Return a copy of the blackList
  */
 OKeyPair::List OKeyConfigManager::blackList()const {
     return m_blackKeys;
 }
 
 
 /**
  * Ask the Manager to handle KeyEvents for you.
  * All handled keys will emit a QSignal and return true
  * that it handled the keyevent
  */
 void OKeyConfigManager::handleWidget( QWidget* wid ) {
     wid->installEventFilter( this );
 }
 
 /**
  * @internal
  */
 bool OKeyConfigManager::eventFilter( QObject* obj, QEvent* ev) {
     if ( !obj->isWidgetType() )
         return false;
 
-    if ( ev->type() != QEvent::KeyPress && ev->type() != QEvent::KeyRelease )
+    if ( (ev->type() != QEvent::KeyPress||!testEventMask(MaskPressed)) &&
+        (ev->type() != QEvent::KeyRelease||!testEventMask(MaskReleased)) )
         return false;
 
     QKeyEvent *key = static_cast<QKeyEvent*>( ev );
     OKeyConfigItem item =  handleKeyEvent( key );
 
     if ( item.isEmpty() )
         return false;
 
     QWidget *wid = static_cast<QWidget*>( obj );
 
     if ( item.object() && !item.slot().isEmpty() ) {
         connect( this, SIGNAL( actionActivated(QWidget*, QKeyEvent*)),
                  item.object(), item.slot().data() );
         emit actionActivated(wid, key);
         disconnect( this, SIGNAL(actionActivated(QWidget*,QKeyEvent*)),
                     item.object(), item.slot().data() );
     }
     emit actionActivated( wid, key, item );
 
     return true;
 }
 
 /**
  * @internal
  */
 OKeyConfigItem::List OKeyConfigManager::keyList( int keycode) {
    /*
     * Create the map if not existing anymore
     */
     if ( !m_map ) {
         m_map = new OKeyMapConfigPrivate;
         /* for every key */
         for ( OKeyConfigItem::List::Iterator it = m_keys.begin();
               it!= m_keys.end(); ++it ) {
 
             bool add = true;
             /* see if this key is blocked */
             OKeyPair pair = (*it).keyPair();
             for ( OKeyPair::List::Iterator pairIt = m_blackKeys.begin();
                   pairIt != m_blackKeys.end(); ++pairIt ) {
                 if ( (*pairIt).keycode()  == pair.keycode() &&
                      (*pairIt).modifier() == pair.modifier() ) {
                     add = false;
                     break;
                 }
             }
             /* check if we added it */
             if ( add )
                 (*m_map)[pair.keycode()].append( *it );
         }
     }
     return (*m_map)[keycode];
 }
 
 }
 }
diff --git a/libopie2/opiecore/okeyconfigmanager.h b/libopie2/opiecore/okeyconfigmanager.h
index d610375..b861675 100644
--- a/libopie2/opiecore/okeyconfigmanager.h
+++ b/libopie2/opiecore/okeyconfigmanager.h
@@ -1,205 +1,277 @@
 /*
  * Copyright (C) 2004
  * LGPL v2  zecke@handhelds.org
  */
 
 
 #ifndef ODP_KEY_MANAGER_WIDGET_H
 #define ODP_KEY_MANAGER_WIDGET_H
 
 #include <opie2/oconfig.h>
 #include <opie2/odevice.h>
 
 #include <qstring.h>
 #include <qpixmap.h>
 #include <qcstring.h>
 #include <qvaluelist.h>
 
 namespace Opie {
 namespace Core {
 
 /**
  * \brief small class representing a Key with possible modifiers
  * This class holds information about key code and possible
  * modifier state. That is the lowest level of the key input
  * functions.
  * There are also static methods to get special keys.
  * OKeyPair will be used with \see OKeyConfigItem
  *
  * @since 1.2
  */
 class OKeyPair {
 public:
     typedef QValueList<OKeyPair> List;
     OKeyPair( int key = -1, int modifier = -1);
     ~OKeyPair();
 
     bool operator==( const OKeyPair& )const;
     bool operator!=( const OKeyPair& )const;
 
     bool isEmpty()const;
 
     int keycode()const;
     int modifier()const;
 
     void setKeycode( int );
     void setModifier( int );
 
     static OKeyPair returnKey();
     static OKeyPair leftArrowKey();
     static OKeyPair rightArrowKey();
     static OKeyPair upArrowKey();
     static OKeyPair downArrowKey();
     static OKeyPair emptyKey();
     static OKeyPair::List hardwareKeys();
 
 private:
     int m_key;
     int m_mod;
     class Private;
     Private* d;
 };
 
 /**
  * A class to represent an OKeyPair.
  * It consists out of a Text exposed to the user, Config Key Item,
  * Pixmap, A default OKeyPair and the set OKeyPair.
  * You can also pass an id to it
  *
  * @since 1.1.2
  */
 class OKeyConfigItem {
     friend class OKeyConfigManager;
 public:
     typedef QValueList<OKeyConfigItem> List;
     OKeyConfigItem( const QString& text = QString::null , const QCString& config_key = QCString(),
                     const QPixmap& symbol  = QPixmap(),
                     int id = -1,
                     const OKeyPair& def = OKeyPair::emptyKey(),
                     QObject *caller = 0, const char* slot = 0);
     OKeyConfigItem( const Opie::Core::ODeviceButton& );
     ~OKeyConfigItem();
 
     bool operator==( const OKeyConfigItem& )const;
     bool operator!=( const OKeyConfigItem& )const;
 
     QString text()const;
     QPixmap pixmap()const;
     int id()const;
 
 
 
     OKeyPair keyPair()const;
     OKeyPair defaultKeyPair()const;
     QCString configKey()const;
 
 
     void setText( const QString& text );
     void setPixmap( const QPixmap& );
     void setKeyPair( const OKeyPair& );
     void setDefaultKeyPair( const OKeyPair& );
 
     bool isEmpty()const;
 
 protected:
     QObject *object()const;
     QCString slot()const;
     void setId( int id );
     void setConfigKey( const QCString& );
 
 private:
     QString  m_text;
     QCString m_config;
     QPixmap  m_pix;
     int m_id;
     OKeyPair m_key;
     OKeyPair m_def;
     QObject *m_obj;
     QCString m_str;
     class Private;
     Private *d;
 };
 
 
 
 /**
  * \brief A manager  to load and save Key Actions and get notified
  * This is the Manager for KeyActions.
  * You can say from which config and group to read data, to grab the
  * keyboard to handle hardware keys, you can supply a blacklist of
  * keys which should not be used by allowed to be used.
  * You can even pass this manager to a Widget to do the configuration for you.
  * You need to add OKeyConfigItem for your keys and then issue a load() to
  * read the Key information.
  * You can either handle the QKeyEvent yourself and ask this class if it is
  * handled by your action and let give you the action. Or you can install
  * the event filter and get a signal.
- * You need to load ans save yourself!
+ * You need to load and save yourself!
  *
  * @since 1.1.2
  */
 class OKeyConfigManager : public QObject {
     Q_OBJECT
     typedef QMap<int, OKeyConfigItem::List> OKeyMapConfigPrivate;
 public:
     OKeyConfigManager(Opie::Core::OConfig *conf = 0,
                       const QString& group = QString::null,
                       const OKeyPair::List &block = OKeyPair::List(),
-                      bool grabkeyboard = false,  QObject * par = 0,
+                      bool grabkeyboard = false, QObject * par = 0,
                       const char* name = 0      );
     ~OKeyConfigManager();
 
     void load();
     void save();
 
     OKeyConfigItem handleKeyEvent( QKeyEvent* );
     int            handleKeyEventId( QKeyEvent* );
 
     void addKeyConfig( const OKeyConfigItem& );
     void removeKeyConfig( const OKeyConfigItem& );
     void clearKeyConfig();
 
     void addToBlackList( const OKeyPair& );
     void removeFromBlackList( const OKeyPair& );
     void clearBlackList();
     OKeyPair::List blackList()const;
 
     void handleWidget( QWidget* );
 
     bool eventFilter( QObject*, QEvent* );
 
+    /**
+     * Sets the event mask flags aMask.
+     *
+     * aMask is a combination of OKeyConfigManager::EventMask
+     *
+     * @see eventMask(), testEventMask(), addEventMask(), clearEventMask()
+     */
+    void setEventMask(uint aMask);
+    /**
+     * Returns the event mask flags set.
+     *
+     * aMask is a combination of OKeyConfigManager::EventMask
+     *
+     * @see setEventMask(), testEventMask(), addEventMask(), clearEventMask()
+     */
+    uint eventMask()const;
+    /**
+     * Test if the event mask flag aMask is set.
+     *
+     * @param aMask one of OKeyConfigManager::EventMask
+     *
+     * @see eventMask(), setEventMask(), addEventMask(), clearEventMask()
+     */
+    bool testEventMask(uint aMask);
+    /**
+     * Add the event mask flag aMask.
+     *
+     * @param aMask one of OKeyConfigManager::EventMask
+     *
+     * @see eventMask(), setEventMask(), addEventMask(), clearEventMask()
+     */
+    void addEventMask(uint aMask);
+    /**
+     * Clears the event mask flag aMask.
+     *
+     * @param aMask is one of OKeyConfigManager::EventMask
+     *
+     * @see eventMask(), testEventMask(), addEventMask(), setEventMask()
+     */
+    void clearEventMask(uint aMask);
+
     OKeyConfigItem::List keyConfigList()const;
+
+    enum EventMask {
+        MaskPressed = 0x1,
+        MaskReleased = 0x2,
+    };
 signals:
     /**
      * The Signals are triggered on KeyPress and KeyRelease!
      * You can check the isDown of the QKeyEvent
      * @see QKeyEvent
      */
     void actionActivated( QWidget*, QKeyEvent*, const Opie::Core::OKeyConfigItem& );
 
     /**
      * This Signal correspondents to the OKeyConfigItem slot
      * and object
      *
      * @see OKeyConfigItem::slot
      * @see OKeyConfigItem::object
      */
     void actionActivated( QWidget* par, QKeyEvent* key);
 
 private:
     OKeyConfigItem::List keyList( int );
     OKeyConfigItem::List m_keys;
     QValueList<QWidget*> m_widgets;
     Opie::Core::OConfig *m_conf;
     QString m_group;
     OKeyPair::List m_blackKeys;
     bool m_grab : 1;
     OKeyMapConfigPrivate *m_map;
     class Private;
     Private *d;
+    uint m_event_mask;
 };
 
+inline bool OKeyConfigManager::testEventMask(uint aMask)
+{
+    return (m_event_mask&aMask)!=0;
+}
+
+inline void OKeyConfigManager::addEventMask(uint aMask)
+{
+    m_event_mask |= aMask;
+}
+
+inline void OKeyConfigManager::clearEventMask(uint aMask)
+{
+    m_event_mask &= ~aMask;
+}
+
+inline void OKeyConfigManager::setEventMask(uint aMask)
+{
+    m_event_mask = aMask;
+}
+
+inline uint OKeyConfigManager::eventMask()const
+{
+    return  m_event_mask;
+}
+
 }
 }
 
 #endif