| -rw-r--r-- | libopie2/examples/opiecore/okeyconfigmanager/README | 1 | ||||
| -rw-r--r-- | libopie2/examples/opieui/okeyconfigwidget/testwidget.cpp | 30 | ||||
| -rw-r--r-- | libopie2/examples/opieui/okeyconfigwidget/testwidget.h | 10 | ||||
| -rw-r--r-- | libopie2/opiecore/okeyconfigmanager.cpp | 733 | ||||
| -rw-r--r-- | libopie2/opiecore/okeyconfigmanager.h | 205 | ||||
| -rw-r--r-- | libopie2/opiecore/okeyconfigmanager_p.h | 9 | ||||
| -rw-r--r-- | libopie2/opiecore/opiecore.pro | 2 | ||||
| -rw-r--r-- | libopie2/opieui/okeyconfigwidget.cpp | 742 | ||||
| -rw-r--r-- | libopie2/opieui/okeyconfigwidget.h | 199 | ||||
| -rw-r--r-- | libopie2/opieui/okeyconfigwidget_p.h | 22 |
10 files changed, 999 insertions, 954 deletions
diff --git a/libopie2/examples/opiecore/okeyconfigmanager/README b/libopie2/examples/opiecore/okeyconfigmanager/README new file mode 100644 index 0000000..327b7c2 --- a/dev/null +++ b/libopie2/examples/opiecore/okeyconfigmanager/README @@ -0,0 +1 @@ +See opieui/okeyconfigwidget for an example of possible usage
\ No newline at end of file diff --git a/libopie2/examples/opieui/okeyconfigwidget/testwidget.cpp b/libopie2/examples/opieui/okeyconfigwidget/testwidget.cpp index 10b52f9..5c7bac2 100644 --- a/libopie2/examples/opieui/okeyconfigwidget/testwidget.cpp +++ b/libopie2/examples/opieui/okeyconfigwidget/testwidget.cpp @@ -8,121 +8,121 @@ #include <qpe/qpeapplication.h> #include <qevent.h> #include <qlayout.h> #include <qpushbutton.h> #include <qmainwindow.h> #include <qdialog.h> /** * QObject with signals and slots inside a .cpp * requires the .moc at the bottom! and a run of qmake */ class MainWindow : public QMainWindow { Q_OBJECT public: static QString appName() { return QString::fromLatin1("keyconfig"); } MainWindow( QWidget*, const char*, WFlags fl ); ~MainWindow() {} private slots: void slotClicked(); private: - Opie::Ui::OKeyConfigManager *m_manager; + Opie::Core::OKeyConfigManager *m_manager; }; OPIE_EXPORT_APP( Opie::Core::OApplicationFactory<MainWindow> ) MainWindow::MainWindow( QWidget* parent, const char* name, WFlags fl ) : QMainWindow( parent, name, fl ) { QVBoxLayout *lay = new QVBoxLayout( this ); QPushButton *btn = new QPushButton( tr("Configure" ), this ); TestMainWindow *wid = new TestMainWindow( this, "name", 0 ); lay->addWidget( btn ); lay->addWidget( wid ); m_manager = wid->manager(); connect( btn, SIGNAL(clicked()), this, SLOT(slotClicked()) ); } void MainWindow::slotClicked() { QDialog diag( this, "name", true ); diag.setCaption( tr( "Manage Keys" ) ); QHBoxLayout *lay = new QHBoxLayout( &diag ); Opie::Ui::OKeyConfigWidget *wid = new Opie::Ui::OKeyConfigWidget( &diag, "key config" ); wid->setChangeMode( Opie::Ui::OKeyConfigWidget::Queue ); wid->insert( tr("MainWindow Options" ), m_manager ); wid->load(); lay->addWidget( wid ); if ( QPEApplication::execDialog( &diag ) == QDialog::Accepted ) { wid->save(); } } TestMainWindow::TestMainWindow( QWidget* parent, const char* slot, WFlags fl ) : Opie::Ui::OListView( parent, slot, fl) { addColumn( tr( "A Doo" ) ); addColumn( tr( "B Doo" ) ); m_config = new Opie::Core::OConfig( "test_config_foo" ); /* generate the black list */ - Opie::Ui::OKeyPair::List blackList; - blackList.append( Opie::Ui::OKeyPair::leftArrowKey() ); - blackList.append( Opie::Ui::OKeyPair::rightArrowKey() ); - blackList.append( Opie::Ui::OKeyPair::downArrowKey() ); - blackList.append( Opie::Ui::OKeyPair::upArrowKey() ); + Opie::Core::OKeyPair::List blackList; + blackList.append( Opie::Core::OKeyPair::leftArrowKey() ); + blackList.append( Opie::Core::OKeyPair::rightArrowKey() ); + blackList.append( Opie::Core::OKeyPair::downArrowKey() ); + blackList.append( Opie::Core::OKeyPair::upArrowKey() ); - m_manager = new Opie::Ui::OKeyConfigManager( m_config, "Key Group", + m_manager = new Opie::Core::OKeyConfigManager( m_config, "Key Group", blackList, false, this, "Key Manager" ); - m_manager->addKeyConfig( Opie::Ui::OKeyConfigItem( tr( "Delete Action" ), "delete_key", QPixmap(), - 10, Opie::Ui::OKeyPair( Qt::Key_D, Qt::ShiftButton ), this, + m_manager->addKeyConfig( Opie::Core::OKeyConfigItem( tr( "Delete Action" ), "delete_key", QPixmap(), + 10, Opie::Core::OKeyPair( Qt::Key_D, Qt::ShiftButton ), this, SLOT(slotDelete(QWidget*,QKeyEvent*)) ) ); - m_manager->addKeyConfig( Opie::Ui::OKeyConfigItem( tr( "Show Action" ), "show_key", QPixmap(), - 11, Opie::Ui::OKeyPair( Qt::Key_S, Qt::AltButton ) ) ); + m_manager->addKeyConfig( Opie::Core::OKeyConfigItem( tr( "Show Action" ), "show_key", QPixmap(), + 11, Opie::Core::OKeyPair( Qt::Key_S, Qt::AltButton ) ) ); - connect(m_manager, SIGNAL(actionActivated(QWidget*,QKeyEvent*,const Opie::Ui::OKeyConfigItem&)), - this, SLOT(slotAction(QWidget*, QKeyEvent*, const Opie::Ui::OKeyConfigItem&)) ); + connect(m_manager, SIGNAL(actionActivated(QWidget*,QKeyEvent*,const Opie::Core::OKeyConfigItem&)), + this, SLOT(slotAction(QWidget*, QKeyEvent*, const Opie::Core::OKeyConfigItem&)) ); // when commenting the line below out the keyPressEvent will work m_manager->handleWidget( this ); m_manager->load(); } TestMainWindow::~TestMainWindow() { m_manager->save(); delete m_config; } -Opie::Ui::OKeyConfigManager* TestMainWindow::manager() { +Opie::Core::OKeyConfigManager* TestMainWindow::manager() { return m_manager; } /* * This only works if we do not handle the even with m_manager->handleWidget( this ) * So this is only for demo purposes */ void TestMainWindow::keyPressEvent( QKeyEvent* ev ) { qWarning( "String is "+ m_manager->handleKeyEvent( ev ).text() ); qWarning( "Id was %d %d %d %d", m_manager->handleKeyEventId( ev ),ev->key(),ev->state(), ev->ascii() ); ev->ignore(); } void TestMainWindow::slotDelete( QWidget* wid, QKeyEvent* ev ) { qWarning( "Slot Delete %d %d %d", wid, ev->key(), ev->state() ); } -void TestMainWindow::slotAction( QWidget* wid, QKeyEvent* ev, const Opie::Ui::OKeyConfigItem& item) { +void TestMainWindow::slotAction( QWidget* wid, QKeyEvent* ev, const Opie::Core::OKeyConfigItem& item) { qWarning( "Slot Action %d %d %d %s %d", wid, ev->key(), ev->state(), item.text().latin1(), item.id() ); } #include "testwidget.moc" diff --git a/libopie2/examples/opieui/okeyconfigwidget/testwidget.h b/libopie2/examples/opieui/okeyconfigwidget/testwidget.h index b95c225..6ecb346 100644 --- a/libopie2/examples/opieui/okeyconfigwidget/testwidget.h +++ b/libopie2/examples/opieui/okeyconfigwidget/testwidget.h @@ -1,40 +1,40 @@ #ifndef TEST_WIDGET_H #define TEST_WIDGET_H #include <qmainwindow.h> #include <opie2/olistview.h> namespace Opie{ namespace Ui{ class OTabWidget; - class OKeyConfigManager; class OListView; - class OKeyConfigItem; } namespace Core { class OConfig; + class OKeyConfigManager; + class OKeyConfigItem; } } class QKeyEvent; class TestMainWindow : public Opie::Ui::OListView { Q_OBJECT public: TestMainWindow(QWidget* parent, const char*, WFlags fl ); ~TestMainWindow(); - Opie::Ui::OKeyConfigManager *manager(); + Opie::Core::OKeyConfigManager *manager(); protected: void keyPressEvent( QKeyEvent* ); private slots: void slotDelete( QWidget*, QKeyEvent* ); - void slotAction( QWidget*, QKeyEvent*, const Opie::Ui::OKeyConfigItem& ); + void slotAction( QWidget*, QKeyEvent*, const Opie::Core::OKeyConfigItem& ); private: Opie::Core::OConfig *m_config; - Opie::Ui::OKeyConfigManager *m_manager; + Opie::Core::OKeyConfigManager *m_manager; }; #endif diff --git a/libopie2/opiecore/okeyconfigmanager.cpp b/libopie2/opiecore/okeyconfigmanager.cpp new file mode 100644 index 0000000..e6055e0 --- a/dev/null +++ b/libopie2/opiecore/okeyconfigmanager.cpp @@ -0,0 +1,733 @@ +#include "okeyconfigmanager.h" + +#include "okeyconfigmanager_p.h" + +namespace Opie { +namespace Core { +namespace Internal { + /* + * the virtual and hardware key events have both issues... + */ + void fixupKeys( int& key, int &mod, QKeyEvent* e ) { + key = e->key(); + mod = e->state(); + /* + * virtual keyboard + * else change the button mod only + */ + if ( key == 0 ) { + key = e->ascii(); + if ( key > 96 && key < 123) + key -= 32; + }else{ + int new_mod = 0; + if ( mod & 256 ) + new_mod |= Qt::ShiftButton; + else if ( mod & 512 ) + new_mod |= Qt::ControlButton; + else if ( mod & 1024 ) + new_mod |= Qt::AltButton; + + mod = new_mod == 0? mod : new_mod; + } + } +} + +/** + * The default Constructor of a OKeyPair. + * A Key and a Modifier ( Alt/Shift/Ctrl ) + * needs to be supplied. + * Use Qt::Key for the information. + * The default arguments create an Empty OKeyPair. If you + * want to get an empty OKeyPair use the static method for getting + * the emptyKey() + * + * @see OKeyPair OKeyPair::emptyKey() + */ +OKeyPair::OKeyPair( int key, int mod ) + : m_key( key ), m_mod( mod ) +{} + +/** + * The destructor + */ +OKeyPair::~OKeyPair() {} + + +/** + * Is this OKeyPair empty/valid? + */ +bool OKeyPair::isEmpty()const { + return ( ( m_key == -1 )&& ( m_mod == -1 ) ); +} + +/** + * get the keycode for this OKeyPair. The Key relates to Qt::Key. + * + * @see Qt::Key + * @see setKey + */ +int OKeyPair::keycode()const { + return m_key; +} + +/** + * get the modifier key for this OKeyPair. The Modifier State relates + * to the Qt::ButtonState + * + * @see Qt::ButtonState + * @see setModifier + */ +int OKeyPair::modifier()const { + return m_mod; +} + + +/** + * Set the keycode + * @param key The Keycode to set + * + * @see keycode() + * @see Qt::Key + */ +void OKeyPair::setKeycode( int key ) { + m_key = key; +} + +/** + * Set the modifier key + * + * @param the Modifier key + * @see Qt::ButtonState + * @see modifier() + */ +void OKeyPair::setModifier( int mod ) { + m_mod = mod; +} + +/** + * Return an OKeyPair for the Return Key without any modifier. + */ +OKeyPair OKeyPair::returnKey() { + return OKeyPair( Qt::Key_Return, 0 ); +} + +/** + * Return an OKeyPair for the Left Arrow Key + * without any modifier Key + */ +OKeyPair OKeyPair::leftArrowKey() { + return OKeyPair( Qt::Key_Left, 0 ); +} + +/** + * Return an OKeyPair for the Right Arrow Key + * without any modifier Key + */ +OKeyPair OKeyPair::rightArrowKey() { + return OKeyPair( Qt::Key_Right, 0 ); +} + +/** + * Return an OKeyPair for the Up Arrow Key + * without any modifier Key + */ +OKeyPair OKeyPair::upArrowKey() { + return OKeyPair( Qt::Key_Up, 0 ); +} + +/** + * Return an OKeyPair for the Down Arrow Key + * without any modifier Key + */ +OKeyPair OKeyPair::downArrowKey() { + return OKeyPair( Qt::Key_Down, 0 ); +} + +/** + * Return an Empty OKeyPair + */ +OKeyPair OKeyPair::emptyKey() { + return OKeyPair(); +} + +/** + * This functions uses the Opie::Core::ODevice::buttons + * for OKeyPairList + * + * @see Opie::Core::ODevice + * @see Opie::Core::ODeviceButton + * @see Opie::Core::ODevice::button + */ +OKeyPair::List OKeyPair::hardwareKeys() { + const QValueList<Opie::Core::ODeviceButton> but = Opie::Core::ODevice::inst()->buttons(); + OKeyPair::List lst; + + for ( QValueList<Opie::Core::ODeviceButton>::ConstIterator it = but.begin(); + it != but.end(); ++it ) + lst.append( OKeyPair( (*it).keycode(), 0 ) ); + + + return lst; +} + +/** + * Equals operator. Check if two OKeyPairs have the same key and modifier + * @see operator!= + */ +bool OKeyPair::operator==( const OKeyPair& pair)const { + if ( m_key != pair.m_key ) return false; + if ( m_mod != pair.m_mod ) return false; + + return true; +} + +/** + * Not equal operator. calls the equal operator internally + */ +bool OKeyPair::operator!=( const OKeyPair& pair)const { + return !(*this == pair); +} + + +/** + * The normal Constructor to create a OKeyConfigItem + * + * You can set the the key paramater of this item but if + * you use this item with the OKeyConfigManager your setting + * will be overwritten. + * You can also specify a QObject and slot which sould get called + * once this item is activated. This slot only works if you + * use the OKeyConfigManager. + * The actual Key is read by load() + * + * \code + * void MySlot::create(){ + * OKeyConfigItem item(tr("Delete"),"delete",Resource::loadPixmap("trash"), + * 123, OKeyPair(Qt::Key_D,Qt::ControlButton), + * this,SLOT(slotDelete(QWidget*,QKeyEvent*))); + * } + * \endcode + * + * @param text The text exposed to the user + * @param config_key The key used in the config + * @param pix A Pixmap associated with this Item + * @param def The OKeyPair used as default + * @param caller The object where the slot exists + * @param slot The slot which should get called + * + */ +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 ); +} + +/** + * \brief c'tor + * The Constructor for a OKeyConfigManager + * + * You can use this manager in multiple ways. Either make it handle + * QKeyEvents + * + * \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(); +} + + +/** + * 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 ) + 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 new file mode 100644 index 0000000..d610375 --- a/dev/null +++ b/libopie2/opiecore/okeyconfigmanager.h @@ -0,0 +1,205 @@ +/* + * 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! + * + * @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, + 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* ); + + OKeyConfigItem::List keyConfigList()const; +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; +}; + +} +} + +#endif diff --git a/libopie2/opiecore/okeyconfigmanager_p.h b/libopie2/opiecore/okeyconfigmanager_p.h new file mode 100644 index 0000000..0fe1056 --- a/dev/null +++ b/libopie2/opiecore/okeyconfigmanager_p.h @@ -0,0 +1,9 @@ + +namespace Opie { +namespace Core { +namespace Internal { +void fixupKeys( int&, int&, QKeyEvent* ); +} +} +} + diff --git a/libopie2/opiecore/opiecore.pro b/libopie2/opiecore/opiecore.pro index ae0af77..171bb0c 100644 --- a/libopie2/opiecore/opiecore.pro +++ b/libopie2/opiecore/opiecore.pro @@ -1,41 +1,43 @@ TEMPLATE = lib CONFIG += qt warn_on DESTDIR = $(OPIEDIR)/lib HEADERS = oapplication.h \ oconfig.h \ odebug.h \ oglobal.h \ oglobalsettings.h \ + okeyconfigmanager.h \ oprocess.h \ oprocctrl.h \ osmartpointer.h \ ostorageinfo.h \ xmltree.h SOURCES = oapplication.cpp \ oconfig.cpp \ odebug.cpp \ oglobal.cpp \ oglobalsettings.cpp \ + okeyconfigmanager.cpp \ oprocess.cpp \ oprocctrl.cpp \ ostorageinfo.cpp \ xmltree.cpp include ( device/device.pro ) INTERFACES = TARGET = opiecore2 VERSION = 1.9.0 INCLUDEPATH += $(OPIEDIR)/include DEPENDPATH += $(OPIEDIR)/include !contains( platform, x11 ) { LIBS = -lqpe include ( $(OPIEDIR)/include.pro ) } contains( platform, x11 ) { LIBS = -L$(OPIEDIR)/lib -Wl,-rpath,$(OPIEDIR)/lib } diff --git a/libopie2/opieui/okeyconfigwidget.cpp b/libopie2/opieui/okeyconfigwidget.cpp index d6d34f5..1991381 100644 --- a/libopie2/opieui/okeyconfigwidget.cpp +++ b/libopie2/opieui/okeyconfigwidget.cpp @@ -1,837 +1,111 @@ #include "okeyconfigwidget.h" #include "okeyconfigwidget_p.h" #include <qgroupbox.h> #include <qradiobutton.h> #include <qpushbutton.h> #include <qbuttongroup.h> #include <qmessagebox.h> #include <qaccel.h> #include <qlayout.h> #include <qlabel.h> /* non gui */ #include <qtimer.h> - -using namespace Opie::Ui; - - - -/** - * The default Constructor of a OKeyPair. - * A Key and a Modifier ( Alt/Shift/Ctrl ) - * needs to be supplied. - * Use Qt::Key for the information. - * The default arguments create an Empty OKeyPair. If you - * want to get an empty OKeyPair use the static method for getting - * the emptyKey() - * - * @see OKeyPair OKeyPair::emptyKey() - */ -OKeyPair::OKeyPair( int key, int mod ) - : m_key( key ), m_mod( mod ) -{} - -/** - * The destructor - */ -OKeyPair::~OKeyPair() {} - - -/** - * Is this OKeyPair empty/valid? - */ -bool OKeyPair::isEmpty()const { - return ( ( m_key == -1 )&& ( m_mod == -1 ) ); -} - -/** - * get the keycode for this OKeyPair. The Key relates to Qt::Key. - * - * @see Qt::Key - * @see setKey - */ -int OKeyPair::keycode()const { - return m_key; -} - -/** - * get the modifier key for this OKeyPair. The Modifier State relates - * to the Qt::ButtonState - * - * @see Qt::ButtonState - * @see setModifier - */ -int OKeyPair::modifier()const { - return m_mod; -} - - -/** - * Set the keycode - * @param key The Keycode to set - * - * @see keycode() - * @see Qt::Key - */ -void OKeyPair::setKeycode( int key ) { - m_key = key; -} - -/** - * Set the modifier key - * - * @param the Modifier key - * @see Qt::ButtonState - * @see modifier() - */ -void OKeyPair::setModifier( int mod ) { - m_mod = mod; -} - -/** - * Return an OKeyPair for the Return Key without any modifier. - */ -OKeyPair OKeyPair::returnKey() { - return OKeyPair( Qt::Key_Return, 0 ); -} - -/** - * Return an OKeyPair for the Left Arrow Key - * without any modifier Key - */ -OKeyPair OKeyPair::leftArrowKey() { - return OKeyPair( Qt::Key_Left, 0 ); -} - -/** - * Return an OKeyPair for the Right Arrow Key - * without any modifier Key - */ -OKeyPair OKeyPair::rightArrowKey() { - return OKeyPair( Qt::Key_Right, 0 ); -} - -/** - * Return an OKeyPair for the Up Arrow Key - * without any modifier Key - */ -OKeyPair OKeyPair::upArrowKey() { - return OKeyPair( Qt::Key_Up, 0 ); -} - -/** - * Return an OKeyPair for the Down Arrow Key - * without any modifier Key - */ -OKeyPair OKeyPair::downArrowKey() { - return OKeyPair( Qt::Key_Down, 0 ); -} - -/** - * Return an Empty OKeyPair - */ -OKeyPair OKeyPair::emptyKey() { - return OKeyPair(); -} - -/** - * This functions uses the Opie::Core::ODevice::buttons - * for OKeyPairList - * - * @see Opie::Core::ODevice - * @see Opie::Core::ODeviceButton - * @see Opie::Core::ODevice::button - */ -OKeyPair::List OKeyPair::hardwareKeys() { - const QValueList<Opie::Core::ODeviceButton> but = Opie::Core::ODevice::inst()->buttons(); - OKeyPair::List lst; - - for ( QValueList<Opie::Core::ODeviceButton>::ConstIterator it = but.begin(); - it != but.end(); ++it ) - lst.append( OKeyPair( (*it).keycode(), 0 ) ); - - - return lst; -} - -/** - * Equals operator. Check if two OKeyPairs have the same key and modifier - * @see operator!= - */ -bool OKeyPair::operator==( const OKeyPair& pair)const { - if ( m_key != pair.m_key ) return false; - if ( m_mod != pair.m_mod ) return false; - - return true; -} - -/** - * Not equal operator. calls the equal operator internally - */ -bool OKeyPair::operator!=( const OKeyPair& pair)const { - return !(*this == pair); -} - - -/** - * The normal Constructor to create a OKeyConfigItem - * - * You can set the the key paramater of this item but if - * you use this item with the OKeyConfigManager your setting - * will be overwritten. - * You can also specify a QObject and slot which sould get called - * once this item is activated. This slot only works if you - * use the OKeyConfigManager. - * The actual Key is read by load() - * - * \code - * void MySlot::create(){ - * OKeyConfigItem item(tr("Delete"),"delete",Resource::loadPixmap("trash"), - * 123, OKeyPair(Qt::Key_D,Qt::ControlButton), - * this,SLOT(slotDelete(QWidget*,QKeyEvent*))); - * } - * \endcode - * - * @param text The text exposed to the user - * @param config_key The key used in the config - * @param pix A Pixmap associated with this Item - * @param def The OKeyPair used as default - * @param caller The object where the slot exists - * @param slot The slot which should get called - * - */ -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 ); -} - -/** - * \brief c'tor - * The Constructor for a OKeyConfigManager - * - * You can use this manager in multiple ways. Either make it handle - * QKeyEvents - * - * \code - * Opie::Core::Config conf = oApp->config(); - * Opie::Ui::OKeyPairList blackList; - * blackList.append(Opie::Ui::OKeyPair::leftArrowKey()); - * blackList.append(Opie::Ui::OKeyPair::rightArrowKey()); - * Opie::Ui::OKeyConfigManager *manager = new Opie::Ui::OKeyConfigManager(conf,"key_actions",blackList, - * false); - * QListView *view = new QListView(); - * manager->handleWidget(view); - * manager->addKeyConfig( Opie::Ui::OKeyPair::returnKey()); - * manager->load(); - * - * connect(manager,SIGNAL(actionActivated(QWidget*,QKeyEvent*,const Opie::Ui::OKeyConfigItem&)), - * this,SLOT(slotHandleKey(QWidget*,QKeyEvent*,const Opie::Ui::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(); -} - - -/** - * 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::Ui::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::Ui::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 ) - 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]; -} - +using Opie::Core::OKeyConfigItem; +using Opie::Core::OKeyPair; +using Opie::Core::OKeyConfigManager; namespace Opie { namespace Ui { namespace Internal { OKeyListViewItem::OKeyListViewItem( const OKeyConfigItem& item, OKeyConfigManager* man, OListViewItem* parent) : Opie::Ui::OListViewItem( parent ), m_manager( man ) { m_origItem = item; setItem( item ); } OKeyListViewItem::~OKeyListViewItem() {} OKeyConfigItem &OKeyListViewItem::item(){ return m_item; } OKeyConfigItem OKeyListViewItem::origItem() const{ return m_origItem; } OKeyConfigManager* OKeyListViewItem::manager() { return m_manager; } void OKeyListViewItem::setItem( const OKeyConfigItem& item ) { m_item = item; setPixmap( 0, m_item.pixmap() ); setText ( 1, m_item.text() ); m_item.keyPair().isEmpty() ? setText( 2, QObject::tr( "None" ) ) : setText( 2, keyToString( m_item.keyPair() ) ); m_item.defaultKeyPair().isEmpty() ? setText( 3, QObject::tr( "None" ) ) : setText ( 3, keyToString( m_item.defaultKeyPair() ) ); } void OKeyListViewItem::updateText() { m_item.keyPair().isEmpty() ? setText( 2, QObject::tr( "None" ) ) : setText( 2, keyToString( m_item.keyPair() ) ); } QString keyToString( const OKeyPair& pair ) { int mod = 0; if ( pair.modifier() & Qt::ShiftButton ) mod |= Qt::SHIFT; if ( pair.modifier() & Qt::ControlButton ) mod |= Qt::CTRL; if ( pair.modifier() & Qt::AltButton ) mod |= Qt::ALT; return QAccel::keyToString( mod + pair.keycode() ); } - /* - * the virtual and hardware key events have both issues... - */ - void fixupKeys( int& key, int &mod, QKeyEvent* e ) { - key = e->key(); - mod = e->state(); - /* - * virtual keyboard - * else change the button mod only - */ - if ( key == 0 ) { - key = e->ascii(); - if ( key > 96 && key < 123) - key -= 32; - }else{ - int new_mod = 0; - if ( mod & 256 ) - new_mod |= Qt::ShiftButton; - else if ( mod & 512 ) - new_mod |= Qt::ControlButton; - else if ( mod & 1024 ) - new_mod |= Qt::AltButton; - - mod = new_mod == 0? mod : new_mod; - } - } - struct OKeyConfigWidgetPrivate{ OKeyConfigWidgetPrivate(const QString& = QString::null, OKeyConfigManager* = 0); bool operator==( const OKeyConfigWidgetPrivate& ); QString name; OKeyConfigManager *manager; }; OKeyConfigWidgetPrivate::OKeyConfigWidgetPrivate( const QString& _name, OKeyConfigManager* man ) : name( _name ), manager( man ){} bool OKeyConfigWidgetPrivate::operator==( const OKeyConfigWidgetPrivate& item) { if ( manager != item.manager) return false; if ( name != item.name ) return false; return true; } } -} -} + //////////////////////// //////////////////////// //////// Widget Starts Here /** * * This is a c'tor. You still need to pass the OKeyConfigManager * and then issue a load. * The default mode is Immediate * */ OKeyConfigWidget::OKeyConfigWidget( QWidget* parent, const char *name, WFlags fl ) : QWidget( parent, name, fl ) { initUi(); } @@ -1135,60 +409,60 @@ void OKeyConfigWidget::updateItem( Opie::Ui::Internal::OKeyListViewItem *item, OKeyChooserConfigDialog::OKeyChooserConfigDialog( QWidget* par, const char* nam, bool mod, WFlags fl ) : QDialog( par, nam, mod, fl ), m_virtKey( false ), m_keyPair( OKeyPair::emptyKey() ) , m_key( 0 ), m_mod( 0 ) { setFocusPolicy( StrongFocus ); QHBoxLayout *lay = new QHBoxLayout( this ); QLabel *lbl = new QLabel( tr("Configure Key" ), this ); lay->addWidget( lbl ); lbl->setFocusPolicy( NoFocus ); m_lbl = new QLabel( this ); lay->addWidget( m_lbl ); m_lbl->setFocusPolicy( NoFocus ); m_timer = new QTimer( this ); connect(m_timer, SIGNAL(timeout()), this, SLOT(slotTimeUp()) ); } OKeyChooserConfigDialog::~OKeyChooserConfigDialog() { } -Opie::Ui::OKeyPair OKeyChooserConfigDialog::keyPair()const{ +Opie::Core::OKeyPair OKeyChooserConfigDialog::keyPair()const{ return m_keyPair; } void OKeyChooserConfigDialog::keyPressEvent( QKeyEvent* ev ) { QDialog::keyPressEvent( ev ); if ( ev->isAutoRepeat() ) return; int mod, key; - Opie::Ui::Internal::fixupKeys( key,mod, ev ); + Opie::Core::Internal::fixupKeys( key,mod, ev ); /* either we used software keyboard * or we've true support */ if ( !m_virtKey && !ev->key()) { m_virtKey = true; m_keyPair = OKeyPair( key, mod ); }else{ mod = 0; switch( key ) { case Qt::Key_Control: mod = Qt::ControlButton; break; case Qt::Key_Shift: mod = Qt::ShiftButton; break; case Qt::Key_Alt: mod = Qt::AltButton; break; default: break; } if (mod ) { m_mod |= mod; @@ -1226,24 +500,28 @@ void OKeyChooserConfigDialog::keyReleaseEvent( QKeyEvent* ev ) { break; case Qt::Key_Shift: mod = Qt::ShiftButton; break; case Qt::Key_Alt: mod = Qt::AltButton; break; default: break; } if (mod ) m_mod &= ~mod; else m_key = key; m_keyPair = OKeyPair( m_key, m_mod ); m_lbl->setText( Opie::Ui::Internal::keyToString( m_keyPair ) ); } } void OKeyChooserConfigDialog::slotTimeUp() { m_mod = m_key = 0; QTimer::singleShot(0, this, SIGNAL(keyCaptured()) ); } + + +} +} diff --git a/libopie2/opieui/okeyconfigwidget.h b/libopie2/opieui/okeyconfigwidget.h index bb8eb6c..d11054c 100644 --- a/libopie2/opieui/okeyconfigwidget.h +++ b/libopie2/opieui/okeyconfigwidget.h @@ -1,322 +1,137 @@ /* * Copyright (C) 2004 * LGPL v2 zecke@handhelds.org */ #ifndef ODP_KEY_CONFIG_WIDGET_H #define ODP_KEY_CONFIG_WIDGET_H -#include <opie2/oconfig.h> -#include <opie2/odevice.h> +#include <opie2/okeyconfigmanager.h> -#include <qstring.h> -#include <qpixmap.h> -#include <qcstring.h> #include <qhbox.h> -#include <qvaluelist.h> + class QKeyEvent; class QLabel; class QPushButton; class QListViewItem; class QRadioButton; class QTimer; namespace Opie { namespace Ui { namespace Internal { class OKeyConfigWidgetPrivate; typedef QValueList<OKeyConfigWidgetPrivate> OKeyConfigWidgetPrivateList; class OKeyListViewItem; } class OListViewItem; class OListView; -/** - * \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! - * - * @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, - 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* ); - - OKeyConfigItem::List keyConfigList()const; -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::Ui::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; -}; - /** * With this Widget you can let the Keyboard Shortcuts * be configured by the user. * There are two ways you can use this widget. Either in a tab were * all changes are immediately getting into effect or in a queue * were you ask for saving. Save won't write the data but only set * it to the OKeyConfigManager * * @since 1.2 */ class OKeyConfigWidget : public QWidget { Q_OBJECT public: /** * Immediate Apply the change directly to the underlying OKeyConfigManager * Queue Save all items and then apply when you save() */ enum ChangeMode { Imediate, Queue }; OKeyConfigWidget( QWidget* parent = 0, const char* name = 0, WFlags fl = 0 ); ~OKeyConfigWidget(); void setChangeMode( enum ChangeMode ); ChangeMode changeMode()const; - void insert( const QString& name, OKeyConfigManager* ); + void insert( const QString& name, Opie::Core::OKeyConfigManager* ); void load(); void save(); private slots: void slotListViewItem( QListViewItem* ); void slotNoKey(); void slotDefaultKey(); void slotCustomKey(); void slotConfigure(); private: static bool sanityCheck( Opie::Ui::Internal::OKeyListViewItem* man, - const OKeyPair& newItem ); + const Opie::Core::OKeyPair& newItem ); void updateItem( Opie::Ui::Internal::OKeyListViewItem* man, - const OKeyPair& newItem); + const Opie::Core::OKeyPair& newItem); void initUi(); Opie::Ui::OListView *m_view; Opie::Ui::Internal::OKeyConfigWidgetPrivateList m_list; QLabel *m_lbl; QPushButton *m_btn; QRadioButton *m_def, *m_cus, *m_none; QWidget* m_box; ChangeMode m_mode; class Private; Private *d; }; /** * This is a small dialog that allows you to * capture a key sequence. * If you want it to close after a key was captured you * can use this code snippet. * * \code * OKeyChooserConfigDialog diag(0,0,true); * connect(&diag,SIGNAL(keyCaptured()), * this,SLOT(accept())); * if( QPEApplication::execDialog(&diag) == QDialog::Accept ){ * take_the_key_and_do_something * } * * \endcode * */ class OKeyChooserConfigDialog : public QDialog { Q_OBJECT public: OKeyChooserConfigDialog( QWidget* parent = 0, const char* name = 0, bool modal = false, WFlags fl = 0 ); ~OKeyChooserConfigDialog(); - OKeyPair keyPair()const; + Opie::Core::OKeyPair keyPair()const; protected: void keyPressEvent( QKeyEvent* ); void keyReleaseEvent( QKeyEvent* ); signals: void keyCaptured(); private slots: void slotTimeUp(); private: QTimer *m_timer; QLabel *m_lbl; bool m_virtKey : 1; - OKeyPair m_keyPair; + Opie::Core::OKeyPair m_keyPair; int m_key, m_mod; class Private; Private *d; }; } } #endif diff --git a/libopie2/opieui/okeyconfigwidget_p.h b/libopie2/opieui/okeyconfigwidget_p.h index 7690846..4dece4d 100644 --- a/libopie2/opieui/okeyconfigwidget_p.h +++ b/libopie2/opieui/okeyconfigwidget_p.h @@ -1,33 +1,35 @@ /* * Only Internal implemented in the same .cpp file anyway */ #include <opie2/olistview.h> +#include <opie2/okeyconfigmanager_p.h> namespace Opie { namespace Ui { namespace Internal { - static QString keyToString( const OKeyPair& ); - static void fixupKeys( int&, int&, QKeyEvent* ); + static QString keyToString( const Opie::Core::OKeyPair& ); class OKeyListViewItem : public Opie::Ui::OListViewItem { public: - OKeyListViewItem( const OKeyConfigItem& item, OKeyConfigManager*, Opie::Ui::OListViewItem* parent); + OKeyListViewItem( const Opie::Core::OKeyConfigItem& item, + Opie::Core::OKeyConfigManager*, + Opie::Ui::OListViewItem* parent); ~OKeyListViewItem(); void setDefault(); - OKeyConfigItem& item(); - OKeyConfigItem origItem()const; - void setItem( const OKeyConfigItem& item ); + Opie::Core::OKeyConfigItem& item(); + Opie::Core::OKeyConfigItem origItem()const; + void setItem( const Opie::Core::OKeyConfigItem& item ); void updateText(); - OKeyConfigManager *manager(); + Opie::Core::OKeyConfigManager *manager(); private: - OKeyConfigItem m_item; - OKeyConfigItem m_origItem; - OKeyConfigManager* m_manager; + Opie::Core::OKeyConfigItem m_item; + Opie::Core::OKeyConfigItem m_origItem; + Opie::Core::OKeyConfigManager* m_manager; }; } } } |