tdeaccelaction.h

/* This file is part of the KDE libraries
    Copyright (C) 2001,2002 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 _TDEACCELACTION_H
#define _TDEACCELACTION_H
 
#include <tqmap.h>
#include <tqptrvector.h>
#include <tqstring.h>
#include <tqvaluevector.h>
 
#include <tdeshortcut.h>
 
class TDEAccelBase;
 
class TQObject;
class TDEConfig;
class TDEConfigBase;
 
class TDECORE_EXPORT TDEAccelAction
{
 public:
    TDEAccelAction();
 
    TDEAccelAction( const TDEAccelAction& );
 
    TDEAccelAction( const TQString& sName, const TQString& sLabel, const TQString& sWhatsThis,
            const TDEShortcut& cutDef3, const TDEShortcut& cutDef4,
            const TQObject* pObjSlot, const char* psMethodSlot,
            bool bConfigurable, bool bEnabled );
    ~TDEAccelAction();
 
    void clear();
 
    bool init( const TQString& sName, const TQString& sLabel, const TQString& sWhatsThis,
            const TDEShortcut& cutDef3, const TDEShortcut& cutDef4,
            const TQObject* pObjSlot, const char* psMethodSlot,
            bool bConfigurable, bool bEnabled );
 
    TDEAccelAction& operator=( const TDEAccelAction& );
 
    const TQString& name() const                { return m_sName; }
 
    const TQString& label() const               { return m_sLabel; }
 
    const TQString& whatsThis() const           { return m_sWhatsThis; }
    
    const TDEShortcut& shortcut() const          { return m_cut; }
 
    const TDEShortcut& shortcutDefault() const;
 
    const TDEShortcut& shortcutDefault3() const  { return m_cutDefault3; }
 
    const TDEShortcut& shortcutDefault4() const  { return m_cutDefault4; }
 
    const TQObject* objSlotPtr() const          { return m_pObjSlot; }
 
    const char* methodSlotPtr() const          { return m_psMethodSlot; }
 
    bool isConfigurable() const                { return m_bConfigurable; }
 
    bool isEnabled() const                     { return m_bEnabled; }
 
    void setName( const TQString& name );
 
    void setLabel( const TQString& label );
 
    void setWhatsThis( const TQString& whatsThis );
 
    bool setShortcut( const TDEShortcut& rgCuts );
 
    void setSlot( const TQObject* pObjSlot, const char* psMethodSlot );
 
    void setConfigurable( bool configurable );
 
    void setEnabled( bool enable );
 
    int getID() const   { return m_nIDAccel; }
 
    void setID( int n ) { m_nIDAccel = n; }
 
    bool isConnected() const;
 
    bool setKeySequence( uint i, const KKeySequence &keySeq );
    
    void clearShortcut();
    
    bool contains( const KKeySequence &keySeq );
 
    TQString toString() const;
 
    TQString toStringInternal() const;
 
    static bool useFourModifierKeys();
 
    static void useFourModifierKeys( bool use );
 
 protected:
    TQString m_sName ,
            m_sLabel ,
            m_sWhatsThis ;
    TDEShortcut m_cut ;
    TDEShortcut m_cutDefault3 , 
          m_cutDefault4 ;
    const TQObject* m_pObjSlot ;
    const char* m_psMethodSlot ;
    bool m_bConfigurable ,
         m_bEnabled ;
    int m_nIDAccel ;
    uint m_nConnections  ;
 
    void incConnections();
    void decConnections();
 
 private:
    static int g_bUseFourModifierKeys;
    class TDEAccelActionPrivate* d;
 
    friend class TDEAccelActions;
    friend class TDEAccelBase;
};
 
//---------------------------------------------------------------------
// TDEAccelActions
//---------------------------------------------------------------------
 
class TDECORE_EXPORT TDEAccelActions
{
 public:
    TDEAccelActions();
 
    TDEAccelActions( const TDEAccelActions& );
    virtual ~TDEAccelActions();
 
    void clear();
 
    bool init( const TDEAccelActions &actions );
 
    bool init( TDEConfigBase& config, const TQString& sGroup );
 
    void updateShortcuts( TDEAccelActions &shortcuts );
 
    int actionIndex( const TQString& sAction ) const;
 
    TDEAccelAction* actionPtr( uint index );
 
    const TDEAccelAction* actionPtr( uint index ) const;
 
    TDEAccelAction* actionPtr( const TQString& sAction );
 
    const TDEAccelAction* actionPtr( const TQString& sAction ) const;
 
    TDEAccelAction* actionPtr( KKeySequence cut );
 
    TDEAccelAction& operator []( uint index );
 
    const TDEAccelAction& operator []( uint index ) const;
 
    TDEAccelAction* insert( const TQString& sAction, const TQString& sLabel, const TQString& sWhatsThis,
            const TDEShortcut& rgCutDefaults3, const TDEShortcut& rgCutDefaults4,
            const TQObject* pObjSlot = 0, const char* psMethodSlot = 0,
            bool bConfigurable = true, bool bEnabled = true );
 
    TDEAccelAction* insert( const TQString& sName, const TQString& sLabel );
 
    bool remove( const TQString& sAction );
 
    bool readActions( const TQString& sConfigGroup = "Shortcuts", TDEConfigBase* pConfig = 0 );
 
    bool writeActions( const TQString& sConfigGroup = "Shortcuts", TDEConfigBase* pConfig = 0,
            bool bWriteAll = false, bool bGlobal = false ) const;
 
    void emitKeycodeChanged();
 
    uint count() const;
 
 protected:
    TDEAccelBase* m_pTDEAccelBase;
    TDEAccelAction** m_prgActions;
    uint m_nSizeAllocated , 
         m_nSize  ;
 
    void resize( uint new_size );
    void insertPtr( TDEAccelAction* );
 
 private:
    class TDEAccelActionsPrivate* d;
 
    TDEAccelActions( TDEAccelBase* );
    void initPrivate( TDEAccelBase* );
    TDEAccelActions& operator =( TDEAccelActions& );
 
    friend class TDEAccelBase;
};
 
#endif // _TDEACCELACTION_H