1//--------------------------------------------------------------------------- 2// This file is generated by wxPython's SIP generator. Do not edit by hand. 3// 4// Copyright: (c) 2018 by Total Control Software 5// License: wxWindows License 6// 7// This file will be included by _adv.sip 8// 9//--------------------------------------------------------------------------- 10 11//--------------------------------------------------------------------------- 12 13class wxExtHelpController : wxHelpControllerBase 14{ 15 %Docstring 16 ExtHelpController(parentWindow=None) 17 18 This class implements help via an external browser. 19 %End 20 %TypeHeaderCode 21 #include <wx/generic/helpext.h> 22 %End 23 24public: 25 wxExtHelpController( 26 wxWindow * parentWindow = NULL 27 ); 28 29 virtual 30 ~wxExtHelpController(); 31 32 virtual 33 void SetViewer( 34 const wxString & viewer = wxEmptyString, 35 long flags = wxHELP_NETSCAPE 36 ); 37 %Docstring 38 SetViewer(viewer=wx.EmptyString, flags=wx.HELP_NETSCAPE) 39 40 Tell it which browser to use. 41 %End 42 43 virtual 44 bool Initialize( 45 const wxString & dir 46 ); 47 %Docstring 48 Initialize(dir) -> bool 49 50 This must be called to tell the controller where to find the 51 documentation. 52 %End 53 54 virtual 55 bool LoadFile( 56 const wxString & file = wxEmptyString 57 ); 58 %Docstring 59 LoadFile(file=wx.EmptyString) -> bool 60 61 If file is "", reloads file given in Initialize. 62 %End 63 64 virtual 65 bool DisplayContents(); 66 %Docstring 67 DisplayContents() -> bool 68 69 Display list of all help entries. 70 %End 71 72 virtual 73 bool DisplaySection( 74 int sectionNo 75 ); 76 %Docstring 77 DisplaySection(sectionNo) -> bool 78 DisplaySection(section) -> bool 79 80 Display help for id sectionNo. 81 %End 82 83 virtual 84 bool DisplaySection( 85 const wxString & section 86 ); 87 88 virtual 89 bool DisplayBlock( 90 long blockNo 91 ); 92 %Docstring 93 DisplayBlock(blockNo) -> bool 94 95 Display help for URL (using DisplayHelp) or keyword (using 96 KeywordSearch) 97 %End 98 99 virtual 100 bool KeywordSearch( 101 const wxString & k, 102 wxHelpSearchMode mode = wxHELP_SEARCH_ALL 103 ); 104 %Docstring 105 KeywordSearch(k, mode=wx.HELP_SEARCH_ALL) -> bool 106 107 Search comment/documentation fields in map file and present a list to 108 chose from. 109 %End 110 111 virtual 112 bool Quit(); 113 %Docstring 114 Quit() -> bool 115 116 Does nothing. 117 %End 118 119 virtual 120 void OnQuit(); 121 %Docstring 122 OnQuit() 123 124 Does nothing. 125 %End 126 127 virtual 128 bool DisplayHelp( 129 const wxString & relativeURL 130 ); 131 %Docstring 132 DisplayHelp(relativeURL) -> bool 133 134 Call the browser using a relative URL. 135 %End 136 137 virtual 138 void SetFrameParameters( 139 const wxString & titleFormat, 140 const wxSize & size, 141 const wxPoint & pos = wxDefaultPosition, 142 bool newFrameEachTime = false 143 ); 144 %Docstring 145 SetFrameParameters(titleFormat, size, pos=wx.DefaultPosition, newFrameEachTime=False) 146 147 Allows one to override the default settings for the help frame. 148 %End 149 150 virtual 151 wxFrame * GetFrameParameters( 152 wxSize * size = NULL, 153 wxPoint * pos = NULL, 154 bool * newFrameEachTime = NULL 155 ); 156 %Docstring 157 GetFrameParameters(size=None, pos=None, newFrameEachTime=None) -> wx.Frame 158 159 Obtains the latest settings used by the help frame and the help frame. 160 %End 161 162 private: 163 wxExtHelpController(const wxExtHelpController&); 164 165 166 public: 167 168 169 %Property(name=FrameParameters, get=GetFrameParameters) 170}; // end of class wxExtHelpController 171 172 173 174//--------------------------------------------------------------------------- 175 176