Package wx :: Class HelpEvent
[frames | no frames]

Type 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.

Events

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 __init__(self, commandType, winid)
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 GetLink(self)
Get an optional link to further help
Point GetPosition(self)
Returns the left-click position of the mouse, in screen coordinates.
String GetTarget(self)
Get an optional target to display help in.
  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.
    Inherited from CommandEvent
bool Checked(self)
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 Clone(self)
PyObject GetClientData(self)
Returns the client data object for a listbox or choice selection event, (if any.)
PyObject GetClientObject(self)
Returns the client data object for a listbox or choice selection event, (if any.)
long GetExtraLong(self)
Returns extra information dependant on the event objects type.
long GetInt(self)
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 GetSelection(self)
Returns item index for a listbox or choice selection event (not valid for a deselection).
String GetString(self)
Returns item string for a listbox or choice selection event (not valid for a deselection).
bool IsChecked(self)
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 IsSelection(self)
For a listbox or similar event, returns true if it is a selection, false if it is a deselection.
  SetClientData(self, clientData)
Associate the given client data with the item at position n.
  SetClientObject(self, clientData)
Associate the given client data with the item at position n.
  SetExtraLong(self, extraLong)
  SetInt(self, i)
  SetString(self, s)
    Inherited from Event
  __del__(self)
Object GetEventObject(self)
Returns the object (usually a window) associated with the event, if any.
wxEventType GetEventType(self)
Returns the identifier of the given event type, such as wxEVT_COMMAND_BUTTON_CLICKED.
int GetId(self)
Returns the identifier associated with this event, such as a button command id.
bool GetSkipped(self)
Returns true if the event handler should be skipped, false otherwise.
long GetTimestamp(self)
bool IsCommandEvent(self)
Returns true if the event is or is derived from wx.CommandEvent else it returns false.
  ResumePropagation(self, propagationLevel)
Resume the event propagation by restoring the propagation level.
  SetEventObject(self, obj)
Sets the originating object, or in other words, obj is normally the object that is sending the event.
  SetEventType(self, typ)
Sets the specific type of the event.
  SetId(self, Id)
Set's the ID for the event.
  SetTimestamp(self, ts)
bool ShouldPropagate(self)
Test if this event should be propagated to the parent window or not, i.e.
  Skip(self, skip)
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 StopPropagation(self)
Stop the event from propagating to its parent window.
    Inherited from Object
  Destroy(self)
Deletes the C++ object this Python object is a proxy for.
String GetClassName(self)
Returns the class name of the C++ class using wxRTTI.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
Return hash(x)...
  __new__(T, S, ...)
Return a new object with type S, a subtype of T...
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
Return str(x)...

Method Details

__init__(self, type=wxEVT_NULL, winid=0, pt=DefaultPosition)
(Constructor)

This event class contains information about command events, which originate from a variety of simple controls, as well as menus and toolbars.

Parameters:
commandType
           (type=wxEventType)

winid
           (type=int)

Returns:
CommandEvent
Overrides:
wx.CommandEvent.__init__ (inherited documentation)

GetLink(self)

Get an optional link to further help

Returns:
String

GetPosition(self)

Returns the left-click position of the mouse, in screen coordinates. This allows the application to position the help appropriately.

Returns:
Point

GetTarget(self)

Get an optional target to display help in. E.g. a window specification

Returns:
String

SetLink(self, link)

Set an optional link to further help

Parameters:
link
           (type=String)

SetPosition(self, pos)

Sets the left-click position of the mouse, in screen coordinates.

Parameters:
pos
           (type=Point)

SetTarget(self, target)

Set an optional target to display help in. E.g. a window specification

Parameters:
target
           (type=String)


Generated by Epydoc 2.1.20050511.rpd on Sat Jun 16 17:01:28 2007 http://epydoc.sf.net