PyCDocument.md

PyCDocument

PyCDocument Object

A document class. Encapsulates an MFC CDocument

class

Methods

• DeleteContents

  Call the MFC DeleteContents method. 

• DoSave

  Save the file. If necessary, prompt for file name. 

• DoFileSave

  Check file attributes, and save the file. 

• GetDocTemplate

  Returns the PyCDocTemplate for the document. 

• GetAllViews

  Returns a list of all views for the current document. 

• GetFirstView

  Returns the first view object attached to this document. 

• GetPathName

  Returns the full path name of the current document. 

• GetTitle

  Returns the title of the current document. 

• IsModified

  Return a flag indicating if the document has been modified. 

• OnChangedViewList

  Informs the document when a view is added or removed. 

• OnCloseDocument

  Call the MFC OnCloseDocument handler. 

• OnNewDocument

  Call the MFC OnNewDocument handler. 

• OnOpenDocument

  Call the MFC OnOpenDocument handler. 

• OnSaveDocument

  Call the MFC OnSaveDocument handler. 

• SetModifiedFlag

  Set the "dirty" flag for the document. 

• SaveModified

  Call the underlying MFC method. 

• SetPathName

  Set the full path name for the document. 

• SetTitle

  Set the title of the document. 

• UpdateAllViews

  Informs each view when a document changes.

sentinel 

PyCDocument.DeleteContents

DeleteContents() Call the MFC DeleteContents method.

This routine is provided so a document object which overrides this method

can call the original MFC version if required.

See Also

• PyCDocument.DeleteContents virtual method

MFC References

• CDocument::DeleteContents

PyCDocument.DeleteContents Virtual

DeleteContents() Called by the MFC architecture when a document is newly created or closed.

Comments

If a handler is defined for this function, the base (MFC) function will not

be called. If necessary, the handler must call this function explicitely.

See Also

• PyCDocument::DeleteContents

PyCDocument.DoFileSave

DoFileSave() Checks the file attributes.

If the file is read only, a new name is prompted, else the

file is saved (by calling DoSave)

See Also

• PyCDocument.DoFileSave virtual method

Undocumented MFC References

• CDocument::DoFileSave

PyCDocument.DoFileSave Virtual

DoFileSave() Called by the MFC architecture.

Comments

If a handler is defined for this function, it must call the

base class PyCDocument::DoFileSave method.

See Also

• PyCDocument::DoFileSave

Return Value

TRUE if the document could be saved, else FALSE.

PyCDocument.DoSave

DoSave(fileName, bReplace) Calls the underlying MFC DoSave method.

Parameters

• fileName : string

  The name of the file to save to.

• bReplace=1 : int

  Should an existing file be silently replaced?.

Comments

If invalid or no filename, will prompt for a name, else

will perform the actual saving of the document.

See Also

• PyCDocument.DoSave virtual method

Undocumented MFC References

• CDocument::DoSave

PyCDocument.DoSave Virtual

DoSave(fileName, bReplace

) Called by the MFC architecture to save a document.

Parameters

• fileName : string

  The name of the file being saved.

• bReplace : int

  TRUE if the file should be replaced.

Comments

If a handler is defined for this function, it must call the

base class PyCDocument::DoSave method.

See Also

• PyCDocument::DoSave

Return Value

TRUE if the document could be saved, else FALSE.

PyCDocument.GetAllViews

[PyCView,...] = GetAllViews() Returns a list of all views for the current document.

MFC References

• CDocument::GetFirstViewPosition

• CDocument::GetNextView

PyCDocument.GetDocTemplate

PyCDocTemplate = GetDocTemplate() Returns the template for the document.

MFC References

• CDocument::GetDocTemplate

PyCDocument.GetFirstView

PyCView = GetFirstView() Returns the first view object attached to this document.

Comments

For more info, see PyCDocument::GetAllViews

shouldnt be possible.

MFC References

• CDocument::GetFirstViewPosition

• CDocument::GetNextView

PyCDocument.GetPathName

string = GetPathName() Returns the full path name of the current document.

The string will be empty if no path name has been set.

MFC References

• CDocument::GetPathName

PyCDocument.GetTitle

string = GetTitle() Returns the title of the current document.

This will often be the file name portion of the path name.

MFC References

• CDocument::GetTitle

PyCDocument.IsModified

int = IsModified() Return a flag indicating if the document has been modified.

MFC References

• CDocument::IsModified

PyCDocument.OnChangedViewList

OnChangedViewList() Informs the document when a view is added or removed.

