tdeshortcutlist.h

/*  This file is part of the KDE libraries
    Copyright (C) 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 __TDESHORTCUTLIST_H
#define __TDESHORTCUTLIST_H
 
#include <tqglobal.h>   // For uint
#include <tqstring.h>
#include "tdelibs_export.h"
 
class TQVariant;
class TDEConfigBase;
class TDEInstance;
class KKeySequence;
class TDEShortcut;
 
/**********************************************************************
* This is a wrapper class which allows a function to use one interface
* to TDEActionCollection, TDEAccelActions, and TDEActionPtrList.
**********************************************************************/

class TDECORE_EXPORT TDEShortcutList
{
 public:
    TDEShortcutList();
    virtual ~TDEShortcutList();

    virtual uint count() const = 0;

    virtual TQString name( uint index ) const = 0;

    virtual TQString label( uint index ) const = 0;

    virtual TQString whatsThis( uint index ) const = 0;
 
    // TODO KDE4: add virtual TQString toolTip( uint index ) const = 0
    // Will then be used by the listview in kkeydialog

    virtual const TDEShortcut& shortcut( uint index ) const = 0;

    virtual const TDEShortcut& shortcutDefault( uint index ) const = 0;

    virtual bool isConfigurable( uint index ) const = 0;

    virtual bool setShortcut( uint index, const TDEShortcut &shortcut ) = 0;

    virtual bool isGlobal( uint index ) const;

    virtual int index( const TQString& sName ) const;

    virtual int index( const KKeySequence& keySeq ) const;

    virtual const TDEInstance* instance() const;
 
    // These are here in order to handle expansion.
    enum Other { };
    virtual TQVariant getOther( Other, uint index ) const = 0;
    virtual bool setOther( Other, uint index, TQVariant ) = 0;

    virtual bool save() const = 0;

    virtual bool readSettings( const TQString& sConfigGroup = TQString::null, TDEConfigBase* pConfig = 0 );

    virtual bool writeSettings( const TQString& sConfigGroup = TQString::null, TDEConfigBase* pConfig = 0,
            bool bWriteAll = false, bool bGlobal = false ) const;
 
 protected:
        virtual void virtual_hook( int id, void* data );
 private:
    class TDEShortcutListPrivate* d;
};
 
//---------------------------------------------------------------------
// TDEAccelShortcutList
//---------------------------------------------------------------------
 
class TDEAccel;
class TDEAccelActions;
class TDEGlobalAccel;

class TDECORE_EXPORT TDEAccelShortcutList : public TDEShortcutList
{
 public:
    TDEAccelShortcutList( TDEAccel* accel );

    TDEAccelShortcutList( TDEGlobalAccel* accel );

    TDEAccelShortcutList( TDEAccelActions &actions, bool bGlobal );
    virtual ~TDEAccelShortcutList();
 
    virtual uint count() const;
    virtual TQString name( uint index ) const;
    virtual TQString label( uint index ) const;
    virtual TQString whatsThis( uint index ) const;
    virtual const TDEShortcut& shortcut( uint index ) const;
    virtual const TDEShortcut& shortcutDefault( uint index ) const;
    virtual bool isConfigurable( uint index ) const;
    virtual bool setShortcut( uint index , const TDEShortcut& shortcut );
    virtual bool isGlobal( uint index ) const;

    virtual TQVariant getOther( Other, uint index ) const;
    virtual bool setOther( Other, uint index, TQVariant );
 
    virtual bool save() const;
 
 protected:
    TDEAccelActions& m_actions;
    bool m_bGlobal;
 
 protected:
    virtual void virtual_hook( int id, void* data );
 private:
    class TDEAccelShortcutListPrivate* d;
};
 
namespace TDEStdAccel {
//---------------------------------------------------------------------
// ShortcutList
//---------------------------------------------------------------------

class TDECORE_EXPORT ShortcutList : public TDEShortcutList
{
 public:
    ShortcutList();
    virtual ~ShortcutList();
 
    virtual uint count() const;
    virtual TQString name( uint index ) const;
    virtual TQString label( uint index ) const;
    virtual TQString whatsThis( uint index ) const;
    virtual const TDEShortcut& shortcut( uint index ) const;
    virtual const TDEShortcut& shortcutDefault( uint index ) const;
    virtual bool isConfigurable( uint index ) const;
    virtual bool setShortcut( uint index , const TDEShortcut& shortcut );

    virtual TQVariant getOther( Other, uint index ) const;
    virtual bool setOther( Other, uint index, TQVariant );
 
    virtual bool save() const;
 
 protected:
    virtual void virtual_hook( int id, void* data );
 private:
    class ShortcutListPrivate* d;
};
}
 
#endif // __TDESHORTCUTLIST_H