Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members

IPlatformScreen Class Reference

Screen interface. More...

#include <IPlatformScreen.h>

Inherits IScreen, IPrimaryScreen, ISecondaryScreen, and IKeyState.

Inherited by CPlatformScreen.

Inheritance diagram for IPlatformScreen:

Inheritance graph
[legend]
Collaboration diagram for IPlatformScreen:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual void * getEventTarget () const =0
 Get event target.
virtual bool getClipboard (ClipboardID id, IClipboard *) const =0
 Get clipboard.
virtual void getShape (SInt32 &x, SInt32 &y, SInt32 &width, SInt32 &height) const =0
 Get screen shape.
virtual void getCursorPos (SInt32 &x, SInt32 &y) const =0
 Get cursor position.
virtual void reconfigure (UInt32 activeSides)=0
 Update configuration.
virtual void warpCursor (SInt32 x, SInt32 y)=0
 Warp cursor.
virtual UInt32 registerHotKey (KeyID key, KeyModifierMask mask)=0
 Register a system hotkey.
virtual void unregisterHotKey (UInt32 id)=0
 Unregister a system hotkey.
virtual void fakeInputBegin ()=0
 Prepare to synthesize input on primary screen.
virtual void fakeInputEnd ()=0
 Done synthesizing input on primary screen.
virtual SInt32 getJumpZoneSize () const =0
 Get jump zone size.
virtual bool isAnyMouseButtonDown () const =0
 Test if mouse is pressed.
virtual void getCursorCenter (SInt32 &x, SInt32 &y) const =0
 Get cursor center position.
virtual void fakeMouseButton (ButtonID id, bool press) const =0
 Fake mouse press/release.
virtual void fakeMouseMove (SInt32 x, SInt32 y) const =0
 Fake mouse move.
virtual void fakeMouseRelativeMove (SInt32 dx, SInt32 dy) const =0
 Fake mouse move.
virtual void fakeMouseWheel (SInt32 xDelta, SInt32 yDelta) const =0
 Fake mouse wheel.
virtual void updateKeyMap ()=0
 Update the keyboard map.
virtual void updateKeyState ()=0
 Update the key state.
virtual void setHalfDuplexMask (KeyModifierMask)=0
 Set half-duplex mask.
virtual void fakeKeyDown (KeyID id, KeyModifierMask mask, KeyButton button)=0
 Fake a key press.
virtual void fakeKeyRepeat (KeyID id, KeyModifierMask mask, SInt32 count, KeyButton button)=0
 Fake a key repeat.
virtual void fakeKeyUp (KeyButton button)=0
 Fake a key release.
virtual void fakeAllKeysUp ()=0
 Fake key releases for all fake pressed keys.
virtual bool fakeCtrlAltDel ()=0
 Fake ctrl+alt+del.
virtual bool isKeyDown (KeyButton) const =0
 Test if key is pressed.
virtual KeyModifierMask getActiveModifiers () const =0
 Get the active modifiers.
virtual KeyModifierMask pollActiveModifiers () const =0
 Get the active modifiers from OS.
virtual SInt32 pollActiveGroup () const =0
 Get the active keyboard layout from OS.
virtual void pollPressedKeys (KeyButtonSet &pressedKeys) const =0
 Get the keys currently pressed from OS.
manipulators
virtual void enable ()=0
 Enable screen.
virtual void disable ()=0
 Disable screen.
virtual void enter ()=0
 Enter screen.
virtual bool leave ()=0
 Leave screen.
virtual bool setClipboard (ClipboardID id, const IClipboard *)=0
 Set clipboard.
virtual void checkClipboards ()=0
 Check clipboard owner.
virtual void openScreensaver (bool notify)=0
 Open screen saver.
virtual void closeScreensaver ()=0
 Close screen saver.
virtual void screensaver (bool activate)=0
 Activate/deactivate screen saver.
virtual void resetOptions ()=0
 Notify of options changes.
virtual void setOptions (const COptionsList &options)=0
 Notify of options changes.
virtual void setSequenceNumber (UInt32)=0
 Set clipboard sequence number.
accessors
virtual bool isPrimary () const =0
 Test if is primary screen.

Protected Member Functions

virtual void handleSystemEvent (const CEvent &event, void *)=0
 Handle system event.

Detailed Description

Screen interface.

This interface defines the methods common to all platform dependent screen implementations that are used by both primary and secondary screens.

Definition at line 33 of file IPlatformScreen.h.


Member Function Documentation

