summaryrefslogtreecommitdiffstats
path: root/kdesktop/KBackgroundIface.h
blob: bd2a6ba05bb3e27a7a27d10b7e3f33384e9d608d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/**
 * DCOP interface for the background manager.
 */

#ifndef __KBackgroundIface_h__
#define __KBackgroundIface_h__

#include <dcopobject.h>
#include <qcolor.h>

class KBackgroundIface : virtual public DCOPObject
{
    K_DCOP
public:

k_dcop:
    /** Reread the configuration */
    virtual void configure() = 0;

    /** Enable/disable export of the background pixmap. */
    virtual void setExport(int xport) = 0;

    /** Returns the export desktop pixmap state. */
    virtual bool isExport() = 0;

    /** Enable/disable common desktop background. */
    virtual void setCommon(int common) = 0;

    /** Returns the common desktop background state. */
    virtual bool isCommon() = 0;

    /** Change caching behaviour.
     * @param bLimit Limit cache if not equal to zero.
     * @param size Cache size in kilobytes. */
    virtual void setCache(int bLimit, int size) = 0;

    /** Change the wallpaper.
     * @param desk desktop number, or 0 for the current visible desktop.
     * @param wallpaper The (local) path to the wallpaper.
     * @param mode The tiling mode. */
    virtual void setWallpaper(int desk, QString wallpaper, int mode) = 0;

    /** Change the wallpaper.
     * @param wallpaper The (local) path to the wallpaper.
     * @param mode The tiling mode. */
    virtual void setWallpaper(QString wallpaper, int mode) = 0;

    /** Set color.
     * @param c The color.
     * @param isColorA true for foreground and false for background color. */
    virtual void setColor(const QColor &c, bool isColorA) = 0;

    /** Change the wallpaper in "multi mode". */
    virtual void changeWallpaper() = 0;

    /** Enable/disable desktop background. */
    virtual void setBackgroundEnabled(const bool enable) = 0;

    /** Return the current wallpaper for specified desk.
     * @param desk desktop number, or 0 for the current visible desktop.
     */
    virtual QString currentWallpaper( int desk ) = 0;

    /** Return the wallpaper list for specified desk.
     * @param desk desktop number, or 0 for the current visible desktop.
     */
    virtual QStringList wallpaperList(int desk) = 0;

    /** Return the wallpaper files for specified desk.
     * @param desk desktop number, or 0 for the current visible desktop.
     */
    virtual QStringList wallpaperFiles(int desk) = 0;
};

#endif // __KBackgroundIface_h__