<?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>wxStyledTextEvent</title>
</header>
<module>wxStyledTextEvent</module>
<modulesummary>Functions for wxStyledTextEvent class</modulesummary>
<description><p>The type of events sent from <seeerl marker="wxStyledTextCtrl"><c>wxStyledTextCtrl</c></seeerl>.
      </p>
  <p>This class is derived (and can use functions) from: 
    <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_styled_text_event.html">wxStyledTextEvent</url></p>
  </description><section><title>Events</title><p>Use <seemfa marker="wxEvtHandler#connect/3"><c>wxEvtHandler:connect/3</c></seemfa> with <seetype marker="#wxStyledTextEventType"><c>wxStyledTextEventType</c></seetype> to subscribe to events of this type.</p></section>
<datatypes>
    <datatype><name name="wxStyledTextEvent"/></datatype>
    <datatype><name name="wxStyledText"/></datatype>
    <datatype><name name="wxStyledTextEventType"/></datatype></datatypes>

<funcs>
  <func>
    <name name="getPosition" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the zero-based text position associated this event. </fsummary>
    <desc><p>Returns the zero-based text position associated this event. 
      </p><p>This method is valid for the following event types:
      </p></desc>
  </func>
  
  <func>
    <name name="getKey" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the key code of the key that generated this event. </fsummary>
    <desc><p>Returns the key code of the key that generated this event. 
      </p><p>This method is valid for the following event types:
      </p></desc>
  </func>
  
  <func>
    <name name="getModifiers" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the modifiers of the key press or mouse click for this event. </fsummary>
    <desc><p>Returns the modifiers of the key press or mouse click for this event. 
      </p><p>The returned value is a bit list that may contain one or more of the following values:
      </p><p>In addition, the value can be checked for equality with ?wxSTC_KEYMOD_NORM  to test if no modifiers are present.
      </p><p>This method is valid for the following event types:
      </p></desc>
  </func>
  
  <func>
    <name name="getModificationType" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the modification type for this event. </fsummary>
    <desc><p>Returns the modification type for this event. 
      </p><p>The modification type is a bit list that describes the change that generated this event. It may contain one or more of the following values:
      </p><p>This method is valid for <c>wxEVT_STC_MODIFIED</c> events. 
      </p></desc>
  </func>
  
  <func>
    <name name="getText" arity="1" clause_i="1" since=""/>
    <fsummary/>
    <desc><p>Deprecated: Use <seemfa marker="wxCommandEvent#getString/1"><c>wxCommandEvent:getString/1</c></seemfa> instead.
      
      </p></desc>
  </func>
  
  <func>
    <name name="getLength" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the length (number of characters) of this event. </fsummary>
    <desc><p>Returns the length (number of characters) of this event. 
      </p><p>This method is valid for <c>wxEVT_STC_MODIFIED</c> and <c>wxEVT_STC_NEEDSHOWN</c> events. 
      </p></desc>
  </func>
  
  <func>
    <name name="getLinesAdded" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the number of lines added or deleted with this event. </fsummary>
    <desc><p>Returns the number of lines added or deleted with this event. 
      </p><p>This method is valid for <c>wxEVT_STC_MODIFIED</c> events when the result of <seemfa marker="#getModificationType/1"><c>getModificationType/1</c></seemfa> includes ?wxSTC_MOD_INSERTTEXT  or ?wxSTC_MOD_DELETETEXT. 
      </p></desc>
  </func>
  
  <func>
    <name name="getLine" arity="1" clause_i="1" since=""/>
    <fsummary>Returns zero-based line number for this event. </fsummary>
    <desc><p>Returns zero-based line number for this event. 
      </p><p>This method is valid for <c>wxEVT_STC_DOUBLECLICK</c> and <c>wxEVT_STC_MODIFIED</c> events. 
      </p></desc>
  </func>
  
  <func>
    <name name="getFoldLevelNow" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the current fold level for the line. </fsummary>
    <desc><p>Returns the current fold level for the line. 
      </p><p>This method is valid for <c>wxEVT_STC_MODIFIED</c> events when the result of <seemfa marker="#getModificationType/1"><c>getModificationType/1</c></seemfa> includes ?wxSTC_MOD_CHANGEFOLD. 
      </p></desc>
  </func>
  
  <func>
    <name name="getFoldLevelPrev" arity="1" clause_i="1" since=""/>
    <fsummary>Returns previous fold level for the line. </fsummary>
    <desc><p>Returns previous fold level for the line. 
      </p><p>This method is valid for <c>wxEVT_STC_MODIFIED</c> events when the result of <seemfa marker="#getModificationType/1"><c>getModificationType/1</c></seemfa> includes ?wxSTC_MOD_CHANGEFOLD. 
      </p></desc>
  </func>
  
  <func>
    <name name="getMargin" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the zero-based index of the margin that generated this event. </fsummary>
    <desc><p>Returns the zero-based index of the margin that generated this event. 
      </p><p>This method is valid for <c>wxEVT_STC_MARGINCLICK</c> and <c>wxEVT_STC_MARGIN_RIGHT_CLICK</c> events. 
      </p></desc>
  </func>
  
  <func>
    <name name="getMessage" arity="1" clause_i="1" since=""/>
    <fsummary>Returns a message number while a macro is being recorded. </fsummary>
    <desc><p>Returns a message number while a macro is being recorded. 
      </p><p>Many of the <seeerl marker="wxStyledTextCtrl"><c>wxStyledTextCtrl</c></seeerl> methods such as <seemfa marker="wxStyledTextCtrl#insertText/3"><c>wxStyledTextCtrl:insertText/3</c></seemfa> and <seemfa marker="wxStyledTextCtrl#paste/1"><c>wxStyledTextCtrl:paste/1</c></seemfa> have an event number associated with them. This method returns that number while a macro is being recorded so that the macro can be played back later.
      </p><p>This method is valid for <c>wxEVT_STC_MACRORECORD</c> events. 
      </p></desc>
  </func>
  
  <func>
    <name name="getWParam" arity="1" clause_i="1" since=""/>
    <fsummary>Returns value of the WParam field for this event. </fsummary>
    <desc><p>Returns value of the WParam field for this event. 
      </p><p>This method is valid for <c>wxEVT_STC_MACRORECORD</c> events. 
      </p></desc>
  </func>
  
  <func>
    <name name="getLParam" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the value of the LParam field for this event. </fsummary>
    <desc><p>Returns the value of the LParam field for this event. 
      </p><p>This method is valid for <c>wxEVT_STC_MACRORECORD</c> events. 
      </p></desc>
  </func>
  
  <func>
    <name name="getListType" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the list type for this event. </fsummary>
    <desc><p>Returns the list type for this event. 
      </p><p>The list type is an integer passed to a list when it is created with the <seemfa marker="wxStyledTextCtrl#userListShow/3"><c>wxStyledTextCtrl:userListShow/3</c></seemfa> method and can be used to distinguish lists if more than one is used.
      </p><p>This method is valid for <c>wxEVT_STC_AUTOCOMP_SELECTION_CHANGE</c> and <c>wxEVT_STC_USERLISTSELECTION</c> events. 
      </p></desc>
  </func>
  
  <func>
    <name name="getX" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the X coordinate of the mouse for this event. </fsummary>
    <desc><p>Returns the X coordinate of the mouse for this event. 
      </p><p>This method is valid for the following event types:
      </p></desc>
  </func>
  
  <func>
    <name name="getY" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the Y coordinate of the mouse for this event. </fsummary>
    <desc><p>Returns the Y coordinate of the mouse for this event. 
      </p><p>This method is valid for the following event types:
      </p></desc>
  </func>
  
  <func>
    <name name="getDragText" arity="1" clause_i="1" since=""/>
    <fsummary/>
    <desc><p>Deprecated: Use <seemfa marker="wxCommandEvent#getString/1"><c>wxCommandEvent:getString/1</c></seemfa> instead.
      
      </p></desc>
  </func>
  
  <func>
    <name name="getDragAllowMove" arity="1" clause_i="1" since=""/>
    <fsummary/>
    <desc/>
  </func>
  
  <func>
    <name name="getDragResult" arity="1" clause_i="1" since=""/>
    <fsummary>Returns drag result for this event. </fsummary>
    <desc><p>Returns drag result for this event. 
      </p><p>This method is valid for <c>wxEVT_STC_DRAG_OVER</c> and <c>wxEVT_STC_DO_DROP</c> events. 
      </p></desc>
  </func>
  
  <func>
    <name name="getShift" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the Shift key is pressed. </fsummary>
    <desc><p>Returns true if the Shift key is pressed. 
      </p><p>This method is valid for the following event types:
      </p></desc>
  </func>
  
  <func>
    <name name="getControl" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the Control key is pressed. </fsummary>
    <desc><p>Returns true if the Control key is pressed. 
      </p><p>This method is valid for the following event types:
      </p></desc>
  </func>
  
  <func>
    <name name="getAlt" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the Alt key is pressed. </fsummary>
    <desc><p>Returns true if the Alt key is pressed. 
      </p><p>This method is valid for the following event types:
      </p></desc>
  </func>
  </funcs>
</erlref>
