Home | Trees | Index | Help |
|
---|
Package wx :: Class HelpEvent |
|
object
--+ |Object
--+ |Event
--+ |CommandEvent
--+ | HelpEvent
A help event is sent when the user has requested context-sensitive help. This can either be caused by the application requesting context-sensitive help mode via wx.ContextHelp, or (on MS Windows) by the system generating a WM_HELP message when the user pressed F1 or clicked on the query button in a dialog caption.
A help event is sent to the window that the user clicked on, and is propagated up the window hierarchy until the event is processed or there are no more event handlers. The application should call event.GetId to check the identity of the clicked-on window, and then either show some suitable help or call event.Skip if the identifier is unrecognised. Calling Skip is important because it allows wxWindows to generate further events for ancestors of the clicked-on window. Otherwise it would be impossible to show help for container windows, since processing would stop after the first window found.
EVT_HELP Sent when the user has requested context- sensitive help. EVT_HELP_RANGE Allows to catch EVT_HELP for a range of IDs
See Also:
wx.ContextHelp
, wx.ContextHelpButton
Method Summary | |
---|---|
CommandEvent |
This event class contains information about command events, which originate from a variety of simple controls, as well as menus and toolbars. |
__repr__(self)
| |
String |
Get an optional link to further help |
Point |
Returns the left-click position of the mouse, in screen coordinates. |
String |
Get an optional target to display help in. |
Set an optional link to further help | |
Sets the left-click position of the mouse, in screen coordinates. | |
Set an optional target to display help in. | |
Inherited from CommandEvent | |
bool |
This method can be used with checkbox and menu events: for the checkboxes, the method returns true for a selection event and false for a deselection one. |
Event |
|
PyObject |
Returns the client data object for a listbox or choice selection event, (if any.) |
PyObject |
Returns the client data object for a listbox or choice selection event, (if any.) |
long |
Returns extra information dependant on the event objects type. |
long |
Returns the integer identifier corresponding to a listbox, choice or radiobox selection (only if the event was a selection, not a deselection), or a boolean value representing the value of a checkbox. |
int |
Returns item index for a listbox or choice selection event (not valid for a deselection). |
String |
Returns item string for a listbox or choice selection event (not valid for a deselection). |
bool |
This method can be used with checkbox and menu events: for the checkboxes, the method returns true for a selection event and false for a deselection one. |
bool |
For a listbox or similar event, returns true if it is a selection, false if it is a deselection. |
Associate the given client data with the item at position n. | |
Associate the given client data with the item at position n. | |
| |
| |
| |
Inherited from Event | |
| |
Object |
Returns the object (usually a window) associated with the event, if any. |
wxEventType |
Returns the identifier of the given event type, such as wxEVT_COMMAND_BUTTON_CLICKED. |
int |
Returns the identifier associated with this event, such as a button command id. |
bool |
Returns true if the event handler should be skipped, false otherwise. |
long |
|
bool |
Returns true if the event is or is derived from wx.CommandEvent else
it returns false. |
Resume the event propagation by restoring the propagation level. | |
Sets the originating object, or in other words, obj is normally the object that is sending the event. | |
Sets the specific type of the event. | |
Set's the ID for the event. | |
| |
bool |
Test if this event should be propagated to the parent window or not, i.e. |
Called by an event handler, it controls whether additional event handlers bound to this event will be called after the current event handler returns. | |
int |
Stop the event from propagating to its parent window. |
Inherited from Object | |
Deletes the C++ object this Python object is a proxy for. | |
String |
Returns the class name of the C++ class using wxRTTI. |
Inherited from object | |
x.__delattr__('name') <==> del x.name | |
x.__getattribute__('name') <==> x.name | |
Return hash(x)... | |
Return a new object with type S, a subtype of T... | |
helper for pickle | |
helper for pickle | |
x.__setattr__('name', value) <==> x.name = value | |
Return str(x)... |
Method Details |
---|
__init__(self,
type=wxEVT_NULL,
winid=0,
pt=DefaultPosition)
|
GetLink(self)Get an optional link to further help
|
GetPosition(self)Returns the left-click position of the mouse, in screen coordinates. This allows the application to position the help appropriately.
|
GetTarget(self)Get an optional target to display help in. E.g. a window specification
|
SetLink(self, link)Set an optional link to further help
|
SetPosition(self, pos)Sets the left-click position of the mouse, in screen coordinates.
|
SetTarget(self, target)Set an optional target to display help in. E.g. a window specification
|
Home | Trees | Index | Help |
|
---|
Generated by Epydoc 2.1.20050511.rpd on Sat Jun 16 17:01:28 2007 | http://epydoc.sf.net |