aknnotecontrol.h

00001 /*
00002 * ============================================================================
00003 *  Name     : AknNoteControl.h
00004 *  Part of  : Avkon
00005 *
00006 *  Description:
00007 * 
00008 *  Version:
00009 *
00010 *  Copyright ?2002 Nokia Corporation.
00011 *  This material, including documentation and any related 
00012 *  computer programs, is protected by copyright controlled by 
00013 *  Nokia Corporation. All rights are reserved. Copying, 
00014 *  including reproducing, storing,  adapting or translating, any 
00015 *  or all of this material requires the prior written consent of 
00016 *  Nokia Corporation. This material also contains confidential 
00017 *  information which may not be disclosed to others without the 
00018 *  prior written consent of Nokia Corporation.
00019 * ============================================================================
00020 */
00023 #ifndef AKNNOTECONTROL_H
00024 #define AKNNOTECONTROL_H
00025 
00026 // INCLUDES
00027 #include <AknControl.h>
00028 #include <aknutils.h>
00030 #include <aknprogresstimer.h>
00031 #include <aknbitmapanimation.h>
00033 // FORWARD DECLARATIONS
00034 class CEikImage;
00035 class CEikLabel;
00036 class CEikProgressInfo;
00037 class CAknNoteAttributes;
00038 class CAknTextControl;
00039 class TAknWindowLineLayout;
00041 // CLASS DECLARATION
00052 class CAknNoteControl : public CAknControl 
00053 {
00054 friend class CAknNoteAttributes;
00056 public: 
00061         IMPORT_C CAknNoteControl();
00066         IMPORT_C virtual ~CAknNoteControl();
00073         void ConstructFromResourceL(TResourceReader& aRes);
00075 public:
00087     IMPORT_C void SetImageL(CEikImage* aImage);
00098         IMPORT_C void SetAnimationL(TInt aResource);
00109     IMPORT_C void SetIconL(CEikImage* aIcon);
00118         IMPORT_C void SetFinalProgressValue(TInt aValue);
00128         IMPORT_C TInt IncrementBarsAndDraw(TInt aIncrement);
00135         IMPORT_C void CreateProgressBarL();
00144         IMPORT_C CEikProgressInfo* GetProgressInfo();
00151         IMPORT_C void StartAnimationL();
00162         IMPORT_C TInt CancelAnimation();
00172         IMPORT_C void ResetText();
00181         IMPORT_C void SetTextL(const TDesC& aText);
00201         IMPORT_C void SetTextL(const TDesC& aText,TInt aLineNum);
00216         IMPORT_C void SetTextNumberL(const TInt aNumber);
00233         IMPORT_C void SetTextPluralityL(const TBool aIsPlural);
00240         IMPORT_C TInt NumberOfLines() const;
00242 public:
00259         IMPORT_C void Layout();
00267         void WindowLayout( TAknWindowLineLayout& aLayout ) const;
00277         IMPORT_C TInt NoteHeight() const;
00288         IMPORT_C TInt NoteWidth() const;
00290 public: //Interface to CAknNoteDialog 
00296         TSize MinimumSize();
CAknNoteAttributes* Attributes() const;
00309         void Reset();
00314         void CreateDefaultImageL();
00316 public:
00317         IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);
00319 public:
00329                 class TIndex 
00330                 {       
00331                 public:
TIndex(TInt aNumberOfLines, 
00341                                TBool aHasNti = EFalse, 
00342                                TSize aImageSize = TSize(0,0));  
00344                 public: 
00350             TInt Lines() const; 
00352                 public: 
00363                         TInt WNPWindowTextsLine1(TInt aLineNum) const;
00374                         TInt NWIPWindowTextsLine1L(TInt aLineNum) const;
00390                         TInt NWIPWindowTextsLine1R(TInt aLineNum) const;
00401                         TInt NWIPWindowTextsLine1B(TInt aLineNum) const;
00420                         TInt NWIPWindowTextsLine1W(TInt aLineNum) const;
00428                         TInt PopupNoteWindow() const;
00438                         TInt PopupNoteWaitWindow() const;
00440                 private:        
00441                         void SelfTest() const;  
00442                         TInt ImageWidthIndex() const;
00443                         TInt ImageHeightIndex() const;
00444                         TInt HasNtiIndex() const;
00446                 private:        
00447                         TInt  iNumberOfLines;
00448                         TBool iHasNti;
00449                         TSize iImageSize;
00450                 };      
00452 private:
00453         //COECONTROL METHODS
00454         void Draw(const TRect& aRect) const;
00455         void SizeChanged();
00456         void DoLayout();
00457         TInt CountComponentControls() const;
00458         CCoeControl* ComponentControl(TInt anIndex) const;
00459 private:
00463     IMPORT_C void* ExtensionInterface( TUid aInterface );
00464 private:        
00465         //LAYOUT METHODS
00466         TInt NumberTypeIndicationIndex() const;
00467         TInt ImageWidthIndex() const;
00469         TInt AnimationIndex();
00470         void AnimationNoteLayout();
00472         //Layout for general notes
00473         void GeneralNoteLayout();
00474         void GeneralNoteLabelLayout();
00475         void GeneralNoteIconLayout();
00477         //Layout for progress and wait notes
00478         void ProgressNoteLayout();
00479         void ProgressNoteLabelLayout();
00480         void ProgressNoteProgressBarLayout();
00481         void ProgressNoteIconLayout();
00482         void ProgressNoteNumberTypeIndicationLayout();
00484         //Layout for image notes
00485         void ImageNoteLayout();
00486         void ImageNoteLabelLayout();
00487         void ImageNoteImageLayout();
00488         void ImageNoteShadowLayout();
00489         void ImageNoteNumberTypeIndicationLayout();
00491         TAknWindowLineLayout GetImageLayout(const TSize& aSize); 
00492         TAknWindowLineLayout GetImageShadowLayout(const TSize& aSize); 
00494         TRect LayoutRect() const;
00495         void SetLineWidthsL();
00498         void ReduceImageIfNeeded();
00500         void ParseTextL();
00502 private:
00503         CAknTextControl*    TextControl() const; 
CEikImage* Image() const; 
CEikImage* Icon() const; 
CEikProgressInfo* ProgressBar() const; 
CAknProgressTimer* Timer() const; 
CAknBitmapAnimation* Animation() const; 
00513         TBitFlags&  Flags() const; 
00515 private:
00516         TInt                iNoteLayout;
TAknLayoutRect      iShadowRect;
00518         TBool               iImageHasShadow;
CAknNoteAttributes*  iAttributes;
00521         CArrayFixFlat<TInt>* iLineWidths;
00523 public:
00529         IMPORT_C void SetDynamicTextL(const TDesC& aText);
00534         IMPORT_C void UpdateAndFormatLabelsL(const TDesC& aLabels);
00539         IMPORT_C void UpdateLabelsL(const TDesC& aLabel1, 
00540                                     const TDesC& aLabel2=KNullDesC, 
00541                                     const TDesC& aLabel3=KNullDesC);
00545         IMPORT_C void UpdateLabels(const TDesC& aLabel1, 
00546                                    const TDesC& aLabel2=KNullDesC, 
00547                                    const TDesC& aLabel3=KNullDesC);
00554         IMPORT_C void SetLabelReserveLengthL(TInt aLength1=0, 
00555                                              TInt aLength2=0, 
00556                                              TInt aLength3=0);
00558 protected: // from MObjectProvider
00571         IMPORT_C TTypeUid::Ptr MopSupplyObject(TTypeUid aId);
00573 public: // new methods
00583         IMPORT_C void SetBgRect(const TRect& aRect, 
00584                                 const TPoint& aPos, 
00585                                 TBool aOwnerNotDialog = EFalse);
00591         TInt NoteLayout() const;
00592         };
00594 #endif // AKNNOTECONTROL_H