ContextHelpButton

Instances of this class may be used to add a question mark button that when pressed, puts the application into context-help mode.

It does this by creating a ContextHelp object which itself generates a wxEVT_HELP event when the user clicks on a window.

On Windows, you may add a question-mark icon to a dialog by use of the DIALOG_EX_CONTEXTHELP extra style, but on other platforms you will have to add a button explicitly, usually next to OK, Cancel or similar buttons.

See also

BitmapButton, ContextHelp

Inheritance Diagram

Inheritance diagram for class ContextHelpButton

Methods Summary

__init__

Constructor, creating and showing a context help button.

Class API

---

class ContextHelpButton(BitmapButton)

Instances of this class may be used to add a question mark button that when pressed, puts the application into context-help mode.

Possible constructors:

ContextHelpButton(parent, id=ID_ANY, pos=DefaultPosition,
                  size=DefaultSize, style=BU_AUTODRAW)

Methods

---

__init__(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=BU_AUTODRAW)

Constructor, creating and showing a context help button.

Parameters:

• parent (Window) – Parent window. Must not be None.
• id (int) – Button identifier. Defaults to ID_CONTEXT_HELP.
• pos (Point) – Button position. If DefaultPosition is specified then a default position is chosen.
• size (Size) – Button size. If DefaultSize is specified then the button is sized appropriately for the question mark bitmap.
• style (long) – Window style.

Note

Normally you only need pass the parent window to the constructor, and use the defaults for the remaining parameters.