Contents Up Previous Next

wxPMDocument

base class for all documents in PMF

Derived from

wxDocument
wxPMService

Data structures

Members

wxPMDocument::wxPMDocument
wxPMDocument::~wxPMDocument
wxPMDocument::AddSubdocument
wxPMDocument::AssociateService
wxPMDocument::CanHaveFile
wxPMDocument::FindSubdocumentForFile
wxPMDocument::GetAbsolutePath
wxPMDocument::GetAllViews
wxPMDocument::GetAssociatedServices
wxPMDocument::GetFileInfo
wxPMDocument::GetFirstPMView
wxPMDocument::GetMergableMenuChain
wxPMDocument::GetParentDocument
wxPMDocument::GetRelativePath
wxPMDocument::GetSerializer
wxPMDocument::GetSubdocuments
wxPMDocument::GetWxObject
wxPMDocument::IsClosing
wxPMDocument::KeepSerializer
wxPMDocument::LoadPMDocument
wxPMDocument::OnActivatePMDocument
wxPMDocument::OnClosingChildDocument
wxPMDocument::RemoveSubdocument
wxPMDocument::SavePMDocument
wxPMDocument::SerializePMDocument
wxPMDocument::SerializeState
wxPMDocument::SetFileInfo
wxPMDocument::SetIsClosing
wxPMDocument::SetParentDocument
wxPMDocument::UseSerializer


wxPMDocument::wxPMDocument

wxPMDocument()


wxPMDocument::~wxPMDocument

~wxPMDocument()


wxPMDocument::AddSubdocument

void AddSubdocument(wxPMDocument* pSubdoc)


wxPMDocument::AssociateService

void AssociateService(wxClassInfo* pSvcClass)

registers services which are automatically started after opening this document


wxPMDocument::CanHaveFile

bool CanHaveFile()

overridable returns TRUE by default


wxPMDocument::FindSubdocumentForFile

wxPMDocument* FindSubdocumentForFile(const wxPMFileInfo& finfo)


wxPMDocument::GetAbsolutePath

wxString GetAbsolutePath(const wxString& relPath)


wxPMDocument::GetAllViews

wxList* GetAllViews()


wxPMDocument::GetAssociatedServices

PMClassInfoListT& GetAssociatedServices()


wxPMDocument::GetFileInfo

wxPMFileInfo* GetFileInfo()

NULL, if file is not determined yet


wxPMDocument::GetFirstPMView

wxPMView* GetFirstPMView()


wxPMDocument::GetMergableMenuChain

wxPMMergableMenuChain* GetMergableMenuChain()

overridden methods of wxPMService


wxPMDocument::GetParentDocument

wxPMDocument* GetParentDocument()


wxPMDocument::GetRelativePath

wxString GetRelativePath(const wxString& absPath)

utility methods returns path relative to the directory from which this document was loaded


wxPMDocument::GetSerializer

wxPMSerializer* GetSerializer()

returns serializer which was kept after loading (if the above method returns TRUE) NOTE:: it should by destroyed by the document class


wxPMDocument::GetSubdocuments

PMDocumentListT& GetSubdocuments()


wxPMDocument::GetWxObject

wxObject* GetWxObject()


wxPMDocument::IsClosing

bool IsClosing()


wxPMDocument::KeepSerializer

bool KeepSerializer()

overridable, returns TRUE if the serializer passed while loading is not destoryed by PMF, but is kept by the document

bool LoadPMDocument()


wxPMDocument::LoadPMDocument

bool LoadPMDocument(wxInputStream& s)


wxPMDocument::OnActivatePMDocument

void OnActivatePMDocument()

notification called whenever the document becomes active


wxPMDocument::OnClosingChildDocument

void OnClosingChildDocument(wxPMDocument* pChild, bool wasSaved)


wxPMDocument::RemoveSubdocument

void RemoveSubdocument(wxPMDocument* pSubdoc)

bool SavePMDocument()

overridables for documents which return FALSE for CanHaveFile();


wxPMDocument::SavePMDocument

bool SavePMDocument(wxOutputStream& s)

NOTE:: use Save/LoadObject of wxDocument is not used, since it relies on wxUSE_STD_IOSTREAM. Interfaces of wx'-native and std:: streams are not compatible, it is probably better to stick with wx-ones, also they have better API for storing binary data types. These methods should not be overridden if your document class returns TRUE from UseSerializer()


wxPMDocument::SerializePMDocument

bool SerializePMDocument(wxPMSerializer& ser)

override this, if your document returns TRUE for UseSerializer();


wxPMDocument::SerializeState

bool SerializeState(wxPMSerializer& ser)

overridden method of wxPMService, saves "visual" state of this document (possibly to the configuration file of containing workplace)


wxPMDocument::SetFileInfo

void SetFileInfo(wxPMFileInfo* pFile)


wxPMDocument::SetIsClosing

void SetIsClosing(bool isClosing)

used by pmf


wxPMDocument::SetParentDocument

void SetParentDocument(wxPMDocument* pParent)

management of hierarchical containment


wxPMDocument::UseSerializer

bool UseSerializer()

saving/loading of document **overridable, returns TRUE if binary file used (default FALSE)