![[Index]](../../../../a_stock/images/btn_index.gif)
![[Previous]](../../../../a_stock/images/btn_prev_top.gif)
![[Next]](../../../../a_stock/images/btn_next_top.gif)
|
|
|
|
|
|
||
class CApaDocument : public CBase;
Defines basic behaviour for documents.
This is the base class for all documents. A document contains the data associated with the application's content.
The class is derived from by the UI framework and is further derived from by the UI application.
CBase -
Base class for all classes to be instantiated on the heap.
CApaDocument - Defines basic behaviour for documents.
Defined in CApaDocument:
Application()constReturns a pointer to the application that created the document.CApaDocument()Constructor for CApaDocument CApaDocument(CApaApplication &,CApaProcess &)Constructs the document object with the specified application and process.Capability()constGets the document's capabilities.CreateFileStoreLC(RFs &,const TDesC &)Creates and fully initialises a new filestore and stores the document into it, r...EditL(MApaEmbeddedDocObserver *,TBool)Starts an editing session on an embedded document.ExternalizeL(RWriteStream &)constGlassPictureL()Gets an object that can draw a representation of the document's content.HasChanged()constTests whether the document has changed since it was last persisted.IsEmpty()constTests whether the document is empty.NewDocumentL()Initialises a new, empty, document with a default setup.OpenFileL(CFileStore *&,RFile &)PrintL(const CStreamStore &)Prints the document without a need for it to be open for editing.Process()constReturns a pointer to the application process associated with this document.Reserved_2()RestoreL(const CStreamStore &,const CStreamDictionary &)Restores the document's content and state from data persisted in the specified s...SaveL()Stores the document to the current file, commits the changes, and marks the docu...StoreL(CStreamStore &,CStreamDictionary &)constStores the document's content and state to the specified store, recording the id...TCapability
CApaDocument capabilities. ValidatePasswordL()constChecks the document password.iContainer~CApaDocument()Destructor.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...protected: IMPORT_C CApaDocument(CApaApplication &aApp, CApaProcess &aProcess);
Constructs the document object with the specified application and process.
Derived classes must define and implement a constructor through which both the associated application and process can be specified. A typical implementation calls this constructor through a constructor initialization list.
|
|
|
virtual void NewDocumentL()=0;
Initialises a new, empty, document with a default setup.
This can be the main document or an embedded document. The function is called by the UI framework when it creates a default document file.
An implementation of this function must be supplied by the UI application.
If initialisation fails, the document must be left in the same state as it was before the function was called.
virtual CFileStore* CreateFileStoreLC(RFs &aFs, const TDesC &aFileName)=0;
Creates and fully initialises a new filestore and stores the document into it, replacing any existing file of the same name.
The function should put the pointer to the filestore object onto the cleanup stack.
An implementation of this function is supplied by the UI framework.
|
|
IMPORT_C virtual CPicture* GlassPictureL();
Gets an object that can draw a representation of the document's content.
If the document supports being embedded as a glass door, then the UI application must provide an implementation for this function.
The default implementation raises an APPARC 8 panic.
|
virtual void EditL(MApaEmbeddedDocObserver *aContainer, TBool aReadOnly=EFalse)=0;
Starts an editing session on an embedded document.
The function should cause the application's UI to be created and the document to be fully restored for editing.
An implementation of this function is supplied by the UI framework.
|
virtual void PrintL(const CStreamStore &aSourceStore)=0;
Prints the document without a need for it to be open for editing.
Typically, this is called from a shell or a file manager type application that wants to print the document without opening it fully.
An empty implementation of this function is supplied by the UI framework.
The UI application can provide its own implementation.
|
virtual void SaveL()=0;
Stores the document to the current file, commits the changes, and marks the document status as unchanged.
Typically, the function is called by the application when it implements a "Save" type menu option in its User Interface.
An implementation of this function is supplied by the UI framework. This is adequate for direct file store applications. Applications using a permanent file store model, need to provide their own implementation.
If the function leaves, an implementation should ensure that any changes made to the file are rolled back, leaving the file in the state it was in before the function was called.
virtual void StoreL(CStreamStore &aStore, CStreamDictionary &aStreamDic) const=0;
Stores the document's content and state to the specified store, recording the identity of any headstreams created in the specified stream dictionary.
The store must be fully constructed before this function is called.
An empty implementation of this function is supplied by the UI framework. UI applications that need to persist any data must provide their own implementation.
If the function leaves, an implementation should ensure that the store and the stream dictionary are returned to the state they were in before the function was called.
|
virtual void RestoreL(const CStreamStore &aStore, const CStreamDictionary &aStreamDic)=0;
Restores the document's content and state from data persisted in the specified store.
An empty implementation of this function is supplied by the UI framework. UI applications that need to restore data must provide their own implementation.
If the function leaves, an implementation should ensure that the store and the stream dictionary are returned to the state they were in before the function was called.
|
inline virtual void DetachFromStoreL(CPicture::TDetach=CPicture::EDetachFull);
Restores the document to the extent that it does not need the store further.
A document only keeps a pointer to a store if it implements deferred loading. This also tells the document that any store pointer that it might have is just about to become invalid.
An empty implementation of this function is supplied by the UI framework. UI applications that support deferred loading or embedding should provide an implementation.
If a document supports embedding, then it should propagate the CApaDocument::DetachFromStoreL(CPicture::TDetach) call on to all embedded objects that it contains.
If the function leaves, the operation should be aborted because the document has not successfully detached from the store. Continuing with the operation may leave the document in an unsafe state or cause user data to be lost.
|
IMPORT_C virtual void ExternalizeL(RWriteStream &aStream) const;
|
virtual TBool IsEmpty() const=0;
Tests whether the document is empty.
The UI framework provides a default implementation which always returns a true value.
The UI application can provide its own implementation. Typically, any application that has editable content should supply an implementation that acts according to the state of that content. Applications without associated document data need not supply an implementation.
|
IMPORT_C virtual void ValidatePasswordL() const;
Checks the document password.
The default implementation is empty.
If a document is intended to be password protected, the UI application should provide an implementation that forces the user to enter the password and validate the input.
If the document is protected by a password and the password entered by the user is incorrect, the function should leave with KErrLocked, otherwise it should just return.
IMPORT_C virtual TCapability Capability() const;
Gets the document's capabilities.
Capabilities are encapsulated by an instance of a CApaDocument::TCapability class, a public class defined inside this class.
The default implementation returns a default CApaDocument::TCapability object, indicating that the document does not support any of the defined capabilities.
If a document does support one or more of the capabilities, it should override this function to return a suitably initialised object.
|
inline CApaApplication* Application() const;
Returns a pointer to the application that created the document.
|
inline CApaProcess* Process() const;
Returns a pointer to the application process associated with this document.
|
virtual TBool HasChanged() const=0;
Tests whether the document has changed since it was last persisted.
An implementation of this function is supplied by the UI framework and need not be changed by the UI application.
|
private: IMPORT_C virtual void OpenFileL(CFileStore *&aFileStore, RFile &aFile);
|
|
|
class TCapability;
CApaDocument capabilities.
Defined in CApaDocument::TCapability:
![[Top]](../../../../a_stock/images/arrow_up_2.gif){kind=icon}
CanDrawGlass()constTests whether the document supports being embedded as a glass door.CanPrint()constTests whether the document supports being printed without using the full applica...SetCanDrawGlass()Sets the document as being capable of being embedded as a glass door. SetCanPrint()Sets the document as being capable of being printed without using the full appli...TCapability()Constructs a default capability object.TCapability()IMPORT_C TCapability();
Constructs a default capability object.
All capabilities are marked as "not supported".
CanDrawGlass()constinline TBool CanDrawGlass() const;
Tests whether the document supports being embedded as a glass door.
|
CanPrint()constinline TBool CanPrint() const;
Tests whether the document supports being printed without using the full application UI.
|
SetCanDrawGlass()inline void SetCanDrawGlass();
Sets the document as being capable of being embedded as a glass door.
SetCanPrint()inline void SetCanPrint();
Sets the document as being capable of being printed without using the full application UI.
|
|
protected: MApaEmbeddedDocObserver * iContainer;
|
Copyright © 2005-2008 Symbian Software Ltd. |
|
![[Previous]](../../../../a_stock/images/btn_prev.gif)
![[Top]](../../../../a_stock/images/btn_top.gif)
![[Next]](../../../../a_stock/images/btn_next.gif)