#----------------------------------------------------------------------------
# Name: docview.py
-# Purpose: Port of the wxWindows docview classes
+# Purpose: Port of the wxWidgets docview classes
#
# Author: Peter Yared
#
# License: wxWindows license
#----------------------------------------------------------------------------
+"""
+A port of the wxWidgets doc/view classes to Python.
+
+:see: `pydocview`
+"""
import os
import os.path
class Document(wx.EvtHandler):
"""
- The document class can be used to model an application's file-based data. It
- is part of the document/view framework supported by wxWindows, and cooperates
- with the wxView, wxDocTemplate and wxDocManager classes.
+ The document class can be used to model an application's
+ file-based data. It is part of the document/view framework, and
+ cooperates with the `View`, `DocTemplate` and `DocManager`
+ classes.
Note this wxPython version also keeps track of the modification date of the
document and if it changes on disk outside of the application, we will warn the
def GetDocumentName(self):
"""
- The document type name given to the wxDocTemplate constructor,
+ The document type name given to the `DocTemplate` constructor,
copied to this document when the document is created. If several
document templates are created that use the same document type, this
- variable is used in wxDocManager::CreateView to collate a list of
+ variable is used in `DocManager.CreateView` to collate a list of
alternative view types that can be used on this kind of document.
"""
return self._documentTypeName
def SetDocumentName(self, name):
"""
- Sets he document type name given to the wxDocTemplate constructor,
+ Sets the document type name given to the `DocTemplate` constructor,
copied to this document when the document is created. If several
document templates are created that use the same document type, this
- variable is used in wxDocManager::CreateView to collate a list of
+ variable is used in `DocManager.CreateView` to collate a list of
alternative view types that can be used on this kind of document. Do
not change the value of this variable.
"""
def GetDocumentSaved(self):
"""
- Returns True if the document has been saved. This method has been
- added to wxPython and is not in wxWindows.
+ Returns True if the document has been saved.
"""
return self._savedYet
def SetDocumentSaved(self, saved = True):
"""
- Sets whether the document has been saved. This method has been
- added to wxPython and is not in wxWindows.
+ Sets whether the document has been saved.
"""
self._savedYet = saved
"""
Sets the command processor to be used for this document. The document
will then be responsible for its deletion. Normally you should not
- call this; override OnCreateCommandProcessor instead.
+ call this; override `OnCreateCommandProcessor` instead.
"""
self._commandProcessor = processor
Call with true to mark the document as modified since the last save,
false otherwise. You may need to override this if your document view
maintains its own record of being modified (for example if using
- xTextWindow to view and edit the document).
+ `wx.TextCtrl` to view and edit the document).
"""
self._documentModified = modify
- def SetDocumentModificationDate(self, filename=None):
+ def SetDocumentModificationDate(self):
"""
Saves the file's last modification date.
This is used to check if the file has been modified outside of the application.
- This method has been added to wxPython and is not in wxWindows.
"""
- if not filename:
- filename = self.GetFilename()
- self._documentModificationDate = os.path.getmtime(filename)
- print "debug print, file: %s set modification date to %s" % (filename, self._documentModificationDate)
+ self._documentModificationDate = os.path.getmtime(self.GetFilename())
def GetDocumentModificationDate(self):
"""
Returns the file's modification date when it was loaded from disk.
This is used to check if the file has been modified outside of the application.
- This method has been added to wxPython and is not in wxWindows.
"""
return self._documentModificationDate
def Close(self):
"""
- Closes the document, by calling OnSaveModified and then (if this true)
- OnCloseDocument. This does not normally delete the document object:
- use DeleteAllViews to do this implicitly.
+ Closes the document, by calling `OnSaveModified` and then (if
+ this returns True) `OnCloseDocument`. This does not normally
+ delete the document object: use DeleteAllViews to do this
+ implicitly.
"""
if self.OnSaveModified():
if self.OnCloseDocument():
def OnCloseDocument(self):
"""
- The default implementation calls DeleteContents (an empty
- implementation) sets the modified flag to false. Override this to
- supply additional behaviour when the document is closed with Close.
+ The default implementation calls `DeleteContents` (an empty
+ implementation) sets the modified flag to false. Override this
+ to supply additional behaviour when the document is closed
+ with `Close`.
"""
self.NotifyClosing()
self.DeleteContents()
def DeleteAllViews(self):
"""
- Calls wxView.Close and deletes each view. Deleting the final view will
- implicitly delete the document itself, because the wxView destructor
- calls RemoveView. This in turns calls wxDocument::OnChangedViewList,
+ Calls `View.Close` and deletes each view. Deleting the final view will
+ implicitly delete the document itself, because the `View` destructor
+ calls `RemoveView`. This in turns calls `Document.OnChangedViewList`,
whose default implemention is to save and delete the document if no
views exist.
"""
def OnNewDocument(self):
"""
- The default implementation calls OnSaveModified and DeleteContents,
- makes a default title for the document, and notifies the views that
- the filename (in fact, the title) has changed.
+ The default implementation calls `OnSaveModified` and
+ `DeleteContents`, makes a default title for the document, and
+ notifies the views that the filename (in fact, the title) has
+ changed.
"""
if not self.OnSaveModified() or not self.OnCloseDocument():
return False
def Save(self):
"""
- Saves the document by calling OnSaveDocument if there is an associated
- filename, or SaveAs if there is no filename.
+ Saves the document by calling `OnSaveDocument` if there is an
+ associated filename, or `SaveAs` if there is no filename.
"""
if not self.IsModified(): # and self._savedYet: This was here, but if it is not modified who cares if it hasn't been saved yet?
return True
""" check for file modification outside of application """
if os.path.exists(self.GetFilename()) and os.path.getmtime(self.GetFilename()) != self.GetDocumentModificationDate():
- print "debug print, File %s: new mod date %s, original mod date %s" % (self.GetFilename(), os.path.getmtime(self.GetFilename()), self.GetDocumentModificationDate())
msgTitle = wx.GetApp().GetAppName()
if not msgTitle:
msgTitle = _("Application")
def SaveAs(self):
"""
- Prompts the user for a file to save to, and then calls OnSaveDocument.
+ Prompts the user for a file to save to, and then calls `OnSaveDocument`.
"""
docTemplate = self.GetDocumentTemplate()
if not docTemplate:
def OnSaveDocument(self, filename):
"""
Constructs an output file for the given filename (which must
- not be empty), and calls SaveObject. If SaveObject returns true, the
- document is set to unmodified; otherwise, an error message box is
- displayed.
+ not be empty), and calls `SaveObject`. If `SaveObject` returns
+ true, the document is set to unmodified; otherwise, an error
+ message box is displayed.
"""
if not filename:
return False
if backupFilename:
os.remove(filename)
os.rename(backupFilename, filename)
+ self.SetDocumentModificationDate()
wx.MessageBox("Could not save '%s'. %s" % (FileNameFromPath(filename), sys.exc_value),
msgTitle,
def OnOpenDocument(self, filename):
"""
Constructs an input file for the given filename (which must not
- be empty), and calls LoadObject. If LoadObject returns true, the
+ be empty), and calls `LoadObject`. If `LoadObject` returns true, the
document is set to unmodified; otherwise, an error message box is
displayed. The document's views are notified that the filename has
changed, to give windows an opportunity to update their titles. All of
def LoadObject(self, file):
"""
- Override this function and call it from your own LoadObject before
- loading your own data. LoadObject is called by the framework
- automatically when the document contents need to be loaded.
+ Override this function and call it from your own `LoadObject`
+ before loading your own data. `LoadObject` is called by the
+ framework automatically when the document contents need to be
+ loaded.
- Note that the wxPython version simply sends you a Python file object,
- so you can use pickle.
+ Note that the wxPython version simply sends you a Python file
+ object, so you can use pickle.
"""
return True
def SaveObject(self, file):
"""
- Override this function and call it from your own SaveObject before
- saving your own data. SaveObject is called by the framework
- automatically when the document contents need to be saved.
+ Override this function and call it from your own `SaveObject`
+ before saving your own data. `SaveObject` is called by the
+ framework automatically when the document contents need to be
+ saved.
- Note that the wxPython version simply sends you a Python file object,
- so you can use pickle.
+ Note that the wxPython version simply sends you a Python file
+ object, so you can use pickle.
"""
return True
def OnCreateCommandProcessor(self):
"""
Override this function if you want a different (or no) command
- processor to be created when the document is created. By default, it
- returns an instance of wxCommandProcessor.
+ processor to be created when the document is created. By
+ default, it returns an instance of `CommandProcessor`.
"""
return CommandProcessor()
def OnSaveModified(self):
"""
- If the document has been modified, prompts the user to ask if the
- changes should be changed. If the user replies Yes, the Save function
- is called. If No, the document is marked as unmodified and the
- function succeeds. If Cancel, the function fails.
+ If the document has been modified, prompts the user to ask if
+ the changes should be changed. If the user replies Yes, the
+ `Save` function is called. If No, the document is marked as
+ unmodified and the function succeeds. If Cancel, the function
+ fails.
"""
if not self.IsModified():
return True
""" check for file modification outside of application """
if os.path.exists(self.GetFilename()) and os.path.getmtime(self.GetFilename()) != self.GetDocumentModificationDate():
- print "debug print, File %s: new mod date %s, original mod date %s" % (self.GetFilename(), os.path.getmtime(self.GetFilename()), self.GetDocumentModificationDate())
msgTitle = wx.GetApp().GetAppName()
if not msgTitle:
msgTitle = _("Warning")
def AddView(self, view):
"""
If the view is not already in the list of views, adds the view and
- calls OnChangedViewList.
+ calls `OnChangedViewList`.
"""
if not view in self._documentViews:
self._documentViews.append(view)
def RemoveView(self, view):
"""
Removes the view from the document's list of views, and calls
- OnChangedViewList.
+ `OnChangedViewList`.
"""
if view in self._documentViews:
self._documentViews.remove(view)
def OnCreate(self, path, flags):
"""
- The default implementation calls DeleteContents (an empty
+ The default implementation calls `DeleteContents` (an empty
implementation) sets the modified flag to false. Override this to
supply additional behaviour when the document is closed with Close.
"""
def UpdateAllViews(self, sender = None, hint = None):
"""
- Updates all views. If sender is non-NULL, does not update this view.
+ Updates all views. If sender is non-None, does not update this view.
hint represents optional information to allow a view to optimize its
update.
"""
def SetFilename(self, filename, notifyViews = False):
"""
Sets the filename for this document. Usually called by the framework.
- If notifyViews is true, wxView.OnChangeFilename is called for all
+ If notifyViews is true, `View.OnChangeFilename` is called for all
views.
"""
self._documentFile = filename
def SetWriteable(self, writeable):
"""
- Set to False if the document can not be saved. This will disable the ID_SAVE_AS
- event and is useful for custom documents that should not be saveable. The ID_SAVE
- event can be disabled by never Modifying the document. This method has been added
- to wxPython and is not in wxWindows.
+ Set to False if the document can not be saved. This will
+ disable the ID_SAVE_AS event and is useful for custom
+ documents that should not be saveable. The ID_SAVE event can
+ be disabled by never modifying the document.
"""
self._writeable = writeable
class View(wx.EvtHandler):
"""
- The view class can be used to model the viewing and editing component of
- an application's file-based data. It is part of the document/view
- framework supported by wxWindows, and cooperates with the wxDocument,
- wxDocTemplate and wxDocManager classes.
+ The view class can be used to model the viewing and editing
+ component of an application's file-based data. It cooperates
+ with the `Document`, `DocTemplate` and `DocManager` classes.
"""
def __init__(self):
def OnActivateView(self, activate, activeView, deactiveView):
"""
- Called when a view is activated by means of wxView::Activate. The
+ Called when a view is activated by means of `View.Activate`. The
default implementation does nothing.
"""
pass
def OnPrint(self, dc, info):
"""
Override this to print the view for the printing framework. The
- default implementation calls View.OnDraw.
+ default implementation calls `View.OnDraw`.
"""
self.OnDraw(dc)
def OnUpdate(self, sender, hint):
"""
- Called when the view should be updated. sender is a pointer to the
- view that sent the update request, or NULL if no single view requested
+ Called when the view should be updated. sender is a reference to the
+ view that sent the update request, or None if no single view requested
the update (for instance, when the document is opened). hint is as yet
unused but may in future contain application-specific information for
making updating more efficient.
def GetViewName(self):
"""
- Gets the name associated with the view (passed to the wxDocTemplate
+ Gets the name associated with the view (passed to the `DocTemplate`
constructor). Not currently used by the framework.
"""
return self._viewTypeName
def Close(self, deleteWindow = True):
"""
- Closes the view by calling OnClose. If deleteWindow is true, this
+ Closes the view by calling `OnClose`. If deleteWindow is true, this
function should delete the window associated with the view.
"""
if self.OnClose(deleteWindow = deleteWindow):
def Activate(self, activate = True):
"""
- Call this from your view frame's OnActivate member to tell the
- framework which view is currently active. If your windowing system
- doesn't call OnActivate, you may need to call this function from
- OnMenuCommand or any place where you know the view must be active, and
- the framework will need to get the current view.
-
- The prepackaged view frame wxDocChildFrame calls wxView.Activate from
- its OnActivate member and from its OnMenuCommand member.
+ Call this from your view frame's EVT_ACTIVATE handler to tell
+ the framework which view is currently active. If your
+ windowing system doesn't support EVT_ACTIVATE, you may need to
+ call this function from an EVT_MENU handler, or any place
+ where you know the view must be active, and the framework will
+ need to get the current view.
"""
if self.GetDocument() and self.GetDocumentManager():
- self.OnActivateView(activate, self, self.GetDocumentManager().GetCurrentView())
+ self.OnActivateView(activate,
+ self,
+ self.GetDocumentManager().GetCurrentView())
self.GetDocumentManager().ActivateView(self, activate)
def OnClose(self, deleteWindow = True):
"""
Implements closing behaviour. The default implementation calls
- wxDocument.Close to close the associated document. Does not delete the
+ `Document.Close` to close the associated document. Does not delete the
view. The application may wish to do some cleaning up operations in
- this function, if a call to wxDocument::Close succeeded. For example,
+ this function, if a call to `Document.Close` succeeded. For example,
if your application's all share the same window, you need to
disassociate the window from the view and perhaps clear the window. If
deleteWindow is true, delete the frame associated with the view.
def OnCreate(self, doc, flags):
"""
- wxDocManager or wxDocument creates a wxView via a wxDocTemplate. Just
- after the wxDocTemplate creates the wxView, it calls wxView::OnCreate.
- In its OnCreate member function, the wxView can create a
- wxDocChildFrame or a derived class. This wxDocChildFrame provides user
- interface elements to view and/or edit the contents of the wxDocument.
+ `DocManager` or `Document` creates a `View` via a `DocTemplate`. Just
+ after the `DocTemplate` creates the `View`, it calls `View.OnCreate`.
+ In its `OnCreate` member function, the `View` can create a
+ `DocChildFrame` or a derived class. This `DocChildFrame` provides user
+ interface elements to view and/or edit the contents of the `Document`.
By default, simply returns true. If the function returns false, the
view will be deleted.
def OnCreatePrintout(self):
"""
- Returns a wxPrintout object for the purposes of printing. It should
+ Returns a `wx.Printout` object for the purposes of printing. It should
create a new object every time it is called; the framework will delete
objects it creates.
- By default, this function returns an instance of wxDocPrintout, which
- prints and previews one page by calling wxView.OnDraw.
+ By default, this function returns an instance of `DocPrintout`, which
+ prints and previews one page by calling `View.OnDraw`.
- Override to return an instance of a class other than wxDocPrintout.
+ Override to return an instance of a class other than `DocPrintout`.
"""
return DocPrintout(self)
def GetFrame(self):
"""
Gets the frame associated with the view (if any). Note that this
- "frame" is not a wxFrame at all in the generic MDI implementation
- which uses the notebook pages instead of the frames and this is why
- this method returns a wxWindow and not a wxFrame.
+ "frame" is not a `wx.Frame` at all in the generic MDI implementation
+ which uses the notebook pages instead of the frames.
"""
return self._viewFrame
def SetFrame(self, frame):
"""
Sets the frame associated with this view. The application should call
- this if possible, to tell the view about the frame. See GetFrame for
- the explanation about the mismatch between the "Frame" in the method
- name and the type of its parameter.
+ this if possible, to tell the view about the frame.
"""
self._viewFrame = frame
class DocTemplate(wx.Object):
"""
- The wxDocTemplate class is used to model the relationship between a
- document class and a view class.
+ The `DocTemplate` class is used to model the relationship between
+ a document class and a view class.
"""
- def __init__(self, manager, description, filter, dir, ext, docTypeName, viewTypeName, docType, viewType, flags = DEFAULT_TEMPLATE_FLAGS, icon = None):
+ def __init__(self, manager, description, filter, dir, ext,
+ docTypeName, viewTypeName, docType, viewType,
+ flags = DEFAULT_TEMPLATE_FLAGS, icon = None):
"""
Constructor. Create instances dynamically near the start of your
- application after creating a wxDocManager instance, and before doing
+ application after creating a `DocManager` instance, and before doing
any document or view operations.
- manager is the document manager object which manages this template.
+ :param manager: the document manager object which manages this template.
- description is a short description of what the template is for. This
- string will be displayed in the file filter list of Windows file
- selectors.
+ :param description: a short description of what the template
+ is for. This string will be displayed in the file filter
+ list of Windows file selectors.
- filter is an appropriate file filter such as *.txt.
+ :param filter: an appropriate file filter such as \*.txt.
- dir is the default directory to use for file selectors.
+ :param dir: the default directory to use for file selectors.
- ext is the default file extension (such as txt).
+ :param ext: the default file extension (such as txt).
- docTypeName is a name that should be unique for a given type of
- document, used for gathering a list of views relevant to a
- particular document.
+ :param docTypeName: a name that should be unique for a given
+ type of document, used for gathering a list of views
+ relevant to a particular document.
- viewTypeName is a name that should be unique for a given view.
+ :param viewTypeName: a name that should be unique for a given view.
- docClass is a Python class. If this is not supplied, you will need to
- derive a new wxDocTemplate class and override the CreateDocument
- member to return a new document instance on demand.
+ :param docType: a Python class. If this is not supplied, you
+ will need to derive a new `DocTemplate` class and override
+ the `CreateDocument` member to return a new document
+ instance on demand.
- viewClass is a Python class. If this is not supplied, you will need to
- derive a new wxDocTemplate class and override the CreateView member to
- return a new view instance on demand.
+ :param viewType: a Python class. If this is not supplied, you
+ will need to derive a new `DocTemplate` class and override
+ the `CreateView` member to return a new view instance on
+ demand.
- flags is a bit list of the following:
- wx.TEMPLATE_VISIBLE The template may be displayed to the user in
- dialogs.
+ :param flags: a bit list of the following
+
+ * TEMPLATE_VISIBLE: The template may be displayed to the
+ user in dialogs.
- wx.TEMPLATE_INVISIBLE The template may not be displayed to the user in
- dialogs.
+ * TEMPLATE_INVISIBLE: The template may not be displayed
+ to the user in dialogs.
- wx.DEFAULT_TEMPLATE_FLAGS Defined as wxTEMPLATE_VISIBLE.
+ * DEFAULT_TEMPLATE_FLAGS: Defined as TEMPLATE_VISIBLE.
+
"""
self._docManager = manager
self._description = description
def GetDefaultExtension(self):
"""
- Returns the default file extension for the document data, as passed to
- the document template constructor.
+ Returns the default file extension for the document data, as
+ passed to the document template constructor.
"""
return self._defaultExt
def GetDescription(self):
"""
- Returns the text description of this template, as passed to the
- document template constructor.
+ Returns the text description of this template, as passed to
+ the document template constructor.
"""
return self._description
def GetDirectory(self):
"""
- Returns the default directory, as passed to the document template
- constructor.
+ Returns the default directory, as passed to the document
+ template constructor.
"""
return self._directory
def GetDocumentManager(self):
"""
- Returns the document manager instance for which this template was
- created.
+ Returns the document manager instance for which this template
+ was created.
"""
return self._docManager
def GetIcon(self):
"""
Returns the icon, as passed to the document template
- constructor. This method has been added to wxPython and is
- not in wxWindows.
+ constructor.
"""
return self._icon
def SetIcon(self, flags):
"""
- Sets the icon. This method has been added to wxPython and is not
- in wxWindows.
+ Sets the icon.
"""
self._icon = icon
def CreateView(self, doc, flags):
"""
- Creates a new instance of the associated document view. If you have
- not supplied a class to the template constructor, you will need to
- override this function to return an appropriate view instance.
+ Creates a new instance of the associated document view. If you
+ have not supplied a class to the template constructor, you
+ will need to override this function to return an appropriate
+ view instance.
"""
view = self._viewType()
view.SetDocument(doc)
class DocManager(wx.EvtHandler):
"""
- The wxDocManager class is part of the document/view framework supported by
- wxWindows, and cooperates with the wxView, wxDocument and wxDocTemplate
- classes.
+ The `DocManager` class is part of the document/view framework and
+ cooperates with the `View`, `Document` and `DocTemplate` classes.
"""
def __init__(self, flags = DEFAULT_DOCMAN_FLAGS, initialize = True):
"""
- Constructor. Create a document manager instance dynamically near the
- start of your application before doing any document or view operations.
+ Constructor. Create a document manager instance dynamically
+ near the start of your application before doing any document
+ or view operations.
- flags is used in the Python version to indicate whether the document
- manager is in DOC_SDI or DOC_MDI mode.
+ :param flags: used to indicate whether the document manager is
+ in DOC_SDI or DOC_MDI mode.
- If initialize is true, the Initialize function will be called to
- create a default history list object. If you derive from wxDocManager,
- you may wish to call the base constructor with false, and then call
- Initialize in your own constructor, to allow your own Initialize or
- OnCreateFileHistory functions to be called.
+ :param initialize: if true, the `Initialize` function will be
+ called to create a default history list object. If you
+ derive from DocManager, you may wish to call the base
+ constructor with false, and then call `Initialize` in your
+ own constructor, to allow your own `Initialize` or
+ `OnCreateFileHistory` functions to be called.
"""
wx.EvtHandler.__init__(self)
def GetFlags(self):
"""
- Returns the document manager's flags. This method has been
- added to wxPython and is not in wxWindows.
+ Returns the document manager's flags.
"""
return self._flags
def Clear(self, force = True):
"""
- Closes all currently opened document by callling CloseDocuments and
+ Closes all currently opened document by calling `CloseDocuments` and
clears the document manager's templates.
"""
if not self.CloseDocuments(force):
def Initialize(self):
"""
- Initializes data; currently just calls OnCreateFileHistory. Some data
+ Initializes data; currently just calls `OnCreateFileHistory`. Some data
cannot always be initialized in the constructor because the programmer
must be given the opportunity to override functionality. In fact
- Initialize is called from the wxDocManager constructor, but this can
- be vetoed by passing false to the second argument, allowing the
+ Initialize is called from the `DocManager` constructor, but this can
+ be prevented by passing false to the second argument, allowing the
derived class's constructor to call Initialize, possibly calling a
- different OnCreateFileHistory from the default.
-
- The bottom line: if you're not deriving from Initialize, forget it and
- construct wxDocManager with no arguments.
+ different `OnCreateFileHistory` from the default.
"""
self.OnCreateFileHistory()
return True
def OnCreateFileHistory(self):
"""
A hook to allow a derived class to create a different type of file
- history. Called from Initialize.
+ history. Called from `Initialize`.
"""
self._fileHistory = wx.FileHistory()
def OnFileRevert(self, event):
"""
- Reverts the current document by calling wxDocument.Save for the current
- document.
+ Reverts the current document by calling `Document.Save` for
+ the current document.
"""
doc = self.GetCurrentDocument()
if not doc:
def OnFileSave(self, event):
"""
- Saves the current document by calling wxDocument.Save for the current
- document.
+ Saves the current document by calling `Document.Save` for the
+ current document.
"""
doc = self.GetCurrentDocument()
if not doc:
def OnFileSaveAs(self, event):
"""
- Calls wxDocument.SaveAs for the current document.
+ Calls `Document.SaveAs` for the current document.
"""
doc = self.GetCurrentDocument()
if not doc:
def OnPrint(self, event):
"""
- Prints the current document by calling its View's OnCreatePrintout
- method.
+ Prints the current document by calling its
+ `View.OnCreatePrintout` method.
"""
view = self.GetCurrentView()
if not view:
def OnPreview(self, event):
"""
- Previews the current document by calling its View's OnCreatePrintout
+ Previews the current document by calling its `View.OnCreatePrintout`
method.
"""
view = self.GetCurrentView()
def GetLastActiveView(self):
"""
- Returns the last active view. This is used in the SDI framework where dialogs can be mistaken for a view
- and causes the framework to deactivete the current view. This happens when something like a custom dialog box used
- to operate on the current view is shown.
+ Returns the last active view. This is used in the SDI
+ framework where dialogs can be mistaken for a view and causes
+ the framework to deactivete the current view. This happens
+ when something like a custom dialog box used to operate on the
+ current view is shown.
"""
if len(self._docs) >= 1:
return self._lastActiveView
def ProcessEvent(self, event):
"""
- Processes an event, searching event tables and calling zero or more
- suitable event handler function(s). Note that the ProcessEvent
- method is called from the wxPython docview framework directly since
- wxPython does not have a virtual ProcessEvent function.
+ Processes an event, searching event tables and calling zero or
+ more suitable event handler function(s). Note that the
+ ProcessEvent method is called from the wxPython docview
+ framework directly since wxPython does not have a virtual
+ ProcessEvent function.
"""
view = self.GetCurrentView()
if view:
def ProcessUpdateUIEvent(self, event):
"""
- Processes a UI event, searching event tables and calling zero or more
- suitable event handler function(s). Note that the ProcessEvent
- method is called from the wxPython docview framework directly since
- wxPython does not have a virtual ProcessEvent function.
+ Processes a UI event, searching event tables and calling zero
+ or more suitable event handler function(s). Note that the
+ ProcessEvent method is called from the wxPython docview
+ framework directly since wxPython does not have a virtual
+ ProcessEvent function.
"""
id = event.GetId()
view = self.GetCurrentView()
Creates a new document in a manner determined by the flags parameter,
which can be:
- wx.lib.docview.DOC_NEW Creates a fresh document.
- wx.lib.docview.DOC_SILENT Silently loads the given document file.
-
- If wx.lib.docview.DOC_NEW is present, a new document will be created and returned,
- possibly after asking the user for a template to use if there is more
- than one document template. If wx.lib.docview.DOC_SILENT is present, a new document
- will be created and the given file loaded into it. If neither of these
- flags is present, the user will be presented with a file selector for
- the file to load, and the template to use will be determined by the
- extension (Windows) or by popping up a template choice list (other
+ * DOC_NEW: Creates a fresh document.
+ * DOC_SILENT: Silently loads the given document file.
+
+ If DOC_NEW is present, a new document will be created and
+ returned, possibly after asking the user for a template to use
+ if there is more than one document template. If DOC_SILENT is
+ present, a new document will be created and the given file
+ loaded into it. If neither of these flags is present, the user
+ will be presented with a file selector for the file to load,
+ and the template to use will be determined by the extension
+ (Windows) or by popping up a template choice list (other
platforms).
- If the maximum number of documents has been reached, this function
- will delete the oldest currently loaded document before creating a new
- one.
+ If the maximum number of documents has been reached, this
+ function will delete the oldest currently loaded document
+ before creating a new one.
- wxPython version supports the document manager's wx.lib.docview.DOC_OPEN_ONCE flag.
+ wxPython version supports the document manager's DOC_OPEN_ONCE
+ flag.
"""
templates = []
for temp in self._templates:
def DeleteTemplate(self, template, flags):
"""
- Placeholder, not yet implemented in wxWindows.
+ Placeholder, not yet implemented
"""
pass
def FlushDoc(self, doc):
"""
- Placeholder, not yet implemented in wxWindows.
+ Placeholder, not yet implemented
"""
return False
def MatchTemplate(self, path):
"""
- Placeholder, not yet implemented in wxWindows.
+ Placeholder, not yet implemented
"""
return None
On other platforms, if there is more than one document template a
choice list is popped up, followed by a file selector.
- This function is used in wxDocManager.CreateDocument.
+ This function is used in `DocManager.CreateDocument`.
"""
if wx.Platform == "__WXMSW__" or wx.Platform == "__WXGTK__" or wx.Platform == "__WXMAC__":
allfilter = ''
def SelectDocumentType(self, temps, sort = False):
"""
Returns a document template by asking the user (if there is more than
- one template). This function is used in wxDocManager.CreateDocument.
+ one template). This function is used in `DocManager.CreateDocument`.
- Parameters
+ :param temps: list of templates from which to choose a desired template.
- templates - list of templates from which to choose a desired template.
-
- sort - If more than one template is passed in in templates, then this
- parameter indicates whether the list of templates that the user will
- have to choose from is sorted or not when shown the choice box dialog.
- Default is false.
+ :param sort: If more than one template is passed in in
+ templates, then this parameter indicates whether the list
+ of templates that the user will have to choose from is
+ sorted or not when shown the choice box dialog. Default
+ is false.
"""
templates = []
for temp in temps:
def SelectViewType(self, temps, sort = False):
"""
- Returns a document template by asking the user (if there is more than one template), displaying a list of valid views. This function is used in wxDocManager::CreateView. The dialog normally will not appear because the array of templates only contains those relevant to the document in question, and often there will only be one such.
+ Returns a document template by asking the user (if there is
+ more than one template), displaying a list of valid
+ views. This function is used in `DocManager.CreateView`. The
+ dialog normally will not appear because the array of templates
+ only contains those relevant to the document in question, and
+ often there will only be one such.
"""
templates = []
strings = []
def GetTemplates(self):
"""
- Returns the document manager's template list. This method has been added to
- wxPython and is not in wxWindows.
+ Returns the document manager's template list.
"""
return self._templates
class DocParentFrame(wx.Frame):
"""
- The wxDocParentFrame class provides a default top-level frame for
- applications using the document/view framework. This class can only be
- used for SDI (not MDI) parent frames.
+ The DocParentFrame class provides a default top-level frame for
+ applications using the document/view framework. This class can
+ only be used for SDI (not MDI) parent frames.
- It cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplates
- classes.
+ It cooperates with the `View`, `Document`, `DocManager` and
+ `DocTemplate` classes.
"""
- def __init__(self, manager, frame, id, title, pos = wx.DefaultPosition, size = wx.DefaultSize, style = wx.DEFAULT_FRAME_STYLE, name = "frame"):
+ def __init__(self, manager, frame, id, title,
+ pos = wx.DefaultPosition,
+ size = wx.DefaultSize,
+ style = wx.DEFAULT_FRAME_STYLE,
+ name = "frame"):
"""
Constructor. Note that the event table must be rebuilt for the
frame since the EvtHandler is not virtual.
class DocChildFrame(wx.Frame):
"""
- The wxDocChildFrame class provides a default frame for displaying
- documents on separate windows. This class can only be used for SDI (not
- MDI) child frames.
+ The `DocChildFrame` class provides a default frame for displaying
+ documents on separate windows. This class can only be used for SDI
+ (not MDI) child frames.
- The class is part of the document/view framework supported by wxWindows,
- and cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate
+ The class is part of the document/view framework and cooperates
+ with the `View`, `Document`, `DocManager` and `DocTemplate`
classes.
"""
class DocMDIParentFrame(wx.MDIParentFrame):
"""
- The wxDocMDIParentFrame class provides a default top-level frame for
- applications using the document/view framework. This class can only be
- used for MDI parent frames.
+ The `DocMDIParentFrame` class provides a default top-level frame
+ for applications using the document/view framework. This class can
+ only be used for MDI parent frames.
- It cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate
- classes.
+ It cooperates with the `View`, `Document`, `DocManager` and
+ `DocTemplate` classes.
"""
class DocMDIChildFrame(wx.MDIChildFrame):
"""
- The wxDocMDIChildFrame class provides a default frame for displaying
- documents on separate windows. This class can only be used for MDI child
- frames.
+ The `DocMDIChildFrame` class provides a default frame for
+ displaying documents on separate windows. This class can only be
+ used for MDI child frames.
- The class is part of the document/view framework supported by wxWindows,
- and cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate
+ The class is part of the document/view framework and cooperates
+ with the `View`, `Document`, `DocManager` and `DocTemplate`
classes.
"""
class DocPrintout(wx.Printout):
"""
- DocPrintout is a default Printout that prints the first page of a document
- view.
+ `DocPrintout` is a default Printout that prints the first page of
+ a document view.
"""
class Command(wx.Object):
"""
- wxCommand is a base class for modelling an application command, which is
- an action usually performed by selecting a menu item, pressing a toolbar
- button or any other means provided by the application to change the data
- or view.
+ `Command` is a base class for modelling an application command,
+ which is an action usually performed by selecting a menu item,
+ pressing a toolbar button or any other means provided by the
+ application to change the data or view.
"""
def __init__(self, canUndo = False, name = None):
"""
- Constructor. wxCommand is an abstract class, so you will need to
- derive a new class and call this constructor from your own constructor.
+ Constructor. Command is an abstract class, so you will need to
+ derive a new class and call this constructor from your own
+ constructor.
- canUndo tells the command processor whether this command is undo-able.
- You can achieve the same functionality by overriding the CanUndo member
- function (if for example the criteria for undoability is context-
- dependent).
+ :param canUndo: tells the command processor whether this
+ command is undo-able. You can achieve the same
+ functionality by overriding the `CanUndo` member function
+ (if for example the criteria for undoability is context-
+ dependent).
- name must be supplied for the command processor to display the command
- name in the application's edit menu.
+ :param name: must be supplied for the command processor to
+ display the command name in the application's edit menu.
+
"""
self._canUndo = canUndo
self._name = name
def Do(self):
"""
- Override this member function to execute the appropriate action when
- called. Return true to indicate that the action has taken place, false
- otherwise. Returning false will indicate to the command processor that
- the action is not undoable and should not be added to the command
- history.
+ Override this member function to execute the appropriate
+ action when called. Return true to indicate that the action
+ has taken place, false otherwise. Returning false will
+ indicate to the command processor that the action is not
+ undoable and should not be added to the command history.
"""
return True
def Undo(self):
"""
- Override this member function to un-execute a previous Do. Return true
- to indicate that the action has taken place, false otherwise. Returning
- false will indicate to the command processor that the action is not
- redoable and no change should be made to the command history.
+ Override this member function to un-execute a previous
+ `Do`. Return true to indicate that the action has taken place,
+ false otherwise. Returning false will indicate to the command
+ processor that the action is not redoable and no change should
+ be made to the command history.
- How you implement this command is totally application dependent, but
- typical strategies include:
+ How you implement this command is totally application
+ dependent, but typical strategies include:
- Perform an inverse operation on the last modified piece of data in the
- document. When redone, a copy of data stored in command is pasted back
- or some operation reapplied. This relies on the fact that you know the
- ordering of Undos; the user can never Undo at an arbitrary position in
- he command history.
+ * Perform an inverse operation on the last modified piece
+ of data in the document. When redone, a copy of data
+ stored in command is pasted back or some operation
+ reapplied. This relies on the fact that you know the
+ ordering of Undos; the user can never Undo at an
+ arbitrary position in he command history.
- Restore the entire document state (perhaps using document
- transactioning). Potentially very inefficient, but possibly easier to
- code if the user interface and data are complex, and an 'inverse
- execute' operation is hard to write.
+ * Restore the entire document state (perhaps using
+ document transactioning). Potentially very inefficient,
+ but possibly easier to code if the user interface and
+ data are complex, and an 'inverse execute' operation is
+ hard to write.
"""
return True
class CommandProcessor(wx.Object):
"""
- wxCommandProcessor is a class that maintains a history of wxCommands, with
- undo/redo functionality built-in. Derive a new class from this if you want
- different behaviour.
+ `CommandProcessor` is a class that maintains a history of
+ `Command` instancess, with undo/redo functionality
+ built-in. Derive a new class from this if you want different
+ behaviour.
"""
def SetEditMenu(self, menu):
"""
- Tells the command processor to update the Undo and Redo items on this
- menu as appropriate. Set this to NULL if the menu is about to be
- destroyed and command operations may still be performed, or the
- command processor may try to access an invalid pointer.
+ Tells the command processor to update the Undo and Redo items
+ on this menu as appropriate. Set this to None if the menu is
+ about to be destroyed and command operations may still be
+ performed, or the command processor may try to access an
+ invalid pointer.
"""
self._editMenu = menu
self._redoAccelerator = accel
- def SetEditMenu(self, menu):
- """
- Tells the command processor to update the Undo and Redo items on this
- menu as appropriate. Set this to NULL if the menu is about to be
- destroyed and command operations may still be performed, or the
- command processor may try to access an invalid pointer.
- """
- self._editMenu = menu
-
-
def SetMenuStrings(self):
"""
- Sets the menu labels according to the currently set menu and the
- current command state.
+ Sets the menu labels according to the currently set menu and
+ the current command state.
"""
if self.GetEditMenu() != None:
undoCommand = self._GetCurrentCommand()
def Submit(self, command, storeIt = True):
"""
Submits a new command to the command processor. The command processor
- calls wxCommand::Do to execute the command; if it succeeds, the
+ calls `Command.Do` to execute the command; if it succeeds, the
command is stored in the history list, and the associated edit menu
(if any) updated appropriately. If it fails, the command is deleted
- immediately. Once Submit has been called, the passed command should
+ immediately. Once `Submit` has been called, the passed command should
not be deleted directly by the application.
storeIt indicates whether the successful command should be stored in
projects / wxWidgets.git / blobdiff