summaryrefslogtreecommitdiffstats
path: root/kdesktop/KScreensaverIface.h
diff options
context:
space:
mode:
Diffstat (limited to 'kdesktop/KScreensaverIface.h')
-rw-r--r--kdesktop/KScreensaverIface.h49
1 files changed, 49 insertions, 0 deletions
diff --git a/kdesktop/KScreensaverIface.h b/kdesktop/KScreensaverIface.h
new file mode 100644
index 000000000..0ed26b67a
--- /dev/null
+++ b/kdesktop/KScreensaverIface.h
@@ -0,0 +1,49 @@
+
+#ifndef __KScreensaverIface_h__
+#define __KScreensaverIface_h__
+
+#include <dcopobject.h>
+
+class KScreensaverIface : virtual public DCOPObject
+{
+ K_DCOP
+public:
+
+k_dcop:
+ /** Lock the screen now even if the screensaver does not lock by default. */
+ virtual void lock() = 0;
+
+ /** Save the screen now. If the user has locking enabled, the screen is
+ * locked also. */
+ virtual void save() = 0;
+
+ /** Quit the screensaver if it is running */
+ virtual void quit() = 0;
+
+ /** Is the screensaver enabled? */
+ virtual bool isEnabled() = 0;
+
+ /**
+ * Enable/disable the screensaver
+ * returns true if the action succeeded
+ */
+ virtual bool enable( bool e ) = 0;
+
+ /** Is the screen currently blanked? */
+ virtual bool isBlanked() = 0;
+
+ /** Reload the screensaver configuration. */
+ virtual void configure() = 0;
+
+ /** Only blank the screen (and possibly lock). Do not use a custom
+ * screen saver in the interest of saving battery.
+ */
+ virtual void setBlankOnly( bool blankOnly ) = 0;
+
+ /***
+ * @internal
+ */
+ virtual void saverLockReady() = 0;
+};
+
+#endif