Base screen implementation. More...

#include <PlatformScreen.h>

Inheritance diagram for PlatformScreen:

[legend]

Collaboration diagram for PlatformScreen:

[legend]

Public Member Functions
	PlatformScreen (IEventQueue *events, bool invertScrollDirection)
	~PlatformScreen () override=default
void *	getEventTarget () const override=0
	Get event target.
bool	getClipboard (ClipboardID id, IClipboard *) const override=0
	Get clipboard.
void	getShape (int32_t &x, int32_t &y, int32_t &width, int32_t &height) const override=0
	Get screen shape.
void	getCursorPos (int32_t &x, int32_t &y) const override=0
	Get cursor position.
void	reconfigure (uint32_t activeSides) override=0
	Update configuration.
uint32_t	activeSides () override=0
	activeSides
void	warpCursor (int32_t x, int32_t y) override=0
	Warp cursor.
uint32_t	registerHotKey (KeyID key, KeyModifierMask mask) override=0
	Register a system hotkey.
void	unregisterHotKey (uint32_t id) override=0
	Unregister a system hotkey.
void	fakeInputBegin () override=0
	Prepare to synthesize input on primary screen.
void	fakeInputEnd () override=0
	Done synthesizing input on primary screen.
int32_t	getJumpZoneSize () const override=0
	Get jump zone size.
bool	isAnyMouseButtonDown (uint32_t &buttonID) const override=0
	Test if mouse is pressed.
void	getCursorCenter (int32_t &x, int32_t &y) const override=0
	Get cursor center position.
void	fakeMouseButton (ButtonID id, bool press) override=0
	Fake mouse press/release.
void	fakeMouseMove (int32_t x, int32_t y) override=0
	Fake mouse move.
void	fakeMouseRelativeMove (int32_t dx, int32_t dy) const override=0
	Fake mouse move.
void	fakeMouseWheel (int32_t xDelta, int32_t yDelta) const override=0
	Fake mouse wheel.
void	updateKeyMap () override
	Update the keyboard map.
void	updateKeyState () override
	Update the key state.
void	setHalfDuplexMask (KeyModifierMask) override
	Set half-duplex mask.
void	fakeKeyDown (KeyID id, KeyModifierMask mask, KeyButton button, const std::string &) override
	Fake a key press.
bool	fakeKeyRepeat (KeyID id, KeyModifierMask mask, int32_t count, KeyButton button, const std::string &lang) override
	Fake a key repeat.
bool	fakeKeyUp (KeyButton button) override
	Fake a key release.
void	fakeAllKeysUp () override
	Fake key releases for all fake pressed keys.
bool	fakeCtrlAltDel () override
	Fake ctrl+alt+del.
bool	isKeyDown (KeyButton) const override
	Test if key is pressed.
KeyModifierMask	getActiveModifiers () const override
	Get the active modifiers.
KeyModifierMask	pollActiveModifiers () const override
	Get the active modifiers from OS.
int32_t	pollActiveGroup () const override
	Get the active keyboard layout from OS.
void	pollPressedKeys (KeyButtonSet &pressedKeys) const override
	Get the keys currently pressed from OS.
void	clearStaleModifiers () override
	Clear stale modifiers.
void	enable () override=0
	Enable screen.
void	disable () override=0
	Disable screen.
void	enter () override=0
	Enter screen.
bool	canLeave () override=0
	Leave screen.
void	leave () override=0
	Leave screen.
bool	setClipboard (ClipboardID, const IClipboard *) override=0
	Set clipboard.
void	checkClipboards () override=0
	Check clipboard owner.
void	openScreensaver (bool notify) override=0
	Open screen saver.
void	closeScreensaver () override=0
	Close screen saver.
void	screensaver (bool activate) override=0
	Activate/deactivate screen saver.
void	resetOptions () override=0
	Notify of options changes.
void	setOptions (const OptionsList &options) override=0
	Notify of options changes.
void	setSequenceNumber (uint32_t) override=0
	Set clipboard sequence number.
bool	isPrimary () const override=0
	Test if is primary screen.
Public Member Functions inherited from IPlatformScreen
	IPlatformScreen (const IEventQueue *events)
virtual std::string	getSecureInputApp () const =0
	Determine the name of the app causing a secure input state.
bool	fakeMediaKey (KeyID) override
	Fake a media key.
