workspace/khotkeys/libkhotkeysprivate/settings.h

   1 /****************************************************************************
   2
   3  KHotKeys
   4
   5  Copyright (C) 1999-2001 Lubos Lunak <l.lunak@kde.org>
   6
   7  Distributed under the terms of the GNU General Public License version 2.
   8
   9 ****************************************************************************/
  10
  11 #ifndef _SETTINGS_H_
  12 #define _SETTINGS_H_
  13
  14 #include "actions/actions.h"
  15 #include "action_data/action_data_group.h"
  16 #include <kshortcut.h>
  17
  18 class KConfig;
  19
  20 namespace KHotKeys
  21 {
  22
  23 class ActionDataGroup;
  24
  25 /**
  26  * How to handle imports.
  27  */
  28 enum ImportType
  29     {
  30     ImportNone,  //!< no import is done
  31     ImportAsk,   //!< if already imported before, ask (called from GUI)
  32     ImportSilent //!< if already imported before, ignore (called from the update script)
  33     };
  34
  35
  36 /**
  37  * Handles KHotKeys Settings.
  38  *
  39  * Settings are saved to the khotkeysrc file.
  40  */
  41 class KDE_EXPORT Settings
  42 {
  43     Q_DISABLE_COPY( Settings )
  44
  45 public:
  46
  47     Settings();
  48     ~Settings();
  49
  50     /**
  51      * Get the system group.
  52      */
  53     ActionDataGroup *get_system_group(ActionDataGroup::system_group_t group_id);
  54
  55     /**
  56      * Read the settings.
  57      *
  58      * \param include_disabled_P Load disabled shortcuts?
  59      */
  60     bool read_settings( bool include_disabled_P );
  61
  62     /**
  63      * Write the settings.
  64      */
  65     void write_settings();
  66
  67     /**
  68      * Import settings from \a cfg_P.
  69      */
  70     bool import( KConfig& cfg_P, bool ask_P );
  71
  72     /**
  73      * Get all actions
  74      */
  75     ActionDataGroup *actions();
  76
  77     /**
  78      * Take the actions.
  79      *
  80      * \note Ownership is transfered to you. Subsequent calls to action() will
  81      * return 0
  82      */
  83     ActionDataGroup *takeActions();
  84
  85     /**
  86      * Set the actions.
  87      *
  88      * \note Ownership is taken. The current action list will be deleted.
  89      */
  90     void setActions( ActionDataGroup *actions );
  91
  92     /**
  93      * @name KHotkeys Daemon
  94      */
  95     //@{
  96     /**
  97      * Disable the daemon.
  98      */
  99     void disableDaemon();
 100
 101     /**
 102      * Enable the daemon.
 103      */
 104     void enableDaemon();
 105
 106     /**
 107      * Is the daemon disabled?
 108      */
 109     bool isDaemonDisabled() const;
 110     //@}
 111
 112     /**
 113      * @name Gestures
 114      */
 115     //@{
 116     void disableGestures();
 117     void enableGestures();
 118     bool areGesturesDisabled() const;
 119
 120     int gestureMouseButton() const;
 121     void setGestureMouseButton( int );
 122
 123     int gestureTimeOut() const;
 124     void setGestureTimeOut(int);
 125
 126     void setGesturesExclude( Windowdef_list *gestures );
 127     Windowdef_list *gesturesExclude();
 128     const Windowdef_list *gesturesExclude() const;
 129     //@}
 130
 131     /**
 132      * @name Voice Commands
 133      */
 134     //@{
 135     void setVoiceShortcut( const KShortcut &shortcut );
 136     KShortcut voiceShortcut() const;
 137     //@}
 138
 139 protected:
 140
 141     /**
 142      * Read settings from \a cfg_P. \a include_disabled_P controls whether
 143      * disabled actions should be discarded.
 144      */
 145     bool read_settings( KConfig& cfg_P, bool include_disabled_P, ImportType import_P );
 146
 147     /**
 148      * Read settings in the v1 legacy format from \a cfg_P .
 149      */
 150     void read_settings_v1( KConfig& cfg_P );
 151
 152     /**
 153      * Read settings in the v2 format from \a cfg_P .
 154      */
 155     void read_settings_v2( KConfig& cfg_P, bool include_disabled_P );
 156
 157     /**
 158      * Write \a parent_P recursively to \a cfg_P
 159      */
 160     int write_actions_recursively_v2(
 161         KConfigGroup& cfg_P,
 162         ActionDataGroup* parent_P,
 163         bool enabled_P );
 164
 165     /**
 166      * Read \a parent_P recursively to \a cfg_P
 167      */
 168     void read_actions_recursively_v2(
 169         KConfigGroup& cfg_P,
 170         ActionDataGroup* parent_P,
 171         bool include_disabled_P );
 172
 173     /**
 174      * Initialize the settings
 175      */
 176     void initialize();
 177
 178 private:
 179
 180     /**
 181      * TODO
 182      */
 183     ActionDataGroup* m_actions;
 184
 185     /**
 186      * @name Gestures
 187      */
 188     //@{
 189     /**
 190      * Gestures globally disabled?
 191      */
 192     bool gestures_disabled;
 193
 194     /**
 195      * Mouse button used for gestures.
 196      */
 197     int gesture_mouse_button;
 198
 199     /**
 200      * Gesture timeout
 201      */
 202     int gesture_timeout;
 203
 204     /**
 205      * Windows to exclude from gestures
 206      */
 207     Windowdef_list* gestures_exclude;
 208     //@}
 209
 210     /**
 211      * KHotKeys daemon disabled?
 212      */
 213     bool daemon_disabled;
 214
 215     /**
 216      * The shortcut that triggers a voice command
 217      */
 218     KShortcut voice_shortcut;
 219
 220     /**
 221      * List of id's for all imported files.
 222      */
 223     QStringList already_imported;
 224
 225
 226 };
 227
 228 } // namespace KHotKeys
 229
 230 #endif