cleanup:

[wxWidgets.git] / wxPython / wx / lib / docview.py

diff --git a/wxPython/wx/lib/docview.py b/wxPython/wx/lib/docview.py
index 2c47b8d0cbf50db0f776a34639ae0e4a51e264de..83423dbf1bc387ce92cda778af9fb7f6369b5320 100644 (file)
--- a/wxPython/wx/lib/docview.py
+++ b/wxPython/wx/lib/docview.py
@@ -6,7 +6,7 @@
 #
 # Created:      5/15/03
 # CVS-ID:       $Id$
 #
 # Created:      5/15/03
 # CVS-ID:       $Id$

-# Copyright:    (c) 2003-2005 ActiveGrid, Inc. (Port of wxWindows classes by Julian Smart et al)
+# Copyright:    (c) 2003-2006 ActiveGrid, Inc. (Port of wxWindows classes by Julian Smart et al)

 # License:      wxWindows license
 #----------------------------------------------------------------------------
 
 # License:      wxWindows license
 #----------------------------------------------------------------------------
 


@@ -214,8 +214,10 @@ class Document(wx.EvtHandler):
         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).
         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).

+        This method has been extended to notify its views that the dirty flag has changed.

         """
         self._documentModified = modify
         """
         self._documentModified = modify

+        self.UpdateAllViews(hint=("modify", self, self._documentModified))

 
 
     def SetDocumentModificationDate(self):
 
 
     def SetDocumentModificationDate(self):


@@ -236,6 +238,16 @@ class Document(wx.EvtHandler):
         return self._documentModificationDate
 
 
         return self._documentModificationDate
 
 

+    def IsDocumentModificationDateCorrect(self):
+        """
+        Returns False if the file has been modified outside of the application.
+        This method has been added to wxPython and is not in wxWindows.
+        """
+        if not os.path.exists(self.GetFilename()):  # document must be in memory only and can't be out of date
+            return True
+        return self._documentModificationDate == os.path.getmtime(self.GetFilename())
+
+

     def GetViews(self):
         """
         Returns the list whose elements are the views on the document.
     def GetViews(self):
         """
         Returns the list whose elements are the views on the document.


@@ -271,6 +283,7 @@ class Document(wx.EvtHandler):
         Destructor. Removes itself from the document manager.
         """
         self.DeleteContents()
         Destructor. Removes itself from the document manager.
         """
         self.DeleteContents()

+        self._documentModificationDate = None

         if self.GetDocumentManager():
             self.GetDocumentManager().RemoveDocument(self)
         wx.EvtHandler.Destroy(self)
         if self.GetDocumentManager():
             self.GetDocumentManager().RemoveDocument(self)
         wx.EvtHandler.Destroy(self)


@@ -364,7 +377,7 @@ class Document(wx.EvtHandler):
             return True
 
         """ check for file modification outside of application """
             return True
 
         """ check for file modification outside of application """

-        if os.path.exists(self.GetFilename()) and os.path.getmtime(self.GetFilename()) != self.GetDocumentModificationDate():
+        if not self.IsDocumentModificationDateCorrect():

             msgTitle = wx.GetApp().GetAppName()
             if not msgTitle:
                 msgTitle = _("Application")
             msgTitle = wx.GetApp().GetAppName()
             if not msgTitle:
                 msgTitle = _("Application")


@@ -485,9 +498,9 @@ class Document(wx.EvtHandler):
                           self.GetDocumentWindow())
             return False
 
                           self.GetDocumentWindow())
             return False
 

+        self.SetDocumentModificationDate()

         self.SetFilename(filename, True)
         self.Modify(False)
         self.SetFilename(filename, True)
         self.Modify(False)