Public Member Functions inherited from IScreen
virtual	~IScreen ()=default
Public Member Functions inherited from IPrimaryScreen
virtual	~IPrimaryScreen ()=default
Public Member Functions inherited from ISecondaryScreen
virtual	~ISecondaryScreen ()=default
Public Member Functions inherited from IKeyState
	IKeyState (const IEventQueue *events)
virtual	~IKeyState ()=default

Protected Member Functions
virtual void	updateButtons ()=0
	Update mouse buttons.
virtual IKeyState *	getKeyState () const =0
	Get the key state.
void	handleSystemEvent (const Event &event) override=0
	Handle system event.
virtual int32_t	mapClientScrollDirection (int32_t) const
	mapClientScrollDirection Convert scroll according to client scroll directio

Static Protected Member Functions
static std::string	sidesMaskToString (uint32_t sides)

Additional Inherited Members
Public Types inherited from IKeyState
using	KeyButtonSet = std::set<KeyButton>
Static Public Attributes inherited from IKeyState
static const auto	s_numButtons = 0x200

Detailed Description

Base screen implementation.

This screen implementation is the superclass of all other screen implementations. It implements a handful of methods and requires subclasses to implement the rest.

Constructor & Destructor Documentation

◆ PlatformScreen()

PlatformScreen::PlatformScreen	(	IEventQueue *	events,
		bool	invertScrollDirection )

explicit

◆ ~PlatformScreen()

PlatformScreen::~PlatformScreen ( )

overridedefault

Member Function Documentation

◆ activeSides()

uint32_t PlatformScreen::activeSides ( )

overridepure virtual

activeSides

Returns: a bitmask of DirectionMask indicating which sides of the primary screen are linked to clients

Implements IPrimaryScreen.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ canLeave()

bool PlatformScreen::canLeave ( )

overridepure virtual

Leave screen.

Called when the user navigates off the screen. Returns true if the leave can proceed. A typical reason for failure is being unable to install the keyboard and mouse snoopers on a primary screen. Secondary screens should not fail.

Implements IPlatformScreen.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ checkClipboards()

void PlatformScreen::checkClipboards ( )

overridepure virtual

Check clipboard owner.

Check ownership of all clipboards and post grab events for any that have changed. This is used as a backup in case the system doesn't reliably report clipboard ownership changes.

Implements IPlatformScreen.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ clearStaleModifiers()

void PlatformScreen::clearStaleModifiers ( )

overridevirtual

Clear stale modifiers.

Clears stuck modifier state in platform-specific keyboard tracking (e.g. XKB). Default implementation does nothing.

Reimplemented from IKeyState.

◆ closeScreensaver()

void PlatformScreen::closeScreensaver ( )

overridepure virtual

Close screen saver.

Close the screen saver. Stop reporting screen saver activation and deactivation and, if the screen saver was disabled by openScreensaver(), enable the screen saver.

Implements IPlatformScreen.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ disable()

void PlatformScreen::disable ( )

overridepure virtual

Disable screen.

Undoes the operations in enable() and events should no longer be reported.

Implements IPlatformScreen.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ enable()

void PlatformScreen::enable ( )

overridepure virtual

Enable screen.

Enable the screen, preparing it to report system and user events. For a secondary screen it also means preparing to synthesize events and hiding the cursor.

Implements IPlatformScreen.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ enter()

void PlatformScreen::enter ( )

overridepure virtual

Enter screen.

Called when the user navigates to this screen.

Implements IPlatformScreen.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ fakeAllKeysUp()

void PlatformScreen::fakeAllKeysUp ( )

overridevirtual

Fake key releases for all fake pressed keys.

Synthesizes a key release event for every key that is synthetically pressed and updates the key state.

Implements IKeyState.

◆ fakeCtrlAltDel()

bool PlatformScreen::fakeCtrlAltDel ( )

overridevirtual

Fake ctrl+alt+del.

Synthesize a press of ctrl+alt+del. Return true if processing is complete and false if normal key processing should continue.

Implements IKeyState.

◆ fakeInputBegin()

void PlatformScreen::fakeInputBegin ( )

overridepure virtual

Prepare to synthesize input on primary screen.

Prepares the primary screen to receive synthesized input. We do not want to receive this synthesized input as user input so this method ensures that we ignore it. Calls to fakeInputBegin() may not be nested.

Implements IPrimaryScreen.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ fakeInputEnd()

void PlatformScreen::fakeInputEnd ( )

overridepure virtual

Done synthesizing input on primary screen.

