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

IScreen Class Reference

Screen interface. More...

#include <IScreen.h>

Inherits IInterface.

Inherited by CScreen, IClient, and IPlatformScreen.

Inheritance diagram for IScreen:

Inheritance graph
[legend]
Collaboration diagram for IScreen:

Collaboration graph
[legend]
List of all members.

accessors

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.
CEvent::Type getErrorEvent ()
 Get error event type.
CEvent::Type getShapeChangedEvent ()
 Get shape changed event type.
CEvent::Type getClipboardGrabbedEvent ()
 Get clipboard grabbed event type.
CEvent::Type getSuspendEvent ()
 Get suspend event type.
CEvent::Type getResumeEvent ()
 Get resume event type.

Detailed Description

Screen interface.

This interface defines the methods common to all screens.

Definition at line 28 of file IScreen.h.


Member Function Documentation

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

Get clipboard.

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

Implemented in CClient, CMSWindowsScreen, COSXScreen, CXWindowsScreen, CBaseClientProxy, CClientProxy, CClientProxy1_0, CPrimaryClient, CPlatformScreen, CScreen, IClient, and IPlatformScreen.

CEvent::Type IScreen::getClipboardGrabbedEvent  )  [static]
 

Get clipboard grabbed event type.

Returns the clipboard grabbed event type. This is sent whenever the clipboard is grabbed by some other application so we don't own it anymore. The data is a pointer to a CClipboardInfo.

Definition at line 42 of file IScreen.cpp.

References CEvent::registerTypeOnce().

Referenced by COSXScreen::checkClipboards(), CMSWindowsScreen::checkClipboards(), and CXWindowsScreen::handleSystemEvent().

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

Get cursor position.

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

Implemented in CClient, CMSWindowsScreen, COSXScreen, CXWindowsScreen, CBaseClientProxy, CClientProxy, CClientProxy1_0, CPrimaryClient, CPlatformScreen, CScreen, IClient, and IPlatformScreen.

CEvent::Type IScreen::getErrorEvent  )  [static]
 

Get error event type.

Returns the error event type. This is sent whenever the screen has failed for some reason (e.g. the X Windows server died).

Definition at line 28 of file IScreen.cpp.

References CEvent::registerTypeOnce().

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

Get event target.

Returns the target used for events created by this object.

Implemented in CClient, CMSWindowsScreen, COSXScreen, CXWindowsScreen, CBaseClientProxy, CClientProxy, CPrimaryClient, CPlatformScreen, CScreen, IClient, and IPlatformScreen.

CEvent::Type IScreen::getResumeEvent  )  [static]
 

Get resume event type.

Returns the suspend event type. This is sent whenever the system wakes up or a user session is activated (fast user switching).

Definition at line 56 of file IScreen.cpp.

References CEvent::registerTypeOnce().

virtual void IScreen::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.

Implemented in CClient, CMSWindowsScreen, COSXScreen, CXWindowsScreen, CBaseClientProxy, CClientProxy, CClientProxy1_0, CPrimaryClient, CPlatformScreen, CScreen, IClient, and IPlatformScreen.

CEvent::Type IScreen::getShapeChangedEvent  )  [static]
 

Get shape changed event type.

Returns the shape changed event type. This is sent whenever the screen's shape changes.

Definition at line 35 of file IScreen.cpp.

References CEvent::registerTypeOnce().

CEvent::Type IScreen::getSuspendEvent  )  [static]
 

Get suspend event type.

Returns the suspend event type. This is sent whenever the system goes to sleep or a user session is deactivated (fast user switching).

Definition at line 49 of file IScreen.cpp.

References CEvent::registerTypeOnce().


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