211 lines
6.4 KiB
C
211 lines
6.4 KiB
C
|
/*
|
||
|
|
* synergy -- mouse and keyboard sharing utility
|
||
|
|
* Copyright (C) 2002 Chris Schoeneman
|
||
|
|
*
|
||
|
|
* This package is free software; you can redistribute it and/or
|
||
|
|
* modify it under the terms of the GNU General Public License
|
||
|
|
* found in the file COPYING that should have accompanied this file.
|
||
|
|
*
|
||
|
|
* This package is distributed in the hope that it will be useful,
|
||
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
|
* GNU General Public License for more details.
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef IPLATFORMSCREEN_H
|
||
|
|
#define IPLATFORMSCREEN_H
|
||
|
|
|
||
|
|
#include "IScreen.h"
|
||
|
|
#include "IPrimaryScreen.h"
|
||
|
|
#include "ISecondaryScreen.h"
|
||
|
|
#include "IKeyState.h"
|
||
|
|
#include "ClipboardTypes.h"
|
||
|
|
#include "OptionTypes.h"
|
||
|
|
|
||
|
|
class IClipboard;
|
||
|
|
|
||
|
|
//! Screen interface
|
||
|
|
/*!
|
||
|
|
This interface defines the methods common to all platform dependent
|
||
|
|
screen implementations that are used by both primary and secondary
|
||
|
|
screens.
|
||
|
|
*/
|
||
|
|
class IPlatformScreen : public IScreen,
|
||
|
|
public IPrimaryScreen, public ISecondaryScreen,
|
||
|
|
public IKeyState {
|
||
|
|
public:
|
||
|
|
//! @name manipulators
|
||
|
|
//@{
|
||
|
|
|
||
|
|
//! 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.
|
||
|
|
*/
|
||
|
|
virtual void enable() = 0;
|
||
|
|
|
||
|
|
//! Disable screen
|
||
|
|
/*!
|
||
|
|
Undoes the operations in enable() and events should no longer
|
||
|
|
be reported.
|
||
|
|
*/
|
||
|
|
virtual void disable() = 0;
|
||
|
|
|
||
|
|
//! Enter screen
|
||
|
|
/*!
|
||
|
|
Called when the user navigates to this screen.
|
||
|
|
*/
|
||
|
|
virtual void enter() = 0;
|
||
|
|
|
||
|
|
//! 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.
|
||
|
|
*/
|
||
|
|
virtual bool leave() = 0;
|
||
|
|
|
||
|
|
//! Set clipboard
|
||
|
|
/*!
|
||
|
|
Set the contents of the system clipboard indicated by \c id.
|
||
|
|
*/
|
||
|
|
virtual bool setClipboard(ClipboardID id, const IClipboard*) = 0;
|
||
|
|
|
||
|
|
//! 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.
|
||
|
|
*/
|
||
|
|
virtual void checkClipboards() = 0;
|
||
|
|
|
||
|
|
//! Open screen saver
|
||
|
|
/*!
|
||
|
|
Open the screen saver. If \c notify is true then this object must
|
||
|
|
send events when the screen saver activates or deactivates until
|
||
|
|
\c closeScreensaver() is called. If \c notify is false then the
|
||
|
|
screen saver is disabled and restored on \c closeScreensaver().
|
||
|
|
*/
|
||
|
|
virtual void openScreensaver(bool notify) = 0;
|
||
|
|
|
||
|
|
//! 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.
|
||
|
|
*/
|
||
|
|
virtual void closeScreensaver() = 0;
|
||
|
|
|
||
|
|
//! Activate/deactivate screen saver
|
||
|
|
/*!
|
||
|
|
Forcibly activate the screen saver if \c activate is true otherwise
|
||
|
|
forcibly deactivate it.
|
||
|
|
*/
|
||
|
|
virtual void screensaver(bool activate) = 0;
|
||
|
|
|
||
|
|
//! Notify of options changes
|
||
|
|
/*!
|
||
|
|
Reset all options to their default values.
|
||
|
|
*/
|
||
|
|
virtual void resetOptions() = 0;
|
||
|
|
|
||
|
|
//! Notify of options changes
|
||
|
|
/*!
|
||
|
|
Set options to given values. Ignore unknown options and don't
|
||
|
|
modify options that aren't given in \c options.
|
||
|
|
*/
|
||
|
|
virtual void setOptions(const COptionsList& options) = 0;
|
||
|
|
|
||
|
|
//! Set clipboard sequence number
|
||
|
|
/*!
|
||
|
|
Sets the sequence number to use in subsequent clipboard events.
|
||
|
|
*/
|
||
|
|
virtual void setSequenceNumber(UInt32) = 0;
|
||
|
|
|
||
|
|
//@}
|
||
|
|
//! @name accessors
|
||
|
|
//@{
|
||
|
|
|
||
|
|
//! Test if is primary screen
|
||
|
|
/*!
|
||
|
|
Return true iff this screen is a primary screen.
|
||
|
|
*/
|
||
|
|
virtual bool isPrimary() const = 0;
|
||
|
|
|
||
|
|
//@}
|
||
|
|
|
||
|
|
// IScreen overrides
|
||
|
|
virtual void* getEventTarget() const = 0;
|
||
|
|
virtual bool getClipboard(ClipboardID id, IClipboard*) const = 0;
|
||
|
|
virtual void getShape(SInt32& x, SInt32& y,
|
||
|
|
SInt32& width, SInt32& height) const = 0;
|
||
|
|
virtual void getCursorPos(SInt32& x, SInt32& y) const = 0;
|
||
|
|
|
||
|
|
// IPrimaryScreen overrides
|
||
|
|
virtual void reconfigure(UInt32 activeSides) = 0;
|
||
|
|
virtual void warpCursor(SInt32 x, SInt32 y) = 0;
|
||
|
|
virtual UInt32 registerHotKey(KeyID key, KeyModifierMask mask) = 0;
|
||
|
|
virtual void unregisterHotKey(UInt32 id) = 0;
|
||
|
|
virtual void fakeInputBegin() = 0;
|
||
|
|
virtual void fakeInputEnd() = 0;
|
||
|
|
virtual SInt32 getJumpZoneSize() const = 0;
|
||
|
|
virtual bool isAnyMouseButtonDown() const = 0;
|
||
|
|
virtual void getCursorCenter(SInt32& x, SInt32& y) const = 0;
|
||
|
|
|
||
|
|
// ISecondaryScreen overrides
|
||
|
|
virtual void fakeMouseButton(ButtonID id, bool press) const = 0;
|
||
|
|
virtual void fakeMouseMove(SInt32 x, SInt32 y) const = 0;
|
||
|
|
virtual void fakeMouseRelativeMove(SInt32 dx, SInt32 dy) const = 0;
|
||
|
|
virtual void fakeMouseWheel(SInt32 xDelta, SInt32 yDelta) const = 0;
|
||
|
|
|
||
|
|
// IKeyState overrides
|
||
|
|
virtual void updateKeyMap() = 0;
|
||
|
|
virtual void updateKeyState() = 0;
|
||
|
|
virtual void setHalfDuplexMask(KeyModifierMask) = 0;
|
||
|
|
virtual void fakeKeyDown(KeyID id, KeyModifierMask mask,
|
||
|
|
KeyButton button) = 0;
|
||
|
|
virtual void fakeKeyRepeat(KeyID id, KeyModifierMask mask,
|
||
|
|
SInt32 count, KeyButton button) = 0;
|
||
|
|
virtual void fakeKeyUp(KeyButton button) = 0;
|
||
|
|
virtual void fakeAllKeysUp() = 0;
|
||
|
|
virtual bool fakeCtrlAltDel() = 0;
|
||
|
|
virtual bool isKeyDown(KeyButton) const = 0;
|
||
|
|
virtual KeyModifierMask
|
||
|
|
getActiveModifiers() const = 0;
|
||
|
|
virtual KeyModifierMask
|
||
|
|
pollActiveModifiers() const = 0;
|
||
|
|
virtual SInt32 pollActiveGroup() const = 0;
|
||
|
|
virtual void pollPressedKeys(KeyButtonSet& pressedKeys) const = 0;
|
||
|
|
|
||
|
|
protected:
|
||
|
|
//! Handle system event
|
||
|
|
/*!
|
||
|
|
A platform screen is expected to install a handler for system
|
||
|
|
events in its c'tor like so:
|
||
|
|
\code
|
||
|
|
EVENTQUEUE->adoptHandler(CEvent::kSystem,
|
||
|
|
IEventQueue::getSystemTarget(),
|
||
|
|
new TMethodEventJob<CXXXPlatformScreen>(this,
|
||
|
|
&CXXXPlatformScreen::handleSystemEvent));
|
||
|
|
\endcode
|
||
|
|
It should remove the handler in its d'tor. Override the
|
||
|
|
\c handleSystemEvent() method to process system events.
|
||
|
|
It should post the events \c IScreen as appropriate.
|
||
|
|
|
||
|
|
A primary screen has further responsibilities. It should post
|
||
|
|
the events in \c IPrimaryScreen as appropriate. It should also
|
||
|
|
call \c onKey() on its \c CKeyState whenever a key is pressed
|
||
|
|
or released (but not for key repeats). And it should call
|
||
|
|
\c updateKeyMap() on its \c CKeyState if necessary when the keyboard
|
||
|
|
mapping changes.
|
||
|
|
|
||
|
|
The target of all events should be the value returned by
|
||
|
|
\c getEventTarget().
|
||
|
|
*/
|
||
|
|
virtual void handleSystemEvent(const CEvent& event, void*) = 0;
|
||
|
|
};
|
||
|
|
|
||
|
|
#endif
|