Undoes whatever fakeInputBegin() did.

Implements IPrimaryScreen.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ fakeKeyDown()

void PlatformScreen::fakeKeyDown	(	KeyID	id,
		KeyModifierMask	mask,
		KeyButton	button,
		const std::string &	lang )

overridevirtual

Fake a key press.

Synthesizes a key press event and updates the key state.

Implements IPlatformScreen.

◆ fakeKeyRepeat()

bool PlatformScreen::fakeKeyRepeat	(	KeyID	id,
		KeyModifierMask	mask,
		int32_t	count,
		KeyButton	button,
		const std::string &	lang )

overridevirtual

Fake a key repeat.

Synthesizes a key repeat event and updates the key state.

Implements IPlatformScreen.

◆ fakeKeyUp()

bool PlatformScreen::fakeKeyUp ( KeyButton button )

overridevirtual

Fake a key release.

Synthesizes a key release event and updates the key state.

Implements IKeyState.

◆ fakeMouseButton()

void PlatformScreen::fakeMouseButton	(	ButtonID	id,
		bool	press )

overridepure virtual

Fake mouse press/release.

Synthesize a press or release of mouse button id.

Implements ISecondaryScreen.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ fakeMouseMove()

void PlatformScreen::fakeMouseMove	(	int32_t	x,
		int32_t	y )

overridepure virtual

Fake mouse move.

Synthesize a mouse move to the absolute coordinates x,y.

Implements ISecondaryScreen.

Implemented in MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ fakeMouseRelativeMove()

void PlatformScreen::fakeMouseRelativeMove	(	int32_t	dx,
		int32_t	dy ) const

overridepure virtual

Fake mouse move.

Synthesize a mouse move to the relative coordinates dx,dy.

Implements ISecondaryScreen.

Implemented in MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ fakeMouseWheel()

void PlatformScreen::fakeMouseWheel	(	int32_t	xDelta,
		int32_t	yDelta ) const

overridepure virtual

Fake mouse wheel.

Synthesize a mouse wheel event of amount xDelta and yDelta.

Implements ISecondaryScreen.

Implemented in MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ getActiveModifiers()

KeyModifierMask PlatformScreen::getActiveModifiers ( ) const

overridevirtual

Get the active modifiers.

Returns the modifiers that are currently active according to our shadowed state.

Implements IKeyState.

◆ getClipboard()

bool PlatformScreen::getClipboard	(	ClipboardID	id,
		IClipboard *	) const

overridepure virtual

Get clipboard.

Save the contents of the clipboard indicated by id and return true iff successful.

Implements IScreen.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ getCursorCenter()

void PlatformScreen::getCursorCenter	(	int32_t &	x,
		int32_t &	y ) const

overridepure virtual

Get cursor center position.

Return the cursor center position which is where we park the cursor to compute cursor motion deltas and should be far from the edges of the screen, typically the center.

Implements IPrimaryScreen.

Implemented in MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ getCursorPos()

void PlatformScreen::getCursorPos	(	int32_t &	x,
		int32_t &	y ) const

overridepure virtual

Get cursor position.

Return the current position of the cursor in x and y.

Implements IScreen.

Implemented in MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ getEventTarget()

void * PlatformScreen::getEventTarget ( ) const

overridepure virtual

Get event target.

Returns the target used for events created by this object.

Implements IScreen.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ getJumpZoneSize()

int32_t PlatformScreen::getJumpZoneSize ( ) const

overridepure virtual

Get jump zone size.

Return the jump zone size, the size of the regions on the edges of the screen that cause the cursor to jump to another screen.

Implements IPrimaryScreen.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ getKeyState()

virtual IKeyState * PlatformScreen::getKeyState ( ) const

protectedpure virtual

Get the key state.

Subclasses must implement this method to return the platform specific key state object that each subclass must have.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ getShape()

void PlatformScreen::getShape	(	int32_t &	x,
		int32_t &	y,
		int32_t &	width,
		int32_t &	height ) const

overridepure virtual

Get screen shape.

Return the position of the upper-left corner of the screen in x and y and the size of the screen in width and height.

Implements IScreen.

Implemented in MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ handleSystemEvent()

void PlatformScreen::handleSystemEvent ( const Event & event )

overrideprotectedpure virtual

Handle system event.

A platform screen is expected to install a handler for system events in its c'tor like so:

m_events->addHandler(EventTypes::System,
                      m_events->getSystemTarget(),
                      [this] (const auto &e) {handleSystemEvent(e);});

