<?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>wxCaret</title>
</header>
<module>wxCaret</module>
<modulesummary>Functions for wxCaret class</modulesummary>
<description><p>A caret is a blinking cursor showing the position where the typed text will appear. Text controls usually have their own caret but <seeerl marker="wxCaret"><c>wxCaret</c></seeerl> provides a way to use a caret in other windows.
      </p><p>Currently, the caret appears as a rectangle of the given size. In the future, it will be possible to specify a bitmap to be used for the caret shape.
      </p><p>A caret is always associated with a window and the current caret can be retrieved using <seemfa marker="wxWindow#getCaret/1"><c>wxWindow:getCaret/1</c></seemfa>. The same caret can't be reused in two different windows.
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_caret.html">wxCaret</url></p>
  </description>
<datatypes><datatype><name name="wxCaret"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
    <fsummary/>
    <desc/>
  </func>
  
  <func>
    <name name="new" arity="3" clause_i="1" since=""/>
    <fsummary>Creates a caret with the given size (in pixels) and associates it with the <c>window</c>. </fsummary>
    <desc><p>Creates a caret with the given size (in pixels) and associates it with the <c>window</c>. 
      </p></desc>
  </func>
  
  <func>
    <name name="create" arity="3" clause_i="1" since=""/>
    <fsummary/>
    <desc/>
  </func>
  
  <func>
    <name name="create" arity="4" clause_i="1" since=""/>
    <fsummary>Creates a caret with the given size (in pixels) and associates it with the <c>window</c> (same as the equivalent constructors). </fsummary>
    <desc><p>Creates a caret with the given size (in pixels) and associates it with the <c>window</c> (same as the equivalent constructors). 
      </p></desc>
  </func>
  
  <func>
    <name name="getBlinkTime" arity="0" clause_i="1" since=""/>
    <fsummary>Returns the blink time which is measured in milliseconds and is the time elapsed between 2 inversions of the caret (blink time of the caret is the same for all carets, so this functions is static). </fsummary>
    <desc><p>Returns the blink time which is measured in milliseconds and is the time elapsed between 2 inversions of the caret (blink time of the caret is the same for all carets, so this functions is static). 
      </p></desc>
  </func>
  
  <func>
    <name name="getPosition" arity="1" clause_i="1" since=""/>
    <fsummary/>
    <desc/>
  </func>
  
  <func>
    <name name="getSize" arity="1" clause_i="1" since=""/>
    <fsummary/>
    <desc/>
  </func>
  
  <func>
    <name name="getWindow" arity="1" clause_i="1" since=""/>
    <fsummary>Get the window the caret is associated with. </fsummary>
    <desc><p>Get the window the caret is associated with. 
      </p></desc>
  </func>
  
  <func>
    <name name="hide" arity="1" clause_i="1" since=""/>
    <fsummary>Hides the caret, same as Show(false). </fsummary>
    <desc><p>Hides the caret, same as Show(false). 
      </p></desc>
  </func>
  
  <func>
    <name name="isOk" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the caret was created successfully. </fsummary>
    <desc><p>Returns true if the caret was created successfully. 
      </p></desc>
  </func>
  
  <func>
    <name name="isVisible" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the caret is visible and false if it is permanently hidden (if it is blinking and not shown currently but will be after the next blink, this method still returns true). </fsummary>
    <desc><p>Returns true if the caret is visible and false if it is permanently hidden (if it is blinking and not shown currently but will be after the next blink, this method still returns true). 
      </p></desc>
  </func>
  
  <func>
    <name name="move" arity="2" clause_i="1" since=""/>
    <fsummary/>
    <desc/>
  </func>
  
  <func>
    <name name="move" arity="3" clause_i="1" since=""/>
    <fsummary>Move the caret to given position (in logical coordinates). </fsummary>
    <desc><p>Move the caret to given position (in logical coordinates). 
      </p></desc>
  </func>
  
  <func>
    <name name="setBlinkTime" arity="1" clause_i="1" since=""/>
    <fsummary>Sets the blink time for all the carets. </fsummary>
    <desc><p>Sets the blink time for all the carets. 
      </p><p>Warning: Under Windows, this function will change the blink time for all carets permanently (until the next time it is called), even for carets in other applications.
      </p><p>See: <seemfa marker="#getBlinkTime/0"><c>getBlinkTime/0</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="setSize" arity="2" clause_i="1" since=""/>
    <fsummary/>
    <desc/>
  </func>
  
  <func>
    <name name="setSize" arity="3" clause_i="1" since=""/>
    <fsummary>Changes the size of the caret. </fsummary>
    <desc><p>Changes the size of the caret. 
      </p></desc>
  </func>
  
  <func>
    <name name="show" arity="1" clause_i="1" since=""/>
    <fsummary>See: <c>show/2</c></fsummary>
  </func>
  
  <func>
    <name name="show" arity="2" clause_i="1" since=""/>
    <fsummary>Shows or hides the caret. </fsummary>
    <desc><p>Shows or hides the caret. 
      </p><p>Notice that if the caret was hidden N times, it must be shown N times as well to reappear on the screen. 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor</fsummary>
    <desc><p>Destroys the object.</p></desc>
  </func>
  </funcs>
</erlref>
