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

IArchConsole Class Reference

Interface for architecture dependent console output. More...

#include <IArchConsole.h>

Inherits IInterface.

Inherited by CArch, CArchConsoleUnix, and CArchConsoleWindows.

Inheritance diagram for IArchConsole:

Inheritance graph
[legend]
Collaboration diagram for IArchConsole:

Collaboration graph
[legend]
List of all members.

Public Member Functions

manipulators
virtual void openConsole (const char *title)=0
 Open the console.
virtual void closeConsole ()=0
 Close the console.
virtual void showConsole (bool showIfEmpty)=0
 Show the console.
virtual void writeConsole (const char *)=0
 Write to the console.
virtual const char * getNewlineForConsole ()=0
 Returns the newline sequence for the console.

Detailed Description

Interface for architecture dependent console output.

This interface defines the console operations required by synergy. Each architecture must implement this interface.

Definition at line 25 of file IArchConsole.h.


Member Function Documentation

virtual void IArchConsole::closeConsole  )  [pure virtual]
 

Close the console.

Close the console. Calling this method on an already closed console must have no effect.

Implemented in CArch, CArchConsoleUnix, and CArchConsoleWindows.

Referenced by CArch::closeConsole().

virtual const char* IArchConsole::getNewlineForConsole  )  [pure virtual]
 

Returns the newline sequence for the console.

Different consoles use different character sequences for newlines. This method returns the appropriate newline sequence for the console.

Implemented in CArch, CArchConsoleUnix, and CArchConsoleWindows.

Referenced by CArch::getNewlineForConsole().

virtual void IArchConsole::openConsole const char *  title  )  [pure virtual]
 

Open the console.

Opens the console for writing. The console is opened automatically on the first write so calling this method is optional. Uses title for the console's title if appropriate for the architecture. Calling this method on an already open console must have no effect.

Implemented in CArch, CArchConsoleUnix, and CArchConsoleWindows.

Referenced by CArch::openConsole().

virtual void IArchConsole::showConsole bool  showIfEmpty  )  [pure virtual]
 

Show the console.

Causes the console to become visible. This generally only makes sense for a console in a graphical user interface. Other implementations will do nothing. Iff showIfEmpty is false then the implementation may optionally only show the console if it's not empty.

Implemented in CArch, CArchConsoleUnix, and CArchConsoleWindows.

Referenced by CArch::showConsole().

virtual void IArchConsole::writeConsole const char *   )  [pure virtual]
 

Write to the console.

Writes the given string to the console, opening it if necessary.

Implemented in CArch, CArchConsoleUnix, and CArchConsoleWindows.

Referenced by CArch::writeConsole().


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