From eae48ea12d199e78aeea3447b25f12cd92311926 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Fri, 28 Sep 2012 23:48:57 +0000 Subject: [PATCH] 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 --- include/wx/html/helpctrl.h | 2 +- interface/wx/generic/helpext.h | 2 +- interface/wx/help.h | 8 ++++---- src/html/helpctrl.cpp | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/include/wx/html/helpctrl.h b/include/wx/html/helpctrl.h index a836a4080d..856c9d2c35 100644 --- 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 b44be1dd0f..0d772cef9d 100644 --- 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 1c15a76ec0..abaf35a33c 100644 --- 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 d3cd0cf50b..af46650fa4 100644 --- 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) -- 2.45.2