cheng/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Make wxHelpControllerBase::SetFrameParameters() title more clear.

Browse Source 
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
This commit is contained in:
Vadim Zeitlin 2012-09-28 23:48:57 +00:00
parent 45df4bb6c2
commit eae48ea12d
4 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
include/wx/html/helpctrl.h
View File

@ -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);

2
interface/wx/generic/helpext.h
View File

@ -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);

8
interface/wx/help.h
View File

@ -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);

4
src/html/helpctrl.cpp
View File

@ -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)