kkeydialog.h

/* This file is part of the KDE libraries
    Copyright (C) 1997 Nicolas Hadacek <hadacek@kde.org>
    Copyright (C) 2001,2001 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 __KKEYDIALOG_H__
#define __KKEYDIALOG_H__
 
#include <tqdict.h>
#include <kdialogbase.h>
#include <tdelistview.h>
 
class TQButtonGroup;
class TQCheckBox;
class TQGroupBox;
class TQLabel;
class TQLineEdit;
class TQRadioButton;
class TDEAccel;
class TDEAccelActions;
class TDEActionCollection;
class TDEConfigBase;
class TDEGlobalAccel;
class KKeySequence;
class TDEShortcut;
class TDEShortcutList;
class KKeyChooserItem;

class TDEUI_EXPORT KKeyChooser : public TQWidget
{
    TQ_OBJECT
 public:
    enum ActionType { Application, ApplicationGlobal, Standard, Global };

    KKeyChooser( TQWidget* parent, ActionType type = Application, bool bAllowLetterShortcuts = true );
    KKeyChooser( TDEActionCollection* coll, TQWidget* parent, bool bAllowLetterShortcuts = true );
 
    KKeyChooser( TDEAccel* actions, TQWidget* parent, bool bAllowLetterShortcuts = true );
    KKeyChooser( TDEGlobalAccel* actions, TQWidget* parent );
    KKeyChooser( TDEShortcutList*, TQWidget* parent, ActionType type = Application, bool bAllowLetterShortcuts = true );
 
    virtual ~KKeyChooser();

    bool insert( TDEActionCollection* ); // #### KDE4 : remove me
    bool insert( TDEActionCollection *, const TQString &title);
 
    void syncToConfig( const TQString& sConfigGroup, TDEConfigBase* pConfig, bool bClearUnset );

    void commitChanges();

    void save();

        static bool checkGlobalShortcutsConflict( const TDEShortcut& cut, bool warnUser, TQWidget* parent );

        static bool checkStandardShortcutsConflict( const TDEShortcut& cut, bool warnUser, TQWidget* parent );
 
 signals:
    void keyChange();
 
 public slots:
    void allDefault();

    void setPreferFourModifierKeys( bool preferFourModifierKeys );
 
 // KDE4 a lot of stuff in this class should be probably private:
 protected:
    enum { NoKey = 1, DefaultKey, CustomKey };
 
    void initGUI( ActionType type, bool bAllowLetterShortcuts );
    bool insert( TDEAccel* );
    bool insert( TDEGlobalAccel* );
    bool insert( TDEShortcutList* );
    void buildListView( uint iList, const TQString &title = TQString::null );
 
    void readGlobalKeys();
 
    void updateButtons();
    void fontChange( const TQFont& _font );
    void setShortcut( const TDEShortcut& cut );
    bool isKeyPresent( const TDEShortcut& cut, bool warnuser = true );
        bool isKeyPresentLocally( const TDEShortcut& cut, KKeyChooserItem* ignoreItem, const TQString& warnText );
    void _warning( const KKeySequence& seq, TQString sAction, TQString sTitle );
 
 protected slots:
    void slotNoKey();
    void slotDefaultKey();
    void slotCustomKey();
    void slotListItemSelected( TQListViewItem *item );
    void capturedShortcut( const TDEShortcut& cut );
        void slotSettingsChanged( int );
        void slotListItemDoubleClicked ( TQListViewItem * ipoQListViewItem, const TQPoint & ipoQPoint, int c );
 
 protected:
    ActionType m_type;
    bool m_bAllowLetterShortcuts;
    bool m_bAllowWinKey; // unused KDE4 remove
    // When set, pressing the 'Default' button will select the aDefaultKeycode4,
    //  otherwise aDefaultKeycode.
    bool m_bPreferFourModifierKeys;
 
    TQRadioButton* m_prbNone;
    TQRadioButton* m_prbDef;
    TQRadioButton* m_prbCustom;
 
 private:
        bool isKeyPresentLocally( const TDEShortcut& cut, KKeyChooserItem* ignoreItem, bool bWarnUser );
        static bool promptForReassign( const KKeySequence& cut, const TQString& sAction, ActionType action, TQWidget* parent );
        // Remove the key sequences contained in cut from the standard shortcut @p name
        // which currently has @p origCut as shortcut.
        static void removeStandardShortcut( const TQString& name, KKeyChooser* chooser, const TDEShortcut &origCut, const TDEShortcut &cut );
        // Remove the key sequences contained in cut from the global shortcut @p name
        // which currently has @p origCut as shortcut.
        static void removeGlobalShortcut( const TQString& name, KKeyChooser* chooser, const TDEShortcut &origCut, const TDEShortcut &cut );
        static void readGlobalKeys( TQMap< TQString, TDEShortcut >& map );
        static bool checkGlobalShortcutsConflict( const TDEShortcut& cut, bool bWarnUser, TQWidget* parent,
            const TQMap< TQString, TDEShortcut >& map, const TQString& ignoreAction );
        // Remove the key sequences contained in cut from this item
        bool removeShortcut( const TQString& name, const TDEShortcut &cut );
 
private slots:
        void captureCurrentItem();
 
#ifndef KDE_NO_COMPAT
 public:
    KKeyChooser( TDEAccel* actions, TQWidget* parent,
            bool bCheckAgainstStdKeys,
            bool bAllowLetterShortcuts,
            bool bAllowWinKey = false );
    KKeyChooser( TDEGlobalAccel* actions, TQWidget* parent,
            bool bCheckAgainstStdKeys,
            bool bAllowLetterShortcuts,
            bool bAllowWinKey = false );
 
 public slots:
    void listSync();
 
#endif
 protected:
    virtual void virtual_hook( int id, void* data );
 private:
    class KKeyChooserPrivate *d;
    friend class KKeyDialog;
};
typedef KKeyChooser KKeyChooser;

class TDEUI_EXPORT KKeyDialog : public KDialogBase
{
    TQ_OBJECT
 
public:
    KKeyDialog( bool bAllowLetterShortcuts = true, TQWidget* parent = 0, const char* name = 0 );

    virtual ~KKeyDialog();

    bool insert( TDEActionCollection* ); // #### KDE4: remove me

        bool insert(TDEActionCollection *, const TQString &title);

    bool configure( bool bSaveSettings = true );

    void commitChanges();

    static int configure( TDEActionCollection* coll, TQWidget* parent = 0, bool bSaveSettings = true );

    static int configure( TDEAccel* keys, TQWidget* parent = 0, bool bSaveSettings = true );

    static int configure( TDEGlobalAccel* keys, TQWidget* parent = 0, bool bSaveSettings = true );
 

    static int configure( TDEActionCollection* coll, bool bAllowLetterShortcuts, TQWidget* parent = 0, bool bSaveSettings = true ); // BCI: merge with bAllowLetterShortcuts = true

    static int configure( TDEAccel* keys, bool bAllowLetterShortcuts, TQWidget* parent = 0, bool bSaveSettings = true ); // BCI: merge with bAllowLetterShortcuts = true

    static int configure( TDEGlobalAccel* keys, bool bAllowLetterShortcuts, TQWidget* parent = 0, bool bSaveSettings = true ); // BCI: merge with bAllowLetterShortcuts = true

    static TDE_DEPRECATED int configureKeys( TDEAccel* keys, bool save_settings = true, TQWidget* parent = 0 )
        { return configure( keys, parent, save_settings ); }

    static TDE_DEPRECATED int configureKeys( TDEGlobalAccel* keys, bool save_settings = true, TQWidget* parent = 0 )
        { return configure( keys, parent, save_settings ); }

    static TDE_DEPRECATED int configureKeys( TDEActionCollection* coll, const TQString& /*xmlfile*/,
        bool save_settings = true, TQWidget* parent = 0 )
        { return configure( coll, parent, save_settings ); }
 
private:
    KKeyDialog( KKeyChooser::ActionType, bool bAllowLetterShortcuts = true, TQWidget* parent = 0, const char* name = 0 );
 
 protected:
    virtual void virtual_hook( int id, void* data );
 
 private:
    class KKeyDialogPrivate* d;
    KKeyChooser* m_pKeyChooser;
};
 
#endif // __KKEYDIALOG_H__