Progressbalken

Ein allgemeines Beispiel zur Verwendung der Klasse progress finden sie hier.

Letzte Änderung :
30.07.2025, 07:35 Uhr

Progressbalken

static int progress::start(
  char* titel,
  int steps = 24,
  int useGlobal = 0,
  int disableChild = 0)

Zeige den Progressbalken. Bei der Verarbeitung mehrerer Skripte (Palettenaktionen für mehrere ausgewählte Dokumentrahmen) wird automatisch ein Progressbalken geöffnet und am Ende der Stapelverarbeitung wieder geschlossen. In diesem Fall darf jedes Script 24 Schritte verwenden. Der Progress wird am Scriptende automatisch wieder geschlossen.

Unter comet_pdf ist die Funktion leer.

Name Typ Default Beschreibung
Return int   0 oder Fehlercode
titel String oder char* - Fenstertitel. Beim Start wird der Fenstertitel auch als Beschriftung für das Kapitel verwendet.
steps int 24 Anzahl der Schritte.
useGlobal int 0 Soll der Progressbalken globel über mehrere Skripte verwendet werden?

0 : Nein. Der Progressbalken wird automatisch am Skriptende geschlossen

1 : Ja. Der Progessbalken muß innerhalb der ausgeführten Skripte mit progress::stop selbst geschlossen werden.

Die Funktion progress::unit ist bisher nicht für den globalen Progressbalken angepasst und führt bei Verwendung im globalen Progressbalken zu Fehlern.

disableChild int 0 Setzen Sie hier den Wert 1 um zu verhindern, dass nachfolgende Fortschrittsbalken Ihren Fortschrittsbalken unterteilen. 
progress::start (titel);

Die Anzahl der Schritte kann ab Version 1.1.10 (25. Mai 2005) angegeben werden.
useGlobal und disableChild seit v4.3 R34890

priint:comet InDesign® Plug-Ins, comet_pdf

progress::unit
progress::stop
comet.progress.start

static int progress::stop()

Schließe den Progressbalken. Skripte können den Progress nur schließen, wenn sie ihn selbst geöffnet haben.

Unter comet_pdf ist die Funktion leer.

Name Typ Default Beschreibung
Return int   0 oder Fehlercode 
progress::stop ();


priint:comet InDesign® Plug-Ins, comet_pdf

progress::start
comet.progress.stop

static int progress::unit(char* chapter, int index = 0)

Ändere die Kapitelüberschrift des Balkens. Ist ein Index angegeben, wird er an die Kapitelüberschrift angehangen.

Die Funktion progress::unit ist bisher nicht für den globalen Progressbalken angepasst und führt bei Verwendung im globalen Progressbalken zu Fehlern.

Unter comet_pdf ist die Funktion leer.

Name Typ Default Beschreibung
Return int   0 oder Fehlercode
chapter String oder char* - Kapitelüberschrift
index int 0 Kapitelnummer 
progress::unit ("Kapitel", 3);


priint:comet InDesign® Plug-Ins, comet_pdf

comet.progress.unit

static int progress::step(char* label, int n = 1)

Ändere die Balkenbeschriftung und teile dem Progressbalken mit, dass im nächsten Schritt n Aufgaben gelöst werden. Der Balken wird erst beim nächsten Aufruf der Funktion um diese n Schritte weitergerückt, denn erst zu diesem Zeitpunkt sind die Aufgaben ja erledigt.

Auf Grund eines Fehlers in InDesign® (betrifft bisher alle Versionen!) wird im ersten Schritt der Text noch nicht gesetzt. Das liegt wohl daran, dass die Update-Events für das Fenster erst gefeuert werden, wenn der Balken weiter gerückt ist - und das ist beim ersten Aufruf ja nun mal nicht der Fall.

Im Stapelbetrieb muss die maximale Schrittanzahl von 24 für Skripte beachtet werden.

Unter comet_pdf ist die Funktion leer.

Name Typ Default Beschreibung
Return int   0
1 : Im Fall eines globlen Progressbalkens : Bearbeitung abgebrochen
label String oder char* - Neue Unter-Überschrift unter dem Balken
n int 1 Anzahl der Schritte, um die der Balken weitergerückt werden soll

0 im lokalen Progressbalken : Nur den Untertitel ändern.

0 im globalen Progressbalken : Erfrage lediglich, ob der Progress abgebrochen wurde. Wurde der Progress abgebrochen, gibt die Funktion den Wert 1 zurück.


priint:comet InDesign® Plug-Ins, comet_pdf

comet.progress.step 

int one_step (int t)
{
    int 			i;
    char			task [256];

    sprintf (task, "%d ...", t);
    progress::step(task, 1);

    for (i=0; i < 1000000; i++)
    {
    }

    return 0;
}

int main ()
{
    int 		i;
    int			m	= 5;

    progress::start ("It' a test", m);

    for (i = 1; i <= m; i++)
    {
        one_step (i);
    }

    progress::step ("Done", 0);
    progress::stop();

    return 0;
}

Seit
Plugin Version 1.0.14
Letzte Änderung
30.07.2025, 07:35 Uhr
Autor
Paul Seidel

Alphabetic index HTML hierarchy of classes or Java