akntitle.h

00001 /*
00002 * ============================================================================
00003 *  Name        : akntitle.h
00004 *  Part of     : UI Framework Core / AVKON
00005 *  Description : A default control in the status pane's title pane.
00006 *  Version     : %version: tr1s60#31 %
00007 *
00008 *  Copyright © 2002-2008 Nokia.  All rights reserved.
00009 *  This material, including documentation and any related computer
00010 *  programs, is protected by copyright controlled by Nokia.  All
00011 *  rights are reserved.  Copying, including reproducing, storing,
00012 *  adapting or translating, any or all of this material requires the
00013 *  prior written consent of Nokia.  This material also contains
00014 *  confidential information which may not be disclosed to others
00015 *  without the prior written consent of Nokia.
00016 * ============================================================================
00017 */
00019 #ifndef C_AKNTITLE_H
00020 #define C_AKNTITLE_H
00021 
00022 #include <akncontrol.h>
00023 #include <coeccntx.h>
00025 class CEikLabel;
00026 class CEikImage;
00027 class CAknTitlePaneExtension;
00028 class CAknTitlePaneLabel;
00029 class MAknTitlePaneObserver;
00030 class TAknTextLineLayout;
00037 class CAknTitlePane : public CAknControl, public MCoeControlContext
00038         {
00039 public:
00043     IMPORT_C CAknTitlePane();
00048     IMPORT_C ~CAknTitlePane();
00053     IMPORT_C void ConstructL();
00059     IMPORT_C void ConstructFromResourceL( TResourceReader& aReader );
00068     IMPORT_C void SetTextL( const TDesC& aText );
00075     IMPORT_C void SetText( HBufC* aText );
00091     IMPORT_C void SetTextL( const TDesC& aText, TBool aScroll );    
00104     IMPORT_C void SetText( HBufC* aText, TBool aScroll );
00112     inline const TDesC* Text() const;
00123     IMPORT_C void SetPicture( const CFbsBitmap* aBitmap,
00124                               const CFbsBitmap* aMaskBitmap = NULL );
00133     IMPORT_C void SetPictureFromFileL( const TDesC& aFileName,
00134                                        TInt aMainId,
00135                                        TInt aMaskId = -1 );
00151     IMPORT_C void SetSmallPicture( const CFbsBitmap* aBitmap,
00152                                    const CFbsBitmap* aMaskBitmap,
00153                                    TBool aVisible );
00160     IMPORT_C void SetFromResourceL( TResourceReader& aReader );
00166     IMPORT_C void SetTextToDefaultL();
00181     IMPORT_C TInt MaxNumberOfVisibleTextRows() const;
00192     IMPORT_C void SetNumberOfVisibleTextRows( TInt aRows );
00194 public: // From base class @c MCoeControlContext.
00201     IMPORT_C virtual void PrepareContext( CWindowGc& aGc ) const;
00203 protected: // From base class @c CCoeControl.
00208     IMPORT_C virtual void SizeChanged();
00213     IMPORT_C virtual void PositionChanged();
00221     IMPORT_C virtual void HandleResourceChange( TInt aType );
00228     IMPORT_C virtual TInt CountComponentControls() const;
00237     IMPORT_C virtual CCoeControl* ComponentControl(TInt aIndex) const;
00239 public: // From base class @c CCoeControl.
00246     IMPORT_C void HandlePointerEventL( const TPointerEvent& aPointerEvent );
00248 public: // New methods
00255     IMPORT_C void SetTitlePaneObserver( MAknTitlePaneObserver* aObserver );
00257 private: // From base class @c CAknControl.
00259     IMPORT_C void* ExtensionInterface( TUid aInterface );
00261 public:
CEikLabel* TextLabel();
CEikImage* TitleImage();
00275 private:
00277     void CommonConstructL();
00278     TUid AppUid();
00280     TInt FormatTitlePaneLabelL( const TInt aOneLineLayoutWidth,
00281                                 const TInt aTwoLineLayoutWidth,
00282                                 const CFont* aOneLineFont,
00283                                 const CFont* aTwoLineFont );
00285     void ReadFromResourceFileL( TResourceReader& aReader );
00286     void SetSmallPictureFromFileL( const TDesC& aFileName, TInt aMainId, TInt aMaskId = -1 );
00288 private: // From base class @c CCoeControl.
00290     IMPORT_C virtual void Draw( const TRect& aRect ) const;
00292 protected:
00294     MAknTitlePaneObserver* iTitlePaneObserver;
00296 private:
00297     void SizeChangedInNormalStatusPane();
00298     void SizeChangedInExtendedStatusPane();
00299     void SizeChangedInFlatStatusPane();
00300     void SizeChangedInStaconPane();
00301     RWindow* StatuspaneContainerWindow() const;
00302     void SetupTitleLabelEffectL();
00303     void SetContainerWindowNonFading( TBool aNonFading );
00305     void SetupStaconPaneScrollEffectL();
00306     void SetupFlatStatusPaneScrollEffectL();
00307     void SetupNormalStatusPaneScrollEffectL();
00308     void SetupFlatStatusPaneFadeEffectL();
00309     void SetupExtendedStatusPaneScrollEffectL();
00310     void SetupNoEffectL();
00312     TBool TextFits( TAknTextLineLayout& aTextLayout );
00314 private: // Member data
00316     HBufC*                  iTitleText;
00317     HBufC*                  iDefaultTitleText;
00318     CAknTitlePaneLabel*     iTitleLabel;
00319     TBool                   iImageShown;
00320     CAknTitlePaneExtension* iExtension;
00321     };
00323 inline const TDesC* CAknTitlePane::Text() const
00324     {
00325     return( iTitleText );
00326     }
00328 #endif // C_AKNTITLE_H