<?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>wxGauge</title>
</header>
<module>wxGauge</module>
<modulesummary>Functions for wxGauge class</modulesummary>
<description><p>A gauge is a horizontal or vertical bar which shows a quantity (often time).
      </p><p><seeerl marker="wxGauge"><c>wxGauge</c></seeerl> supports two working modes: determinate and indeterminate progress.
      </p><p>The first is the usual working mode (see <seemfa marker="#setValue/2"><c>setValue/2</c></seemfa> and <seemfa marker="#setRange/2"><c>setRange/2</c></seemfa>) while the second can be used when the program is doing some processing but you don't know how much progress is being done. In this case, you can periodically call the <seemfa marker="#pulse/1"><c>pulse/1</c></seemfa> function to make the progress bar switch to indeterminate mode (graphically it's usually a set of blocks which move or bounce in the bar control).
      </p><p><seeerl marker="wxGauge"><c>wxGauge</c></seeerl> supports dynamic switch between these two work modes.
      </p><p>There are no user commands for the gauge.
      </p><p>Styles</p><p>This class supports the following styles:
      </p><p>See: <seeerl marker="wxSlider"><c>wxSlider</c></seeerl>, <seeerl marker="wxScrollBar"><c>wxScrollBar</c></seeerl>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxControl"><c>wxControl</c></seeerl> <seeerl marker="wxWindow"><c>wxWindow</c></seeerl> <seeerl marker="wxEvtHandler"><c>wxEvtHandler</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_gauge.html">wxGauge</url></p>
  </description>
<datatypes><datatype><name name="wxGauge"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>Default constructor. </fsummary>
    <desc><p>Default constructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="new" arity="3" clause_i="1" since=""/>
    <fsummary>See: <c>new/4</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="4" clause_i="1" since=""/>
    <fsummary>Constructor, creating and showing a gauge. </fsummary>
    <desc><p>Constructor, creating and showing a gauge. 
      </p><p>See: <seemfa marker="#create/5"><c>create/5</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor, destroying the gauge. </fsummary>
    <desc><p>Destructor, destroying the gauge. 
      </p></desc>
  </func>
  
  <func>
    <name name="create" arity="4" clause_i="1" since=""/>
    <fsummary>See: <c>create/5</c></fsummary>
  </func>
  
  <func>
    <name name="create" arity="5" clause_i="1" since=""/>
    <fsummary>Creates the gauge for two-step construction. </fsummary>
    <desc><p>Creates the gauge for two-step construction. 
      </p><p>See <seemfa marker="#new/4"><c>new/4</c></seemfa> for further details. 
      </p></desc>
  </func>
  
  <func>
    <name name="getRange" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the maximum position of the gauge. </fsummary>
    <desc><p>Returns the maximum position of the gauge. 
      </p><p>See: <seemfa marker="#setRange/2"><c>setRange/2</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="getValue" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the current position of the gauge. </fsummary>
    <desc><p>Returns the current position of the gauge. 
      </p><p>See: <seemfa marker="#setValue/2"><c>setValue/2</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="isVertical" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the gauge is vertical (has <c>wxGA_VERTICAL</c> style) and false otherwise. </fsummary>
    <desc><p>Returns true if the gauge is vertical (has <c>wxGA_VERTICAL</c> style) and false otherwise. 
      </p></desc>
  </func>
  
  <func>
    <name name="setRange" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the range (maximum value) of the gauge. </fsummary>
    <desc><p>Sets the range (maximum value) of the gauge. 
      </p><p>This function makes the gauge switch to determinate mode, if it's not already.
      </p><p>When the gauge is in indeterminate mode, under wxMSW the gauge repeatedly goes from zero to <c>range</c> and back; under other ports when in indeterminate mode, the <c>range</c> setting is ignored.
      </p><p>See: <seemfa marker="#getRange/1"><c>getRange/1</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="setValue" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the position of the gauge. </fsummary>
    <desc><p>Sets the position of the gauge. 
      </p><p>The <c>pos</c> must be between 0 and the gauge range as returned by <seemfa marker="#getRange/1"><c>getRange/1</c></seemfa>, inclusive.
      </p><p>This function makes the gauge switch to determinate mode, if it was in indeterminate mode before.
      </p><p>See: <seemfa marker="#getValue/1"><c>getValue/1</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="pulse" arity="1" clause_i="1" since=""/>
    <fsummary>Switch the gauge to indeterminate mode (if required) and makes the gauge move a bit to indicate the user that some progress has been made. </fsummary>
    <desc><p>Switch the gauge to indeterminate mode (if required) and makes the gauge move a bit to indicate the user that some progress has been made. 
      </p><p>Note: After calling this function the value returned by <seemfa marker="#getValue/1"><c>getValue/1</c></seemfa> is undefined and thus you need to explicitly call <seemfa marker="#setValue/2"><c>setValue/2</c></seemfa> if you want to restore the determinate mode. 
      </p></desc>
  </func>
  </funcs>
</erlref>
