Class CClipboard

class CClipboard : public CBase;

Description

Clipboard. A repository of copied data which is available for pasting. The clipboard storage drive is defined in the HAL layer, in HALData::EClipboardDrive.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CClipboard - Clipboard. A repository of copied data which is available for pasting. The clipb...

Members

Defined in CClipboard:

• Clear(RFs &)Empties the clipboard.
• ClipboardFileDrive()Returns the clipboad file drive information stored in the TLS
• CommitL()Commits changes to the clipboard's store.
• CopyToL(TReal)Copies a double-precision floating point value to the clipboard.
• NewForReadingL(RFs &)Constructs a clipboard object and prepares the clipboard's store for reading.
• NewForReadingLC(RFs &)Constructs a clipboard object and prepares the clipboard's store for reading, pl...
• NewForWritingLC(RFs &)Constructs a clipboard object and prepares the clipboard's store for writing.
• PasteFromL(TReal &)Pastes a double-precision floating point value from the clipboard.
• Store()constReturns a reference to the clipboard's file store.
• StreamDictionary()constReturns a reference to the clipboard's stream dictionary.
• ~CClipboard()Destructor. Frees all resources owned by the object, prior to its destruction. I...

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C ~CClipboard();

Description

Destructor. Frees all resources owned by the object, prior to its destruction. In particular, the file associated with the clipboard's store is closed.

Note that if the clipboard file store has no root stream, i.e. the CClipboard::CommitL() member function of CClipboard has not been called prior to deleting the CClipboard object, then the file associated with the clipboard file store is deleted.

IMPORT_C static CClipboard* NewForReadingLC(RFs &aFs);

Description

Constructs a clipboard object and prepares the clipboard's store for reading, placing a pointer to the object on the cleanup stack. This allows the object and allocated resources to be cleaned up if a subsequent leave occurs.

Parameters

Return value

IMPORT_C static CClipboard* NewForReadingL(RFs &aFs);

Description

Constructs a clipboard object and prepares the clipboard's store for reading.

Parameters

Return value

IMPORT_C static CClipboard* NewForWritingLC(RFs &aFs);

Description

Constructs a clipboard object and prepares the clipboard's store for writing.

If the file associated with the clipboard's store does not exist, it is created; if it already exists, any existing content is discarded.

Parameters

Return value

IMPORT_C static TInt Clear(RFs &aFs);

Description

Empties the clipboard.

Note that if the file associated with the clipboard's store does not exist, this is not regarded as an error and the function completes successfully.

Parameters

Return value

IMPORT_C void CommitL();

Description

Commits changes to the clipboard's store.

It externalises the stream dictionary to the clipboard store as the root stream and then commits all changes to the store. This function must be called after application data has been externalised; failure to do so results in the deletion of the file associated with the clipboard store and the loss of data.

inline CStreamStore& Store() const;

Description

Returns a reference to the clipboard's file store.

Return value

inline CStreamDictionary& StreamDictionary() const;

Description

Returns a reference to the clipboard's stream dictionary.

Return value

IMPORT_C void CopyToL(TReal aReal);

Description

Copies a double-precision floating point value to the clipboard.

Note that the function does not automatically commit changes to the clipboard's store. This must be done explicitly.

Parameters

See also:

• CClipboard::CommitL()Commits changes to the clipboard's store.

IMPORT_C TBool PasteFromL(TReal &aReal);

Description

Pastes a double-precision floating point value from the clipboard.

If a double-precision floating point value exists on the clipboard, then the function restores it to the referenced argument and returns a true value.

If there is no double-precision floating point value on the clipboard, then the function returns a false value. The referenced argument is not changed.

Parameters

Return value

IMPORT_C static TDriveName ClipboardFileDrive();

Description

Returns the clipboad file drive information stored in the TLS

Return value

Panic codes