PyCDocument.OnChangedViewList Virtual

OnChangedViewList() Called by the MFC architecture when after a view is attached.

Comments

If a handler is defined for this function, the base (MFC) function will not

be called. If necessary, the handler must call this function explicitely.

See Also

• PyCDocument::OnChangedViewList

PyCDocument.OnCloseDocument

OnCloseDocument() Call the MFC OnCloseDocument handler.

This routine is provided so a document object which overrides this method

can call the original MFC version if required.

See Also

• PyCDocument.OnCloseDocument virtual method

MFC References

• CDocument::OnCloseDocument

PyCDocument.OnCloseDocument Virtual

OnCloseDocument() Called by the MFC architecture.

Comments

If a handler is defined for this function, the base (MFC) function will not

be called. If necessary, the handler must call this function explicitely.

See Also

• PyCDocument::OnCloseDocument

PyCDocument.OnNewDocument

OnNewDocument() Call the MFC OnNewDocument handler.

This routine is provided so a document object which overrides this method

can call the original MFC version if required.

See Also

• PyCDocument.OnNewDocument virtual method

MFC References

• CDocument::OnNewDocument

PyCDocument.OnNewDocument Virtual

OnNewDocument() Called by the MFC architecture.

Comments

If a handler is defined for this function, the base (MFC) function will not

be called. If necessary, the handler must call this function explicitely.

See Also

• PyCDocument::OnNewDocument

Return Value

TRUE if a new document could be created, else FALSE.

PyCDocument.OnOpenDocument

OnOpenDocument(pathName) Call the MFC OnOpenDocument handler.

This routine is provided so a document object which overrides this method

can call the original MFC version if required.

Parameters

• pathName : string

  The full path of the file to open.

MFC References

• CDocument::OnOpenDocument

PyCDocument.OnOpenDocument Virtual

OnOpenDocument(fileName) Called by the MFC architecture.

Parameters

• fileName : string

  The name of the file being opened.

Comments

If a handler is defined for this function, the base (MFC) function will not

be called. If necessary, the handler must call this function explicitely.

See Also

• PyCDocument::OnOpenDocument

Return Value

TRUE if the document could be opened, else FALSE.

PyCDocument.OnSaveDocument

OnSaveDocument(pathName) Call the MFC OnSaveDocument handler.

This routine is provided so a document object which overrides this method

can call the original MFC version if required.

Parameters

• pathName : string

  The full path of the file to save.

MFC References

• CDocument::OnSaveDocument

PyCDocument.OnSaveDocument Virtual

OnSaveDocument(fileName) Called by the MFC architecture.

Parameters

• fileName : string

  The name of the file being saved.

Comments

If a handler is defined for this function, the base (MFC) function will not

be called. If necessary, the handler must call this function explicitely.

See Also

• PyCDocument::OnSaveDocument

Return Value

TRUE if the document could be saved, else FALSE.

PyCDocument.PreCloseFrame Virtual

PreCloseFrame() Called before the frame window is closed.

Comments

The MFC base implementation is always called after the Python handler returns.

PyCDocument.SaveModified

int = SaveModified() Call the underlying MFC method.

See Also

• PyCDocument.SaveModified virtual method

MFC References

• CDocument::SaveModified

Return Value

Nonzero if it is safe to continue and close the document; 0 if the document should not be closed.

PyCDocument.SaveModified Virtual

SaveModified() Called by the MFC architecture when a document is closed.

Comments

If a handler is defined for this function, the base (MFC) function will not

be called. If necessary, the handler must call this function explicitely.

See Also

• PyCDocument::SaveModified

Return Value

The handler should return TRUE if it is safe to continue and close

the document; 0 if the document should not be closed.

PyCDocument.SetModifiedFlag

SetModifiedFlag(bModified) Set the "dirty" flag for the document.

Parameters

• bModified=1 : int

  Set dirty flag

MFC References

• CDocument::SetModifiedFlag

PyCDocument.SetPathName

SetPathName(path) Set the full path name for the document.

Parameters

• path : string

  The full path of the file.

MFC References

• CDocument::SetPathName

PyCDocument.SetTitle

SetTitle(title) Set the title of the document (ie, the name

to appear in the window caption for the document.

Parameters

• title : string

  The new title.

MFC References

• CDocument::SetTitle

PyCDocument.UpdateAllViews

UpdateAllViews(sender, hint) Informs each view when a document changes.

Parameters

• sender : PyCView

  The view who initiated the update

• hint=None : object

  A hint for the update.

MFC References

• CDocument::UpdateAllViews