CEikDocument Class Reference

Constructor for CEikDocument

Constructs a new document.

This constructor is typically called from a derived UI-specific document class constructor.

Destructor.

Gets the caption of the application that created the document.

The application's caption is usually specified in its localisable resource file.

See also: CEikApplication::AppCaption().

Gets the document's file sharing and access mode.

By default, the access mode is EFileShareExclusive|EFileWrite, except when the file could not be opened for exclusive writing, in which case, its default access mode is EFileRead|EFileShareReadersOnly.

See also: TFileMode

Constructs the application UI.

This function is called by the UI framework during application start-up. It should only carry out first phase construction of the app UI, in other words, using new(ELeave). It should not call the app UI's ConstructL(), because the UI framework is responsible for this. Note also that the UI framework takes ownership of the app UI, so the document does not need to destroy it.

Creates a file store for a new default document.

This function is called by the UI framework during application start-up, as part of creating a default document.

Creates an embedded document's app UI and opens the document for editing or viewing.

Gets the file store object which is used to edit the document.

Externalises an object to a write stream.

Implementations of this function are normally called from StoreL().

Gets the document's 'Has changed' flag.

The flag is set and unset using SetChanged(). Also, calling SaveL() unsets it.

CEikAppUi::SaveAnyChangesL() tests the value of this flag to identify whether the document needs to be saved.

See also: CEikAppUi::SaveAnyChangesL()

Tests whether the document contains any content.

This implementation always returns ETrue. Any applications that persist data may optionally override it. It is not called by the UI framework.

This empty function can be implemented in file-based applications to initialise a new default document.

It is called by the UI framework during application start-up when the application is launched without a document being associated with it and when no default document exists.

Restores the document's state from the specified file, or creates a new default document.

If aDoOpen is true, the function tries to open the file for exclusive writing. If that fails, it tries to open it for reading only. If that fails, it leaves.

If aDoOpen is false, the function creates a new default document whose path and name are specified in aFilename.

This function is called by the UI framework during application start-up.

Restores the document's state from the specified file.

This virtual function should be overridden if the file is not a "native" Symbian OS file (i.e. is not a CFileStore). In this case, the override should set the aFileStore parameter to NULL.

Overrides of this function must only set aFileStore once all leave-prone operations have succesfully completed.

This function is called by the UI framework during application start-up.

When a file is opened, the current write position is automatically set to the start of the file, therefore there is no need to call RFile::Seek(ESeekStart,0). A call to RFile::Close() should be made when the file handle is no longer required. The file handle should not be passed to another process or application as it will be closed automatically when its associated file-server session is closed.

See also: RFile RFs

Prepares an embedded document for editing by creating its app UI.

This function is called by EditL().

Prepares a main (non-embedded) document for editing, by creating its app UI.

This function is called by the UI framework during application start-up.

Prints a document without opening it first.

This function is empty. It might be used to print a document directly from a shell or file manager application rather than from the document's associated application, using default print parameters.