wx.html.HtmlHelpFrame

Inheritance diagram for wx.html.HtmlHelpFrame:

Description

This class is used by wx.html.HtmlHelpController to display help.

It is an internal class and should not be used directly – except for the case when you’re writing your own HTML help controller.

Derived From

• wx.Frame
• wx.TopLevelWindow
• wx.Window
• wx.EvtHandler
• wx.Object

Methods Summary

• __init__
• AddGrabIfNeeded
• Create
• Display
• DisplayContents
• DisplayID
• DisplayIndex
• GetController
• GetData
• GetHelpWindow
• KeywordSearch
• ReadCustomization
• SetController
• SetTitleFormat
• UseConfig
• WriteCustomization

Properties Summary

• Controller
• Data
• HelpWindow

Class API

Methods

__init__(parent, id, title="", style=wx.html.HF_DEFAULT_STYLE, data=None)

Constructor.

Parameters:

• parent (wx.Window): Parent window.
• id (int): Window Id.
• title (string): Window title
• style (long): For the possible values of style, see wx.html.HtmlHelpController.__init__
• data (wx.html.HtmlHelpData):

Returns:

wx.html.HtmlHelpFrame

---

AddGrabIfNeeded()

No docstrings available for this method.

---

Create(parent, id, title="", style=wx.html.HF_DEFAULT_STYLE)

Creates the dialog.

Parameters:

• parent (wx.Window): Parent window.
• id (int): Window Id.
• title (string): Window title
• style (long): For the possible values of style, see wx.html.HtmlHelpController.__init__

Returns:

bool

---

Display(x)

See wx.html.HtmlHelpController.Display

Parameters:

• x (string)

---

DisplayContents()

See wx.html.HtmlHelpController.DisplayContents

---

DisplayID(x)

See wx.html.HtmlHelpController.DisplayId

Parameters:

• x (int)

---

DisplayIndex()

See wx.html.HtmlHelpController.DisplayIndex

---

GetController()

Returns the help controller associated with the frame.

Returns:

wx.html.HtmlHelpController

---

GetData()

No docstrings available for this method.

---

GetHelpWindow()

No docstrings available for this method.

---

KeywordSearch(keyword, mode=wx.html.HELP_SEARCH_ALL)

See wx.html.HtmlHelpController.KeywordSearch

Parameters:

• keyword (string)
• mode (int)

---

ReadCustomization(cfg, path="")

Reads the user’s settings for this frame, see wx.html.HtmlHelpController.ReadCustomization

Parameters:

• cfg (wx.ConfigBase)
• path (string)

---

SetController(contoller)

Sets the help controller associated with the frame.

Parameters:

• controller (wx.html.HtmlHelpController)

---

SetTitleFormat(format)

Sets the frame’s title format.

format must contain exactly one “%s” (it will be replaced by the page title).

Parameters:

• format (string)

---

UseConfig(config, rootpath='')

See wx.html.HtmlHelpController.UseConfig

Parameters:

• config (wx.ConfigBase)
• rootpath (string)

---

WriteCustomization(cfg, path="")

Saves the user’s settings for this frame (see wx.html.HtmlHelpController.WriteCustomization).

Parameters:

• cfg (wx.ConfigBase)
• path (string)

---

Properties

Controller

See GetController and SetController

Data

See GetData

HelpWindow

See GetHelpWindow