<?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><year>2021</year>
    <holder>wxWidgets team.</holder></copyright>
  <legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
  </legalnotice>
  <title>wxNavigationKeyEvent</title>
</header>
<module>wxNavigationKeyEvent</module>
<modulesummary>Functions for wxNavigationKeyEvent class</modulesummary>
<description><p>This event class contains information about navigation events, generated by navigation keys such as tab and page down.
      </p><p>This event is mainly used by wxWidgets implementations. A <seeerl marker="wxNavigationKeyEvent"><c>wxNavigationKeyEvent</c></seeerl> handler is automatically provided by wxWidgets when you enable keyboard navigation inside a window by inheriting it from wxNavigationEnabled&lt;&gt;.
      </p><p>See: <seemfa marker="wxWindow#navigate/2"><c>wxWindow:navigate/2</c></seemfa>, <c>wxWindow::NavigateIn</c> (not implemented in wx)
      </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_navigation_key_event.html">wxNavigationKeyEvent</url></p>
  </description><section><title>Events</title><p>Use <seemfa marker="wxEvtHandler#connect/3"><c>wxEvtHandler:connect/3</c></seemfa> with <seetype marker="#wxNavigationKeyEventType"><c>wxNavigationKeyEventType</c></seetype> to subscribe to events of this type.</p></section>
<datatypes>
    <datatype><name name="wxNavigationKeyEvent"/></datatype>
    <datatype><name name="wxNavigationKey"/></datatype>
    <datatype><name name="wxNavigationKeyEventType"/></datatype></datatypes>

<funcs>
  <func>
    <name name="getDirection" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the navigation was in the forward direction. </fsummary>
    <desc><p>Returns true if the navigation was in the forward direction. 
      </p></desc>
  </func>
  
  <func>
    <name name="setDirection" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the direction to forward if <c>direction</c> is true, or backward if false. </fsummary>
    <desc><p>Sets the direction to forward if <c>direction</c> is true, or backward if false. 
      </p></desc>
  </func>
  
  <func>
    <name name="isWindowChange" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the navigation event represents a window change (for example, from Ctrl-Page Down in a notebook). </fsummary>
    <desc><p>Returns true if the navigation event represents a window change (for example, from Ctrl-Page Down in a notebook). 
      </p></desc>
  </func>
  
  <func>
    <name name="setWindowChange" arity="2" clause_i="1" since=""/>
    <fsummary>Marks the event as a window change event. </fsummary>
    <desc><p>Marks the event as a window change event. 
      </p></desc>
  </func>
  
  <func>
    <name name="isFromTab" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the navigation event was from a tab key. </fsummary>
    <desc><p>Returns true if the navigation event was from a tab key. 
      </p><p>This is required for proper navigation over radio buttons. 
      </p></desc>
  </func>
  
  <func>
    <name name="setFromTab" arity="2" clause_i="1" since=""/>
    <fsummary>Marks the navigation event as from a tab key. </fsummary>
    <desc><p>Marks the navigation event as from a tab key. 
      </p></desc>
  </func>
  
  <func>
    <name name="getCurrentFocus" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the child that has the focus, or NULL. </fsummary>
    <desc><p>Returns the child that has the focus, or NULL. 
      </p></desc>
  </func>
  
  <func>
    <name name="setCurrentFocus" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the current focus window member. </fsummary>
    <desc><p>Sets the current focus window member. 
      </p></desc>
  </func>
  </funcs>
</erlref>
