COSXClipboard Class Reference

OS X clipboard implementation. More...

#include <COSXClipboard.h>

Inherits IClipboard.

Collaboration diagram for COSXClipboard:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual bool empty ()
 Empty clipboard.
virtual void add (EFormat, const CString &data)
 Add data.
virtual bool open (Time) const
 Open clipboard.
virtual void close () const
 Close clipboard.
virtual Time getTime () const
 Get time.
virtual bool has (EFormat) const
 Check for data.
virtual CString get (EFormat) const
 Get data.
bool synchronize ()

Static Public Member Functions

static bool isOwnedBySynergy ()
 Test if clipboard is owned by synergy.

Detailed Description

OS X clipboard implementation.

Definition at line 25 of file COSXClipboard.h.


Member Function Documentation

void COSXClipboard::add ( EFormat  ,
const CString &  data 
) [virtual]

Add data.

Add data in the given format to the clipboard. May only be called after a successful empty().

Implements IClipboard.

Definition at line 70 of file COSXClipboard.cpp.

References IOSXClipboardConverter::fromIClipboard(), IOSXClipboardConverter::getFormat(), and IOSXClipboardConverter::getOSXFormat().

void COSXClipboard::close (  )  const [virtual]

Close clipboard.

Close the clipboard. close() must match a preceding successful open(). This signals that the clipboard has been filled with all the necessary data or all data has been read. It does not mean the clipboard ownership should be released (if it was taken).

Implements IClipboard.

Definition at line 105 of file COSXClipboard.cpp.

bool COSXClipboard::empty (  )  [virtual]

Empty clipboard.

Take ownership of the clipboard and clear all data from it. This must be called between a successful open() and close(). Return false if the clipboard ownership could not be taken; the clipboard should not be emptied in this case.

Implements IClipboard.

Definition at line 42 of file COSXClipboard.cpp.

CString COSXClipboard::get ( EFormat   )  const [virtual]

Get data.

Return the data in the given format. Returns the empty string if there is no data in that format. Must be called between a successful open() and close().

Implements IClipboard.

Definition at line 144 of file COSXClipboard.cpp.

References IOSXClipboardConverter::getFormat(), IOSXClipboardConverter::getOSXFormat(), and IOSXClipboardConverter::toIClipboard().

IClipboard::Time COSXClipboard::getTime (  )  const [virtual]

Get time.

Return the timestamp passed to the last successful open().

Implements IClipboard.

Definition at line 112 of file COSXClipboard.cpp.

bool COSXClipboard::has ( EFormat   )  const [virtual]

Check for data.

Return true iff the clipboard contains data in the given format. Must be called between a successful open() and close().

Implements IClipboard.

Definition at line 118 of file COSXClipboard.cpp.

References IOSXClipboardConverter::getFormat(), and IOSXClipboardConverter::getOSXFormat().

bool COSXClipboard::open ( Time  time  )  const [virtual]

Open clipboard.

Open the clipboard. Return true iff the clipboard could be opened. If open() returns true then the client must call close() at some later time; if it returns false then close() must not be called. time should be the current time or a time in the past when the open should effectively have taken place.

Implements IClipboard.

Definition at line 97 of file COSXClipboard.cpp.


The documentation for this class was generated from the following files:

Generated on 12 Nov 2010 for synergy-plus by  doxygen 1.6.1