kdat/Options.h

   1 // KDat - a tar-based DAT archiver
   2 // Copyright (C) 1998-2000  Sean Vyain, svyain@mail.tds.net
   3 // Copyright (C) 2001-2002  Lawrence Widman, kdat@cardiothink.com
   4 //
   5 // This program is free software; you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation; either version 2 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  18
  19 #ifndef _Options_h_
  20 #define _Options_h_
  21
  22 #include <qobject.h>
  23
  24 class KConfig;
  25
  26 /**
  27  * @short The central repository for user preferences.
  28  */
  29 class Options : public QObject {
  30     Q_OBJECT
  31     KConfig* _config;
  32     int      _defaultTapeSize;
  33     int      _tapeBlockSize;
  34     QString  _tapeDevice;
  35     QString  _tarCommand;
  36     bool     _loadOnMount;
  37     bool     _lockOnMount;
  38     bool     _ejectOnUnmount;
  39     bool     _variableBlockSize;
  40
  41     static Options* _instance;
  42
  43     Options();
  44 public:
  45     /**
  46      * Get a reference to the single instance of the Options object.
  47      *
  48      * @return A pointer to the options object.
  49      */
  50     static Options* instance();
  51
  52     /**
  53      * Save the current user preference settings.
  54      */
  55     void sync();
  56
  57     /**
  58      * Get the default size to use when formatting a tape.
  59      *
  60      * @return The default size in kilobytes of a tape.
  61      */
  62     int getDefaultTapeSize();
  63
  64     /**
  65      * The size of a tape block can be different from the size of a tar block.
  66      * Tar blocks are always 512 bytes long.  Be careful!
  67      *
  68      * @return the size in bytes of a single tape block
  69      */
  70     int getTapeBlockSize();
  71
  72     /**
  73      * Get the full path to the tape device.
  74      *
  75      * @return The tape device path.
  76      */
  77     QString getTapeDevice();
  78
  79     /**
  80      * Get the full path to the tar command.
  81      *
  82      * @return The path to the tar command.
  83      */
  84     QString getTarCommand();
  85
  86     /**
  87      * Get whether to load the tape before attempting to mount it.
  88      *
  89      * @return TRUE if the tape should be loaded.
  90      */
  91     bool getLoadOnMount();
  92
  93     /**
  94      * Get whether to lock the tape drive when a tape is mounted.
  95      *
  96      * @return TRUE if the tape drive should be locked, otherwise FALSE.
  97      */
  98     bool getLockOnMount();
  99
 100     /**
 101      * Get whether to automatically eject the tape when it is unmounted.
 102      *
 103      * @return TRUE if the tape should be ejected, otherwise FALSE.
 104      */
 105     bool getEjectOnUnmount();
 106
 107     /**
 108      * Get whether the tape drive supports variable block sizes.
 109      *
 110      * @return TRUE if the tape drive can handle the MTSETBLK command.
 111      */
 112     bool getVariableBlockSize();
 113
 114     /**
 115      * Set the default size for new tapes.
 116      *
 117      * @param kbytes The size in kilobytes.
 118      */
 119     void setDefaultTapeSize( int kbytes );
 120
 121     /**
 122      * Set the size of tape block.
 123      *
 124      * @param bytes The size in bytes of one tape block.
 125      */
 126     void setTapeBlockSize( int bytes );
 127
 128     /**
 129      * Set the path to the tape device.
 130      *
 131      * @param str The full path to the tape device.
 132      */
 133     void setTapeDevice( const QString & str );
 134
 135     /**
 136      * Set the path to the tar command.
 137      *
 138      * @param str The full path to the tar command.
 139      */
 140     void setTarCommand( const QString & str );
 141
 142     /**
 143      * Set whether to load the tape before attempting to mount it.
 144      *
 145      * @param b TRUE if the tape should be loaded.
 146      */
 147     void setLoadOnMount( bool b );
 148
 149     /**
 150      * Set whether to lock the tape drive whenever a tape is mounted.
 151      *
 152      * @param b TRUE means lock the drive, FALSE means don't.
 153      */
 154     void setLockOnMount( bool b );
 155
 156     /**
 157      * Set whether to eject the tape drive whenever a tape is unmounted.
 158      *
 159      * @param b TRUE means eject the tape, FALSE means don't.
 160      */
 161     void setEjectOnUnmount( bool b );
 162
 163     /**
 164      * Set whether the tape drive can support variable block sizes.
 165      *
 166      * @param b TRUE means the tape drive understands MTSETBLK.
 167      */
 168     void setVariableBlockSize( bool b );
 169 signals:
 170     /**
 171      * Emitted when the default tape size changes.
 172      */
 173     void sigDefaultTapeSize();
 174
 175     /**
 176      * Emitted when the tape block size changes.
 177      */
 178     void sigTapeBlockSize();
 179
 180     /**
 181      * Emitted when the path to the tape device changes.
 182      */
 183     void sigTapeDevice();
 184
 185     /**
 186      * Emitted when the path to the tar command changes.
 187      */
 188     void sigTarCommand();
 189
 190     /**
 191      * Emitted when the load on mount feature is enabled/disabled.
 192      */
 193     void sigLoadOnMount();
 194
 195     /**
 196      * Emitted when the lock on mount feature is enabled/disabled.
 197      */
 198     void sigLockOnMount();
 199
 200     /**
 201      * Emitted when the eject on umount feature is enabled/disabled.
 202      */
 203     void sigEjectOnUnmount();
 204
 205     /**
 206      * Emitted when the variable block size feature is enabled/disabled.
 207      */
 208     void sigVariableBlockSize();
 209 };
 210
 211 #endif