OfxProgressSuiteV1 Struct Reference

#include <ofxProgress.h>

List of all members.

---

Detailed Description

A suite that provides progress feedback from a plugin to an application.

A plugin instance can initiate, update and close a progress indicator with this suite.

This is an optional suite in the Image Effect API.

Public Attributes
OfxStatus(*	progressStart )(void *effectInstance, const char *label)
	Initiate a progress bar display.
OfxStatus(*	progressUpdate )(void *effectInstance, double progress)
	Indicate how much of the processing task has been completed and reports on any abort status.
OfxStatus(*	progressEnd )(void *effectInstance)
	Signal that we are finished with the progress meter.

---

Member Data Documentation

OfxStatus(* OfxProgressSuiteV1::progressEnd)(void *effectInstance)

Signal that we are finished with the progress meter. Call this when you are done with the progress meter and no longer need it displayed. effectInstance - the instance of the plugin this progress bar is associated with. It cannot be NULL. - you can no longer call progressUpdate on the instance Returns: kOfxStatOK - the progress object was successfully closed kOfxStatErrBadHandle - the progress handle was invalid,

OfxStatus(* OfxProgressSuiteV1::progressStart)(void *effectInstance, const char *label)

Initiate a progress bar display. Call this to initiate the display of a progress bar. effectInstance - the instance of the plugin this progress bar is associated with. It cannot be NULL. label - a text label to display in any message portion of the progress object's user interface. A UTF8 string. Returns: kOfxStatOK - the handle is now valid for use kOfxStatFailed - the progress object failed for some reason kOfxStatErrBadHandle - effectInstance was invalid

OfxStatus(* OfxProgressSuiteV1::progressUpdate)(void *effectInstance, double progress)

Indicate how much of the processing task has been completed and reports on any abort status. effectInstance - the instance of the plugin this progress bar is associated with. It cannot be NULL. progress - a number between 0.0 and 1.0 indicating what proportion of the current task has been processed. Returns: kOfxStatOK - the progress object was successfully updated and the task should continue kOfxStatReplyNo - the progress object was successfully updated and the task should abort kOfxStatErrBadHandle - the progress handle was invalid,

---

The documentation for this struct was generated from the following file:

• ofxProgress.h

---

Copyright 2003-2004 The Foundry Visonmongers Ltd. All rights reserved.
Copying and redistribution with or without modification, is permitted provided that the following conditions are met:

1. Redistributions of the document must retain the above copyright notice and this list of conditions.
2. Neither the name of The Foundry Visonmongers Ltd nor names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

Automatic documentation generated by DOxygen.