kdecore Library API Documentation

kaccelbase.h

00001 /* This file is part of the KDE libraries 00002 Copyright (C) 2001 Ellis Whitehead <ellis@kde.org> 00003 00004 This library is free software; you can redistribute it and/or 00005 modify it under the terms of the GNU Library General Public 00006 License as published by the Free Software Foundation; either 00007 version 2 of the License, or (at your option) any later version. 00008 00009 This library is distributed in the hope that it will be useful, 00010 but WITHOUT ANY WARRANTY; without even the implied warranty of 00011 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00012 Library General Public License for more details. 00013 00014 You should have received a copy of the GNU Library General Public License 00015 along with this library; see the file COPYING.LIB. If not, write to 00016 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, 00017 Boston, MA 02111-1307, USA. 00018 */ 00019 00020 #ifndef _KACCELBASE_H 00021 #define _KACCELBASE_H 00022 00023 #include <qmap.h> 00024 #include <qptrvector.h> 00025 #include <qstring.h> 00026 #include <qvaluevector.h> 00027 #include <qvaluelist.h> 00028 00029 #include "kaccelaction.h" 00030 #include "kkeyserver.h" 00031 00032 class QPopupMenu; 00033 class QWidget; 00034 00035 //---------------------------------------------------- 00036 00121 class KDECORE_EXPORT KAccelBase 00122 { 00123 public: 00124 enum Init { QT_KEYS = 0x00, NATIVE_KEYS = 0x01 }; 00125 enum Signal { KEYCODE_CHANGED }; 00126 00127 KAccelBase( int fInitCode ); 00128 virtual ~KAccelBase(); 00129 00130 uint actionCount() const; 00131 KAccelActions& actions(); 00132 bool isEnabled() const; 00133 00134 KAccelAction* actionPtr( const QString& sAction ); 00135 const KAccelAction* actionPtr( const QString& sAction ) const; 00136 KAccelAction* actionPtr( const KKey& key ); 00137 KAccelAction* actionPtr( const KKeyServer::Key& key ); 00138 00139 const QString& configGroup() const { return m_sConfigGroup; } 00140 void setConfigGroup( const QString& group ); 00141 void setConfigGlobal( bool global ); 00142 virtual void setEnabled( bool bEnabled ) = 0; 00143 bool getAutoUpdate() { return m_bAutoUpdate; } 00144 // return value of AutoUpdate flag before this call. 00145 bool setAutoUpdate( bool bAuto ); 00146 00147 // Procedures for manipulating Actions. 00148 //void clearActions(); 00149 00150 KAccelAction* insert( const QString& sName, const QString& sDesc ); 00151 KAccelAction* insert( 00152 const QString& sAction, const QString& sDesc, const QString& sHelp, 00153 const KShortcut& rgCutDefaults3, const KShortcut& rgCutDefaults4, 00154 const QObject* pObjSlot, const char* psMethodSlot, 00155 bool bConfigurable = true, bool bEnabled = true ); 00156 bool remove( const QString& sAction ); 00157 bool setActionSlot( const QString& sAction, const QObject* pObjSlot, const char* psMethodSlot ); 00158 00159 bool updateConnections(); 00160 00161 bool setShortcut( const QString& sAction, const KShortcut& cut ); 00162 00163 // Modify individual Action sub-items 00164 bool setActionEnabled( const QString& sAction, bool bEnable ); 00165 00174 void readSettings( KConfigBase* pConfig = 0 ); 00175 00181 void writeSettings( KConfigBase* pConfig = 0 ) const; 00182 00183 QPopupMenu* createPopupMenu( QWidget* pParent, const KKeySequence& ); 00184 00185 // Protected methods 00186 protected: 00187 void slotRemoveAction( KAccelAction* ); 00188 00189 struct X; 00190 void createKeyList( QValueVector<struct X>& rgKeys ); 00191 bool insertConnection( KAccelAction* ); 00192 bool removeConnection( KAccelAction* ); 00193 00194 virtual bool emitSignal( Signal ) = 0; 00195 virtual bool connectKey( KAccelAction&, const KKeyServer::Key& ) = 0; 00196 virtual bool connectKey( const KKeyServer::Key& ) = 0; 00197 virtual bool disconnectKey( KAccelAction&, const KKeyServer::Key& ) = 0; 00198 virtual bool disconnectKey( const KKeyServer::Key& ) = 0; 00199 00200 protected: 00201 struct ActionInfo 00202 { 00203 KAccelAction* pAction; 00204 uint iSeq, iVariation; 00205 //ActionInfo* pInfoNext; // nil if only one action uses this key. 00206 00207 ActionInfo() { pAction = 0; iSeq = 0xffff; iVariation = 0xffff; } 00208 ActionInfo( KAccelAction* _pAction, uint _iSeq, uint _iVariation ) 00209 { pAction = _pAction; iSeq = _iSeq; iVariation = _iVariation; } 00210 }; 00211 typedef QMap<KKeyServer::Key, ActionInfo> KKeyToActionMap; 00212 00213 KAccelActions m_rgActions; 00214 KKeyToActionMap m_mapKeyToAction; 00215 QValueList<KAccelAction*> m_rgActionsNonUnique; 00216 bool m_bNativeKeys; // Use native key codes instead of Qt codes 00217 bool m_bEnabled; 00218 bool m_bConfigIsGlobal; 00219 QString m_sConfigGroup; 00220 bool m_bAutoUpdate; 00221 KAccelAction* mtemp_pActionRemoving; 00222 00223 private: 00224 KAccelBase& operator =( const KAccelBase& ); 00225 00226 friend class KAccelActions; 00227 }; 00228 00229 #endif // _KACCELBASE_H
KDE Logo
This file is part of the documentation for kdecore Library Version 3.4.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Apr 14 00:03:25 2005 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003