It should remove the handler in its d'tor. Override the handleSystemEvent() method to process system events. It should post the events IScreen as appropriate.

A primary screen has further responsibilities. It should post the events in IPrimaryScreen as appropriate. It should also call onKey() on its KeyState whenever a key is pressed or released (but not for key repeats). And it should call updateKeyMap() on its KeyState if necessary when the keyboard mapping changes.

The target of all events should be the value returned by getEventTarget().

Implements IPlatformScreen.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ isAnyMouseButtonDown()

bool PlatformScreen::isAnyMouseButtonDown ( uint32_t & buttonID ) const

overridepure virtual

Test if mouse is pressed.

Return true if any mouse button is currently pressed. Ideally, "current" means up to the last processed event but it can mean the current physical mouse button state.

Implements IPrimaryScreen.

Implemented in MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ isKeyDown()

bool PlatformScreen::isKeyDown ( KeyButton ) const

overridevirtual

Test if key is pressed.

Returns true iff the given key is down. Half-duplex toggles always return false.

Implements IKeyState.

◆ isPrimary()

bool PlatformScreen::isPrimary ( ) const

overridepure virtual

Test if is primary screen.

Return true iff this screen is a primary screen.

Implements IPlatformScreen.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ leave()

void PlatformScreen::leave ( )

overridepure virtual

Leave screen.

Called when the user navigates off the screen. Should be gated by canLeave().

Implements IPlatformScreen.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ mapClientScrollDirection()

int32_t PlatformScreen::mapClientScrollDirection ( int32_t x ) const

protectedvirtual

mapClientScrollDirection Convert scroll according to client scroll directio

Returns: converted value according to the client scroll direction

◆ openScreensaver()

void PlatformScreen::openScreensaver ( bool notify )

overridepure virtual

Open screen saver.

Open the screen saver. If notify is true then this object must send events when the screen saver activates or deactivates until closeScreensaver() is called. If notify is false then the screen saver is disabled and restored on closeScreensaver().

Implements IPlatformScreen.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ pollActiveGroup()

int32_t PlatformScreen::pollActiveGroup ( ) const

overridevirtual

Get the active keyboard layout from OS.

Returns the active keyboard layout according to the operating system.

Implements IKeyState.

◆ pollActiveModifiers()

KeyModifierMask PlatformScreen::pollActiveModifiers ( ) const

overridevirtual

Get the active modifiers from OS.

Returns the modifiers that are currently active according to the operating system.

Implements IKeyState.

◆ pollPressedKeys()

void PlatformScreen::pollPressedKeys ( KeyButtonSet & pressedKeys ) const

overridevirtual

Get the keys currently pressed from OS.

Adds any keys that are currently pressed according to the operating system to pressedKeys.

Implements IKeyState.

◆ reconfigure()

void PlatformScreen::reconfigure ( uint32_t activeSides )

overridepure virtual

Update configuration.

This is called when the configuration has changed. activeSides is a bitmask of DirectionMask indicating which sides of the primary screen are linked to clients. Override to handle the possible change in jump zones.

Implements IPrimaryScreen.

Implemented in MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ registerHotKey()

uint32_t PlatformScreen::registerHotKey	(	KeyID	key,
		KeyModifierMask	mask )

overridepure virtual

Register a system hotkey.

Registers a system-wide hotkey. The screen should arrange for an event to be delivered to itself when the hot key is pressed or released. When that happens the screen should post a getHotKeyDownEvent() or getHotKeyUpEvent(), respectively. The hot key is key key with exactly the modifiers mask. Returns 0 on failure otherwise an id that can be used to unregister the hotkey.

A hot key is a set of modifiers and a key, which may itself be a modifier. The hot key is pressed when the hot key's modifiers and only those modifiers are logically down (active) and the key is pressed. The hot key is released when the key is released, regardless of the modifiers.

The hot key event should be generated no matter what window or application has the focus. No other window or application should receive the key press or release events (they can and should see the modifier key events). When the key is a modifier, it's acceptable to allow the user to press the modifiers in any order or to require the user to press the given key last.

Implements IPrimaryScreen.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ resetOptions()

void PlatformScreen::resetOptions ( )

overridepure virtual

Notify of options changes.

Reset all options to their default values.

Implements IPlatformScreen.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ screensaver()

void PlatformScreen::screensaver ( bool activate )

overridepure virtual

Activate/deactivate screen saver.

