tdeaccel.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 _TDEACCEL_H
#define _TDEACCEL_H
 
#include <tqaccel.h>
#include <tdeshortcut.h>
#include <tdestdaccel.h>
#include "tdelibs_export.h"
 
class TQPopupMenu; // for obsolete insertItem() methods below
class TQWidget;
class TDEAccelAction;
class TDEAccelActions;
class TDEConfigBase;
 
class TDEAccelPrivate;
 
class TDECORE_EXPORT TDEAccel : public TQAccel
{
    TQ_OBJECT
 public:
    TDEAccel( TQWidget* pParent, const char* psName = 0 );

    TDEAccel( TQWidget* watch, TQObject* parent, const char* psName = 0 );
    virtual ~TDEAccel();

    TDEAccelActions& actions();

    const TDEAccelActions& actions() const;

    bool isEnabled();

    void setEnabled( bool bEnabled );

    bool setAutoUpdate( bool bAuto );

    TDEAccelAction* insert( const TQString& sAction, const TQString& sLabel, const TQString& sWhatsThis,
                     const TDEShortcut& cutDef,
                     const TQObject* pObjSlot, const char* psMethodSlot,
                     bool bConfigurable = true, bool bEnabled = true );
    TDEAccelAction* insert( const TQString& sAction, const TQString& sLabel, const TQString& sWhatsThis,
                     const TDEShortcut& cutDef3, const TDEShortcut& cutDef4,
                     const TQObject* pObjSlot, const char* psMethodSlot,
                     bool bConfigurable = true, bool bEnabled = true );
    TDEAccelAction* insert( const char* psAction, const TDEShortcut& cutDef,
                     const TQObject* pObjSlot, const char* psMethodSlot,
                     bool bConfigurable = true, bool bEnabled = true );
    TDEAccelAction* insert( TDEStdAccel::StdAccel id,
                     const TQObject* pObjSlot, const char* psMethodSlot,
                     bool bConfigurable = true, bool bEnabled = true );

    bool remove( const TQString& sAction );

    bool updateConnections();

    const TDEShortcut& shortcut( const TQString& sAction ) const;

    bool setShortcut( const TQString& sAction, const TDEShortcut &shortcut );

    bool setSlot( const TQString& sAction, const TQObject* pObjSlot, const char* psMethodSlot );
    bool setEnabled( const TQString& sAction, bool bEnabled );

    const TQString& configGroup() const;

    void setConfigGroup( const TQString &name );

    bool readSettings( TDEConfigBase* pConfig = 0 );
    bool writeSettings( TDEConfigBase* pConfig = 0 ) const;

    void emitKeycodeChanged();
 
 signals:
    void keycodeChanged();
 
#ifndef KDE_NO_COMPAT
 public:
    // Source compatibility to KDE 2.x
    bool insertItem( const TQString& sLabel, const TQString& sAction,
                     const char* psKey,
                     int nIDMenu = 0, TQPopupMenu* pMenu = 0, bool bConfigurable = true ) TDE_DEPRECATED;
    bool insertItem( const TQString& sLabel, const TQString& sAction,
                     int key,
                     int nIDMenu = 0, TQPopupMenu* pMenu = 0, bool bConfigurable = true ) TDE_DEPRECATED;
    bool insertStdItem( TDEStdAccel::StdAccel id, const TQString& descr = TQString::null ) TDE_DEPRECATED;
    bool connectItem( const TQString& sAction, const TQObject* pObjSlot, const char* psMethodSlot, bool bActivate = true ) TDE_DEPRECATED;
    TDE_DEPRECATED bool connectItem( TDEStdAccel::StdAccel accel, const TQObject* pObjSlot, const char* psMethodSlot )
        { return insert( accel, pObjSlot, psMethodSlot ); }

    bool removeItem( const TQString& sAction ) TDE_DEPRECATED;
    bool setItemEnabled( const TQString& sAction, bool bEnable ) TDE_DEPRECATED;
    void changeMenuAccel( TQPopupMenu *menu, int id, const TQString& action ) TDE_DEPRECATED;
    void changeMenuAccel( TQPopupMenu *menu, int id, TDEStdAccel::StdAccel accel ) TDE_DEPRECATED;
    static int stringToKey( const TQString& ) TDE_DEPRECATED;

    int currentKey( const TQString& action ) const TDE_DEPRECATED;

    TQString findKey( int key ) const TDE_DEPRECATED;
#endif // !KDE_NO_COMPAT
 
 protected:
    virtual void virtual_hook( int id, void* data );
 private:
    class TDEAccelPrivate* d;
    friend class TDEAccelPrivate;
};
 
#endif // _TDEACCEL_H