XWindowsScreenSaver Class Reference

X11 screen saver implementation. More...

#include <XWindowsScreenSaver.h>

Inheritance diagram for XWindowsScreenSaver:

Collaboration diagram for XWindowsScreenSaver:

Public Member Functions
	XWindowsScreenSaver (Display *, Window, void *eventTarget, IEventQueue *events)
	XWindowsScreenSaver (XWindowsScreenSaver const &)=delete
	XWindowsScreenSaver (XWindowsScreenSaver &&)=delete
	~XWindowsScreenSaver () override
XWindowsScreenSaver &	operator= (XWindowsScreenSaver const &)=delete
XWindowsScreenSaver &	operator= (XWindowsScreenSaver &&)=delete
Public Member Functions inherited from IScreenSaver
Public Member Functions inherited from IInterface
virtual	~IInterface ()=default
	Interface destructor does nothing.

manipulators
bool	handleXEvent (const XEvent *)
	Event filtering.
void	destroy ()
	Destroy without the display.
void	enable () override
	Enable screen saver.
void	disable () override
	Disable screen saver.
void	activate () override
	Activate screen saver.
void	deactivate () override
	Deactivate screen saver.
bool	isActive () const override
	Test if screen saver on.

Detailed Description

X11 screen saver implementation.

Constructor & Destructor Documentation

XWindowsScreenSaver() [1/3]

XWindowsScreenSaver::XWindowsScreenSaver	(	Display *	display,
		Window	window,
		void *	eventTarget,
		IEventQueue *	events )

XWindowsScreenSaver() [2/3]

XWindowsScreenSaver::XWindowsScreenSaver ( XWindowsScreenSaver const & )

delete

XWindowsScreenSaver() [3/3]

XWindowsScreenSaver::XWindowsScreenSaver ( XWindowsScreenSaver && )

delete

~XWindowsScreenSaver()

XWindowsScreenSaver::~XWindowsScreenSaver ( )

override

Member Function Documentation

activate()

void XWindowsScreenSaver::activate ( )

overridevirtual

Activate screen saver.

Activate (i.e. show) the screen saver.

Implements IScreenSaver.

deactivate()

void XWindowsScreenSaver::deactivate ( )

overridevirtual

Deactivate screen saver.

Deactivate (i.e. hide) the screen saver, reseting the screen saver timer.

Implements IScreenSaver.

destroy()

void XWindowsScreenSaver::destroy

(

)

Destroy without the display.

Tells this object to delete itself without using the X11 display. It may leak some resources as a result.

disable()

void XWindowsScreenSaver::disable ( )

overridevirtual

Disable screen saver.

Disable the screen saver, saving the old settings for the next call to enable().

Implements IScreenSaver.

enable()

void XWindowsScreenSaver::enable ( )

overridevirtual

Enable screen saver.

Enable the screen saver, restoring the screen saver settings to what they were when disable() was previously called. If disable() wasn't previously called then it should keep the current settings or use reasonable defaults.

Implements IScreenSaver.

handleXEvent()

bool XWindowsScreenSaver::handleXEvent

(

const XEvent *

xevent

)

Event filtering.

Should be called for each system event before event translation and dispatch. Returns true to skip translation and dispatch.

isActive()

bool XWindowsScreenSaver::isActive ( ) const

overridevirtual

Test if screen saver on.

Returns true iff the screen saver is currently active (showing).

Implements IScreenSaver.

operator=() [1/2]

XWindowsScreenSaver & XWindowsScreenSaver::operator= ( XWindowsScreenSaver && )

delete

operator=() [2/2]

XWindowsScreenSaver & XWindowsScreenSaver::operator= ( XWindowsScreenSaver const & )

delete

---

The documentation for this class was generated from the following files:

• src/lib/platform/XWindowsScreenSaver.h
• src/lib/platform/XWindowsScreenSaver.cpp