X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b792147db7e5ceb5da741f5f6e27fea79944a04c..25b3661bd4cb44304418b93c0dee1d0dfb99765c:/wxPython/wx/lib/docview.py diff --git a/wxPython/wx/lib/docview.py b/wxPython/wx/lib/docview.py index a945a14969..2ef9db4441 100644 --- a/wxPython/wx/lib/docview.py +++ b/wxPython/wx/lib/docview.py @@ -13,6 +13,7 @@ import os import os.path +import shutil import wx import sys _ = wx.GetTranslation @@ -83,7 +84,7 @@ class Document(wx.EvtHandler): """ - def __init__(self, parent = None): + def __init__(self, parent=None): """ Constructor. Define your own default constructor to initialize application-specific data. @@ -171,7 +172,7 @@ class Document(wx.EvtHandler): return self._savedYet - def SetDocumentSaved(self, saved = True): + def SetDocumentSaved(self, saved=True): """ Sets whether the document has been saved. This method has been added to wxPython and is not in wxWindows. @@ -435,6 +436,8 @@ class Document(wx.EvtHandler): msgTitle = _("File Error") backupFilename = None + fileObject = None + copied = False try: # if current file exists, move it to a safe place temporarily if os.path.exists(filename): @@ -452,19 +455,27 @@ class Document(wx.EvtHandler): while os.path.exists(backupFilename): i += 1 backupFilename = "%s.bak%s" % (filename, i) - os.rename(filename, backupFilename) + shutil.copy(filename, backupFilename) + copied = True fileObject = file(filename, 'w') self.SaveObject(fileObject) - + fileObject.close() + fileObject = None + if backupFilename: os.remove(backupFilename) except: - # save failed, restore old file - if backupFilename: - os.remove(filename) - os.rename(backupFilename, filename) - self.SetDocumentModificationDate() + # for debugging purposes + import traceback + traceback.print_exc() + + if fileObject: + fileObject.close() # file is still open, close it, need to do this before removal + + # save failed, remove copied file + if backupFilename and copied: + os.remove(backupFilename) wx.MessageBox("Could not save '%s'. %s" % (FileNameFromPath(filename), sys.exc_value), msgTitle, @@ -500,7 +511,16 @@ class Document(wx.EvtHandler): fileObject = file(filename, 'r') try: self.LoadObject(fileObject) + fileObject.close() + fileObject = None except: + # for debugging purposes + import traceback + traceback.print_exc() + + if fileObject: + fileObject.close() # file is still open, close it + wx.MessageBox("Could not open '%s'. %s" % (FileNameFromPath(filename), sys.exc_value), msgTitle, wx.OK | wx.ICON_EXCLAMATION, @@ -876,7 +896,7 @@ class View(wx.EvtHandler): self._viewTypeName = name - def Close(self, deleteWindow = True): + def Close(self, deleteWindow=True): """ Closes the view by calling OnClose. If deleteWindow is true, this function should delete the window associated with the view. @@ -887,7 +907,7 @@ class View(wx.EvtHandler): return False - def Activate(self, activate = True): + 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 @@ -903,7 +923,7 @@ class View(wx.EvtHandler): self.GetDocumentManager().ActivateView(self, activate) - def OnClose(self, deleteWindow = True): + def OnClose(self, deleteWindow=True): """ Implements closing behaviour. The default implementation calls wxDocument.Close to close the associated document. Does not delete the @@ -944,7 +964,7 @@ class View(wx.EvtHandler): Override to return an instance of a class other than wxDocPrintout. """ - return DocPrintout(self) + return DocPrintout(self, self.GetDocument().GetPrintableName()) def GetFrame(self): @@ -984,7 +1004,7 @@ class DocTemplate(wx.Object): """ - 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 @@ -1241,7 +1261,7 @@ class DocManager(wx.EvtHandler): classes. """ - def __init__(self, flags = DEFAULT_DOCMAN_FLAGS, initialize = True): + 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. @@ -1314,7 +1334,7 @@ class DocManager(wx.EvtHandler): return self._flags - def CloseDocument(self, doc, force = True): + def CloseDocument(self, doc, force=True): """ Closes the specified document. """ @@ -1326,7 +1346,7 @@ class DocManager(wx.EvtHandler): return False - def CloseDocuments(self, force = True): + def CloseDocuments(self, force=True): """ Closes all currently opened documents. """ @@ -1337,7 +1357,7 @@ class DocManager(wx.EvtHandler): return True - def Clear(self, force = True): + def Clear(self, force=True): """ Closes all currently opened document by callling CloseDocuments and clears the document manager's templates. @@ -1390,7 +1410,7 @@ class DocManager(wx.EvtHandler): """ return self.CloseDocuments(force = False) - + def OnFileNew(self, event): """ Creates a new document and reads in the selected file. @@ -1449,9 +1469,14 @@ class DocManager(wx.EvtHandler): printout = view.OnCreatePrintout() if printout: - pdd = wx.PrintDialogData() + if not hasattr(self, "printData"): + self.printData = wx.PrintData() + self.printData.SetPaperId(wx.PAPER_LETTER) + self.printData.SetPrintMode(wx.PRINT_MODE_PRINTER) + + pdd = wx.PrintDialogData(self.printData) printer = wx.Printer(pdd) - printer.Print(view.GetFrame(), printout) # , True) + printer.Print(view.GetFrame(), printout) def OnPrintSetup(self, event): @@ -1464,11 +1489,21 @@ class DocManager(wx.EvtHandler): else: parentWin = wx.GetApp().GetTopWindow() - data = wx.PrintDialogData() + if not hasattr(self, "printData"): + self.printData = wx.PrintData() + self.printData.SetPaperId(wx.PAPER_LETTER) + + data = wx.PrintDialogData(self.printData) printDialog = wx.PrintDialog(parentWin, data) printDialog.GetPrintDialogData().SetSetupDialog(True) printDialog.ShowModal() - # TODO: Confirm that we don't have to remember PrintDialogData + + # this makes a copy of the wx.PrintData instead of just saving + # a reference to the one inside the PrintDialogData that will + # be destroyed when the dialog is destroyed + self.printData = wx.PrintData(printDialog.GetPrintDialogData().GetPrintData()) + + printDialog.Destroy() def OnPreview(self, event): @@ -1482,13 +1517,22 @@ class DocManager(wx.EvtHandler): printout = view.OnCreatePrintout() if printout: + if not hasattr(self, "printData"): + self.printData = wx.PrintData() + self.printData.SetPaperId(wx.PAPER_LETTER) + self.printData.SetPrintMode(wx.PRINT_MODE_PREVIEW) + + data = wx.PrintDialogData(self.printData) # Pass two printout objects: for preview, and possible printing. - preview = wx.PrintPreview(printout, view.OnCreatePrintout()) + preview = wx.PrintPreview(printout, view.OnCreatePrintout(), data) + if not preview.Ok(): + wx.MessageBox(_("Unable to display print preview.")) + return # wxWindows source doesn't use base frame's pos, size, and icon, but did it this way so it would work like MS Office etc. mimicFrame = wx.GetApp().GetTopWindow() frame = wx.PreviewFrame(preview, mimicFrame, _("Print Preview"), mimicFrame.GetPosition(), mimicFrame.GetSize()) frame.SetIcon(mimicFrame.GetIcon()) - frame.SetTitle(mimicFrame.GetTitle() + _(" - Preview")) + frame.SetTitle(_("%s - %s - Preview") % (mimicFrame.GetTitle(), view.GetDocument().GetPrintableName())) frame.Initialize() frame.Show(True) @@ -1574,7 +1618,7 @@ class DocManager(wx.EvtHandler): if doc and doc.GetCommandProcessor(): doc.GetCommandProcessor().SetMenuStrings() else: - event.SetText(_("Undo") + '\t' + _('Ctrl+Z')) + event.SetText(_("&Undo\tCtrl+Z")) def OnUpdateRedo(self, event): @@ -1586,7 +1630,7 @@ class DocManager(wx.EvtHandler): if doc and doc.GetCommandProcessor(): doc.GetCommandProcessor().SetMenuStrings() else: - event.SetText(_("Redo") + '\t' + _('Ctrl+Y')) + event.SetText(_("&Redo\tCtrl+Y")) def OnUpdatePrint(self, event): @@ -1737,7 +1781,7 @@ class DocManager(wx.EvtHandler): return False - def CreateDocument(self, path, flags = 0): + def CreateDocument(self, path, flags=0): """ Creates a new document in a manner determined by the flags parameter, which can be: @@ -1799,9 +1843,27 @@ class DocManager(wx.EvtHandler): temp, path = self.SelectDocumentPath(templates, path, flags) # Existing document - if self.GetFlags() & DOC_OPEN_ONCE: + if path and self.GetFlags() & DOC_OPEN_ONCE: for document in self._docs: - if document.GetFilename() == path: + if document.GetFilename() and os.path.normcase(document.GetFilename()) == os.path.normcase(path): + """ check for file modification outside of application """ + if os.path.exists(path) and os.path.getmtime(path) != document.GetDocumentModificationDate(): + msgTitle = wx.GetApp().GetAppName() + if not msgTitle: + msgTitle = _("Warning") + shortName = document.GetPrintableName() + res = wx.MessageBox(_("'%s' has been modified outside of %s. Reload '%s' from file system?") % (shortName, msgTitle, shortName), + msgTitle, + wx.YES_NO | wx.ICON_QUESTION, + self.FindSuitableParent()) + if res == wx.YES: + if not self.CloseDocument(document, False): + wx.MessageBox(_("Couldn't reload '%s'. Unable to close current '%s'.") % (shortName, shortName)) + return None + return self.CreateDocument(path, flags) + elif res == wx.NO: # don't ask again + document.SetDocumentModificationDate() + firstView = document.GetFirstView() if firstView and firstView.GetFrame(): firstView.GetFrame().SetFocus() # Not in wxWindows code but useful nonetheless @@ -1824,7 +1886,7 @@ class DocManager(wx.EvtHandler): return None - def CreateView(self, document, flags = 0): + def CreateView(self, doc, flags=0): """ Creates a new view for the given document. If more than one view is allowed for the document (by virtue of multiple templates mentioning @@ -1985,7 +2047,7 @@ class DocManager(wx.EvtHandler): self._fileHistory.Save(config) - def FileHistoryAddFilesToMenu(self, menu = None): + def FileHistoryAddFilesToMenu(self, menu=None): """ Appends the files in the history list, to all menus managed by the file history object. @@ -2015,11 +2077,17 @@ class DocManager(wx.EvtHandler): Given a path, try to find template that matches the extension. This is only an approximate method of finding a template for creating a document. + + Note this wxPython verson looks for and returns a default template if no specific template is found. """ + default = None for temp in self._templates: if temp.FileMatchesTemplate(path): return temp - return None + + if "*.*" in temp.GetFileFilter(): + default = temp + return default def FindSuitableParent(self): @@ -2058,7 +2126,7 @@ class DocManager(wx.EvtHandler): allfilter = allfilter + _(';') descr = descr + temp.GetDescription() + _(" (") + temp.GetFileFilter() + _(") |") + temp.GetFileFilter() # spacing is important, make sure there is no space after the "|", it causes a bug on wx_gtk allfilter = allfilter + temp.GetFileFilter() - descr = _("All") + _(" (") + allfilter + _(") |") + allfilter + _('|') + descr # spacing is important, make sure there is no space after the "|", it causes a bug on wx_gtk + descr = _("All (%s)|%s|%s|Any (*.*) | *.*") % (allfilter, allfilter, descr) # spacing is important, make sure there is no space after the "|", it causes a bug on wx_gtk else: descr = _("*.*") @@ -2093,7 +2161,7 @@ class DocManager(wx.EvtHandler): pass - def SelectDocumentType(self, temps, sort = False): + 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. @@ -2141,7 +2209,7 @@ class DocManager(wx.EvtHandler): return templates[res] - def SelectViewType(self, temps, sort = False): + 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. """ @@ -2211,7 +2279,7 @@ class DocManager(wx.EvtHandler): self._docs.remove(doc) - def ActivateView(self, view, activate = True, deleting = False): + def ActivateView(self, view, activate=True, deleting=False): """ Sets the current view. """ @@ -2258,7 +2326,7 @@ class DocParentFrame(wx.Frame): 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. @@ -2368,7 +2436,7 @@ class DocChildFrame(wx.Frame): """ - def __init__(self, doc, view, frame, id, title, pos = wx.DefaultPosition, size = wx.DefaultSize, style = wx.DEFAULT_FRAME_STYLE, name = "frame"): + def __init__(self, doc, view, 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. @@ -2514,7 +2582,7 @@ class DocMDIParentFrame(wx.MDIParentFrame): """ - 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. @@ -2624,7 +2692,7 @@ class DocMDIChildFrame(wx.MDIChildFrame): """ - def __init__(self, doc, view, frame, id, title, pos = wx.DefaultPosition, size = wx.DefaultSize, style = wx.DEFAULT_FRAME_STYLE, name = "frame"): + def __init__(self, doc, view, 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. @@ -2722,8 +2790,10 @@ class DocMDIChildFrame(wx.MDIChildFrame): self._childView.Activate(False) self._childView.Destroy() self._childView = None - if self._childDocument: - self._childDocument.Destroy() # This isn't in the wxWindows codebase but the document needs to be disposed of somehow + if self._childDocument: # This isn't in the wxWindows codebase but the document needs to be disposed of somehow + self._childDocument.DeleteContents() + if self._childDocument.GetDocumentManager(): + self._childDocument.GetDocumentManager().RemoveDocument(self._childDocument) self._childDocument = None self.Destroy() else: @@ -2767,11 +2837,11 @@ class DocPrintout(wx.Printout): """ - def __init__(self, view, title = "Printout"): + def __init__(self, view, title="Printout"): """ Constructor. """ - wx.Printout.__init__(self) + wx.Printout.__init__(self, title) self._printoutView = view @@ -2913,7 +2983,7 @@ class CommandProcessor(wx.Object): """ - def __init__(self, maxCommands = -1): + def __init__(self, maxCommands=-1): """ Constructor. maxCommands may be set to a positive integer to limit the number of commands stored to it, otherwise (and by default) the @@ -3039,15 +3109,15 @@ class CommandProcessor(wx.Object): else: redoAccel = '' if undoCommand and undoItem and undoCommand.CanUndo(): - undoItem.SetText(_("Undo ") + undoCommand.GetName() + undoAccel) + undoItem.SetText(_("&Undo ") + undoCommand.GetName() + undoAccel) #elif undoCommand and not undoCommand.CanUndo(): # undoItem.SetText(_("Can't Undo") + undoAccel) else: - undoItem.SetText(_("Undo" + undoAccel)) + undoItem.SetText(_("&Undo" + undoAccel)) if redoCommand and redoItem: - redoItem.SetText(_("Redo ") + redoCommand.GetName() + redoAccel) + redoItem.SetText(_("&Redo ") + redoCommand.GetName() + redoAccel) else: - redoItem.SetText(_("Redo") + redoAccel) + redoItem.SetText(_("&Redo") + redoAccel) def CanUndo(self): @@ -3068,7 +3138,7 @@ class CommandProcessor(wx.Object): return self._GetCurrentRedoCommand() != None - def Submit(self, command, storeIt = True): + 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