Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://wxpython.org/Phoenix/docs/html/wx.html.HtmlHelpWindow.html below:

wx.html.HtmlHelpWindow — wxPython Phoenix 4.2.4a1 documentation

This class is used by wx.html.HtmlHelpController to display help within a frame or dialog, but you can use it yourself to create an embedded HTML help window.

For example:

def EmbedHTML(self):
    # self.embeddedHelpWindow is a wx.html.HtmlHelpWindow
    # self.embeddedHtmlHelp is a wx.html.HtmlHelpController

    # Create embedded HTML Help window
    self.embeddedHelpWindow = wx.html.HtmlHelpWindow
    self.embeddedHtmlHelp.UseConfig(config, rootPath) # Set your own config object here
    self.embeddedHtmlHelp.SetHelpWindow(self.embeddedHelpWindow)
    self.embeddedHelpWindow.Create(self, wx.ID_ANY, wx.DefaultPosition, self.GetClientSize(),
                                   wx.TAB_TRAVERSAL | wx.BORDER_NONE, wx.html.HF_DEFAULT_STYLE)
    self.embeddedHtmlHelp.AddBook("doc.zip")

You should pass the style wx.html.HF_EMBEDDED to the style parameter of wx.html.HtmlHelpController to allow the embedded window to be destroyed independently of the help controller.

Inheritance diagram for class

:

class wx.html.HtmlHelpWindow(Window)¶

Possible constructors:

HtmlHelpWindow(data=None) -> None

HtmlHelpWindow(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize,
               style=TAB_TRAVERSAL|BORDER_NONE, helpStyle=HF_DEFAULT_STYLE, data=None)
               -> None

This class is used by HtmlHelpController to display help within a frame or dialog, but you can use it yourself to create an embedded HTML help window.

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

__init__ (self, data=None)

Parameters:

data (wx.html.HtmlHelpData)

Return type:

None

__init__ (self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=TAB_TRAVERSAL|BORDER_NONE, helpStyle=HF_DEFAULT_STYLE, data=None)

Constructor.

For the values of helpStyle, please see the documentation for wx.html.HtmlHelpController.

Parameters:

• parent (wx.Window)

• id (wx.WindowID)

• pos (wx.Point)

• size (wx.Size)

• style (int)

• helpStyle (int)

• data (wx.html.HtmlHelpData)

Return type:

None

AddToolbarButtons(self, toolBar, style)¶

You may override this virtual method to add more buttons to the help window’s toolbar.

toolBar is a pointer to the toolbar and style is the style flag as passed to the Create method.

wx.ToolBar.Realize is called immediately after returning from this function. See samples/html/helpview for an example.

Parameters:

• toolBar (wx.ToolBar)

• style (int)

Return type:

None

Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=TAB_TRAVERSAL | BORDER_NONE, helpStyle=HF_DEFAULT_STYLE)¶

Creates the help window.

See the constructor for a description of the parameters.

Parameters:

• parent (wx.Window)

• id (wx.WindowID)

• pos (wx.Point)

• size (wx.Size)

• style (int)

• helpStyle (int)

Return type:

bool

CreateContents(self)¶

Creates contents panel.

(May take some time.)

Return type:

None

CreateIndex(self)¶

Creates index panel.

(May take some time.)

Return type:

None

CreateSearch(self)¶

Creates search panel.

Return type:

None

Display(self, *args, **kw)¶

Overloaded Implementations:

Display (self, x)

Displays page x.

If not found it will give the user the choice of searching books. Looking for the page runs in these steps:

• try to locate file named x (if x is for example “doc/howto.htm”)

• try to open starting page of book x

• try to find x in contents (if x is for example “How To …”)

• try to find x in index (if x is for example “How To …”)

Parameters:

x (string)

Return type:

bool

Display (self, id)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:

id (int)

Return type:

bool

DisplayContents(self)¶

Displays contents panel.

Return type:

bool

DisplayIndex(self)¶

Displays index panel.

Return type:

bool

static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)¶

Parameters:

variant (WindowVariant)

Return type:

VisualAttributes

GetController(self)¶

Return type:

wx.html.HtmlHelpController

GetData(self)¶

Returns the wx.html.HtmlHelpData object, which is usually a pointer to the controller’s data.

Return type:

wx.html.HtmlHelpData

KeywordSearch(self, keyword, mode=HELP_SEARCH_ALL)¶

Search for given keyword.

Optionally it searches through the index (mode = HELP_SEARCH_INDEX ), default the content (mode = HELP_SEARCH_ALL ).

Parameters:

• keyword (string)

• mode (HelpSearchMode)

Return type:

bool

ReadCustomization(self, cfg, path='')¶

Reads the user’s settings for this window.

Parameters:

• cfg (wx.ConfigBase)

• path (string)

Return type:

None

RefreshLists(self)¶

Refresh all panels.

This is necessary if a new book was added.

Return type:

None

SetController(self, controller)¶

Parameters:

controller (wx.html.HtmlHelpController)

Return type:

None

UseConfig(self, config, rootpath='')¶

Associates a Config object with the help window.

It is recommended that you use wx.html.HtmlHelpController.UseConfig instead.

Parameters:

• config (wx.ConfigBase)

• rootpath (string)

Return type:

None

WriteCustomization(self, cfg, path='')¶

Saves the user’s settings for this window.

Parameters:

• cfg (wx.ConfigBase)

• path (string)

Return type:

None

Properties¶

Controller¶

See GetController and SetController

Data¶

See GetData

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4