.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxHelpEvent 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxHelpEvent \- 
.SH DESCRIPTION

  


   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
   wxContextHelp
   , 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 wxEvent::GetId to check
   the identity of the clicked-on window, and then either show some suitable
   help or call wxEvent::Skip if the identifier is unrecognised. Calling Skip is
   important because it allows wxWidgets 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.
  
 
.SH "PARENTS"

  wxCommandEvent
   
  wxEvent
   
  wxObject
 
.SH "INCLUDE FILES"
wx/event.h
.SH MEMBERS

  
.SS  wxHelpEvent (WXTYPE eventType = 0wxWindowID id = 0const wxPoint& point)

     


      Constructor.
     
    
   
  
.SS const wxPoint& GetPosition ()

     


      Returns the left-click position of the mouse, in screen coordinates. This
      allows the application to position the help appropriately.
     
    
   
  
.SS void SetPosition (const wxPoint& pt)

     


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

.SS EVT_HELP(id, func)

   Process a wxEVT_HELP event.
  
.SS EVT_HELP_RANGE(id1, id2, func)

   Process a wxEVT_HELP event for a range of ids.
  
.SH "SEE ALSO"

  wxCommandEvent
   
  wxEvent
   
  wxObject
 
  wxContextHelp
  , 
  wxDialog
  , 
  Event handling overview
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.