Forcibly activate the screen saver if activate is true otherwise forcibly deactivate it.

Implements IPlatformScreen.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ setClipboard()

bool PlatformScreen::setClipboard	(	ClipboardID	id,
		const IClipboard *	)

overridepure virtual

Set clipboard.

Set the contents of the system clipboard indicated by id.

Implements IPlatformScreen.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ setHalfDuplexMask()

void PlatformScreen::setHalfDuplexMask ( KeyModifierMask )

overridevirtual

Set half-duplex mask.

Sets which modifier toggle keys are half-duplex. A half-duplex toggle key doesn't report a key release when toggled on and doesn't report a key press when toggled off.

Implements IKeyState.

◆ setOptions()

void PlatformScreen::setOptions ( const OptionsList & options )

overridepure virtual

Notify of options changes.

Set options to given values. Ignore unknown options and don't modify options that aren't given in options.

Implements IPlatformScreen.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ setSequenceNumber()

void PlatformScreen::setSequenceNumber ( uint32_t )

overridepure virtual

Set clipboard sequence number.

Sets the sequence number to use in subsequent clipboard events.

Implements IPlatformScreen.

Implemented in MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ sidesMaskToString()

std::string PlatformScreen::sidesMaskToString ( uint32_t sides )

staticprotected

Converts a sides mask (e.g. LeftMask | RightMask) to a string representation (e.g. "LR").

◆ unregisterHotKey()

void PlatformScreen::unregisterHotKey ( uint32_t id )

overridepure virtual

Unregister a system hotkey.

Unregisters a previously registered hot key.

Implements IPrimaryScreen.

Implemented in MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ updateButtons()

virtual void PlatformScreen::updateButtons ( )

protectedpure virtual

Update mouse buttons.

Subclasses must implement this method to update their internal mouse button mapping and, if desired, state tracking.

Implemented in deskflow::EiScreen, MSWindowsScreen, OSXScreen, and XWindowsScreen.

◆ updateKeyMap()

void PlatformScreen::updateKeyMap ( )

overridevirtual

Update the keyboard map.

Causes the key state to get updated to reflect the current keyboard mapping.

Implements IKeyState.

◆ updateKeyState()

void PlatformScreen::updateKeyState ( )

overridevirtual

Update the key state.

Causes the key state to get updated to reflect the physical keyboard state.

Implements IKeyState.

◆ warpCursor()

void PlatformScreen::warpCursor	(	int32_t	x,
		int32_t	y )

overridepure virtual

Warp cursor.

Warp the cursor to the absolute coordinates x,y. Also discard input events up to and including the warp before returning.

Implements IPrimaryScreen.

Implemented in MSWindowsScreen, OSXScreen, and XWindowsScreen.

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

src/lib/deskflow/PlatformScreen.h
src/lib/deskflow/PlatformScreen.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PlatformScreen()

◆ ~PlatformScreen()

Member Function Documentation

◆ activeSides()

◆ canLeave()

◆ checkClipboards()

◆ clearStaleModifiers()

◆ closeScreensaver()

◆ disable()

◆ enable()

◆ enter()

◆ fakeAllKeysUp()

◆ fakeCtrlAltDel()

◆ fakeInputBegin()

◆ fakeInputEnd()

◆ fakeKeyDown()

◆ fakeKeyRepeat()

◆ fakeKeyUp()

◆ fakeMouseButton()

◆ fakeMouseMove()

◆ fakeMouseRelativeMove()

◆ fakeMouseWheel()

◆ getActiveModifiers()

◆ getClipboard()

◆ getCursorCenter()

◆ getCursorPos()

◆ getEventTarget()

◆ getJumpZoneSize()

◆ getKeyState()

◆ getShape()

◆ handleSystemEvent()

◆ isAnyMouseButtonDown()

◆ isKeyDown()

◆ isPrimary()

◆ leave()

◆ mapClientScrollDirection()

◆ openScreensaver()

◆ pollActiveGroup()

◆ pollActiveModifiers()

◆ pollPressedKeys()

◆ reconfigure()

◆ registerHotKey()

◆ resetOptions()

◆ screensaver()

◆ setClipboard()

◆ setHalfDuplexMask()

◆ setOptions()

◆ setSequenceNumber()

◆ sidesMaskToString()

◆ unregisterHotKey()

◆ updateButtons()

◆ updateKeyMap()

◆ updateKeyState()

◆ warpCursor()