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

CClipboard Class Reference

Memory buffer clipboard. More...

#include <CClipboard.h>

Inherits IClipboard.

Inheritance diagram for CClipboard:

Inheritance graph
[legend]
Collaboration diagram for CClipboard:

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.
manipulators
void unmarshall (const CString &data, Time time)
 Unmarshall clipboard data.
accessors
CString marshall () const
 Marshall clipboard data.

Detailed Description

Memory buffer clipboard.

This class implements a clipboard that stores data in memory.

Definition at line 24 of file CClipboard.h.


Member Function Documentation

void CClipboard::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 56 of file CClipboard.cpp.

void CClipboard::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 77 of file CClipboard.cpp.

bool CClipboard::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 36 of file CClipboard.cpp.

CString CClipboard::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 98 of file CClipboard.cpp.

CClipboard::Time CClipboard::getTime  )  const [virtual]
 

Get time.

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

Implements IClipboard.

Definition at line 85 of file CClipboard.cpp.

bool CClipboard::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 91 of file CClipboard.cpp.

CString CClipboard::marshall  )  const
 

Marshall clipboard data.

Merge this clipboard's data into a single buffer that can be later unmarshalled to restore the clipboard and return the buffer.

Definition at line 111 of file CClipboard.cpp.

References IClipboard::marshall().

bool CClipboard::open 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 66 of file CClipboard.cpp.

void CClipboard::unmarshall const CString &  data,
Time  time
 

Unmarshall clipboard data.

Extract marshalled clipboard data and store it in this clipboard. Sets the clipboard time to time.

Definition at line 105 of file CClipboard.cpp.

References IClipboard::unmarshall().


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