<?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>wxGridEvent</title>
</header>
<module>wxGridEvent</module>
<modulesummary>Functions for wxGridEvent class</modulesummary>
<description><p>This event class contains information about various grid events.
      </p><p>Notice that all grid event table macros are available in two versions: <c>EVT_GRID_XXX</c> and <c>EVT_GRID_CMD_XXX</c>. The only difference between the two is that the former doesn't allow to specify the grid window identifier and so takes a single parameter, the event handler, but is not suitable if there is more than one grid control in the window where the event table is used (as it would catch the events from all the grids). The version with <c>CMD</c> takes the id as first argument and the event handler as the second one and so can be used with multiple grids as well. Otherwise there are no difference between the two and only the versions without the id are documented below for brevity.
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxNotifyEvent"><c>wxNotifyEvent</c></seeerl> <seeerl marker="wxCommandEvent"><c>wxCommandEvent</c></seeerl> <seeerl marker="wxEvent"><c>wxEvent</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_grid_event.html">wxGridEvent</url></p>
  </description><section><title>Events</title><p>Use <seemfa marker="wxEvtHandler#connect/3"><c>wxEvtHandler:connect/3</c></seemfa> with <seetype marker="#wxGridEventType"><c>wxGridEventType</c></seetype> to subscribe to events of this type.</p></section>
<datatypes>
    <datatype><name name="wxGridEvent"/></datatype>
    <datatype><name name="wxGrid"/></datatype>
    <datatype><name name="wxGridEventType"/></datatype></datatypes>

<funcs>
  <func>
    <name name="altDown" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the Alt key was down at the time of the event. </fsummary>
    <desc><p>Returns true if the Alt key was down at the time of the event. 
      </p></desc>
  </func>
  
  <func>
    <name name="controlDown" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the Control key was down at the time of the event. </fsummary>
    <desc><p>Returns true if the Control key was down at the time of the event. 
      </p></desc>
  </func>
  
  <func>
    <name name="getCol" arity="1" clause_i="1" since=""/>
    <fsummary>Column at which the event occurred. </fsummary>
    <desc><p>Column at which the event occurred. 
      </p><p>Notice that for a <c>wxEVT_GRID_SELECT_CELL</c> event this column is the column of the newly selected cell while the previously selected cell can be retrieved using <seemfa marker="wxGrid#getGridCursorCol/1"><c>wxGrid:getGridCursorCol/1</c></seemfa>. 
      </p></desc>
  </func>
  
  <func>
    <name name="getPosition" arity="1" clause_i="1" since=""/>
    <fsummary>Position in pixels at which the event occurred. </fsummary>
    <desc><p>Position in pixels at which the event occurred. 
      </p></desc>
  </func>
  
  <func>
    <name name="getRow" arity="1" clause_i="1" since=""/>
    <fsummary>Row at which the event occurred. </fsummary>
    <desc><p>Row at which the event occurred. 
      </p><p>Notice that for a <c>wxEVT_GRID_SELECT_CELL</c> event this row is the row of the newly selected cell while the previously selected cell can be retrieved using <seemfa marker="wxGrid#getGridCursorRow/1"><c>wxGrid:getGridCursorRow/1</c></seemfa>. 
      </p></desc>
  </func>
  
  <func>
    <name name="metaDown" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the Meta key was down at the time of the event. </fsummary>
    <desc><p>Returns true if the Meta key was down at the time of the event. 
      </p></desc>
  </func>
  
  <func>
    <name name="selecting" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the user is selecting grid cells, or false if deselecting. </fsummary>
    <desc><p>Returns true if the user is selecting grid cells, or false if deselecting. 
      </p></desc>
  </func>
  
  <func>
    <name name="shiftDown" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the Shift key was down at the time of the event. </fsummary>
    <desc><p>Returns true if the Shift key was down at the time of the event. 
      </p></desc>
  </func>
  </funcs>
</erlref>
