nobody at rubyforge.org
2006-Nov-27 10:21 UTC
[Wxruby-development] [760] trunk/wxruby2/swig/classes/include/wxHelpController.h: Correct method signatures for Initialize, OnQuit, GetFrameParameters;
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <html xmlns="w3.org/1999/xhtml"> <head><meta http-equiv="content-type" content="text/html; charset=utf-8" /><style type="text/css"><!-- #msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; } #msg dt { float: left; width: 6em; font-weight: bold; } #msg dt:after { content:'':'';} #msg dl, #msg dt, #msg ul, #msg li, #header, #footer { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; } #msg dl a { font-weight: bold} #msg dl a:link { color:#fc3; } #msg dl a:active { color:#ff0; } #msg dl a:visited { color:#cc6; } h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; } #msg pre { overflow: auto; background: #ffc; border: 1px #fc0 solid; padding: 6px; } #msg ul, pre { overflow: auto; } #header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; } #patch { width: 100%; } #patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;} #patch .propset h4, #patch .binary h4 {margin:0;} #patch pre {padding:0;line-height:1.2em;margin:0;} #patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;} #patch .propset .diff, #patch .binary .diff {padding:10px 0;} #patch span {display:block;padding:0 10px;} #patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;} #patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;} #patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;} #patch .lines, .info {color:#888;background:#fff;} --></style> <title>[760] trunk/wxruby2/swig/classes/include/wxHelpController.h: Correct method signatures for Initialize, OnQuit, GetFrameParameters;</title> </head> <body> <div id="msg"> <dl> <dt>Revision</dt> <dd>760</dd> <dt>Author</dt> <dd>brokentoy</dd> <dt>Date</dt> <dd>2006-11-27 05:21:56 -0500 (Mon, 27 Nov 2006)</dd> </dl> <h3>Log Message</h3> <pre>Correct method signatures for Initialize, OnQuit, GetFrameParameters; strip comments</pre> <h3>Modified Paths</h3> <ul> <li><a href="#trunkwxruby2swigclassesincludewxHelpControllerh">trunk/wxruby2/swig/classes/include/wxHelpController.h</a></li> </ul> </div> <div id="patch"> <h3>Diff</h3> <a id="trunkwxruby2swigclassesincludewxHelpControllerh"></a> <div class="modfile"><h4>Modified: trunk/wxruby2/swig/classes/include/wxHelpController.h (759 => 760)</h4> <pre class="diff"><span> <span class="info">--- trunk/wxruby2/swig/classes/include/wxHelpController.h        2006-11-26 09:50:17 UTC (rev 759) +++ trunk/wxruby2/swig/classes/include/wxHelpController.h        2006-11-27 10:21:56 UTC (rev 760) </span><span class="lines">@@ -8,176 +8,22 @@ </span><span class="cx"> class wxHelpController : public wxObject </span><span class="cx"> { </span><span class="cx"> public: </span><del>-        /** -         * \brief Constructs a help instance object, but does not invoke the help viewer. -        */ - </del><span class="cx"> wxHelpController() ; </span><del>-        /** -         * \brief Destroys the help instance, closing down the viewer if it is running. -        */ - </del><span class="cx"> virtual ~wxHelpController() ; </span><del>-        /** -         * \brief -         * \param const wxString& -        */ - - virtual void Initialize(const wxString& file ) ; -        /** -         * \brief Initializes the help instance with a help filename, and optionally a server socket -number if using wxHelp (now obsolete). Does not invoke the help viewer. -This must be called directly after the help instance object is created and before -any attempts to communicate with the viewer. - -You may omit the file extension and a suitable one will be chosen. For -wxHtmlHelpController, the extensions zip, htb and hhp will be appended while searching for -a suitable file. For WinHelp, the hlp extension is appended. -         * \param const wxString& -         * \param int -        */ - - virtual void Initialize(const wxString& file , int server ) ; -        /** -         * \brief If the help viewer is not running, runs it and displays the file at the given block number. - - Refers to the context number. - - Refers to the context number. - - the same as for . - - is an identifier as specified in the file. See . - -This function is for backward compatibility only, and applications should use instead. -         * \param long -        */ - </del><ins>+ virtual bool Initialize(const wxString& file ) ; + virtual bool Initialize(const wxString& file , int server ) ; </ins><span class="cx"> virtual bool DisplayBlock(long blockNo ) ; </span><del>-        /** -         * \brief If the help viewer is not running, runs it and displays the -contents. -        */ - </del><span class="cx"> virtual bool DisplayContents() ; </span><del>-        /** -         * \brief Displays the section as a popup window using a context id. - -Returns false if unsuccessful or not implemented. -         * \param int -        */ - </del><span class="cx"> virtual bool DisplayContextPopup(int contextId ) ; </span><del>-        /** -         * \brief If the help viewer is not running, runs it and displays the given section. - -The interpretation of differs between help viewers. For most viewers, -this call is equivalent to KeywordSearch. For MS HTML Help, wxHTML help and external HTML help, -if has a .htm -or .html extension, that HTML file will be displayed; otherwise -a keyword search is done. -         * \param const wxString& -        */ - </del><span class="cx"> virtual bool DisplaySection(const wxString& section ) ; </span><del>-        /** -         * \brief If the help viewer is not running, runs it and displays the given section. - - is a context id. - - wxExtHelpController implements as an id in a map file, which is of the form: - - - - is an identifier as specified in the file. See . - -See also the help sample for notes on how to specify section numbers for various help file formats. -         * \param int -        */ - </del><span class="cx"> virtual bool DisplaySection(int sectionNo ) ; </span><del>-        /** -         * \brief Displays the text in a popup window, if possible. - -Returns false if unsuccessful or not implemented. -         * \param const wxString& -         * \param const wxPoint& -        */ - </del><span class="cx"> virtual bool DisplayTextPopup(const wxString& text , const wxPoint& pos ) ; </span><del>-        /** -         * \brief wxHtmlHelpController returns the frame, size and position. - -For all other help controllers, this function does nothing -and just returns NULL. -         * \param const wxSize * -         * \param const wxPoint * -         * \param bool * -        */ - - virtual wxFrame * GetFrameParameters(const wxSize * size = NULL, const wxPoint * pos = NULL, bool * newFrameEachTime = NULL) ; -        /** -         * \brief If the help viewer is not running, runs it, and searches for sections matching the given keyword. If one -match is found, the file is displayed at this section. - - If more than one match is found, -the first topic is displayed. - - If more than one match is found, -a choice of topics is displayed. - - see . -         * \param const wxString& -        */ - </del><ins>+ virtual wxFrame * GetFrameParameters(wxSize * size = NULL, wxPoint * pos = NULL, bool * newFrameEachTime = NULL) ; </ins><span class="cx"> virtual bool KeywordSearch(const wxString& keyWord ) ; </span><del>-        /** -         * \brief If the help viewer is not running, runs it and loads the given file. -If the filename is not supplied or is -empty, the file specified in is used. If the viewer is -already displaying the specified file, it will not be reloaded. This -member function may be used before each display call in case the user -has opened another file. - -wxHtmlHelpController ignores this call. -         * \param const wxString& -        */ - </del><span class="cx"> virtual bool LoadFile(const wxString& file = wxT("")) ; </span><del>-        /** -         * \brief Overridable member called when this application''s viewer is quit by the user. - -This does not work for all help controllers. -        */ - - virtual bool OnQuit() ; -        /** -         * \brief For wxHtmlHelpController, the title is set (again with \page title) and also the size and position of the frame if the frame is already -open. is ignored. - -For all other help controllers this function has no effect. -         * \param const wxString & -         * \param const wxSize & -         * \param const wxPoint & -         * \param bool -        */ - </del><ins>+ virtual void OnQuit() ; </ins><span class="cx"> virtual void SetFrameParameters(const wxString & title , const wxSize & size , const wxPoint & pos = wxDefaultPosition, bool newFrameEachTime = false) ; </span><del>-        /** -         * \brief Sets detailed viewer information. So far this is only relevant to wxExtHelpController. - -Some examples of usage: -         * \param const wxString& -         * \param long -        */ - </del><span class="cx"> virtual void SetViewer(const wxString& viewer , long flags ) ; </span><del>-        /** -         * \brief If the viewer is running, quits it by disconnecting. - -For Windows Help, the viewer will only close if no other application is using it. -        */ - </del><span class="cx"> virtual bool Quit() ; </span><span class="cx"> }; </span><span class="cx"> </span></span></pre> </div> </div> </body> </html>
Apparently Analagous Threads
- [953] branches/wxruby2/wxwidgets_282: Additions to HelpController API 2.6 -> 2.8
- [791] trunk/wxruby2/swig/classes/include/wxWindow.h: Remove shadowing GetBestSize def causing warning, plus strip crufty comments
- [950] branches/wxruby2/wxwidgets_282: Changes in GenericDirCtrl API 2.6->2.8, fix TreeItemId mapping, remove cruft
- [883] branches/wxruby2/wxwidgets_282/swig: API changes for move to WxWidgets 2.8
- [1103] trunk/wxruby2: Added 2.8 methods to StaticBitmap & document them; cleanup header file