From ea58481248da20a3979dd407abfa168a4e995c2f Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Fri, 21 May 2010 15:25:43 +0000 Subject: [PATCH] Document wxDocManager::CloseDocument(). 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 | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/interface/wx/docview.h b/interface/wx/docview.h index dd5f3bcc19..09a4db25b1 100644 --- a/interface/wx/docview.h +++ b/interface/wx/docview.h @@ -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); -- 2.45.2