kglobalaccel.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 _KGLOBALACCEL_H_
#define _KGLOBALACCEL_H_
 
#include <tqobject.h>
#include <tdeshortcut.h>
 
class TQPopupMenu;
class TQWidget;
class TDEAccelAction;
class TDEAccelActions;
class TDEConfigBase;
 
class TDEGlobalAccelPrivate;

class TDECORE_EXPORT TDEGlobalAccel : public TQObject
{
    TQ_OBJECT
 public:
    TDEGlobalAccel( TQObject* pParent, const char* psName = 0 );
    virtual ~TDEGlobalAccel();

    bool isEnabled();
    
    void setEnabled( bool bEnabled );

    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 );

    bool remove( const TQString& sAction );

    TDEAccelAction* insert( const TQString& sName, const TQString& sLabel );

    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 setActionEnabled( const TQString& sAction, bool bEnable );
    TQString label( const TQString& sAction ) const;

    const TQString& configGroup() const;

    void setConfigGroup( const TQString &cg );

    bool readSettings( TDEConfigBase* pConfig = 0 );

    bool writeSettings( TDEConfigBase* pConfig = 0 ) const;
    // BCI: merge these two writeSettings methods in KDE 4.0
    bool writeSettings( TDEConfigBase* pConfig, bool bGlobal ) const;

    static bool useFourModifierKeys();
        
        static void blockShortcuts( bool block );
        void disableBlocking( bool disable );
        
        // like setEnabled(), but doesn't ungrab (see in TDEGlobalAccelPrivate)
        void suspend( bool s );
 
private:
 
    TDEAccelActions& actions();
    const TDEAccelActions& actions() const;
 
    friend class TDEGlobalAccelPrivate;
    friend class TDEAccelShortcutList;
protected:
    virtual void virtual_hook( int id, void* data );
private:
    class TDEGlobalAccelPrivate* d;
};
 
#endif // _KGLOBALACCEL_H_