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

CServerTaskBarReceiver Class Reference

Implementation of IArchTaskBarReceiver for the synergy server. More...

#include <CServerTaskBarReceiver.h>

Inherits IArchTaskBarReceiver.

Inherited by CMSWindowsServerTaskBarReceiver, COSXServerTaskBarReceiver, and CXWindowsServerTaskBarReceiver.

Inheritance diagram for CServerTaskBarReceiver:

Inheritance graph
[legend]
Collaboration diagram for CServerTaskBarReceiver:

Collaboration graph
[legend]
List of all members.

Public Member Functions

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

Protected Types

typedef std::vector< CString > CClients
enum  EState {
  kNotRunning, kNotWorking, kNotConnected, kConnected,
  kMaxState
}

Protected Member Functions

EState getStatus () const
 Get status.
const CString & getErrorMessage () const
 Get error message.
const CClients & getClients () const
 Get connected clients.
void quit ()
 Quit app.
virtual void onStatusChanged (CServer *server)
 Status change notification.

Detailed Description

Implementation of IArchTaskBarReceiver for the synergy server.

Definition at line 25 of file CServerTaskBarReceiver.h.


Member Function Documentation

virtual const Icon CServerTaskBarReceiver::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.

Implements IArchTaskBarReceiver.

Implemented in CMSWindowsServerTaskBarReceiver, COSXServerTaskBarReceiver, and CXWindowsServerTaskBarReceiver.

std::string CServerTaskBarReceiver::getToolTip  )  const [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.

Implements IArchTaskBarReceiver.

Definition at line 114 of file CServerTaskBarReceiver.cpp.

References CStringUtil::print().

Referenced by CMSWindowsServerTaskBarReceiver::showStatus().

void CServerTaskBarReceiver::lock  )  const [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.

Implements IArchTaskBarReceiver.

Definition at line 102 of file CServerTaskBarReceiver.cpp.

Referenced by CMSWindowsServerTaskBarReceiver::showStatus().

void CServerTaskBarReceiver::onStatusChanged CServer server  )  [protected, virtual]
 

Status change notification.

Called when status changes. The default implementation does nothing.

Definition at line 96 of file CServerTaskBarReceiver.cpp.

Referenced by updateStatus().

virtual void CServerTaskBarReceiver::primaryAction  )  [pure virtual]
 

Perform primary action.

Perform the primary (default) action.

Implements IArchTaskBarReceiver.

Implemented in CMSWindowsServerTaskBarReceiver, COSXServerTaskBarReceiver, and CXWindowsServerTaskBarReceiver.

void CServerTaskBarReceiver::quit  )  [protected]
 

Quit app.

Causes the application to quit gracefully

Definition at line 90 of file CServerTaskBarReceiver.cpp.

Referenced by CMSWindowsServerTaskBarReceiver::runMenu().

virtual void CServerTaskBarReceiver::runMenu int  x,
int  y
[pure virtual]
 

Popup menu.

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

Implements IArchTaskBarReceiver.

Implemented in CMSWindowsServerTaskBarReceiver, COSXServerTaskBarReceiver, and CXWindowsServerTaskBarReceiver.

virtual void CServerTaskBarReceiver::showStatus  )  [pure virtual]
 

Show status window.

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

Implements IArchTaskBarReceiver.

Implemented in CMSWindowsServerTaskBarReceiver, COSXServerTaskBarReceiver, and CXWindowsServerTaskBarReceiver.

void CServerTaskBarReceiver::updateStatus CServer ,
const CString &  errorMsg
 

Update status.

Determine the status and query required information from the server.

Definition at line 39 of file CServerTaskBarReceiver.cpp.

References CServer::getClients(), and onStatusChanged().


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