]> git.saurik.com Git - wxWidgets.git/commitdiff
Document wxDocManager::CloseDocument().
authorVadim Zeitlin <vadim@wxwidgets.org>
Fri, 21 May 2010 15:25:43 +0000 (15:25 +0000)
committerVadim Zeitlin <vadim@wxwidgets.org>
Fri, 21 May 2010 15:25:43 +0000 (15:25 +0000)
CloseDocuments() was documented but not CloseDocument(), this probably wasn't
intentional.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64377 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/wx/docview.h

index dd5f3bcc19f455d283806d02025bc1a40dad19ba..09a4db25b1a7653d83c8cae5233cc5523ee4fc82 100644 (file)
@@ -363,8 +363,27 @@ public:
     */
     void AssociateTemplate(wxDocTemplate* temp);
 
+    /**
+        Closes the specified document.
+
+        If @a force is @true, the document is closed even if it has unsaved
+        changes.
+
+        @param doc
+            The document to close, must be non-@NULL.
+        @param force
+            If @true, close the document even if wxDocument::Close() returns
+            @false.
+        @return
+            @true if the document was closed or @false if closing it was
+            cancelled by user (only in @a force = @false case).
+     */
+    bool CloseDocument(wxDocument *doc, bool force = false);
+
     /**
         Closes all currently opened documents.
+
+        @see CloseDocument()
     */
     bool CloseDocuments(bool force = true);