CClipboard Class Reference

#include <baclipb.h>

Link against: bafl.lib

class CClipboard : public CBase

Inherits from

CClipboard
- CBase

Public Member Functions
	~CClipboard()
IMPORT_C TInt	Clear(RFs &)
IMPORT_C TDriveName	ClipboardFileDrive()
IMPORT_C void	CommitL()
IMPORT_C void	CopyToL(TReal)
IMPORT_C CClipboard *	NewForReadingL(RFs &)
IMPORT_C CClipboard *	NewForReadingLC(RFs &)
IMPORT_C CClipboard *	NewForWritingLC(RFs &)
IMPORT_C TBool	PasteFromL(TReal &)
CStreamStore &	Store()
CStreamDictionary &	StreamDictionary()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

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

Constructor & Destructor Documentation

~CClipboard ( )

IMPORT_C

~CClipboard

(

)

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 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.

Member Function Documentation

Clear ( RFs & )

IMPORT_C TInt

Clear

(

RFs &

aFs

)

[static]

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
aFs	A handle to a file server session.

Return Value: KErrNone if successful, otherwise another of the system-wide error codes.

ClipboardFileDrive ( )

IMPORT_C TDriveName

ClipboardFileDrive

(

)

[static]

Returns the clipboad file drive information stored in the TLS

Return Value: A drive letter and a colon (A:, B:... etc,.)

Panic Codes
BAFL	23 If drive is either not in range 0-24 or is not defined in

CommitL ( )

IMPORT_C void

CommitL

(

)

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.

CopyToL ( TReal )

IMPORT_C void

CopyToL

(

TReal

aReal

)

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
aReal	The double-precision floating point value to be copied to the clipboard.

NewForReadingL ( RFs & )

IMPORT_C CClipboard *

NewForReadingL

(

RFs &

aFs

)

[static]

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

Parameters
aFs	A handle to a file server session.

Return Value: A pointer to the newly constructed clipboard object.

NewForReadingLC ( RFs & )

IMPORT_C CClipboard *

NewForReadingLC

(

RFs &

aFs

)

[static]

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
aFs	A handle to a file server session.

Return Value: A pointer to the newly constructed clipboard object. This pointer is put onto the cleanup stack.

NewForWritingLC ( RFs & )

IMPORT_C CClipboard *

NewForWritingLC

(

RFs &

aFs

)

[static]

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
aFs	A handle to a file server session.

Return Value: A pointer to the newly constructed clipboard object. This pointer is put onto the cleanup stack.

PasteFromL ( TReal & )

IMPORT_C TBool

PasteFromL

(

TReal &

aReal

)

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
aReal	On return, contains the double-precision floating point value found on the clipboard.

Return Value: ETrue, if a double-precision floating point value exists on the clipboard and has been pasted to the referenced argument; EFalse otherwise.

Store ( )

CStreamStore &

Store

(

)

const [inline]

Returns a reference to the clipboard's file store.

Return Value: A reference to the clipboard's store.

StreamDictionary ( )

CStreamDictionary &

StreamDictionary

(

)

const [inline]

Returns a reference to the clipboard's stream dictionary.

Return Value: A reference to the clipboard's stream dictionary.