.. highlightlang:: us

.. index:: AppProgressDialog

.. _appprogressdialog:

AppProgressDialog
=================

.. us.tag  AppProgressDialog NOTREADYGERMAN App Toolbar New5401

:ref:`AppProgressDialog` erzeugt einen Fortschrittsanzeige-Dialog.

.. function::  bool = AppProgressDialog()
               bool = AppProgressDialog(nUpper)
               bool = AppProgressDialog(nUpper, ssTitle)

.. us.return

**Returnwert**

*bool* ist TRUE (1), wenn Funktion erfolgreich war, sonst FALSE (0).

.. us.params

**Parameter**

.. uparam:: nUpper

   Defaultwert ist 100.

.. uparam:: ssTitle

   Defaultwert ist "Progress".

.. us.comment

**Kommentar**

Oberhalb der Fortschrittsanzeige befinden sich zwei Zeilen für Texte, die mit
der Funktion :ref:`AppSetStatusBarText` gesetzt werden können.

Die Funktionen :ref:`AppProgressDialog` oder :ref:`AppProgressCreate` 
können ab UniPlot R2015.8 geschachtelt aufgerufen werden.

Beispiel: Es soll der Fortschritt beim importieren von 5 Dateien angezeigt werden.
Für jede Datei sollt der Importfortschritt angezeigt werden. Für jede 
Datei stehen dann 20 % der Fortschrittsanzeige zur Verfügung. Die Funktion
:ref:`AppProgressStepIt` sollte jeweils nach dem Aufruf der inneren
Funktion aufgerufen werden. Ansonsten würde der 20 % Forschritt sofort angezeigt
und nicht wie gewünscht entsprechned des Fortschritts der aufgerufenen 
Funktion angezeigt. Siehe Beispiel.

.. image:: S:/uniplot-obj/images/ProgressDialog.*

.. us.example

**Beispiel**

::

   def SubAppProgressDialog()
   {
      nStep = 10;
      AppProgressDialog(nStep);
      for (i in 1:nStep) {
          AppSetStatusBarText(sprintf("Step: %d", i));
          bRet = AppProgressStepIt();
          if (!bRet) {
             return FALSE; // cancel
          }
          AppSleep(50); // Simulate some work
      }
      AppProgressDestroy();
      return TRUE;
   }

   def TestAppProgressDialog()
   {
       nStep = 5
       AppProgressDialog(nStep, "Import Data");
       for (i in 1:nStep) {
           
           bRet = SubAppProgressDialog(); 
           if (!bRet) {
               return FALSE; // cancel
           }

           bRet = AppProgressStepIt(); 
           if (!bRet) {
               return FALSE; // cancel
           }
           AppSetStatusBarText(sprintf("Step: %d", i));
           AppSleep(50); // Simulate some work
       }
       AppProgressDestroy()
   }

   TestAppProgressDialog()

.. us.history

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Beschreibung
   * - R2015.8
     - Die Funktion kann geschachtelt aufgerufen werden.
   * - R2012.1 (5.40.1)
     - Neu.

.. seealso::
   :ref:`uberblick-application-objekt`,
   :ref:`AppProgressCreate`,
   :ref:`AppProgressStepIt`,
   :ref:`ShowWaitCursor`,
   :ref:`AppSetStatusBarText`

:sub:`id-796429`