<?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>wxStatusBar</title>
</header>
<module>wxStatusBar</module>
<modulesummary>Functions for wxStatusBar class</modulesummary>
<description><p>A status bar is a narrow window that can be placed along the bottom of a frame to give small amounts of status information. It can contain one or more fields, one or more of which can be variable length according to the size of the window.
      </p><p><seeerl marker="wxStatusBar"><c>wxStatusBar</c></seeerl> also maintains an independent stack of status texts for each field (see <seemfa marker="#pushStatusText/3"><c>pushStatusText/3</c></seemfa> and <seemfa marker="#popStatusText/2"><c>popStatusText/2</c></seemfa>).
      </p><p>Note that in <seeerl marker="wxStatusBar"><c>wxStatusBar</c></seeerl> context, the terms <c>pane</c> and <c>field</c> are synonyms.
      </p><p>Styles</p><p>This class supports the following styles:
      </p><p>Remark: It is possible to create controls and other windows on the status bar. Position these windows from an OnSize() event handler.
      </p><p>Remark: Notice that only the first 127 characters of a string will be shown in status bar fields under Windows if a proper manifest indicating that the program uses version 6 of common controls library is not used. This is a limitation of the native control on these platforms.
      </p><p>See: <c>wxStatusBarPane</c> (not implemented in wx), <seeerl marker="wxFrame"><c>wxFrame</c></seeerl>, <url href="https://docs.wxwidgets.org/3.1/page_samples.html#page_samples_statbar">Examples</url>
      </p>
  <p>This class is derived (and can use functions) from: 
    <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_status_bar.html">wxStatusBar</url></p>
  </description>