-        self.SetDocumentModificationDate()

         self.SetDocumentSaved(True)
         #if wx.Platform == '__WXMAC__':  # Not yet implemented in wxPython
         #    wx.FileName(file).MacSetDefaultTypeAndCreator()
         self.SetDocumentSaved(True)
         #if wx.Platform == '__WXMAC__':  # Not yet implemented in wxPython
         #    wx.FileName(file).MacSetDefaultTypeAndCreator()


@@ -529,9 +542,9 @@ class Document(wx.EvtHandler):
                           self.GetDocumentWindow())
             return False
 
                           self.GetDocumentWindow())
             return False
 

+        self.SetDocumentModificationDate()

         self.SetFilename(filename, True)
         self.Modify(False)
         self.SetFilename(filename, True)
         self.Modify(False)

-        self.SetDocumentModificationDate()

         self.SetDocumentSaved(True)
         self.UpdateAllViews()
         return True
         self.SetDocumentSaved(True)
         self.UpdateAllViews()
         return True


@@ -614,7 +627,7 @@ class Document(wx.EvtHandler):
             return True
 
         """ check for file modification outside of application """
             return True
 
         """ check for file modification outside of application """

-        if os.path.exists(self.GetFilename()) and os.path.getmtime(self.GetFilename()) != self.GetDocumentModificationDate():
+        if not self.IsDocumentModificationDateCorrect():

             msgTitle = wx.GetApp().GetAppName()
             if not msgTitle:
                 msgTitle = _("Warning")
             msgTitle = wx.GetApp().GetAppName()
             if not msgTitle:
                 msgTitle = _("Warning")


@@ -844,8 +857,14 @@ class View(wx.EvtHandler):
         unused but may in future contain application-specific information for
         making updating more efficient.
         """
         unused but may in future contain application-specific information for
         making updating more efficient.
         """

-        pass
-
+        if hint:
+            if hint[0] == "modify":  # if dirty flag changed, update the view's displayed title
+                frame = self.GetFrame()
+                if frame and hasattr(frame, "OnTitleIsModified"):
+                    frame.OnTitleIsModified()
+                    return True
+        return False
+        

 
     def OnChangeFilename(self):
         """
 
     def OnChangeFilename(self):
         """


@@ -916,11 +935,11 @@ class View(wx.EvtHandler):
         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
         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

-        any place where you know the view must be active, and
+        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
         the framework will need to get the current view.
 
         The prepackaged view frame wxDocChildFrame calls wxView.Activate from

-        its OnActivate member.
+        its OnActivate member and from its OnMenuCommand member.

         """
         if self.GetDocument() and self.GetDocumentManager():
             self.OnActivateView(activate, self, self.GetDocumentManager().GetCurrentView())
         """
         if self.GetDocument() and self.GetDocumentManager():
             self.OnActivateView(activate, self, self.GetDocumentManager().GetCurrentView())


@@ -1020,7 +1039,7 @@ class DocTemplate(wx.Object):
         string will be displayed in the file filter list of Windows file
         selectors.
 
         string will be displayed in the file filter list of Windows file
         selectors.
 

-        filter is an appropriate file filter such as *.txt.
+        filter is an appropriate file filter such as \*.txt.

 
         dir is the default directory to use for file selectors.
 
 
         dir is the default directory to use for file selectors.
 


@@ -1368,7 +1387,8 @@ class DocManager(wx.EvtHandler):
         for document in self._docs[::-1]:  # Close in lifo (reverse) order.  We clone the list to make sure we go through all docs even as they are deleted
             if not self.CloseDocument(document, force):
                 return False
         for document in self._docs[::-1]:  # Close in lifo (reverse) order.  We clone the list to make sure we go through all docs even as they are deleted
             if not self.CloseDocument(document, force):
                 return False

-            document.DeleteAllViews() # Implicitly delete the document when the last view is removed
+            if document:
+                document.DeleteAllViews() # Implicitly delete the document when the last view is removed

         return True
 
 
         return True
 
 


