workspace/kcontrol/keys/kglobalshortcutseditor.h

   1 /*
   2  *  Copyright 2008 Michael Jansen <kde@michael-jansen.biz>
   3  *
   4  *  This program is free software; you can redistribute it and/or modify
   5  *  it under the terms of the GNU General Public License as published by
   6  *  the Free Software Foundation; either version 2 of the License, or
   7  *  (at your option) any later version.
   8  *
   9  *  This program is distributed in the hope that it will be useful,
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *  GNU General Public License for more details.
  13  *
  14  *  You should have received a copy of the GNU General Public License
  15  *  along with this program; if not, write to the Free Software
  16  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  17  */
  18 #ifndef KGLOBALSHORTCUTSEDITOR_H
  19 #define KGLOBALSHORTCUTSEDITOR_H
  20
  21 #include <QWidget>
  22
  23 #include "kshortcutseditor.h"
  24
  25 class KActionCollection;
  26 class KShortcut;
  27 class KConfig;
  28
  29 /**
  30  * Combine a KShortcutsEditor with a KComboBox.
  31  *
  32  * @see KShortcutsEditor
  33  * @author Michael Jansen <kde@michael-jansen.biz>
  34  */
  35 class KGlobalShortcutsEditor : public QWidget
  36 {
  37     Q_OBJECT
  38
  39 public:
  40
  41     /**
  42      * Constructor
  43      *
  44      * @param parent parent widget
  45      */
  46     KGlobalShortcutsEditor(QWidget *parent,
  47                            KShortcutsEditor::ActionTypes actionTypes = KShortcutsEditor::AllActions);
  48     ~KGlobalShortcutsEditor();
  49
  50     /**
  51      * Insert an action collection, i.e. add all it's actions to the ones already associated
  52      * with the KShortcutsEditor object.
  53      *
  54      * @param collection  the collection to add
  55      * @param component   title for the component
  56      * @param title       title for the subtree in the component
  57      */
  58     void addCollection(KActionCollection *, const QString &id, const QString &name);
  59
  60     /**
  61      * Clear all collections were currently hosting.
  62      */
  63     void clear();
  64
  65
  66     /**
  67      * Revert all changes made since the last save.
  68      */
  69     void undo();
  70
  71
  72     /**
  73      * Load the shortcuts from the configuration.
  74      */
  75     void importConfiguration(KConfig *config);
  76
  77
  78     /**
  79      * Save the shortcuts to the configuration.
  80      */
  81     void exportConfiguration(KConfig *config) const;
  82
  83
  84     /**
  85      * Are the unsaved changes?
  86      */
  87     bool isModified() const;
  88
  89 Q_SIGNALS:
  90
  91     /**
  92      * Indicate that state of the modules contents has changed.
  93      *
  94      * @param state changed or not
  95      */
  96     void changed(bool);
  97
  98
  99 public Q_SLOTS:
 100
 101     /**
 102      * Activate the component \a component.
 103      *
 104      * @param component the component
 105      */
 106     void activateComponent(const QString &component);
 107
 108
 109     /**
 110      * Make the changes persistent.
 111      *
 112      * That's function is not really saving. Global shortcuts are saved immediately. This
 113      * prevent the undo on deleting the editor.
 114      */
 115     void save();
 116
 117     /**
 118      * Reset all \a components to default values.
 119      */
 120     void allDefault();
 121
 122
 123 private Q_SLOTS:
 124     void _k_key_changed();
 125
 126 private:
 127
 128     friend class KGlobalShortcutsEditorPrivate;
 129     class KGlobalShortcutsEditorPrivate;
 130     KGlobalShortcutsEditorPrivate *const d;
 131     Q_DISABLE_COPY(KGlobalShortcutsEditor)
 132 }; // class KGlobalShortcutsEditor
 133
 134 #endif // KGLOBALSHORTCUTSEDITOR_H