# kdecore Library API Documentation

Overview | Class Hierarchy | Classes | Classes (annotated) | Members | Source Files

# 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_x11.h"
    00031
    00032 class QPopupMenu;
    00033 class QWidget;
    00034
    00035 //----------------------------------------------------
    00036
    00122 class KAccelBase
    00123 {
    00124  public:
    00125         enum Init { QT_KEYS = 0x00, NATIVE_KEYS = 0x01 };
    00126         enum Signal { KEYCODE_CHANGED };
    00127
    00128         KAccelBase( int fInitCode );
    00129         virtual ~KAccelBase();
    00130
    00131         uint actionCount() const;
    00132         KAccelActions& actions();
    00133         bool isEnabled() const;
    00134
    00135         KAccelAction* actionPtr( const QString& sAction );
    00136         const KAccelAction* actionPtr( const QString& sAction ) const;
    00137         KAccelAction* actionPtr( const KKey& key );
    00138         KAccelAction* actionPtr( const KKeyServer::Key& key );
    00139
    00140         const QString& configGroup() const { return m_sConfigGroup; }
    00141         void setConfigGroup( const QString& group );
    00142         void setConfigGlobal( bool global );
    00143         virtual void setEnabled( bool bEnabled ) = 0;
    00144         bool getAutoUpdate() { return m_bAutoUpdate; }
    00145         // return value of AutoUpdate flag before this call.
    00146         bool setAutoUpdate( bool bAuto );
    00147
    00148 // Procedures for manipulating Actions.
    00149         //void clearActions();
    00150
    00151         KAccelAction* insert( const QString& sName, const QString& sDesc );
    00152         KAccelAction* insert(
    00153                          const QString& sAction, const QString& sDesc, const QString& sHelp,
    00154                          const KShortcut& rgCutDefaults3, const KShortcut& rgCutDefaults4,
    00155                          const QObject* pObjSlot, const char* psMethodSlot,
    00156                          bool bConfigurable = true, bool bEnabled = true );
    00157         bool remove( const QString& sAction );
    00158         bool setActionSlot( const QString& sAction, const QObject* pObjSlot, const char* psMethodSlot );
    00159
    00160         bool updateConnections();
    00161
    00162         bool setShortcut( const QString& sAction, const KShortcut& cut );
    00163
    00164 // Modify individual Action sub-items
    00165         bool setActionEnabled( const QString& sAction, bool bEnable );
    00166
    00175         void readSettings( KConfigBase* pConfig = 0 );
    00176
    00182         void writeSettings( KConfigBase* pConfig = 0 ) const;
    00183
    00184         QPopupMenu* createPopupMenu( QWidget* pParent, const KKeySequence& );
    00185
    00186  // Protected methods
    00187  protected:
    00188         void slotRemoveAction( KAccelAction* );
    00189
    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

This file is part of the documentation for kdelibs Version 3.1.5.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Jan 28 12:46:18 2004 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2001