workspace/kcontrol/kdm/background/bgsettings.h

   1 /* vi: ts=8 sts=4 sw=4
   2  * kate: space-indent on; indent-width 4; indent-mode cstyle;
   3  *
   4  * This file is part of the KDE project, module kdesktop.
   5  * Copyright (C) 1999 Geert Jansen <g.t.jansen@stud.tue.nl>
   6  *
   7  * You can Freely distribute this program under the GNU Library General
   8  * Public License. See the file "COPYING.LIB" for the exact licensing terms.
   9  */
  10
  11 #ifndef __BGSettings_h_Included__
  12 #define __BGSettings_h_Included__
  13
  14
  15 #include <QColor>
  16 #include <QMap>
  17 #include <QVector>
  18 #include <ksharedconfig.h>
  19
  20 template <class QString, class T> class QMap;
  21 class KStandardDirs;
  22 class KDesktopFile;
  23 class QString;
  24
  25 /**
  26  * A class to manipulate/read/write/list KDE desktop patterns.
  27  *
  28  * A pattern is a raster image. An entry for earch pattern is
  29  * stored as a .desktop file in $(datadir)/kdesktop/patterns.
  30  */
  31 class KBackgroundPattern
  32 {
  33 public:
  34     explicit KBackgroundPattern(const QString &name = QString());
  35     ~KBackgroundPattern();
  36
  37     void copyConfig(const KBackgroundPattern*);
  38
  39     QString name() const { return m_Name; }
  40     void load(const QString &name);
  41
  42     void setComment(const QString &comment);
  43     QString comment() const {return m_Comment; }
  44
  45     void setPattern(const QString &file);
  46     QString pattern() const { return m_Pattern; }
  47
  48     void readSettings();
  49     void writeSettings();
  50
  51     bool isAvailable();
  52     bool isGlobal()const { return m_bReadOnly; }
  53     bool remove();
  54
  55     int hash();
  56
  57     static QStringList list();
  58
  59 private:
  60     void init(bool force_rw=false);
  61     QString fingerprint();
  62
  63     bool dirty, hashdirty;
  64     bool m_bReadOnly;
  65     int m_Hash;
  66     QString m_Name, m_Comment;
  67     QString m_Pattern, m_File;
  68     KStandardDirs *m_pDirs;
  69     KDesktopFile *m_pConfig;
  70 };
  71
  72
  73 /**
  74  * A class to manipulate/read/write/list KDE desktop programs (a la xearth).
  75  *
  76  * A program is described by a string like:
  77  *
  78  *   a_program -xres %x -yres %y -outfile %f
  79  *
  80  * Possible escape sequences:
  81  *
  82  *   %x    Horizontal resolution in pixels.
  83  *   %y    Vertical resolution in pixels.
  84  *   %f    Filename to dump to.
  85  *
  86  * An entry for each program is stored as a .desktop file in
  87  * $(datadir)/kdesktop/programs.
  88  */
  89 class KBackgroundProgram
  90 {
  91 public:
  92     explicit KBackgroundProgram(const QString &name = QString());
  93     ~KBackgroundProgram();
  94
  95     void copyConfig(const KBackgroundProgram*);
  96
  97     QString name()const { return m_Name; }
  98     void load(const QString & name);
  99
 100     void setComment(const QString &comment);
 101     QString comment()const { return m_Comment; }
 102
 103     void setCommand(const QString &command);
 104     QString command()const { return m_Command; }
 105
 106     void setPreviewCommand(const QString &command);
 107     QString previewCommand()const { return m_PreviewCommand; }
 108
 109     void setRefresh(int refresh);
 110     int refresh()const { return m_Refresh; }
 111
 112     void setExecutable(const QString &executable);
 113     QString executable()const { return m_Executable; }
 114
 115     void readSettings();
 116     void writeSettings();
 117
 118     void update();
 119     bool needUpdate();
 120
 121     int hash();
 122
 123     bool isAvailable();
 124     bool isGlobal()const { return m_bReadOnly; }
 125     bool remove();
 126
 127     static QStringList list();
 128
 129 private:
 130     void init(bool force_rw=false);
 131     QString fingerprint();
 132
 133     bool dirty, hashdirty;
 134     bool m_bReadOnly;
 135     int m_Refresh, m_Hash, m_LastChange;
 136     QString m_Name, m_Command;
 137     QString m_PreviewCommand, m_Comment;
 138     QString m_Executable, m_File;
 139     KStandardDirs *m_pDirs;
 140     KDesktopFile *m_pConfig;
 141 };
 142
 143
 144 /**
 145  * KBackgroundSettings: A class to read/write/manipulate
 146  * KDE desktop settings.
 147  */
 148 class KBackgroundSettings
 149     : public KBackgroundPattern,
 150       public KBackgroundProgram
 151 {
 152 public:
 153     /**
 154      * @param drawBackgroundPerScreen if false, then all screens (in xinerama
 155      * mode) will be treated as one big display, and the "screen" paramater
 156      * will be ignored.
 157      */
 158     KBackgroundSettings(int screen, bool drawBackgroundPerScreen, const KSharedConfigPtr &config);
 159     ~KBackgroundSettings();
 160
 161     void copyConfig(const KBackgroundSettings*);
 162
 163     bool drawBackgroundPerScreen() const { return m_bDrawBackgroundPerScreen; }
 164     void setDrawBackgroundPerScreen(bool draw);
 165
 166     int screen() const { return m_Screen; }
 167     void load(int screen, bool drawBackgroundPerScreen, bool reparseConfig);
 168
 169     void setColorA(const QColor &color);
 170     QColor colorA() const { return m_ColorA; }
 171     void setColorB(const QColor &color);
 172     QColor colorB() const { return m_ColorB; }
 173
 174     void setProgram(const QString &program);
 175     void setPatternName(const QString &pattern);
 176
 177     enum BackgroundMode {
 178         Flat, Pattern, Program,
 179         HorizontalGradient, VerticalGradient, PyramidGradient,
 180         PipeCrossGradient, EllipticGradient, lastBackgroundMode
 181     };
 182     void setBackgroundMode(int mode);
 183     int backgroundMode() const { return m_BackgroundMode; }
 184
 185     enum BlendMode {
 186         NoBlending, FlatBlending,
 187         HorizontalBlending, VerticalBlending, PyramidBlending,
 188         PipeCrossBlending, EllipticBlending,
 189         IntensityBlending, SaturateBlending, ContrastBlending,
 190         HueShiftBlending, lastBlendMode
 191     };
 192     void setBlendMode(int mode);
 193     int blendMode() const { return m_BlendMode; }
 194
 195     void setReverseBlending(bool value);
 196     bool reverseBlending() const { return m_ReverseBlending; }
 197
 198     void setBlendBalance(int value);
 199     int blendBalance() const { return m_BlendBalance; }
 200
 201     void setWallpaper(const QString &name);
 202     QString wallpaper() const { return m_Wallpaper; }
 203
 204     enum WallpaperMode {
 205         NoWallpaper, Centred, Tiled, CenterTiled, CentredMaxpect, TiledMaxpect,
 206         Scaled, CentredAutoFit, ScaleAndCrop, lastWallpaperMode
 207     };
 208     void setWallpaperMode(int mode);
 209     int wallpaperMode() const { return m_WallpaperMode; }
 210
 211     void setWallpaperList(const QStringList&);
 212     QStringList wallpaperList() const;
 213     QStringList wallpaperFiles() const;
 214
 215     void setWallpaperChangeInterval(int);
 216     int wallpaperChangeInterval() const { return m_Interval; }
 217
 218     enum MultiMode {
 219         NoMulti, InOrder, Random, NoMultiRandom
 220     };
 221     void setMultiWallpaperMode(int mode);
 222     int multiWallpaperMode() const { return m_MultiMode; }
 223
 224     enum MinOptDepth {
 225         AlwaysOpt, Opt16bpp, Opt15bpp, NeverOpt };
 226
 227     void setMinOptimizationDepth( int mode );
 228     int minOptimizationDepth() const { return m_MinOptimizationDepth; }
 229     bool optimize() const;
 230
 231     void setUseShm( bool use );
 232     bool useShm() const { return m_bShm; }
 233
 234     void changeWallpaper(bool init=false);
 235     void updateWallpaperFiles();
 236     void randomizeWallpaperFiles();
 237
 238     QString currentWallpaper() const;
 239     /**
 240      * @return true if the currentWallpaper has changed
 241      */
 242     bool discardCurrentWallpaper();
 243     int lastWallpaperChange() const { return m_LastChange; }
 244     bool needWallpaperChange();
 245
 246     void readSettings(bool reparse=false);
 247     void writeSettings();
 248     QString configGroupName() const;
 249
 250     int hash();
 251     QString fingerprint();
 252
 253     void setEnabled( const bool enable );
 254     bool enabled() const { return m_bEnabled; }
 255
 256 private:
 257     void updateHash();
 258
 259     bool dirty;
 260     bool hashdirty;
 261     int m_Screen, m_Hash;
 262
 263     QColor m_ColorA, defColorA;
 264     QColor m_ColorB, defColorB;
 265     QString m_Wallpaper;
 266     QStringList m_WallpaperList, m_WallpaperFiles;
 267
 268     int m_BackgroundMode, defBackgroundMode;
 269     int m_WallpaperMode, defWallpaperMode;
 270     int m_BlendMode, defBlendMode;
 271     int m_BlendBalance, defBlendBalance;
 272     bool m_ReverseBlending, defReverseBlending;
 273     int m_MinOptimizationDepth;
 274     bool m_bShm;
 275     bool m_bDrawBackgroundPerScreen;
 276
 277     int m_MultiMode, defMultiMode;
 278     int m_Interval, m_LastChange;
 279     int m_CurrentWallpaper;
 280     QString m_CurrentWallpaperName;
 281
 282     KSharedConfigPtr m_pConfig;
 283     KStandardDirs *m_pDirs;
 284     bool m_bDeleteConfig;
 285     bool m_bEnabled;
 286
 287 public:
 288     QMap<QString,int> m_BMMap;
 289     QMap<QString,int> m_WMMap;
 290     QMap<QString,int> m_MMMap;
 291     QMap<QString,int> m_BlMMap;
 292     char *m_BMRevMap[16];
 293     char *m_WMRevMap[16];
 294     char *m_MMRevMap[16];
 295     char *m_BlMRevMap[16];
 296 };
 297
 298
 299 /**
 300  * A class to read/modify the global desktop background settings.
 301  */
 302 class KGlobalBackgroundSettings
 303 {
 304 public:
 305     KGlobalBackgroundSettings(const KSharedConfigPtr &config);
 306
 307     int cacheSize() { return m_CacheSize; }
 308     void setCacheSize(int size);
 309
 310     bool drawBackgroundPerScreen() const;
 311     void setDrawBackgroundPerScreen(bool perScreen);
 312
 313     bool limitCache() { return m_bLimitCache; }
 314     void setLimitCache(bool limit);
 315
 316     bool commonScreenBackground() { return m_bCommonScreen; }
 317     void setCommonScreenBackground(bool common);
 318
 319     void readSettings();
 320     void writeSettings();
 321
 322 private:
 323     bool dirty;
 324     bool m_bCommonScreen;
 325     bool m_bLimitCache;
 326     int m_CacheSize;
 327
 328     KSharedConfigPtr m_pConfig;
 329     bool m_bDrawBackgroundPerScreen;
 330 };
 331
 332
 333 #endif // __BGSettings_h_Included__