IArchTaskBarReceiver Class Reference

Interface for architecture dependent task bar event handling. More...

#include <IArchTaskBarReceiver.h>

Inherits IInterface.

Inherited by CClientTaskBarReceiver, and CServerTaskBarReceiver.

Inheritance diagram for IArchTaskBarReceiver:

Inheritance graph
[legend]
Collaboration diagram for IArchTaskBarReceiver:

Collaboration graph
[legend]
List of all members.

Public Types

typedef void * Icon

Public Member Functions

manipulators
virtual void showStatus ()=0
 Show status window.
virtual void runMenu (int x, int y)=0
 Popup menu.
virtual void primaryAction ()=0
 Perform primary action.
accessors
virtual void lock () const =0
 Lock receiver.
virtual void unlock () const =0
 Unlock receiver.
virtual const Icon getIcon () const =0
 Get icon.
virtual std::string getToolTip () const =0
 Get tooltip.

Detailed Description

Interface for architecture dependent task bar event handling.

This interface defines the task bar icon event handlers required by synergy. Each architecture must implement this interface though each operation can be a no-op.

Definition at line 27 of file IArchTaskBarReceiver.h.


Member Function Documentation

virtual const Icon IArchTaskBarReceiver::getIcon (  )  const [pure virtual]

Get icon.

Returns the icon to display in the task bar. The interface to set the icon is left to subclasses. Getting and setting the icon must be thread safe.

Implemented in CClientTaskBarReceiver, CMSWindowsClientTaskBarReceiver, COSXClientTaskBarReceiver, CXWindowsClientTaskBarReceiver, CMSWindowsServerTaskBarReceiver, COSXServerTaskBarReceiver, CServerTaskBarReceiver, and CXWindowsServerTaskBarReceiver.

virtual std::string IArchTaskBarReceiver::getToolTip (  )  const [pure virtual]

Get tooltip.

Returns the tool tip to display in the task bar. The interface to set the tooltip is left to sublclasses. Getting and setting the icon must be thread safe.

Implemented in CClientTaskBarReceiver, and CServerTaskBarReceiver.

virtual void IArchTaskBarReceiver::lock (  )  const [pure virtual]

Lock receiver.

Locks the receiver from changing state. The receiver should be locked when querying it's state to ensure consistent results. Each call to lock() must have a matching unlock() and locks cannot be nested.

Implemented in CClientTaskBarReceiver, and CServerTaskBarReceiver.

virtual void IArchTaskBarReceiver::primaryAction (  )  [pure virtual]

Perform primary action.

Perform the primary (default) action.

Implemented in CClientTaskBarReceiver, CMSWindowsClientTaskBarReceiver, COSXClientTaskBarReceiver, CXWindowsClientTaskBarReceiver, CMSWindowsServerTaskBarReceiver, COSXServerTaskBarReceiver, CServerTaskBarReceiver, and CXWindowsServerTaskBarReceiver.

virtual void IArchTaskBarReceiver::runMenu ( int  x,
int  y 
) [pure virtual]

Popup menu.

Popup a menu of operations at or around x,y and perform the chosen operation.

Implemented in CClientTaskBarReceiver, CMSWindowsClientTaskBarReceiver, COSXClientTaskBarReceiver, CXWindowsClientTaskBarReceiver, CMSWindowsServerTaskBarReceiver, COSXServerTaskBarReceiver, CServerTaskBarReceiver, and CXWindowsServerTaskBarReceiver.

virtual void IArchTaskBarReceiver::showStatus (  )  [pure virtual]

Show status window.

Open a window displaying current status. This should return immediately without waiting for the window to be closed.

Implemented in CClientTaskBarReceiver, CMSWindowsClientTaskBarReceiver, COSXClientTaskBarReceiver, CXWindowsClientTaskBarReceiver, CMSWindowsServerTaskBarReceiver, COSXServerTaskBarReceiver, CServerTaskBarReceiver, and CXWindowsServerTaskBarReceiver.


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