virtual void IPlatformScreen::checkClipboards  )  [pure 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.

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::leave().

virtual void IPlatformScreen::closeScreensaver  )  [pure 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.

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::setOptions().

virtual void IPlatformScreen::disable  )  [pure virtual]
 

Disable screen.

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

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::disable().

virtual void IPlatformScreen::enable  )  [pure 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.

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::enable().

virtual void IPlatformScreen::enter  )  [pure virtual]
 

Enter screen.

Called when the user navigates to this screen.

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::enter().

virtual void IPlatformScreen::fakeAllKeysUp  )  [pure virtual]
 

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.

Implemented in CMSWindowsScreen, and CPlatformScreen.

virtual bool IPlatformScreen::fakeCtrlAltDel  )  [pure virtual]
 

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.

Implemented in CPlatformScreen.

Referenced by CScreen::keyDown().

virtual void IPlatformScreen::fakeInputBegin  )  [pure 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 CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::fakeInputBegin().

virtual void IPlatformScreen::fakeInputEnd  )  [pure virtual]
 

Done synthesizing input on primary screen.

Undoes whatever fakeInputBegin() did.

Implements IPrimaryScreen.

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::fakeInputEnd().

virtual void IPlatformScreen::fakeKeyDown KeyID  id,
KeyModifierMask  mask,
KeyButton  button
[pure virtual]
 

Fake a key press.

Synthesizes a key press event and updates the key state.

Implements IKeyState.

Implemented in CMSWindowsScreen, and CPlatformScreen.

Referenced by CScreen::keyDown().

virtual void IPlatformScreen::fakeKeyRepeat KeyID  id,
KeyModifierMask  mask,
SInt32  count,
KeyButton  button
[pure virtual]
 

Fake a key repeat.

Synthesizes a key repeat event and updates the key state.

Implements IKeyState.

Implemented in CMSWindowsScreen, and CPlatformScreen.

Referenced by CScreen::keyRepeat().

virtual void IPlatformScreen::fakeKeyUp KeyButton  button  )  [pure virtual]
 

Fake a key release.

Synthesizes a key release event and updates the key state.

Implements IKeyState.

Implemented in CMSWindowsScreen, and CPlatformScreen.

Referenced by CScreen::keyUp().

virtual void IPlatformScreen::fakeMouseButton ButtonID  id,
bool  press
const [pure virtual]
 

Fake mouse press/release.

Synthesize a press or release of mouse button id.

Implements ISecondaryScreen.

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::mouseDown(), and CScreen::mouseUp().

virtual void IPlatformScreen::fakeMouseMove SInt32  x,
SInt32  y
const [pure virtual]
 

Fake mouse move.

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

Implements ISecondaryScreen.

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::mouseMove().

virtual void IPlatformScreen::fakeMouseRelativeMove SInt32  dx,
SInt32  dy
const [pure virtual]
 

Fake mouse move.

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

Implements ISecondaryScreen.

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::mouseRelativeMove().

virtual void IPlatformScreen::fakeMouseWheel SInt32  xDelta,
SInt32  yDelta
const [pure virtual]
 

Fake mouse wheel.

Synthesize a mouse wheel event of amount xDelta and yDelta.

Implements ISecondaryScreen.

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::mouseWheel().

virtual KeyModifierMask IPlatformScreen::getActiveModifiers  )  const [pure virtual]
 

Get the active modifiers.

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

Implements IKeyState.

Implemented in CPlatformScreen.

Referenced by CScreen::getActiveModifiers().

virtual bool IPlatformScreen::getClipboard ClipboardID  id,
IClipboard
const [pure virtual]
 

Get clipboard.

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

Implements IScreen.

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::getClipboard().

virtual void IPlatformScreen::getCursorCenter SInt32 &  x,
SInt32 &  y
const [pure 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 CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::getCursorCenter().

virtual void IPlatformScreen::getCursorPos SInt32 &  x,
SInt32 &  y
const [pure virtual]
 

Get cursor position.

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

Implements IScreen.

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::getCursorPos().

virtual void* IPlatformScreen::getEventTarget  )  const [pure virtual]
 

Get event target.

Returns the target used for events created by this object.

Implements IScreen.

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

