barrier/client/ISecondaryScreen.h

83 lines
2.6 KiB
C
Raw Normal View History

2001-10-06 14:13:28 +00:00
#ifndef ISECONDARYSCREEN_H
#define ISECONDARYSCREEN_H
#include "IInterface.h"
#include "ClipboardTypes.h"
#include "KeyTypes.h"
#include "MouseTypes.h"
2001-10-06 14:13:28 +00:00
class IClipboard;
2001-10-06 14:13:28 +00:00
class ISecondaryScreen : 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, hide the cursor, and disable the screen
2002-07-10 21:22:28 +00:00
// saver. start reporting events to the IScreenReceiver (which is
// set through some other interface).
virtual void open() = 0;
2001-10-06 14:13:28 +00:00
// close the screen. should restore the screen saver. it should
// also simulate key up events for any keys that have simulate key
// down events without a matching key up. without this the client
// will leave its keyboard in the wrong logical state.
2001-10-06 14:13:28 +00:00
virtual void close() = 0;
// called when the user navigates to the secondary screen. warp
// the cursor to the given coordinates and unhide it. prepare to
// simulate input events.
virtual void enter(SInt32 xAbsolute, SInt32 yAbsolute,
KeyModifierMask mask) = 0;
2001-10-06 14:13:28 +00:00
// called when the user navigates off the secondary screen. clean
// up input event simulation and hide the cursor.
virtual void leave() = 0;
// keyboard input simulation
virtual void keyDown(KeyID, KeyModifierMask) = 0;
virtual void keyRepeat(KeyID, KeyModifierMask, SInt32 count) = 0;
virtual void keyUp(KeyID, KeyModifierMask) = 0;
2001-10-06 14:13:28 +00:00
// mouse input simulation
virtual void mouseDown(ButtonID) = 0;
virtual void mouseUp(ButtonID) = 0;
virtual void mouseMove(SInt32 xAbsolute, SInt32 yAbsolute) = 0;
virtual void mouseWheel(SInt32 delta) = 0;
2001-10-06 14:13:28 +00:00
// 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
// take ownership of clipboard
virtual void grabClipboard(ClipboardID) = 0;
// activate or deactivate the screen saver
virtual void screenSaver(bool activate) = 0;
2001-10-06 14:13:28 +00:00
// accessors
// get the position of the mouse on the screen
virtual void getMousePos(SInt32& x, SInt32& y) const = 0;
2001-10-06 14:13:28 +00:00
// get the size of the screen
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
virtual void getClipboard(ClipboardID, IClipboard*) const = 0;
2001-10-06 14:13:28 +00:00
};
#endif