Add wxDocument::Activate() method.

Make activating the first (and, in the vast majority of cases, the only) view
of the document easier.

Closes #15120.

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

diff --git a/docs/changes.txt b/docs/changes.txt
index cf2e34f02a85cf1c485605d83b722b5b6b607111..5ece48ffc888d04ce4e9d76303d4b37b9e7daec4 100644 (file)
--- a/docs/changes.txt
+++ b/docs/changes.txt
@@ -624,6 +624,7 @@ All (GUI):
 - Add wxAUI_TB_PLAIN_BACKGROUND wxAuiToolBar style (Allann Jones).
 - Make wxGenericDataViewCtrl::SetFont() really work (Laurent Poujoulat).
 - Remove wxLogWindow::OnFrameCreate(), it was never called anyhow.
 - Add wxAUI_TB_PLAIN_BACKGROUND wxAuiToolBar style (Allann Jones).
 - Make wxGenericDataViewCtrl::SetFont() really work (Laurent Poujoulat).
 - Remove wxLogWindow::OnFrameCreate(), it was never called anyhow.

+- Added wxDocument::Activate() (troelsk).

 
 wxGTK:
 
 
 wxGTK:
 

diff --git a/include/wx/docview.h b/include/wx/docview.h
index 420355df5fb561711dd239fa6e86bab96f002a53..d9c34e64a615f0ee1051f621047a5ea67d4c3597 100644 (file)
--- a/include/wx/docview.h
+++ b/include/wx/docview.h
@@ -86,6 +86,9 @@ public:
     bool GetDocumentSaved() const { return m_savedYet; }
     void SetDocumentSaved(bool saved = true) { m_savedYet = saved; }
 
     bool GetDocumentSaved() const { return m_savedYet; }
     void SetDocumentSaved(bool saved = true) { m_savedYet = saved; }
 

+    // activate the first view of the document if any
+    void Activate();
+

     // return true if the document hasn't been modified since the last time it
     // was saved (implying that it returns false if it was never saved, even if
     // the document is not modified)
     // return true if the document hasn't been modified since the last time it
     // was saved (implying that it returns false if it was never saved, even if
     // the document is not modified)


@@ -550,10 +553,6 @@ protected:
     // view and returns it then
     wxView *GetActiveView() const;
 
     // view and returns it then
     wxView *GetActiveView() const;
 

-    // activate the first view of the given document if any
-    void ActivateDocument(wxDocument *doc);
-
-

     int               m_defaultDocumentNameCounter;
     int               m_maxDocsOpen;
     wxList            m_docs;
     int               m_defaultDocumentNameCounter;
     int               m_maxDocsOpen;
     wxList            m_docs;

diff --git a/interface/wx/docview.h b/interface/wx/docview.h
index 13d8b218fe32880d289aa48fd2dcf106f41acd76..279556757b159bffc065886789b57dea251058a5 100644 (file)
--- a/interface/wx/docview.h
+++ b/interface/wx/docview.h
@@ -1240,6 +1240,15 @@ public:
      */
     bool AlreadySaved() const;
 
      */
     bool AlreadySaved() const;
 

+    /**
+        Activate the first view of the document if any.
+
+        @see GetFirstView()
+
+        @since 2.9.5
+     */
+    void Activate() const;
+

     /**
         Closes the document, by calling OnSaveModified() and then (if this
         returned @true) OnCloseDocument(). This does not normally delete the
     /**
         Closes the document, by calling OnSaveModified() and then (if this
         returned @true) OnCloseDocument(). This does not normally delete the

diff --git a/src/common/docview.cpp b/src/common/docview.cpp
index 849a3a275441c4118bb938be714aa01ffd2172fb..234c5c2b85e9819d7d131179ec31299fc6168175 100644 (file)
--- a/src/common/docview.cpp
+++ b/src/common/docview.cpp
@@ -1407,9 +1407,9 @@ wxDocTemplateVector GetVisibleTemplates(const wxList& allTemplates)
 
 } // anonymous namespace
 
 
 } // anonymous namespace
 

-void wxDocManager::ActivateDocument(wxDocument *doc)
+void wxDocument::Activate()

 {
 {

-    wxView * const view = doc->GetFirstView();
+    wxView * const view = GetFirstView();

     if ( !view )
         return;
 
     if ( !view )
         return;
 


@@ -1472,7 +1472,7 @@ wxDocument *wxDocManager::CreateDocument(const wxString& pathOrig, long flags)
             if ( fn == doc->GetFilename() )
             {
                 // file already open, just activate it and return
             if ( fn == doc->GetFilename() )
             {
                 // file already open, just activate it and return

-                ActivateDocument(doc);
+                doc->Activate();

                 return doc;
             }
         }
                 return doc;
             }
         }


@@ -1523,7 +1523,7 @@ wxDocument *wxDocManager::CreateDocument(const wxString& pathOrig, long flags)
     // at least under Mac (where views are top level windows) it seems to be
     // necessary to manually activate the new document to bring it to the
     // forefront -- and it shouldn't hurt doing this under the other platforms
     // at least under Mac (where views are top level windows) it seems to be
     // necessary to manually activate the new document to bring it to the
     // forefront -- and it shouldn't hurt doing this under the other platforms

-    ActivateDocument(docNew);
+    docNew->Activate();

 
     return docNew;
 }
 
     return docNew;
 }