InternalClipboardFormat Class Reference

This class is a very simple class which describes an internal clipboard data format. Each ClipboardMapping uses one of these to describe the type of input data they require in order to export, and thes export mappings will only be available to the clipboard if at least one node in the InternalClipboard supports output in this internal format. More...

#include <cliptype.h>

List of all members.

Public Member Functions

 InternalClipboardFormat ()
 InternalClipboardFormat (INT32 Format)
BOOL IsSameFormat (InternalClipboardFormat &OtherFormat) const \
void SetFormatID (INT32 Format)
INT32 GetFormatID (void)

Protected Attributes

INT32 FormatID


Detailed Description

This class is a very simple class which describes an internal clipboard data format. Each ClipboardMapping uses one of these to describe the type of input data they require in order to export, and thes export mappings will only be available to the clipboard if at least one node in the InternalClipboard supports output in this internal format.

Author:
Jason_Williams (Xara Group Ltd) <camelotdev@xara.com>
Date:
26/4/95
These formats are (currently): CLIPTYPE_VECTOR, CLIPTYPE_TEXT, CLIPTYPE_BITMAP.

VECTOR includes all nodes, and is always assumed to be exportable. i.e. it's an "I can always export" thing.

TEXT includes text characters only (text can be exported as paths or as unicode text). That is, an export mapping that supports Text can export text characters only, so will not be placed upon the clipboard unless there is some text somewhere on the clipboard.

BITMAP is used for exporting bitmap fills as simple bitmaps. i.e. If no bitmap fills are on the clipboard, Bitmap mappings will not be available.

See also:
ExternalClipboard; Node::SupportsClipboardFormat; ClipboardMapping

Definition at line 145 of file cliptype.h.


Constructor & Destructor Documentation

InternalClipboardFormat::InternalClipboardFormat  )  [inline]
 

Definition at line 151 of file cliptype.h.

00151 { FormatID = CLIPTYPE_NONE; }

InternalClipboardFormat::InternalClipboardFormat INT32  Format  )  [inline]
 

Definition at line 152 of file cliptype.h.

00152 { FormatID = Format; }


Member Function Documentation

INT32 InternalClipboardFormat::GetFormatID void   )  [inline]
 

Definition at line 160 of file cliptype.h.

00160 { return(FormatID); }

BOOL InternalClipboardFormat::IsSameFormat InternalClipboardFormat OtherFormat  )  const [inline]
 

Definition at line 154 of file cliptype.h.

00155                                             { return(FormatID == OtherFormat.FormatID); }

void InternalClipboardFormat::SetFormatID INT32  Format  )  [inline]
 

Definition at line 159 of file cliptype.h.

00159 { FormatID = Format; }


Member Data Documentation

INT32 InternalClipboardFormat::FormatID [protected]
 

Definition at line 164 of file cliptype.h.


The documentation for this class was generated from the following file:
Generated on Sat Nov 10 03:55:31 2007 for Camelot by  doxygen 1.4.4