<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year>
    <holder>Ericsson AB. All Rights Reserved.</holder></copyright>
  <legalnotice>
      Licensed under the Apache License, Version 2.0 (the "License");
      you may not use this file except in compliance with the License.
      You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

  </legalnotice>
  <title>wxHelpEvent</title>
</header>
<module>wxHelpEvent</module>
<modulesummary>Functions for wxHelpEvent class</modulesummary>
<description><p>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 <c>wxContextHelp</c> (not implemented in wx), 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.
      </p><p>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.
      </p><p>The application should call <seemfa marker="wxEvent#getId/1"><c>wxEvent:getId/1</c></seemfa> to check the identity of the clicked-on window, and then either show some suitable help or call <seemfa marker="wxEvent#skip/2"><c>wxEvent:skip/2</c></seemfa> if the identifier is unrecognised.
      </p><p>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.
      </p><p>See: <c>wxContextHelp</c> (not implemented in wx), <seeerl marker="wxDialog"><c>wxDialog</c></seeerl>, <url href="https://docs.wxwidgets.org/3.1/overview_events.html#overview_events">Overview events</url>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxEvent"><c>wxEvent</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_help_event.html">wxHelpEvent</url></p>
  </description><section><title>Events</title><p>Use <seemfa marker="wxEvtHandler#connect/3"><c>wxEvtHandler:connect/3</c></seemfa> with <seetype marker="#wxHelpEventType"><c>wxHelpEventType</c></seetype> to subscribe to events of this type.</p></section>
<datatypes>
    <datatype><name name="wxHelpEvent"/></datatype>
    <datatype><name name="wxHelp"/></datatype>
    <datatype><name name="wxHelpEventType"/></datatype></datatypes>

<funcs>
  <func>
    <name name="getOrigin" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the origin of the help event which is one of the <c>wxHelpEvent::Origin</c> (not implemented in wx) values. </fsummary>
    <desc><p>Returns the origin of the help event which is one of the <c>wxHelpEvent::Origin</c> (not implemented in wx) values. 
      </p><p>The application may handle events generated using the keyboard or mouse differently, e.g. by using <seemfa marker="wx_misc#getMousePosition/0"><c>wx_misc:getMousePosition/0</c></seemfa> for the mouse events.
      </p><p>See: <seemfa marker="#setOrigin/2"><c>setOrigin/2</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="getPosition" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the left-click position of the mouse, in screen coordinates. </fsummary>
    <desc><p>Returns the left-click position of the mouse, in screen coordinates. 
      </p><p>This allows the application to position the help appropriately. 
      </p></desc>
  </func>
  
  <func>
    <name name="setOrigin" arity="2" clause_i="1" since=""/>
    <fsummary>Set the help event origin, only used internally by wxWidgets normally. </fsummary>
    <desc><p>Set the help event origin, only used internally by wxWidgets normally. 
      </p><p>See: <seemfa marker="#getOrigin/1"><c>getOrigin/1</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="setPosition" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the left-click position of the mouse, in screen coordinates. </fsummary>
    <desc><p>Sets the left-click position of the mouse, in screen coordinates. 
      </p></desc>
  </func>
  </funcs>
</erlref>