virtual SInt32 IPlatformScreen::getJumpZoneSize  )  const [pure 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 CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::getJumpZoneSize().

virtual void IPlatformScreen::getShape SInt32 &  x,
SInt32 &  y,
SInt32 &  width,
SInt32 &  height
const [pure 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 CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::getShape().

virtual void IPlatformScreen::handleSystemEvent const CEvent event,
void * 
[protected, pure virtual]
 

Handle system event.

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

    EVENTQUEUE->adoptHandler(CEvent::kSystem,
                         IEventQueue::getSystemTarget(),
                         new TMethodEventJob<CXXXPlatformScreen>(this,
                             &CXXXPlatformScreen::handleSystemEvent));
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 CKeyState whenever a key is pressed or released (but not for key repeats). And it should call updateKeyMap() on its CKeyState if necessary when the keyboard mapping changes.

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

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

virtual bool IPlatformScreen::isAnyMouseButtonDown  )  const [pure 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 CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::isLockedToScreen().

virtual bool IPlatformScreen::isKeyDown KeyButton   )  const [pure virtual]
 

Test if key is pressed.

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

Implements IKeyState.

Implemented in CPlatformScreen.

virtual bool IPlatformScreen::isPrimary  )  const [pure virtual]
 

Test if is primary screen.

Return true iff this screen is a primary screen.

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

virtual bool IPlatformScreen::leave  )  [pure virtual]
 

Leave screen.

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

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::leave().

virtual void IPlatformScreen::openScreensaver bool  notify  )  [pure 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().

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::resetOptions(), and CScreen::setOptions().

virtual SInt32 IPlatformScreen::pollActiveGroup  )  const [pure virtual]
 

Get the active keyboard layout from OS.

Returns the active keyboard layout according to the operating system.

Implements IKeyState.

Implemented in CPlatformScreen.

virtual KeyModifierMask IPlatformScreen::pollActiveModifiers  )  const [pure virtual]
 

Get the active modifiers from OS.

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

Implements IKeyState.

Implemented in CPlatformScreen.

Referenced by CScreen::pollActiveModifiers().

virtual void IPlatformScreen::pollPressedKeys KeyButtonSet &  pressedKeys  )  const [pure virtual]
 

Get the keys currently pressed from OS.

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

Implements IKeyState.

Implemented in CPlatformScreen.

virtual void IPlatformScreen::reconfigure UInt32  activeSides  )  [pure virtual]
 

Update configuration.

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

Implements IPrimaryScreen.

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::reconfigure().

virtual UInt32 IPlatformScreen::registerHotKey KeyID  key,
KeyModifierMask  mask
[pure 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 CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::registerHotKey().

virtual void IPlatformScreen::resetOptions  )  [pure virtual]
 

Notify of options changes.

Reset all options to their default values.

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::resetOptions().

virtual void IPlatformScreen::screensaver bool  activate  )  [pure virtual]
 

Activate/deactivate screen saver.

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

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::screensaver().

virtual bool IPlatformScreen::setClipboard ClipboardID  id,
const IClipboard
[pure virtual]
 

Set clipboard.

Set the contents of the system clipboard indicated by id.

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::grabClipboard(), and CScreen::setClipboard().

virtual void IPlatformScreen::setHalfDuplexMask KeyModifierMask   )  [pure virtual]
 

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.

Implemented in CPlatformScreen.

Referenced by CScreen::setOptions().

virtual void IPlatformScreen::setOptions const COptionsList &  options  )  [pure virtual]
 

Notify of options changes.

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

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::setOptions().

virtual void IPlatformScreen::setSequenceNumber UInt32   )  [pure virtual]
 

Set clipboard sequence number.

Sets the sequence number to use in subsequent clipboard events.

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::setSequenceNumber().

virtual void IPlatformScreen::unregisterHotKey UInt32  id  )  [pure virtual]
 

Unregister a system hotkey.

Unregisters a previously registered hot key.

Implements IPrimaryScreen.

Implemented in CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::unregisterHotKey().

virtual void IPlatformScreen::updateKeyMap  )  [pure virtual]
 

Update the keyboard map.

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

Implements IKeyState.

Implemented in CPlatformScreen.

Referenced by CScreen::enable().

virtual void IPlatformScreen::updateKeyState  )  [pure virtual]
 

Update the key state.

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

Implements IKeyState.

Implemented in CPlatformScreen.

Referenced by CScreen::enable().

virtual void IPlatformScreen::warpCursor SInt32  x,
SInt32  y
[pure 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 CMSWindowsScreen, COSXScreen, CXWindowsScreen, and CPlatformScreen.

Referenced by CScreen::warpCursor().


The documentation for this class was generated from the following file:
Generated on Fri Nov 6 00:21:37 2009 for synergy-plus by  doxygen 1.3.9.1