#include <mw/eikprogi.h>
| class CEikProgressInfo : public CEikBorderedControl |
| Public Member Functions | |
|---|---|
| CEikProgressInfo() | |
| CEikProgressInfo(const SInfo &) | |
| ~CEikProgressInfo() | |
| virtual IMPORT_C void | ActivateL() |
| virtual IMPORT_C void | ConstructFromResourceL(TResourceReader &) |
| IMPORT_C void | ConstructL() |
| TInt | CurrentValue() |
| virtual IMPORT_C void | GetColorUseListL(CArrayFix< TCoeColorUse > &) |
| virtual IMPORT_C void | HandlePointerEventL(const TPointerEvent &) |
| virtual IMPORT_C void | HandleResourceChange(TInt) |
| IMPORT_C void | IncrementAndDraw(TInt) |
| const SInfo & | Info() |
| const SLayout & | Layout() |
| virtual IMPORT_C TSize | MinimumSize() |
| IMPORT_C void | SetAndDraw(TInt) |
| IMPORT_C void | SetBorder(const TGulBorder &) |
| IMPORT_C void | SetFinalValue(TInt) |
| IMPORT_C void | SetLayout(const SLayout &) |
| virtual IMPORT_C void | SizeChanged() |
| Protected Member Functions | |
|---|---|
| virtual IMPORT_C const TDesC * | EvaluateText(TDes &) |
| virtual IMPORT_C void | WriteInternalStateL(RWriteStream &) |
| Inherited Attributes | |
|---|---|
| CCoeControl::iCoeEnv | |
| CCoeControl::iContext | |
| CCoeControl::iPosition | |
| CCoeControl::iSize | |
| CEikBorderedControl::iBorder | |
| Inherited Enumerations | |
|---|---|
| CCoeControl:TZoomType | |
Control used to indicate the progress of an operation.
Progress consists of a rectangular block that grows during an increment and shrinks during a decrement. The control can have progress text within the bar that provides updated information on how far the operation has progressed. The text can be displayed as either a percentage or a fraction. The bar can also have a series of invisible splits, or lines. These splits are displayed by the rectangular blocks as it fills the bar. When the control is in this mode progress text cannot be used.
This class has an associated PROGRESSINFO resource and EEikCtProgInfo control factory identifier.
| IMPORT_C void | ActivateL | ( | ) | [virtual] |
Reimplemented from CCoeControl::ActivateL()
From CCoeControl.
Activates the progress information control.
| IMPORT_C void | ConstructFromResourceL | ( | TResourceReader & | aReader | ) | [virtual] |
Reimplemented from CCoeControl::ConstructFromResourceL(TResourceReader &)
From CCoeControl.
Constructs a progress information control from a PROGRESSINFO resource. Uses default layout values.
| Parameter | Description |
|---|---|
| aReader | The resource reader to use. |
| TInt | CurrentValue | ( | ) | const [inline] |
Gets the current value, indicating how far the operation has progressed.
Returns: The value for how far the operation has progressed.
Evaluates the progress text.
| Parameter | Description |
|---|---|
| aTextBuf | On return, the evaluted text. This is the same as the return value. |
Returns: The evaluated text. Null if progress information is not held as text. A percentage if it is held as a percentage. Otherwise, the current value and final value separated by a slash. Subclassers may wish to use their own buffer.
| IMPORT_C void | GetColorUseListL | ( | CArrayFix< TCoeColorUse > & | aColorUseList | ) | const [virtual] |
Reimplemented from CEikBorderedControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
From CCoeControl.
Gets a list of the logical colours used to draw the control, appended to aColorUseList.
Gets the list of logical colors employed in the drawing of the control, paired with an explanation of how they are used. Appends the list to aColorUseList.
| Parameter | Description |
|---|---|
| aColorUseList | On return, the colours used to draw the control. |
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
Reimplemented from CEikBorderedControl::HandlePointerEventL(const TPointerEvent &)
From CCoeControl.
Handles pointer events. This function gets called whenever a pointer event occurs in the control, i.e. when the pointer is within the control's extent, or when the control has grabbed the pointer. The control should implement this function to handle pointer events.
Note: events of type EButton1Down are processed before HandlePointerEventL() is called, in order to transfer keyboard focus to the control in which the EButton1Down event occurred. If overriding HandlePointerEventL(), the implementation must include a base call to CCoeControl's HandlePointerEventL().
| Parameter | Description |
|---|---|
| aPointerEvent | The pointer event. |
| IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [virtual] |
Reimplemented from CEikBorderedControl::HandleResourceChange(TInt)
From CCoeControl.
Handles a change to the control's resources.
Handles a change to the control's resources of type aType which are shared across the environment, e.g. colors or fonts.
| Parameter | Description |
|---|---|
| aType | A message UID value. |
| IMPORT_C void | IncrementAndDraw | ( | TInt | aInc | ) |
Adds the specified increment to the current progress value and, if the progress value has increased, redraws the control.
| Parameter | Description |
|---|---|
| aInc | The increment to add to the current progress value. |
| const SInfo & | Info | ( | ) | const [inline] |
Gets a pointer to the information used to define the progress information control's type.
Returns: The information that defines the type of progress information control.
| const SLayout & | Layout | ( | ) | const [inline] |
Gets a pointer to the colours and layout of the progress information control.
Returns: Defines the layout of the control.
| IMPORT_C TSize | MinimumSize | ( | ) | [virtual] |
Reimplemented from CCoeControl::MinimumSize()
From CCoeControl.
Gets the minimum size required to draw the control.
Returns: Two-dimensional size as a width and a height value.
| IMPORT_C void | SetAndDraw | ( | TInt | aValue | ) |
Sets the specified value as the new progress value and redraws the control if the new value differs from the old value.
| Parameter | Description |
|---|---|
| aValue | The new progress value. |
| IMPORT_C void | SetBorder | ( | const TGulBorder & | aBorder | ) |
Sets the control's border.
| Parameter | Description |
|---|---|
| aBorder | The control's border. |
| IMPORT_C void | SetFinalValue | ( | TInt | aFinalValue | ) |
Sets the final value for the progress information control. This value indicates the operation being monitored is complete.
| Parameter | Description |
|---|---|
| aFinalValue | The final value for the progress information control. If this is specified as zero, the value is set to one. |
| IMPORT_C void | SetLayout | ( | const SLayout & | aLayout | ) |
Sets the layout for the control.
| Parameter | Description |
|---|---|
| aLayout | The layout for the control. |
| IMPORT_C void | SizeChanged | ( | ) | [virtual] |
Reimplemented from CCoeControl::SizeChanged()
From CCoeControl.
Recalculates the control's size in response to a size change.
| IMPORT_C void | WriteInternalStateL | ( | RWriteStream & | aWriteStream | ) | const [protected, virtual] |
Reimplemented from CEikBorderedControl::WriteInternalStateL(RWriteStream &)const
From CCoeControl.
Writes the internal state of the control and its components to a stream. This function is empty in release builds. It is intended to be overridden and base called by subclasses.
| Parameter | Description |
|---|---|
| aWriteStream | The internal state of the control and its components. |