@@ -1865,7 +1885,7 @@ class DocManager(wx.EvtHandler):
             for document in self._docs:
                 if document.GetFilename() and os.path.normcase(document.GetFilename()) == os.path.normcase(path):
                     """ check for file modification outside of application """
             for document in self._docs:
                 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():
+                    if not document.IsDocumentModificationDateCorrect():

                         msgTitle = wx.GetApp().GetAppName()
                         if not msgTitle:
                             msgTitle = _("Warning")
                         msgTitle = wx.GetApp().GetAppName()
                         if not msgTitle:
                             msgTitle = _("Warning")


@@ -1903,7 +1923,7 @@ class DocManager(wx.EvtHandler):
                     newDoc.DeleteAllViews()  # Implicitly deleted by DeleteAllViews
                     frame = newDoc.GetFirstView().GetFrame()
                     if frame:
                     newDoc.DeleteAllViews()  # Implicitly deleted by DeleteAllViews
                     frame = newDoc.GetFirstView().GetFrame()
                     if frame:

-                        Destroy() # DeleteAllViews doesn't get rid of the frame, so we'll explicitly destroy it.
+                        frame.Destroy() # DeleteAllViews doesn't get rid of the frame, so we'll explicitly destroy it.

                     return None
                 self.AddFileToHistory(path)
             return newDoc
                     return None
                 self.AddFileToHistory(path)
             return newDoc


@@ -2148,7 +2168,7 @@ class DocManager(wx.EvtHandler):
                     if len(descr) > 0:
                         descr = descr + _('|')
                     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
                     if len(descr) > 0:
                         descr = descr + _('|')
                     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

-            descr = _("All (*.*)|*.*|%s") % descr  # spacing is important, make sure there is no space after the "|", it causes a bug on wx_gtk
+            descr = _("All|*.*|%s") % descr  # spacing is important, make sure there is no space after the "|", it causes a bug on wx_gtk

         else:
             descr = _("*.*")
 
         else:
             descr = _("*.*")
 


@@ -2791,6 +2811,7 @@ class DocMDIChildFrame(wx.MDIChildFrame):
             self._childView.Activate(event.GetActive())
         self._activated = 0
 
             self._childView.Activate(event.GetActive())
         self._activated = 0
 

+

     def OnCloseWindow(self, event):
         """
         Closes and deletes the current view and document.
     def OnCloseWindow(self, event):
         """
         Closes and deletes the current view and document.


@@ -2846,6 +2867,28 @@ class DocMDIChildFrame(wx.MDIChildFrame):
         self._childView = view
 
 
         self._childView = view
 
 

+    def OnTitleIsModified(self):
+        """
+        Add/remove to the frame's title an indication that the document is dirty.
+        If the document is dirty, an '*' is appended to the title
+        This method has been added to wxPython and is not in wxWindows.
+        """
+        title = self.GetTitle()
+        if title:
+            if self.GetDocument().IsModified():
+                if title.endswith("*"):
+                    return
+                else:
+                    title = title + "*"
+                    self.SetTitle(title)
+            else:
+                if title.endswith("*"):
+                    title = title[:-1]
+                    self.SetTitle(title)                
+                else:
+                    return
+
+

 class DocPrintout(wx.Printout):
     """
     DocPrintout is a default Printout that prints the first page of a document
 class DocPrintout(wx.Printout):
     """
     DocPrintout is a default Printout that prints the first page of a document


@@ -2892,15 +2935,6 @@ class DocPrintout(wx.Printout):
         return pageNum == 1
 
 
         return pageNum == 1
 
 

-    def OnBeginDocument(self, startPage, endPage):
-        """
-        Not quite sure why this was overridden, but it was in wxWindows! :)
-        """
-        if not wx.Printout.base_OnBeginDocument(self, startPage, endPage):
-            return False
-        return True
-
-

     def GetPageInfo(self):
         """
         Indicates that the DocPrintout only has a single page.
     def GetPageInfo(self):
         """
         Indicates that the DocPrintout only has a single page.