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 _html.sip 8// 9//--------------------------------------------------------------------------- 10 11//--------------------------------------------------------------------------- 12 13const int wxHF_TOOLBAR; 14const int wxHF_CONTENTS; 15const int wxHF_INDEX; 16const int wxHF_SEARCH; 17const int wxHF_BOOKMARKS; 18const int wxHF_OPEN_FILES; 19const int wxHF_PRINT; 20const int wxHF_FLAT_TOOLBAR; 21const int wxHF_MERGE_BOOKS; 22const int wxHF_ICONS_BOOK; 23const int wxHF_ICONS_BOOK_CHAPTER; 24const int wxHF_ICONS_FOLDER; 25const int wxHF_DEFAULT_STYLE; 26class wxHtmlHelpFrame : wxFrame 27{ 28 %Docstring 29 HtmlHelpFrame(data=None) 30 HtmlHelpFrame(parent, id=wx.ID_ANY, title=wx.EmptyString, style=HF_DEFAULT_STYLE, data=None, config=None, rootpath=wx.EmptyString) 31 32 This class is used by wxHtmlHelpController to display help. 33 %End 34 %TypeHeaderCode 35 #include <wx/html/helpfrm.h> 36 %End 37 38public: 39 wxHtmlHelpFrame( 40 wxHtmlHelpData * data = NULL 41 ); 42 %PreMethodCode 43 if (!wxPyCheckForApp()) return NULL; 44 %End 45 46 wxHtmlHelpFrame( 47 wxWindow * parent, 48 wxWindowID id = wxID_ANY, 49 const wxString & title = wxEmptyString, 50 int style = wxHF_DEFAULT_STYLE, 51 wxHtmlHelpData * data = NULL, 52 wxConfigBase * config = NULL, 53 const wxString & rootpath = wxEmptyString 54 ) /Transfer/; 55 %PreMethodCode 56 if (!wxPyCheckForApp()) return NULL; 57 %End 58 59 void AddToolbarButtons( 60 wxToolBar * toolBar, 61 int style 62 ); 63 %Docstring 64 AddToolbarButtons(toolBar, style) 65 66 You may override this virtual method to add more buttons to the help 67 window's toolbar. 68 %End 69 70 bool Create( 71 wxWindow * parent, 72 wxWindowID id = wxID_ANY, 73 const wxString & title = wxEmptyString, 74 int style = wxHF_DEFAULT_STYLE, 75 wxConfigBase * config = NULL, 76 const wxString & rootpath = wxEmptyString 77 ) /TransferThis/; 78 %Docstring 79 Create(parent, id=wx.ID_ANY, title=wx.EmptyString, style=HF_DEFAULT_STYLE, config=None, rootpath=wx.EmptyString) -> bool 80 81 Creates the frame. 82 %End 83 84 wxHtmlHelpController * GetController() const; 85 %Docstring 86 GetController() -> HtmlHelpController 87 88 Returns the help controller associated with the frame. 89 %End 90 91 void SetController( 92 wxHtmlHelpController * controller /Transfer/ 93 ); 94 %Docstring 95 SetController(controller) 96 97 Sets the help controller associated with the frame. 98 %End 99 100 void SetTitleFormat( 101 const wxString & format 102 ); 103 %Docstring 104 SetTitleFormat(format) 105 106 Sets the frame's title format. 107 %End 108 109 public: 110 virtual wxPoint GetClientAreaOrigin() const; 111 virtual bool Validate(); 112 virtual bool TransferDataToWindow(); 113 virtual bool TransferDataFromWindow(); 114 virtual void InitDialog(); 115 virtual bool AcceptsFocus() const; 116 virtual bool AcceptsFocusRecursively() const; 117 virtual bool AcceptsFocusFromKeyboard() const; 118 virtual void AddChild( wxWindowBase *child ); 119 virtual void RemoveChild( wxWindowBase *child ); 120 virtual void InheritAttributes(); 121 virtual bool ShouldInheritColours() const; 122 virtual void OnInternalIdle(); 123 virtual wxWindow *GetMainWindowOfCompositeControl(); 124 virtual bool InformFirstDirection(int direction, int size, int availableOtherDir); 125 virtual void SetCanFocus(bool canFocus); 126 virtual bool Destroy(); 127 virtual void SetValidator( const wxValidator &validator ); 128 virtual wxValidator* GetValidator(); 129 130 131 protected: 132 virtual bool ProcessEvent(wxEvent & event); 133 virtual void DoEnable(bool enable); 134 virtual void DoGetPosition(int *x, int *y) const; 135 virtual void DoGetSize(int *width, int *height) const; 136 virtual void DoGetClientSize(int *width, int *height) const; 137 virtual wxSize DoGetBestSize() const; 138 virtual wxSize DoGetBestClientSize() const; 139 virtual void DoSetSize(int x, int y, int width, int height, int sizeFlags); 140 virtual void DoSetClientSize(int width, int height); 141 virtual void DoSetSizeHints( int minW, int minH, int maxW, int maxH, int incW, int incH ); 142 virtual wxSize DoGetBorderSize() const; 143 virtual void DoMoveWindow(int x, int y, int width, int height); 144 virtual void DoSetWindowVariant( wxWindowVariant variant); 145 virtual wxBorder GetDefaultBorder() const; 146 virtual wxBorder GetDefaultBorderForControl() const; 147 virtual void DoFreeze(); 148 virtual void DoThaw(); 149 virtual bool HasTransparentBackground(); 150 virtual bool TryBefore(wxEvent& event); 151 virtual bool TryAfter(wxEvent& event); 152 153 154 public: 155 156 157 static 158 wxVisualAttributes GetClassDefaultAttributes( 159 wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL 160 ); 161 %Docstring 162 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 163 %End 164 %PreMethodCode 165 if (!wxPyCheckForApp()) return NULL; 166 %End 167 168 public: 169 170 171 %Property(name=Controller, get=GetController, set=SetController) 172}; // end of class wxHtmlHelpFrame 173 174 175 176//--------------------------------------------------------------------------- 177 178