smjg.libs.sdwf.clipboarddata.ClipboardData Interface Reference

Data that may be copied to the clipboard. More...

List of all members.

Public Member Functions

HANDLE clipboardDataHandle (CLIPBOARD_FORMAT format, bool clearAutoDelete=true)
 Returns a data handle that can be used to copy the data onto the clipboard.


Detailed Description

Data that may be copied to the clipboard.

The ClipboardData interface is implemented by classes representing data that may be copied to the clipboard.

Since:
0.3

Member Function Documentation

HANDLE smjg.libs.sdwf.clipboarddata.ClipboardData.clipboardDataHandle ( CLIPBOARD_FORMAT  format,
bool  clearAutoDelete = true 
)

Returns a data handle that can be used to copy the data onto the clipboard.

Parameters:
format the format in which the data will be copied. This may be used by an implementing class to select a data format in order to prepare the data for the clipboard. An assert statement should be used to check that the format is valid for this object.
clearAutoDelete whether the object should be prevented from deleting the associated Windows handle when it is garbage-collected. This will be set unless the format is in the application-private range.
Returns:
a handle to a clipboard data object, as specified in the Windows API for the clipboard data format.


The documentation for this interface was generated from the following file:
Generated on Sun Jan 11 21:54:10 2009 for Stewart's D Windows Framework by  doxygen 1.5.4