barrier/synergy/IPrimaryScreen.h

94 lines
3.2 KiB
C
Raw Normal View History

2001-10-06 14:13:28 +00:00
#ifndef IPRIMARYSCREEN_H
#define IPRIMARYSCREEN_H
#include "IInterface.h"
#include "KeyTypes.h"
#include "ClipboardTypes.h"
2001-10-06 14:13:28 +00:00
class CServer;
class IClipboard;
2001-10-06 14:13:28 +00:00
class IPrimaryScreen : public IInterface {
2002-04-29 14:40:01 +00:00
public:
2001-10-06 14:13:28 +00:00
// manipulators
// enter the screen's message loop. this returns when it detects
// the application should terminate or when stop() is called.
// the screen must be open()'d before run() and must not be
// close()'d until run() returns.
virtual void run() = 0;
// cause run() to return
virtual void stop() = 0;
2001-10-06 14:13:28 +00:00
// initialize the screen and start reporting events to the server.
// events should be reported no matter where on the screen they
// occur but do not interfere with normal event dispatch. the
// screen saver engaging should be reported as an event. if that
// can't be detected then this object should disable the system's
// screen saver timer and should start the screen saver after
// idling for an appropriate time.
//
// open() must call server->setInfo() to notify the server of the
// primary screen's resolution and jump zone size. the mouse
// position is ignored and may be 0,0.
virtual void open(CServer* server) = 0;
2001-10-06 14:13:28 +00:00
// close the screen. should restore the screen saver timer if it
// was disabled.
virtual void close() = 0;
// called when the user navigates back to the primary screen.
// warp the cursor to the given coordinates, unhide it, and
// ungrab the input devices. every call to enter has a matching
// call to leave() which preceeds it, however the screen can
// assume an implicit call to enter() in the call to open().
2001-10-06 14:13:28 +00:00
virtual void enter(SInt32 xAbsolute, SInt32 yAbsolute) = 0;
// called when the user navigates off the primary screen. hide
// the cursor and grab exclusive access to the input devices.
// return true iff successful.
virtual bool leave() = 0;
2001-10-06 14:13:28 +00:00
// called when the configuration has changed. subclasses may need
// to adjust things (like the jump zones) after the configuration
// changes.
virtual void onConfigure() = 0;
2001-10-06 14:13:28 +00:00
// warp the cursor to the given position
virtual void warpCursor(SInt32 xAbsolute, SInt32 yAbsolute) = 0;
// set the screen's clipboard contents. this is usually called
// soon after an enter().
virtual void setClipboard(ClipboardID, const IClipboard*) = 0;
2001-10-06 14:13:28 +00:00
// synergy should own the clipboard
virtual void grabClipboard(ClipboardID) = 0;
2001-10-06 14:13:28 +00:00
// accessors
// get the screen region
virtual void getShape(SInt32& x, SInt32& y,
SInt32& width, SInt32& height) const = 0;
2001-10-06 14:13:28 +00:00
// get the size of jump zone
virtual SInt32 getJumpZoneSize() const = 0;
// get the screen's clipboard contents. the implementation can
// and should avoid setting the clipboard object if the screen's
// clipboard hasn't changed.
virtual void getClipboard(ClipboardID, IClipboard*) const = 0;
// get the primary screen's current toggle modifier key state.
// the returned mask should have the corresponding bit set for
// each toggle key that is active.
virtual KeyModifierMask getToggleMask() const = 0;
// return true if any key or button is being pressed or if there's
// any other reason that the user should not be allowed to switch
// screens.
virtual bool isLockedToScreen() const = 0;
2001-10-06 14:13:28 +00:00
};
#endif