AknIndicatorContainer.h

00001 /*
00002 * ============================================================================
00003 *  Name        : AknIndicatorContainer.h
00004 *  Part of     : UI Framework Core / AVKON
00005 *  Description : A default control in the status pane's small indicator pane.
00006 *                Editor indicators uses also same control in the navigation
00007 *                pane and in queries.
00008 *  Version     : %version: be1s60pr#33.1.3.1.1 %
00009 *
00010 *  Copyright ?2002-2008 Nokia.  All rights reserved.
00011 *  This material, including documentation and any related computer
00012 *  programs, is protected by copyright controlled by Nokia.  All
00013 *  rights are reserved.  Copying, including reproducing, storing,
00014 *  adapting or translating, any or all of this material requires the
00015 *  prior written consent of Nokia.  This material also contains
00016 *  confidential information which may not be disclosed to others
00017 *  without the prior written consent of Nokia.
00018 * ============================================================================
00019 */
00021 #ifndef AKNINDICATORCONTAINER_H
00022 #define AKNINDICATORCONTAINER_H
00023 
00024 //  INCLUDES
00025 #include <akncontrol.h>
00026 #include <eikspane.h>
00028 class CIncallStatusBubble;
00029 class CAknIndicator;
00030 class CAknIndicatorContainerExtension;
00031 class CAknPictographInterface;
00032 class MAknIndicatorObserver;
00039 class CAknIndicatorContainer : public CAknControl, public MEikStatusPaneObserver
00040         {
00041 friend class CAknIndicatorContainerExtension;
00042 friend class CAknIndicatorDataObserver;
00043 public:
00050     enum TLayoutOrientation
00051         {
EVertical,  
00053         EHorizontal 
00054         };
00057     enum TIndicatorAlignment
00058         {
ELeft,   
00060         ERight   
00061         };
00068     enum TIndicatorContext
00069         {
EUniversalIndicators = 0,   
ENaviPaneEditorIndicators,  
EQueryEditorIndicators,     
00073         EFindIndicators             
00074         };
00081     enum TIndicatorPosition
00082         {
ELeftSide,  
ERightSide, 
00085         EMiddle     
00086         };
00089     enum TCustomIndicatorFlags
00090         {
EMultiColorIndicator       = 0x1, 
00092         EIndicatorPositionInverted = 0x2  
00093         };
00096     enum TLayoutMode
00097                 {
ELayoutModeUsual, 
00099                 ELayoutModeWide   
00100                 };
00102 public:
00108     IMPORT_C CAknIndicatorContainer();
00116     IMPORT_C CAknIndicatorContainer( TInt aIndicatorContext );
00121     IMPORT_C ~CAknIndicatorContainer();
00126     IMPORT_C void ConstructL();
00143     IMPORT_C void SetIndicatorState( TUid aIndicatorId,
00144                                      TInt aState,
00145                                      TBool aDrawNow = ETrue );
00153     IMPORT_C TInt IndicatorState( TUid aIndicatorId );
00162     IMPORT_C void SetIndicatorValueL( TUid aIndicatorId, const TDesC& aString );
00170     IMPORT_C void SetIncallBubbleFlags( const TInt& aFlags );
00177     IMPORT_C void ConstructFromResourceL( TResourceReader& aReader );
00184     IMPORT_C TInt IndicatorContext() const;
00187 public: // From base class @c MEikStatusPaneObserver.
00195     IMPORT_C void HandleStatusPaneSizeChange();
00197 public: // From base class @c CCoeControl.
00204     IMPORT_C void HandlePointerEventL( const TPointerEvent& aPointerEvent );
00206 protected: // From base class @c CCoeControl.
00215         IMPORT_C virtual void HandleResourceChange( TInt aType );
00220     IMPORT_C virtual void SizeChanged();
00225     IMPORT_C virtual void PositionChanged();
00232     IMPORT_C virtual TInt CountComponentControls() const;
00240     IMPORT_C virtual CCoeControl* ComponentControl( TInt aIndex ) const;
00242 private: // From base class @c CCoeControl.
00244     IMPORT_C virtual void Draw(const TRect& aRect) const;
00246 private: // From base class @c CAknControl.
00248     IMPORT_C void* ExtensionInterface( TUid aInterface );
00250 private:
00252     virtual void Reserved_1();
00253     void PrioritizeIndicatorsL();
00255         static TInt TickerCallback( TAny* aThis );
00256     TInt DoTick();
00258     void IncallBubbleSizeChanged( TBool aAllowIdleStateBubble );
00260     void SizeChangedInSmallStatusPane();
00262     void SizeChangedInNormalStatusPane();
00264     void SizeChangedInStaconPane();
00266     void SizeChangedInFlatStatusPane();
00268     void SizeChangedInExtendedStatusPane();
00270     void SizeChangedInIdleExtendedStatusPane();
00272         void SizeChangedInIdleVertical();
00274     void SetContainerWindowNonFading( TBool aNonFading );
00276     void SetupIndicatorLayoutModes();
00278     TInt SelectIndicatorLayoutMode();
00280         void CreateIndicatorFromPaneResourceL( TUid aUid,
00281                                                TInt aIndicatorPaneResourceId,
00282                                                TInt aCustomIndicatorFlags );
00284         TBool IndicatorExists( TUid aUid ) const;
00286         void CreateIncallBubbleL();
00288         TBool UpdateSmallLayoutL();
00290         void SetIncallBubbleDisabled( TBool aDisabled );
00292         void ResetAnimTicker( TBool bForeground );
00294 public:
00307     IMPORT_C void SetIndicatorValue( TUid aIndicatorId,
00308                                      TInt aValue,
00309                                      TInt aMaxValue );
00314     void DrawPictographArea();
CAknPictographInterface* PictographInterface() const;
00335     IMPORT_C void SetIncallBubbleAllowedInIdle( TBool aAllowed );
00347     IMPORT_C void SetIncallBubbleAllowedInUsual( TBool aAllowed );
00356     IMPORT_C void SetIndicatorObserver( MAknIndicatorObserver* aIndicatorObserver,
00357                                         TUid aIndicatorUid );
00388         IMPORT_C TUid CreateIndicatorFromResourceL( TInt aIndicatorResourceId,
00389                                                     TInt aCustomIndicatorFlags );
00411         IMPORT_C void ReplaceIndicatorIconL( TUid aIndicator,
00412                                              TInt aState,
00413                                              TInt aLayoutMode,
00414                                              CFbsBitmap* aIconBitmap,
00415                                              CFbsBitmap* aIconMask,
00416                                              TInt aIconIndex = 0 );
00418 private:
00421         typedef CArrayPtrFlat<CAknIndicator> CAknIndicatorQueue;
00422     CAknIndicatorQueue* iIndicators;
TLayoutOrientation iLayoutOrientation;
TLayoutOrientation iPreviousLayoutOrientation;
TIndicatorAlignment iAlignment;
00432     TInt iIndicatorsShown;
00435     TInt iAnimatedIndicatorsShown;
CAknIndicatorContainerExtension* iExtension;
00441     TInt iIndicatorContext;
00444         CPeriodic* iTicker;
00447     TBool iSpare2;
00450     TInt iSynchronizingValue;
00453     CIncallStatusBubble* iIncallBubble;
00454     };
00456 #endif // AKNINDICATORCONTAINER_H
00457 
00458 // End of File