<?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>wxProgressDialog</title>
</header>
<module>wxProgressDialog</module>
<modulesummary>Functions for wxProgressDialog class</modulesummary>
<description><p>If supported by the platform this class will provide the platform's native progress dialog, else it will simply be the <c>wxGenericProgressDialog</c> (not implemented in wx). 
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxDialog"><c>wxDialog</c></seeerl> <seeerl marker="wxTopLevelWindow"><c>wxTopLevelWindow</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_progress_dialog.html">wxProgressDialog</url></p>
  </description>
<datatypes><datatype><name name="wxProgressDialog"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>new/3</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="3" clause_i="1" since=""/>
    <fsummary/>
    <desc/>
  </func>
  
  <func>
    <name name="resume" arity="1" clause_i="1" since=""/>
    <fsummary>Can be used to continue with the dialog, after the user had clicked the "Abort" button. </fsummary>
    <desc><p>Can be used to continue with the dialog, after the user had clicked the "Abort" button. 
      </p></desc>
  </func>
  
  <func>
    <name name="update" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>update/3</c></fsummary>
  </func>
  
  <func>
    <name name="update" arity="3" clause_i="1" since=""/>
    <fsummary>Updates the dialog, setting the progress bar to the new value and updating the message if new one is specified. </fsummary>
    <desc><p>Updates the dialog, setting the progress bar to the new value and updating the message if new one is specified. 
      </p><p>Returns true unless the "Cancel" button has been pressed.
      </p><p>If false is returned, the application can either immediately destroy the dialog or ask the user for the confirmation and if the abort is not confirmed the dialog may be resumed with <seemfa marker="#resume/1"><c>resume/1</c></seemfa> function.
      </p><p>If <c>value</c> is the maximum value for the dialog, the behaviour of the function depends on whether <c>wxPD_AUTO_HIDE</c> was used when the dialog was created. If it was, the dialog is hidden and the function returns immediately. If it was not, the dialog becomes a modal dialog and waits for the user to dismiss it, meaning that this function does not return until this happens.
      </p><p>Notice that if <c>newmsg</c> is longer than the currently shown message, the dialog will be automatically made wider to account for it. However if the new message is shorter than the previous one, the dialog doesn't shrink back to avoid constant resizes if the message is changed often. To do this and fit the dialog to its current contents you may call <seemfa marker="wxWindow#fit/1"><c>wxWindow:fit/1</c></seemfa> explicitly. However the native MSW implementation of this class does make the dialog shorter if the new text has fewer lines of text than the old one, so it is recommended to keep the number of lines of text constant in order to avoid jarring dialog size changes. You may also want to make the initial message, specified when creating the dialog, wide enough to avoid having to resize the dialog later, e.g. by appending a long string of unbreakable spaces (<c>wxString</c> (not implemented in wx)(L'\u00a0', 100)) to it.
      </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>
