tdeaccelbase.h

/* This file is part of the KDE libraries
    Copyright (C) 2001 Ellis Whitehead <ellis@kde.org>
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
 
#ifndef _TDEACCELBASE_H
#define _TDEACCELBASE_H
 
#include <tqmap.h>
#include <tqptrvector.h>
#include <tqstring.h>
#include <tqvaluevector.h>
#include <tqvaluelist.h>
 
#include "tdeaccelaction.h"
#include "kkeyserver.h"
 
class TQPopupMenu;
class TQWidget;
 
//----------------------------------------------------
 
class TDECORE_EXPORT TDEAccelBase
{
 public:
    enum Init { QT_KEYS = 0x00, NATIVE_KEYS = 0x01 };
 
    enum Signal { KEYCODE_CHANGED };
 
    TDEAccelBase( int fInitCode );
    virtual ~TDEAccelBase();
 
    uint actionCount() const;
    TDEAccelActions& actions();
    bool isEnabled() const;
 
    TDEAccelAction* actionPtr( const TQString& sAction );
    const TDEAccelAction* actionPtr( const TQString& sAction ) const;
    TDEAccelAction* actionPtr( const KKey& key );
    TDEAccelAction* actionPtr( const KKeyServer::Key& key );
 
    const TQString& configGroup() const { return m_sConfigGroup; }
    void setConfigGroup( const TQString& group );
    void setConfigGlobal( bool global );
    virtual void setEnabled( bool bEnabled ) = 0;
    bool getAutoUpdate() { return m_bAutoUpdate; }
    bool setAutoUpdate( bool bAuto );
 
// Procedures for manipulating Actions.
    //void clearActions();
 
    TDEAccelAction* insert( const TQString& sName, const TQString& sDesc );
    TDEAccelAction* insert(
                     const TQString& sAction, const TQString& sDesc, const TQString& sHelp,
                     const TDEShortcut& rgCutDefaults3, const TDEShortcut& rgCutDefaults4,
                     const TQObject* pObjSlot, const char* psMethodSlot,
             bool bConfigurable = true, bool bEnabled = true );
    bool remove( const TQString& sAction );
    bool setActionSlot( const TQString& sAction, const TQObject* pObjSlot, const char* psMethodSlot );
 
    bool updateConnections();
 
    bool setShortcut( const TQString& sAction, const TDEShortcut& cut );
 
// Modify individual Action sub-items
    bool setActionEnabled( const TQString& sAction, bool bEnable );
 
    void readSettings( TDEConfigBase* pConfig = 0 );
 
    void writeSettings( TDEConfigBase* pConfig = 0 ) const;
 
    TQPopupMenu* createPopupMenu( TQWidget* pParent, const KKeySequence& );
 
 // Protected methods
 protected:
    void slotRemoveAction( TDEAccelAction* );
 
    struct X;
 
    void createKeyList( TQValueVector<struct X>& rgKeys );
    bool insertConnection( TDEAccelAction* );
    bool removeConnection( TDEAccelAction* );
 
    virtual bool emitSignal( Signal signal ) = 0;
    virtual bool connectKey( TDEAccelAction& action, const KKeyServer::Key& key ) = 0;
    virtual bool connectKey( const KKeyServer::Key& key) = 0;
    virtual bool disconnectKey( TDEAccelAction&, const KKeyServer::Key& ) = 0;
    virtual bool disconnectKey( const KKeyServer::Key& ) = 0;
 
 protected:
        virtual bool isEnabledInternal() const;
    struct ActionInfo
    {
        TDEAccelAction* pAction;
        uint iSeq, iVariation;
        //ActionInfo* pInfoNext; // nil if only one action uses this key.
 
        ActionInfo() { pAction = 0; iSeq = 0xffff; iVariation = 0xffff; }
        ActionInfo( TDEAccelAction* _pAction, uint _iSeq, uint _iVariation )
            { pAction = _pAction; iSeq = _iSeq; iVariation = _iVariation; }
    };
    typedef TQMap<KKeyServer::Key, ActionInfo> KKeyToActionMap;
 
    TDEAccelActions m_rgActions;
    KKeyToActionMap m_mapKeyToAction;
    TQValueList<TDEAccelAction*> m_rgActionsNonUnique;
    bool m_bNativeKeys; // Use native key codes instead of Qt codes
    bool m_bEnabled;
    bool m_bConfigIsGlobal;
    TQString m_sConfigGroup;
    bool m_bAutoUpdate;
    TDEAccelAction* mtemp_pActionRemoving;
 
 private:
    TDEAccelBase& operator =( const TDEAccelBase& );
 
    friend class TDEAccelActions;
};
 
#endif // _TDEACCELBASE_H