All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

Dialog Class CATDlgProgress

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATEventSubscriber
        |
        +---System.CATCommand
          |
          +---Dialog.CATDialog
            |
            +---Dialog.CATDlgControl
              |
              +---CATDlgProgress
 

Usage: you must use this class as is. You should never derive it.


public class CATDlgProgress

Base class for progress controls.
Role:Progress controls provide a graphic gauge which give feedback to the user about the completion percentage of a given task.


Constructor and Destructor Index


o CATDlgProgress(CATDialog*,CATString&,CATDlgStyle)
Constructor.
o ~CATDlgProgress()
Destructor.

Method Index


o GetPos()
Gets the current value of the progress control.
o GetRange(int*,int*)
Retrieves the interval displayed by the progress control.
o GetStep()
Get the step (the amount by which the current value will augment every time the StepIt method is invoked).
o OffsetPos(int)
Augments the value of the progress control.
o SetPos(int)
Sets the current value of the progress control.
o SetRange(int,int)
Specifies the interval displayed by the progress control.
o SetStep(int)
Set the step (the amount by which the current value will augment every time the StepIt method is invoked).
o StepIt()
Augments the value of the progress control by a fixed step.

Constructor and Destructor


o CATDlgProgress
public CATDlgProgress(CATDialog* iParent,
const CATString& iObjectName,
CATDlgStyle iStyle=NULL)
Constructor.
Parameters:
iParent
The parent widget.
iObjectName
The internal name of the menu item.
iStyle
The style of the progress control. Legal values:Only the current default value is available.
o ~CATDlgProgress
public virtual ~CATDlgProgress()
Destructor.

Methods


o GetPos
public int GetPos()
Gets the current value of the progress control.
Returns:
the current progress value.
o GetRange
public void GetRange(int* oMin,
int* oMax)
Retrieves the interval displayed by the progress control.
Parameters:
oMin
the lower bound of the interval displayed by the progress control.
oMax
the upper bound of the interval displayed by the progress control.
o GetStep
public int GetStep()
Get the step (the amount by which the current value will augment every time the StepIt method is invoked).
Returns:
the step value.
o OffsetPos
public void OffsetPos(int iPos)
Augments the value of the progress control.
Parameters:
iPos
the amount by which the value of the progress control must be augmented.
o SetPos
public void SetPos(int iVal)
Sets the current value of the progress control.
Parameters:
iVal
the current progress value.
o SetRange
public void SetRange(int iMin,
int iMax)
Specifies the interval displayed by the progress control.
Parameters:
iMin
the lower bound of the interval displayed by the progress control.
iMax
the upper bound of the interval displayed by the progress control.
o SetStep
public void SetStep(int iStep)
Set the step (the amount by which the current value will augment every time the StepIt method is invoked).
Parameters:
iStep
the step value.
o StepIt
public void StepIt()
Augments the value of the progress control by a fixed step.

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

Copyright © 2003, Dassault Systèmes. All rights reserved.