<datatypes><datatype><name name="wxStatusBar"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>Default ctor. </fsummary>
    <desc><p>Default ctor. 
      </p></desc>
  </func>
  
  <func>
    <name name="new" arity="1" clause_i="1" since=""/>
    <fsummary>See: <c>new/2</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
    <fsummary>Constructor, creating the window. </fsummary>
    <desc><p>Constructor, creating the window. 
      </p><p>See: <seemfa marker="#create/3"><c>create/3</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor. </fsummary>
    <desc><p>Destructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="create" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>create/3</c></fsummary>
  </func>
  
  <func>
    <name name="create" arity="3" clause_i="1" since=""/>
    <fsummary>Creates the window, for two-step construction. </fsummary>
    <desc><p>Creates the window, for two-step construction. 
      </p><p>See <seemfa marker="#new/2"><c>new/2</c></seemfa> for details. 
      </p></desc>
  </func>
  
  <func>
    <name name="getFieldRect" arity="2" clause_i="1" since=""/>
    <fsummary>Returns the size and position of a field's internal bounding rectangle. </fsummary>
    <desc><p>Returns the size and position of a field's internal bounding rectangle. 
      </p><p>Return: true if the field index is valid, false otherwise.
      </p><p>See: {X,Y,W,H}
      </p></desc>
  </func>
  
  <func>
    <name name="getFieldsCount" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the number of fields in the status bar. </fsummary>
    <desc><p>Returns the number of fields in the status bar. 
      </p></desc>
  </func>
  
  <func>
    <name name="getStatusText" arity="1" clause_i="1" since=""/>
    <fsummary>See: <c>getStatusText/2</c></fsummary>
  </func>
  
  <func>
    <name name="getStatusText" arity="2" clause_i="1" since=""/>
    <fsummary>Returns the string associated with a status bar field. </fsummary>
    <desc><p>Returns the string associated with a status bar field. 
      </p><p>Return: The status field string if the field is valid, otherwise the empty string.
      </p><p>See: <seemfa marker="#setStatusText/3"><c>setStatusText/3</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="popStatusText" arity="1" clause_i="1" since=""/>
    <fsummary>See: <c>popStatusText/2</c></fsummary>
  </func>
  
  <func>
    <name name="popStatusText" arity="2" clause_i="1" since=""/>
    <fsummary>Restores the text to the value it had before the last call to <c>pushStatusText/3</c>. </fsummary>
    <desc><p>Restores the text to the value it had before the last call to <seemfa marker="#pushStatusText/3"><c>pushStatusText/3</c></seemfa>. 
      </p><p>Notice that if <seemfa marker="#setStatusText/3"><c>setStatusText/3</c></seemfa> had been called in the meanwhile, <seemfa marker="#popStatusText/2"><c>popStatusText/2</c></seemfa> will not change the text, i.e. it does not override explicit changes to status text but only restores the saved text if it hadn't been changed since.
      </p><p>See: <seemfa marker="#pushStatusText/3"><c>pushStatusText/3</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="pushStatusText" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>pushStatusText/3</c></fsummary>
  </func>
  
  <func>
    <name name="pushStatusText" arity="3" clause_i="1" since=""/>
    <fsummary>Saves the current field text in a per-field stack, and sets the field text to the string passed as argument. </fsummary>
    <desc><p>Saves the current field text in a per-field stack, and sets the field text to the string passed as argument. 
      </p><p>See: <seemfa marker="#popStatusText/2"><c>popStatusText/2</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="setFieldsCount" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>setFieldsCount/3</c></fsummary>
  </func>
  
  <func>
    <name name="setFieldsCount" arity="3" clause_i="1" since=""/>
    <fsummary>Sets the number of fields, and optionally the field widths. </fsummary>
    <desc><p>Sets the number of fields, and optionally the field widths. 
      </p></desc>
  </func>
  
  <func>
    <name name="setMinHeight" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the minimal possible height for the status bar. </fsummary>
    <desc><p>Sets the minimal possible height for the status bar. 
      </p><p>The real height may be bigger than the height specified here depending on the size of the font used by the status bar. 
      </p></desc>
  </func>
  
  <func>
    <name name="setStatusText" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>setStatusText/3</c></fsummary>
  </func>
  
  <func>
    <name name="setStatusText" arity="3" clause_i="1" since=""/>
    <fsummary>Sets the status text for the <c>i-th</c> field. </fsummary>
    <desc><p>Sets the status text for the <c>i-th</c> field. 
      </p><p>The given text will replace the current text. The display of the status bar is updated immediately, so there is no need to call <seemfa marker="wxWindow#update/1"><c>wxWindow:update/1</c></seemfa> after calling this function.
      </p><p>Note that if <seemfa marker="#pushStatusText/3"><c>pushStatusText/3</c></seemfa> had been called before the new text will also replace the last saved value to make sure that the next call to <seemfa marker="#popStatusText/2"><c>popStatusText/2</c></seemfa> doesn't restore the old value, which was overwritten by the call to this function.
      </p><p>See: <seemfa marker="#getStatusText/2"><c>getStatusText/2</c></seemfa>, <seemfa marker="wxFrame#setStatusText/3"><c>wxFrame:setStatusText/3</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="setStatusWidths" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the widths of the fields in the status line. </fsummary>
    <desc><p>Sets the widths of the fields in the status line. 
      </p><p>There are two types of fields: <c>fixed</c> widths and <c>variable</c> width fields. For the fixed width fields you should specify their (constant) width in pixels. For the variable width fields, specify a negative number which indicates how the field should expand: the space left for all variable width fields is divided between them according to the absolute value of this number. A variable width field with width of -2 gets twice as much of it as a field with width -1 and so on.
      </p><p>For example, to create one fixed width field of width 100 in the right part of the status bar and two more fields which get 66% and 33% of the remaining space correspondingly, you should use an array containing -2, -1 and 100.
      </p><p>Remark: The widths of the variable fields are calculated from the total width of all fields, minus the sum of widths of the non-variable fields, divided by the number of variable fields.
      </p><p>See: <seemfa marker="#setFieldsCount/3"><c>setFieldsCount/3</c></seemfa>, <seemfa marker="wxFrame#setStatusWidths/2"><c>wxFrame:setStatusWidths/2</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="setStatusStyles" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the styles of the fields in the status line which can make fields appear flat or raised instead of the standard sunken 3D border. </fsummary>
    <desc><p>Sets the styles of the fields in the status line which can make fields appear flat or raised instead of the standard sunken 3D border. 
      </p></desc>
  </func>
  </funcs>
</erlref>
