All Frameworks Class Hierarchy This Framework Indexes Previous Next

AfrStandard Interface CATIProgressTaskUI

SystemTS.IUnknown

System.IDispatch

System.CATBaseUnknown

CATIProgressTaskUI

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIProgressTaskUI

Interface to customize user interface for an interruptible task.
RoleThis interface is used in the CATIProgressTask.PerformTask method.

See also:: CATIProgressTask, CATTaskController

Method Index

o Flush(): Commits the UI's modifications.
o GetAutoFlush(CATBoolean*): Gets the auto flush state.
o Interruptible(CATBoolean): Sets the interruptible state of the progress bar.
o IsInterrupted(CATBoolean*): Tells whether a task interruption is requested.
o SetAutoFlush(CATBoolean): Indicates to the user interface to manage automatically the flush.
o SetComment(CATUnicodeString&): Sets a runtime comment.
o SetObject(CATUnicodeString&): Sets a runtime object name concerned by the task.
o SetProgress(long): Sets the current progress indicator's value.
o SetRange(long,long): Sets minimal and maximal range of the progress bar.

Methods

o Flush

public virtual HRESULT Flush(

)= 0

Commits the UI's modifications.
Role: Modifies the user interface to take account of the range, progress, comment and object; See the SetRange, SetProgress, SetComment and SetObject methods.
This method must be called with care, since it may be costly in performance.

o GetAutoFlush

public virtual HRESULT GetAutoFlush( CATBoolean* oAutoFlush) = 0

Gets the auto flush state.

Parameters:

oAutoFlush: The state of the auto flush.

o Interruptible

public virtual HRESULT Interruptible( CATBoolean iInter) = 0

Sets the interruptible state of the progress bar.
Role: Modifies the interruptible state of the progress bar. The progress bar has to be defined as interruptible in CATTaskController::Schedule. At any step, this method changes the interruptible state by disabling/enabling the Cancel button of the progress bar dialog box.

Parameters:

iInter: The interruptible state : TRUE to set the state to "interruptible", FALSE to set the state to "not interruptible".

o IsInterrupted

public virtual HRESULT IsInterrupted( CATBoolean* oInterrupted) = 0

Tells whether a task interruption is requested.

Parameters:

oInterrupted: TRUE if the task has been interrupted, otherwise FALSE. If the task is not interruptible, see the second argument of the

o SetAutoFlush

public virtual HRESULT SetAutoFlush( CATBoolean iAutoFlush) = 0

Indicates to the user interface to manage automatically the flush.

Parameters:

iAutoFlush

FALSE : Indicates to the user interface to stop managing automatically the flushing.
TRUE : The flushing is automatically called after each

See also:

SetProgress Flush

o SetComment

public virtual HRESULT SetComment( const CATUnicodeString& iComment) = 0

Sets a runtime comment.
Role:The default comment is the one set in the NLS file defined by CATIProgressTask.GetCatalogName. The keyword associated with this message is CATIProgressTask.Comment. With this method, you can customize the comment at the beginning of a task or during a step. See the CATIProgressTask.PerformTask method.

o SetObject

public virtual HRESULT SetObject( const CATUnicodeString& iObject) = 0

Sets a runtime object name concerned by the task.
Role:The default object name is the one set in the NLS file defined by CATIProgressTask.GetCatalogName. The keyword associated with this message is CATIProgressTask.ObjectName. With this method, you can customize an object name at the beginning of a task, or during a step; See the CATIProgressTask.PerformTask method.

o SetProgress

public virtual HRESULT SetProgress( long iValue) = 0

Sets the current progress indicator's value.
Role:This value is used to define:

The current value of the progress control.
The percentage of process executed:

p = (iValue-min)/(max-min)

where "min" and "max" define the range set by the SetRange method

The estimated remaining time:

t= EllapsedTimeAlreadyPassed * (1-p)/p

Parameters:

iValue: The range of the value must be between the minimum and maximum bounds. if iValue is greated than the maximum value, the step progression is the maximum value. If the ivalue is less than the minimum value, the step progression is the minimum value.

Returns:

S_OK in all cases

o SetRange

public virtual HRESULT SetRange(	long	`iMinValue`,
	long	`iMaxValue`) = 0

Sets minimal and maximal range of the progress bar.
Role:This method sets the bounds of the progress bar. If the maximum value is lower than the minimum value, the dialog box is not displayed.

Parameters:

iMinValue: The lower bound of the interval displayed by the progress bar. The default value is 0.
iMaxValue: The upper bound of the interval displayed by the progress bar. The default value is 100.

Returns:

S_OK in all cases

This object is included in the file: CATIProgressTaskUI.h
If needed, your Imakefile.mk should include the module: CATAfrProgressTask