| class CEikProgressInfo : public CEikBorderedControl |
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.
| Public Member Functions | |
|---|---|
| CEikProgressInfo () | |
| CEikProgressInfo (const SInfo &) | |
| ~CEikProgressInfo () | |
| IMPORT_C void | ActivateL () |
| IMPORT_C void | ConstructFromResourceL ( TResourceReader &) |
| IMPORT_C void | ConstructL () |
| TInt | CurrentValue () |
| IMPORT_C void | GetColorUseListL ( CArrayFix < TCoeColorUse > &) |
| IMPORT_C void | HandlePointerEventL (const TPointerEvent &) |
| IMPORT_C void | HandleResourceChange ( TInt ) |
| IMPORT_C void | IncrementAndDraw ( TInt ) |
| const SInfo & | Info () |
| const SLayout & | Layout () |
| 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 &) |
| IMPORT_C void | SizeChanged () |
| Protected Member Functions | |
|---|---|
| IMPORT_C const TDesC * | EvaluateText ( TDes &) |
| IMPORT_C void | WriteInternalStateL ( RWriteStream &) |
| Private Member Functions | |
|---|---|
| void | CheckSizeCalculated () |
| void | Construct () |
| void | DeleteBitmaps () |
| IMPORT_C void | Draw (const TRect &) |
| void | DrawPartial () |
| void | DrawProgressBarBackground ( CWindowGc &) |
| void | DrawProgressBarForeground ( CWindowGc &) |
| IMPORT_C void * | ExtensionInterface ( TUid ) |
| TInt | FilledWidth () |
| void | LoadBitmapsL () |
| IMPORT_C void | Reserved_2 () |
| void | SetBitmapSizes () |
| Inherited Enumerations | |
|---|---|
| CCoeControl:TZoomType | |
| Private Attributes | |
|---|---|
| CFbsBitmap * | iBackgroundBitmap |
| CFbsBitmap * | iBitmap |
| CFbsBitmap * | iBitmapMask |
| TInt | iCurrentValue |
| CEikProgressInfoExtension * | iExtension |
| TBool | iHeightWasSupplied |
| SInfo | iInfo |
| SLayout | iLayout |
| Inherited Attributes | |
|---|---|
| CCoeControl::iCoeEnv | |
| CCoeControl::iContext | |
| CCoeControl::iPosition | |
| CCoeControl::iSize | |
| CEikBorderedControl::iBorder | |
| IMPORT_C | CEikProgressInfo | ( | const SInfo & | aProgInfo | ) |
Constructs a progress information control using the information held in the specified SInfo struct. Uses default layout values.
| const SInfo & aProgInfo | Holds information about the type of progress information control. |
| IMPORT_C void | ActivateL | ( | ) | [virtual] |
From CCoeControl .
Activates the progress information control.
| IMPORT_C void | ConstructFromResourceL | ( | TResourceReader & | aReader | ) | [virtual] |
From CCoeControl .
Constructs a progress information control from a PROGRESSINFO resource. Uses default layout values.
| TResourceReader & aReader | The resource reader to use. |
| TInt | CurrentValue | ( | ) | const [inline] |
Gets the current value, indicating how far the operation has progressed.
| IMPORT_C void | Draw | ( | const TRect & | aRect | ) | const [private, virtual] |
From CCoeControl . Draws the border around the control. This function also clears the central area if the IsBlank() method returns ETrue .
From CCoeControl
| const TRect & aRect | Not used. |
| void | DrawProgressBarBackground | ( | CWindowGc & | aGc | ) | const [private] |
| CWindowGc & aGc |
| void | DrawProgressBarForeground | ( | CWindowGc & | aGc | ) | const [private] |
| CWindowGc & aGc |
| IMPORT_C const TDesC * | EvaluateText | ( | TDes & | aTextBuf | ) | const [protected, virtual] |
Evaluates the progress text.
| TDes & aTextBuf | On return, the evaluted text. This is the same as the return value. |
| IMPORT_C void * | ExtensionInterface | ( | TUid | aInterface | ) | [private, virtual] |
From CAknControl
| TUid aInterface |
| IMPORT_C void | GetColorUseListL | ( | CArrayFix < TCoeColorUse > & | aColorUseList | ) | const [virtual] |
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.
| CArrayFix < TCoeColorUse > & aColorUseList | On return, the colours used to draw the control. |
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
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() .
| const TPointerEvent & aPointerEvent | The pointer event. |
| IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [virtual] |
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.
| TInt 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.
| TInt 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.
| const SLayout & | Layout | ( | ) | const [inline] |
Gets a pointer to the colours and layout of the progress information control.
| 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.
| TInt aValue | The new progress value. |
| IMPORT_C void | SetBorder | ( | const TGulBorder & | aBorder | ) |
Sets the control's border.
| const TGulBorder & 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.
| TInt 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.
| const SLayout & aLayout | The layout for the control. |
| IMPORT_C void | SizeChanged | ( | ) | [virtual] |
From CCoeControl .
Recalculates the control's size in response to a size change.
| IMPORT_C void | WriteInternalStateL | ( | RWriteStream & | aWriteStream | ) | const [protected, virtual] |
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.
| RWriteStream & aWriteStream | The internal state of the control and its components. |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.