Make wxHelpControllerBase::SetFrameParameters() title more clear.

Describe it as "title format string" and call it "titleFormat" and not just
"title" because this is what it is.

Closes #14707.

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

diff --git a/include/wx/html/helpctrl.h b/include/wx/html/helpctrl.h
index a836a4080dabe4745425035e868c8185d877c03d..856c9d2c351307665272efce78aff4bc765b23b6 100644 (file)
--- a/include/wx/html/helpctrl.h
+++ b/include/wx/html/helpctrl.h
@@ -91,7 +91,7 @@ public:
     virtual bool DisplayBlock(long blockNo) { return DisplaySection(blockNo); }
     virtual bool DisplayTextPopup(const wxString& text, const wxPoint& pos);
 
-    virtual void SetFrameParameters(const wxString& title,
+    virtual void SetFrameParameters(const wxString& titleFormat,
                                const wxSize& size,
                                const wxPoint& pos = wxDefaultPosition,
                                bool newFrameEachTime = false);

diff --git a/interface/wx/generic/helpext.h b/interface/wx/generic/helpext.h
index b44be1dd0fd4206621db491a6053d738d8d7fb31..0d772cef9dd5941c555d5e2151503020f76c1447 100644 (file)
--- a/interface/wx/generic/helpext.h
+++ b/interface/wx/generic/helpext.h
@@ -140,7 +140,7 @@ public:
     /**
         Allows one to override the default settings for the help frame.
     */
-    virtual void SetFrameParameters(const wxString& title,
+    virtual void SetFrameParameters(const wxString& titleFormat,
                                     const wxSize& size,
                                     const wxPoint& pos = wxDefaultPosition,
                                     bool newFrameEachTime = false);

diff --git a/interface/wx/help.h b/interface/wx/help.h
index 1c15a76ec02d6fa1786cc44d3377ae65bb15f8df..abaf35a33cc9dd56580624450153b75be17caee2 100644 (file)
--- a/interface/wx/help.h
+++ b/interface/wx/help.h
@@ -199,15 +199,15 @@ public:
     /**
         Set the parameters of the frame window.
 
-        For wxHtmlHelpController, @a title specifies the title string format
-        (with @c %s being replaced by the actual page title) and @a size and
-        @a position specify the geometry of the frame.
+        For wxHtmlHelpController, @a titleFormat specifies the title string
+        format (with @c %s being replaced by the actual page title) and @a size
+        and @a position specify the geometry of the frame.
 
         For all other help controllers this function has no effect.
 
         Finally, @a newFrameEachTime is always ignored currently.
     */
-    virtual void SetFrameParameters(const wxString& title,
+    virtual void SetFrameParameters(const wxString& titleFormat,
                                     const wxSize& size,
                                     const wxPoint& pos = wxDefaultPosition,
                                     bool newFrameEachTime = false);

diff --git a/src/html/helpctrl.cpp b/src/html/helpctrl.cpp
index d3cd0cf50b9bc954e6b8d04b8dc05e7e84de3d29..af46650fa42fd4fd9eb014790dd0a49e0d67998e 100644 (file)
--- a/src/html/helpctrl.cpp
+++ b/src/html/helpctrl.cpp
@@ -341,12 +341,12 @@ void wxHtmlHelpController::SetHelpWindow(wxHtmlHelpWindow* helpWindow)
         helpWindow->SetController(this);
 }
 
-void wxHtmlHelpController::SetFrameParameters(const wxString& title,
+void wxHtmlHelpController::SetFrameParameters(const wxString& titleFormat,
                                    const wxSize& size,
                                    const wxPoint& pos,
                                    bool WXUNUSED(newFrameEachTime))
 {
-    SetTitleFormat(title);
+    SetTitleFormat(titleFormat);
     wxHtmlHelpFrame* frame = wxDynamicCast(FindTopLevelWindow(), wxHtmlHelpFrame);
     wxHtmlHelpDialog* dialog = wxDynamicCast(FindTopLevelWindow(), wxHtmlHelpDialog);
     if (frame)