Source: kshortcutlist.h

# Source: kshortcutlist.h |
Annotated List
Files
Globals
Hierarchy
Index

    /*  This file is part of the KDE libraries
        Copyright (C) 2002 Ellis Whitehead

        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., 59 Temple Place - Suite 330,
        Boston, MA 02111-1307, USA.
    */

    #ifndef __KSHORTCUTLIST_H
    #define __KSHORTCUTLIST_H

    #include
    class QVariant;
    class KInstance;
    class KShortcut;
    class KKeySequence;
    class KConfigBase;

    /**********************************************************************
    * This is a wrapper class which allows a function to use one interface
    * to KActionCollection, KAccelActions, and KActionPtrList.
    **********************************************************************/

    /**
     * KShortcutList is an abstract base class for
     * @ref KAccelShortcutList and @ref KStdAccel::ShortcutList. It gives
     * you an unified interface for accessing the accelerator lists
     * of @ref KAccel (using @KAccelShortcutList),
     * @ref KGlobalAccel (using @KAccelShortcutList), and
     * @ref KStdAccel (using @ref KStdAccel::ShortcutList).
     *
     * @short Base class for accessing accelerator lists
     */
    class KShortcutList
    {
     public:
            /**
    	 * Default constructor.
    	 */
    	KShortcutList();
    	virtual ~KShortcutList();

    	/**
    	 * Returns the number of entries.
    	 * @return the number of entries
    	 */
    	virtual unsigned int count() const = 0;

    	/**
    	 * Returns the name of the shortcut with the given @p index.
    	 * @param index the index of the shortcut (must be < @ref count())
    	 * @return the name of the shortcut
    	 */
    	virtual QString name( unsigned int index ) const = 0;

    	/**
    	 * Returns the (i18n'd) label of the shortcut with the given @p index.
    	 * @param index the index of the shortcut (must be < @ref count())
    	 * @return the label (i18n'd) of the shortcut
    	 */
    	virtual QString label( unsigned int index ) const = 0;

    	/**
    	 * Returns the (i18n'd) What's This text of the shortcut with the given @p index.
    	 * @param index the index of the shortcut (must be < @ref count())
    	 * @return the What's This text (i18n'd) of the shortcut
    	 */
    	virtual QString whatsThis( unsigned int index ) const = 0;

    	/**
    	 * Returns the shortcut with the given @p index.
    	 * @param index the index of the shortcut (must be < @ref count())
    	 * @return the shortcut
    	 * @see shortcutDefault()
    	 */
    	virtual const KShortcut& shortcut( unsigned int index ) const = 0;

    	/**
    	 * Returns default shortcut with the given @p index.
    	 * @param index the index of the shortcut (must be < @ref count())
    	 * @return the default shortcut
    	 * @see shortcut()
    	 */
    	virtual const KShortcut& shortcutDefault( unsigned int index ) const = 0;

    	/**
    	 * Checks whether the shortcut with the given @p index is configurable.
    	 * @param index the index of the shortcut (must be < @ref count())
    	 * @return true if configurable, false otherwise
    	 */
    	virtual bool isConfigurable( unsigned int index ) const = 0;

    	/**
    	 * Sets the shortcut of the given entry
    	 * @param index the index of the shortcut (must be < @ref count())
    	 * @param shortcut the shortcut
    	 */
    	virtual bool setShortcut( unsigned int index, const KShortcut &shortcut ) = 0;

    	/**
    	 * Checks whether the shortcut with the given @p index is saved in the
    	 * global configuration.
    	 * @param index the index of the shortcut (must be < @ref count())
    	 * @return true if global, false otherwise
    	 */
    	virtual bool isGlobal( unsigned int index ) const;

    	/**
    	 * Returns the index of the shortcut with he given name.
    	 * @param sName the name of the shortcut to search
    	 * @return the index of the shortcut, of -1 if not found
    	 */
    	virtual int index( const QString& sName ) const;

    	/**
    	 * Returns the index of the shortcut with he given key sequence.
    	 * @param keySeq the key sequence to search for
    	 * @return the index of the shortcut, of -1 if not found
    	 */
    	virtual int index( const KKeySequence& keySeq ) const;

    	/**
    	 * The KInstance.
    	 * @return the KInstance of the list, can be 0 if not available
    	 */
    	virtual const KInstance* instance() const;

    	// These are here in order to handle expansion.
    	enum Other { };
    	/// @internal
    	virtual QVariant getOther( Other, unsigned int index ) const = 0;
    	/// @internal
    	virtual bool setOther( Other, unsigned int index, QVariant ) = 0;

    	/**
    	 * Save the shortcut list.
    	 * @return true if successful, false otherwise
    	 */
    	virtual bool save() const = 0;

    	/**
    	 * Loads the shortcuts from the given configuration file.
    	 *
    	 * @param sConfigGroup the group in the configuration file
    	 * @param pConfig the configuration file to load from
    	 * @return true if successful, false otherwise
    	 */
    	virtual bool readSettings( const QString& sConfigGroup = QString::null, KConfigBase* pConfig = 0 );

    	/**
    	 * Writes the shortcuts to the given configuration file.
    	 *
    	 * @param sConfigGroup the group in the configuration file
    	 * @param pConfig the configuration file to save to
    	 * @param bWriteAll true to write all actions
    	 * @param bGlobal true to write to the global configuration file
    	 * @return true if successful, false otherwise
    	 */
    	virtual bool writeSettings( const QString& sConfigGroup = QString::null, KConfigBase* pConfig = 0,
    			bool bWriteAll = false, bool bGlobal = false ) const;

     protected:
    	/// used to extend the interface with virtuals without breaking binary compatibility
            virtual void virtual_hook( int id, void* data );
     private:
    	class KShortcutListPrivate* d;
    };

    //---------------------------------------------------------------------
    // KAccelShortcutList
    //---------------------------------------------------------------------

    class KAccel;
    class KAccelActions;
    class KGlobalAccel;

    /**
     * @ref KShortcutList implementation to access @ref KAccel and
     * @ref KGlobalAccel lists.
     */
    class KAccelShortcutList : public KShortcutList
    {
     public:
            /**
    	 * Creates a new @ref KShortcutList that accesses the given KAccel.
    	 * @param accel the accelerators to access
    	 */
    	KAccelShortcutList( KAccel* accel );

            /**
    	 * Creates a new @ref KShortcutList that accesses the given
    	 * @ref KGlobalAccel.
    	 * @param accel the accelerators to access
    	 */
    	KAccelShortcutList( KGlobalAccel* accel );

            /**
    	 * @internal
    	 * Creates a new @ref KShortcutList that accesses the given
    	 * @ref KAccelActions collection.
    	 * @param accel the actions to access
    	 * @param bGlobal true to save the actions in the global
    	 *        configuration file
    	 */
    	KAccelShortcutList( KAccelActions &actions, bool bGlobal );
    	virtual ~KAccelShortcutList();

    	virtual unsigned int count() const;
    	virtual QString name( unsigned int index ) const;
    	virtual QString label( unsigned int index ) const;
    	virtual QString whatsThis( unsigned int index ) const;
    	virtual const KShortcut& shortcut( unsigned int index ) const;
    	virtual const KShortcut& shortcutDefault( unsigned int index ) const;
    	virtual bool isConfigurable( unsigned int index ) const;
    	virtual bool setShortcut( unsigned int index , const KShortcut& shortcut );
    	virtual bool isGlobal( unsigned int index ) const;

    	/// @internal
    	virtual QVariant getOther( Other, unsigned int index ) const;
    	/// @internal
    	virtual bool setOther( Other, unsigned int index, QVariant );

    	virtual bool save() const;

     protected:
    	KAccelActions& m_actions;
    	bool m_bGlobal;

     protected:
    	virtual void virtual_hook( int id, void* data );
     private:
    	class KAccelShortcutListPrivate* d;
    };

    namespace KStdAccel {
    //---------------------------------------------------------------------
    // ShortcutList
    //---------------------------------------------------------------------

    /**
     * @ref KShortcutList implementation that accesses @ref KStdAccel
     * actions.
     */
    class ShortcutList : public KShortcutList
    {
     public:
            /**
    	 * Creates a new ShortcutList.
    	 */
    	ShortcutList();
    	virtual ~ShortcutList();

    	virtual unsigned int count() const;
    	virtual QString name( unsigned int index ) const;
    	virtual QString label( unsigned int index ) const;
    	virtual QString whatsThis( unsigned int index ) const;
    	virtual const KShortcut& shortcut( unsigned int index ) const;
    	virtual const KShortcut& shortcutDefault( unsigned int index ) const;
    	virtual bool isConfigurable( unsigned int index ) const;
    	virtual bool setShortcut( unsigned int index , const KShortcut& shortcut );

    	/// @internal
    	virtual QVariant getOther( Other, unsigned int index ) const;
    	/// @internal
    	virtual bool setOther( Other, unsigned int index, QVariant );

    	virtual bool save() const;

     protected:
    	virtual void virtual_hook( int id, void* data );
     private:
    	class ShortcutListPrivate* d;
    };
    }

    #endif // __KSHORTCUTLIST_H

Generated by: root on macppc.ports.openbsd.org on Sat Sep 6 10:36:15 2003, using kdoc 2.0a54.