CEikProgressInfo Class Reference
| 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.
Nested Classes and Structures
| Inherited Functions |
|---|
| | CAknControl::CAknControl() |
| | CAknControl::~CAknControl() |
| | CBase::CBase() |
| | CBase::Delete(CBase *) |
| | CBase::Extension_(TUint,TAny *&,TAny *) |
| | CBase::operator new(TUint) |
| | CBase::operator new(TUint,TAny *) |
| | CBase::operator new(TUint,TLeave) |
| | CBase::operator new(TUint,TLeave,TUint) |
| | CBase::operator new(TUint,TUint) |
| | CBase::~CBase() |
| | CCoeControl::AccumulatedZoom()const |
| | CCoeControl::ActivateGc()const |
| | CCoeControl::BackedUpWindow()const |
| | CCoeControl::Background()const |
| | CCoeControl::CCoeControl() |
| | CCoeControl::CCoeControl(CCoeEnv *) |
| | CCoeControl::CCoeControl(const CCoeControl &) |
| | CCoeControl::CapturesPointer()const |
| | CCoeControl::ClaimPointerGrab(TBool) |
| | CCoeControl::ClaimPointerGrab(TInt,TBool) |
| | CCoeControl::CloseWindow() |
| | CCoeControl::ComponentArrayExists()const |
| | CCoeControl::ComponentControl(TInt)const |
| | CCoeControl::Components() |
| | CCoeControl::Components()const |
| | CCoeControl::ControlContext()const |
| | CCoeControl::ControlEnv()const |
| | CCoeControl::CopyControlContextFrom(const CCoeControl *) |
| | CCoeControl::CountComponentControls()const |
| | CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &) |
| | CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode) |
| | CCoeControl::CreateWindowL() |
| | CCoeControl::CreateWindowL(RWindowGroup *) |
| | CCoeControl::CreateWindowL(RWindowTreeNode &) |
| | CCoeControl::CreateWindowL(const CCoeControl *) |
| | CCoeControl::CustomGc()const |
| | CCoeControl::DeactivateGc()const |
| | CCoeControl::DrawBackground(const TRect &)const |
| | CCoeControl::DrawDeferred()const |
| | CCoeControl::DrawForeground(const TRect &)const |
| | CCoeControl::DrawNow()const |
| | CCoeControl::DrawNow(const TRect &)const |
| | CCoeControl::DrawableWindow()const |
| | CCoeControl::EnableDragEvents() |
| | CCoeControl::EnableReportControlStateChange(TBool) |
| | CCoeControl::EnableWindowTransparency() |
| | CCoeControl::FindBackground()const |
| | CCoeControl::FindFontProvider()const |
| | CCoeControl::FocusChanged(TDrawNow) |
| | CCoeControl::GetColor(TInt,TRgb &)const |
| | CCoeControl::GetGc()const |
| | CCoeControl::GetHelpContext(TCoeHelpContext &)const |
| | CCoeControl::GrabbingComponent()const |
| | CCoeControl::GrabbingComponent(TInt)const |
| | CCoeControl::HandleComponentControlsResourceChange(TInt) |
| | CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray *,CCoeControl *,TInt) |
| | CCoeControl::HandlePointerBufferReadyL() |
| | CCoeControl::HandleRedrawEvent(const TRect &)const |
| | CCoeControl::HitTest()const |
| | CCoeControl::IgnoreEventsUntilNextPointerUp() |
| | CCoeControl::Index(const CCoeControl *)const |
| | CCoeControl::InitComponentArrayL() |
| | CCoeControl::InputCapabilities()const |
| | CCoeControl::IsActivated()const |
| | CCoeControl::IsBackedUp()const |
| | CCoeControl::IsBeingDestroyed()const |
| | CCoeControl::IsBlank()const |
| | CCoeControl::IsDimmed()const |
| | CCoeControl::IsFocused()const |
| | CCoeControl::IsNonFocusing()const |
| | CCoeControl::IsReadyToDraw()const |
| | CCoeControl::IsVisible()const |
| | CCoeControl::LayoutManager()const |
| | CCoeControl::MakeVisible(TBool) |
| | CCoeControl::MaximumWidth()const |
| | CCoeControl::MopSupplyObject(TTypeUid) |
| | CCoeControl::NotifyFontChange(const CCoeFontProvider *) |
| | CCoeControl::Observer()const |
| | CCoeControl::OfferKeyEventL(const TKeyEvent &,TEventCode) |
| | CCoeControl::OverrideColorL(TInt,TRgb) |
| | CCoeControl::OwnsWindow()const |
| | CCoeControl::Parent() |
| | CCoeControl::Parent()const |
| | CCoeControl::Position()const |
| | CCoeControl::PositionChanged() |
| | CCoeControl::PositionRelativeToScreen()const |
| | CCoeControl::PrepareForFocusGainL() |
| | CCoeControl::PrepareForFocusLossL() |
| | CCoeControl::ProcessPointerBufferReadyL() |
| | CCoeControl::ProcessPointerEventL(const TPointerEvent &) |
| | CCoeControl::Rect()const |
| | CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const |
| | CCoeControl::RecursivelyMergedInputCapabilities()const |
| | CCoeControl::RefetchPixelMappingL() |
| | CCoeControl::RemoveFromParent() |
| | CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent) |
| | CCoeControl::RequestRelayout(const CCoeControl *) |
| | CCoeControl::ResetGc()const |
| | CCoeControl::ScreenFont(const TCoeFont &)const |
| | CCoeControl::SetAllowStrayPointers() |
| | CCoeControl::SetBackground(const MCoeControlBackground *) |
| | CCoeControl::SetBlank() |
| | CCoeControl::SetCanDrawOutsideRect() |
| | CCoeControl::SetComponentsToInheritVisibility(TBool) |
| | CCoeControl::SetContainerWindowL(RBackedUpWindow &) |
| | CCoeControl::SetContainerWindowL(RWindow &) |
| | CCoeControl::SetContainerWindowL(const CCoeControl &) |
| | CCoeControl::SetControlContext(MCoeControlContext *) |
| | CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &) |
| | CCoeControl::SetCustomGc(CWindowGc *) |
| | CCoeControl::SetDimmed(TBool) |
| | CCoeControl::SetExtent(const TPoint &,const TSize &) |
| | CCoeControl::SetExtentToWholeScreen() |
| | CCoeControl::SetFocus(TBool,TDrawNow) |
| | CCoeControl::SetFocusing(TBool) |
| | CCoeControl::SetFontProviderL(const CCoeFontProvider &) |
| | CCoeControl::SetGc(CWindowGc *)const |
| | CCoeControl::SetGloballyCapturing(TBool) |
| | CCoeControl::SetHitTest(const MCoeControlHitTest *) |
| | CCoeControl::SetLayoutManagerL(MCoeLayoutManager *) |
| | CCoeControl::SetMaximumWidth(TInt) |
| | CCoeControl::SetMopParent(MObjectProvider *) |
| | CCoeControl::SetNeighbor(CCoeControl *) |
| | CCoeControl::SetNonFocusing() |
| | CCoeControl::SetObserver(MCoeControlObserver *) |
| | CCoeControl::SetParent(CCoeControl *) |
| | CCoeControl::SetPointerCapture(TBool) |
| | CCoeControl::SetPosition(const TPoint &) |
| | CCoeControl::SetRect(const TRect &) |
| | CCoeControl::SetSize(const TSize &) |
| | CCoeControl::SetSizeWithoutNotification(const TSize &) |
| | CCoeControl::SetTextBaselineSpacing(TInt) |
| | CCoeControl::SetUniqueHandle(TInt) |
| | CCoeControl::SetZoomFactorL(TInt,TZoomType) |
| | CCoeControl::Size()const |
| | CCoeControl::SystemGc()const |
| | CCoeControl::TextBaselineOffset(const TSize &)const |
| | CCoeControl::TextDrawer(TInt)const |
| | CCoeControl::UniqueHandle()const |
| | CCoeControl::Window()const |
| | CCoeControl::WriteInternalStateNowL(RWriteStream &)const |
| | CCoeControl::ZoomWithType()const |
| | CCoeControl::operator=(const CCoeControl &) |
| | CCoeControl::~CCoeControl() |
| | CEikBorderedControl::Border()const |
| | CEikBorderedControl::CEikBorderedControl() |
| | CEikBorderedControl::CEikBorderedControl(const TGulBorder &) |
| | CEikBorderedControl::HasBorder()const |
| | CEikBorderedControl::SetAdjacent(TInt) |
| | CEikBorderedControl::SetBorder(TGulBorder::TBorderType) |
| | CEikBorderedControl::SetBorder(TInt) |
Constructor & Destructor Documentation
CEikProgressInfo()
| IMPORT_C | CEikProgressInfo | ( | ) | |
CEikProgressInfo(const SInfo &)
| IMPORT_C | CEikProgressInfo | ( | const SInfo & | aProgInfo | ) | |
Constructs a progress information control using the information held in the specified SInfo struct. Uses default layout values.
Parameters
| const SInfo & aProgInfo | Holds information about the type of progress information control. |
~CEikProgressInfo()
| IMPORT_C | ~CEikProgressInfo | ( | ) | |
Member Functions Documentation
ActivateL()
| IMPORT_C void | ActivateL | ( | ) | [virtual] |
From CCoeControl.
Activates the progress information control.
CheckSizeCalculated()
| void | CheckSizeCalculated | ( | ) | [private] |
ConstructFromResourceL(TResourceReader &)
From CCoeControl.
Constructs a progress information control from a PROGRESSINFO resource. Uses default layout values.
ConstructL()
| IMPORT_C void | ConstructL | ( | ) | |
By default Symbian 2nd phase constructor is private.
CurrentValue()
|
TInt
| CurrentValue | ( | ) | const [inline] |
Gets the current value, indicating how far the operation has progressed.
DeleteBitmaps()
| void | DeleteBitmaps | ( | ) | [private] |
Draw(const TRect &)
| IMPORT_C void | Draw | ( | const TRect & | aRect | ) | const [private, virtual] |
Parameters
| const TRect & aRect | Not used. |
DrawPartial()
| void | DrawPartial | ( | ) | const [private] |
DrawProgressBarBackground(CWindowGc &)
| void | DrawProgressBarBackground | ( | CWindowGc & | aGc | ) | const [private] |
DrawProgressBarForeground(CWindowGc &)
| void | DrawProgressBarForeground | ( | CWindowGc & | aGc | ) | const [private] |
EvaluateText(TDes &)
| IMPORT_C const TDesC * | EvaluateText | ( | TDes & | aTextBuf | ) | const [protected, virtual] |
Evaluates the progress text.
Parameters
| TDes & aTextBuf | On return, the evaluted text. This is the same as the return value. |
ExtensionInterface(TUid)
| IMPORT_C void * | ExtensionInterface | ( | TUid | aInterface | ) | [private, virtual] |
FilledWidth()
|
TInt
| FilledWidth | ( | ) | const [private] |
GetColorUseListL(CArrayFix< TCoeColorUse > &)
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.
HandlePointerEventL(const TPointerEvent &)
| 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().
Parameters
| const TPointerEvent & aPointerEvent | The pointer event. |
HandleResourceChange(TInt)
| 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.
Parameters
| TInt aType | A message UID value. |
IncrementAndDraw(TInt)
| 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.
Parameters
| TInt aInc | The increment to add to the current progress value. |
Info()
| const SInfo & | Info | ( | ) | const [inline] |
Gets a pointer to the information used to define the progress information control's type.
Layout()
| const SLayout & | Layout | ( | ) | const [inline] |
Gets a pointer to the colours and layout of the progress information control.
LoadBitmapsL()
| void | LoadBitmapsL | ( | ) | [private] |
MinimumSize()
| IMPORT_C TSize | MinimumSize | ( | ) | [virtual] |
From CCoeControl.
Gets the minimum size required to draw the control.
Reserved_2()
| IMPORT_C void | Reserved_2 | ( | ) | [private, virtual] |
SetAndDraw(TInt)
| 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.
Parameters
| TInt aValue | The new progress value. |
SetBitmapSizes()
| void | SetBitmapSizes | ( | ) | [private] |
SetBorder(const TGulBorder &)
Sets the control's border.
SetFinalValue(TInt)
| IMPORT_C void | SetFinalValue | ( | TInt | aFinalValue | ) | |
Sets the final value for the progress information control. This value indicates the operation being monitored is complete.
Parameters
| TInt aFinalValue | The final value for the progress information control. If this is specified as zero, the value is set to one. |
SetLayout(const SLayout &)
| IMPORT_C void | SetLayout | ( | const SLayout & | aLayout | ) | |
Sets the layout for the control.
Parameters
| const SLayout & aLayout | The layout for the control. |
SizeChanged()
| IMPORT_C void | SizeChanged | ( | ) | [virtual] |
From CCoeControl.
Recalculates the control's size in response to a size change.
WriteInternalStateL(RWriteStream &)
| 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.
- Since
- App-Framework_6.1
Writes the internal state of the control and its components to aStream. Does nothing in release mode. Designed to be overidden and base called by subclasses.
Parameters
| RWriteStream & aWriteStream | The internal state of the control and its components. |
Member Data Documentation
CFbsBitmap * iBackgroundBitmap
TInt
iCurrentValue
|
TInt
| iCurrentValue | [private] |
CEikProgressInfoExtension * iExtension
| CEikProgressInfoExtension * | iExtension | [private] |
TBool
iHeightWasSupplied
|
TBool
| iHeightWasSupplied | [private] |
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.