.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.ContextHelpButton:
==========================================================================================================================================
|phoenix_title| **wx.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 :ref:`wx.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 ``wx.DIALOG_EX_CONTEXTHELP`` extra style, but on other platforms you will have to add a button explicitly, usually next to ``wx.OK``, Cancel or similar buttons.
.. seealso:: :ref:`wx.BitmapButton`, :ref:`wx.ContextHelp`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
ContextHelpButton:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.ContextHelpButton.__init__` Constructor, creating and showing a context help button.
:meth:`~wx.ContextHelpButton.GetClassDefaultAttributes`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.ContextHelpButton(BitmapButton)
**Possible constructors**::
ContextHelpButton(parent : Window, id: int=ID_CONTEXT_HELP, pos:
Point=DefaultPosition, size: Size=DefaultSize, style: int=0) -> None
Instances of this class may be used to add a question mark button that
when pressed, puts the application into context-help mode.
.. method:: __init__(self, parent : Window, id: int=ID_CONTEXT_HELP, pos: Point=DefaultPosition, size: Size=DefaultSize, style: int=0)
Constructor, creating and showing a context help button.
:param `parent`: Parent window. Must not be ``None``.
:type `parent`: wx.Window
:param `id`: Button identifier. Defaults to ``wx.ID_CONTEXT_HELP``.
:type `id`: wx.WindowID
:param `pos`: Button position. If `wx.DefaultPosition` is specified then a default position is chosen.
:type `pos`: wx.Point
:param `size`: Button size. If `wx.DefaultSize` is specified then the button is sized appropriately for the question mark bitmap.
:type `size`: wx.Size
:param `style`: Window style.
:type `style`: long
:rtype: `None`
.. note::
Normally you only need pass the parent window to the constructor, and use the defaults for the remaining parameters.
.. staticmethod:: GetClassDefaultAttributes(variant: WindowVariant=WINDOW_VARIANT_NORMAL)
:param `variant`:
:type `variant`: wx.WindowVariant
:rtype: :ref:`wx.VisualAttributes`