eikcba.h

00001 /*
00002 * ============================================================================
00003 *  Name        : eikcba.h
00004 *  Part of     : UI Framework Core / EIKON Concrete Controls
00005 *  Description : EIKON control button array and cba button class definitions.
00006 *  Version     : %version: 29.1.2 %
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 * Template version: 4.1
00018 */
00020 #ifndef __EIKCBA_H__
00021 #define __EIKCBA_H__
00022 
00023 #include <eikctgrp.h>
00024 #include <badesca.h>
00025 #include <eikbtgrp.h>
00026 #include <eiksbobs.h>
00027 #include <eiksbfrm.h>
00029 #include <eikimage.h>
00030 #include <akncontrol.h>
00031 #include <aknsitemdata.h> // TAknsItemID
00032 #include <babitflags.h>   // TBitFlags
00034 class CEikLabel;
00035 class CEikCbaButton;
00036 class CCoeBrushAndPenContext;
00037 class MEikCommandObserver;
00038 class TCoeColorUse;
00040 class CAknScrollBar;
00041 class TEikScrollBarModel;
00043 class CEikEnhancedCbaButton;
00044 class CEikCommandTable;
00046 class CAknsBasicBackgroundControlContext;
00047 class CAknsLayeredBackgroundControlContext;
00048 class CAknsMaskedLayerBackgroundControlContext;
00049 class CEikCbaExtension;
00051 const TInt KMaxCbaLabelLength = 32;
00052 const TInt KMaxButtonsInCommandTable = 4;
00061 NONSHARABLE_CLASS(CEikCba) :
00062     public CEikControlGroup, 
00063     public MEikEnhancedButtonGroup, 
00064     public MEikScrollBarObserver,
00065     public MCoeControlObserver
00066     {
00067 public: 
00072     DECLARE_TYPE_ID(0x101F4105)
00083     static CEikCba* NewL(
00084         const CEikCba* aPrevious, 
00085         MEikCommandObserver* aCommandObserver, 
00086         RWindowGroup* aParentWg);
00098     static CEikCba* NewL(
00099         TInt aResourceId,
00100         const CEikCba* aPrevious,
00101         MEikCommandObserver* aCommandObserver,
00102         RWindowGroup* aParentWg);
00113     static CEikCba* NewLC(
00114         const CEikCba* aPrevious,
00115         MEikCommandObserver* aCommandObserver,
00116         RWindowGroup* aParentWg);
00128     static CEikCba* NewLC(
00129         TInt aResourceId,
00130         const CEikCba* aPrevious,
00131         MEikCommandObserver* aCommandObserver,
00132         RWindowGroup* aParentWg);
00137     ~CEikCba();
00139 public: // new methods
00146     TInt MaxCommands() const;
00156     void UpdateCbaLabels(TBool aScrollerOn);
00164     TInt MSKEnabledInPlatform() const;
00172     void SetSBFrameObserver(MEikScrollBarObserver* aObserver);
00180     void SetScrollBarModelL(TEikScrollBarModel* aModel);
00188     const CEikCbaScrollBarFrame* ScrollBarFrame() const;
CAknScrollBar* VScrollBarAsControl();
00203     void CreateArrowHeadScrollBarL(); 
00205 public:
00214     void InsertControlL(TEikGroupControl& aGroupControl, TInt aIndex);
00227     void SetCommandL(
00228         TInt aPosition,
00229         TInt aCommandId,
00230         const TDesC* aText,
00231         const CFbsBitmap* aBitmap,
00232         const CFbsBitmap* aMask);
00245     void SetCommandL(TInt aPosition, TInt aResourceId);
00256     void SetCommandSetL(TInt aResourceId);
00271     void AddCommandL(
00272         TInt aPosition,
00273         TInt aCommandId,
00274         const TDesC* aText,
00275         const CFbsBitmap* aBitmap,
00276         const CFbsBitmap* aMask);
00291     void AddCommandToStackL(
00292         TInt aPosition,
00293         TInt aCommandId,
00294         const TDesC* aText,
00295         const CFbsBitmap* aBitmap,
00296         const CFbsBitmap* aMask);
00308     void AddCommandToStackL(TInt aPosition, TInt aResourceId);
00320     void AddCommandSetToStackL(TInt aResourceId);
00330     void SetDefaultCommand(TInt aCommandId);
00343     TSize CalcMinimumSizeL(TInt aResourceId);
00357     void RemoveCommandFromStack(TInt aPosition, TInt aCommandId);
00368     TInt CommandPos(TInt aCommandId) const;
00379     void DimCommand(TInt aCommandId, TBool aDimmed);
00391     TBool IsCommandDimmed(TInt aCommandId) const;
00404     void MakeCommandVisible(TInt aCommandId, TBool aVisible);
00416     TBool IsCommandVisible(TInt aCommandId) const;
00426     void AnimateCommand(TInt aCommandId);
00436     CCoeControl* AsControl();
00446     const CCoeControl* AsControl() const;
00457     void SetBoundingRect(const TRect& aBoundingRect);
00469     void ReduceRect(TRect& aBoundingRect) const;
00479     CCoeControl* GroupControlById(TInt aCommandId);
00490     CCoeControl* GroupControlById(TInt aCommandId) const;
00501     TInt CommandId(TInt aCommandPos) const;
00511     TInt ButtonCount() const;
00520     void RemovePreviousCommand(TInt aPosition);
CEikCommandButton* GroupControlAsButton(TInt aCommandId) const;
00542     TUint ButtonGroupFlags() const;
00551     IMPORT_C void SetButtonGroupFlags(TInt aFlags);
00564     IMPORT_C void SetSkinBackgroundId(const TAknsItemID& aIID);
00573     void SetMSKIconL();
00584     void SetMSKCommandObserver(MEikCommandObserver* aCommandObserver);
00595     void DimCommandByPosition(TInt aPosition, TBool aDimmed);
00606     TBool IsCommandDimmedByPosition(TInt aPosition) const;
00617     void MakeCommandVisibleByPosition(TInt aPosition, TBool aVisible);
00628     TBool IsCommandVisibleByPosition(TInt aPosition) const;
00638     void AnimateCommandByPosition(TInt aPosition);
00648 //    CCoeControl* GroupControlByPosition(TInt aPosition) const;
00667     TRect ButtonRectByPosition( TInt aPosition,
00668                                 TBool aRelativeToScreen );
00678     void EnablePostingTransparency( TBool aEnable );
00680 public:
00684     virtual void Reserved_MtsmPosition();
00689     virtual void Reserved_MtsmObject();
00691 public: // from CCoeControl
00700     TKeyResponse OfferKeyEventL(const TKeyEvent& aKeyEvent,TEventCode aType);
00708     TSize MinimumSize();
00717     void GetColorUseListL(CArrayFix<TCoeColorUse>& aColorUseList) const;
00725     void HandleResourceChange(TInt aType);
00733     void MakeVisible(TBool aVisible);
00741     void HandlePointerEventL(const TPointerEvent& aPointerEvent);
00749     void SetContainerWindowL( const CCoeControl& aContainer );
00751     void ActivateL();
00753 public: // from MEikEnhancedButtonGroup
00760     IMPORT_C void OfferCommandListL(const RArray<TInt>& aCommandList);
00768     IMPORT_C void OfferCommandListL(const TInt aResourceId);
00777     IMPORT_C TBool IsCommandInGroup(const TInt aCommandId) const;
00786     IMPORT_C void ReplaceCommand(const TInt aCommandId, const TInt aResourceId);
00788 public: // From MCoeControlObserver
00789     void HandleControlEventL( CCoeControl* aControl, TCoeEvent aEventType );
00791 private:
00795     IMPORT_C void* ExtensionInterface( TUid aInterface );
00797 protected:
00807     virtual void HandleScrollEventL(CEikScrollBar* aScrollBar, TEikScrollEvent aEventType);
00819     TTypeUid::Ptr MopSupplyObject(TTypeUid aId);
00827     void Draw(const TRect& aRect) const;
00829 public:
00842     IMPORT_C TBool IsEmpty() const;
00844 private: // new methods
CEikCba(
00846         const CEikCba* aPrevious, 
00847         MEikCommandObserver* aCommandObserver, 
00848         RWindowGroup* aParentWg);
00850     void BaseConstructL();
00851     void ConstructL(TInt aResourceId);
00852     void ConstructFromResourceL(TResourceReader& aReader);
00853     CCoeControl* ButtonById( TInt aCommandId ) const;
00854     void CreateScrollBarFrameL();
00855     void InsertScrollBarL();
TEikGroupControl VScrollBarAsGroupControl();
00857     void CheckSkinAndUpdateContext();
00859     TInt AknLayoutFlags() const;
00860     void SizeChangedInControlPane();
00861     void SizeChangedInStaconPane();
00862     void SizeChangedInRightPane();
00863     void UpdateFonts();
00865     void DoSkinChange();
00866     void DoColorChange();
00867     void DoLayoutChange();
00869     void SizeChangedInsideDialog();
00878     void LayoutControl(CCoeControl* aControl, const TRect& aRect);        
00880     void DoSetLayers( const TAknsItemID& aIID );
00886     void BroadcastPostingTransparency( TBool aEnable );
00891     void SetFadeState();
00893 private: // from CCoeControl
00894     void SizeChanged();
00896 private: // data
00897     TUint                   iCbaFlags;
00900     const CEikCba*          iLink; 
00902     CCoeBrushAndPenContext* iBrushAndPenContext;
00903     MEikCommandObserver*    iCommandObserver;
CEikCbaScrollBarFrame*  iSBFrame;
00905     RWindowGroup*           iParentWg;
CEikCommandTable*   iCommandTable;
00911     TBool iMSKset;
00914     TBool iMSKEnabledInPlatform;
00917     MEikCommandObserver* iMSKCommandObserver;
00919     // From extension.
00920     const CFont* iLabelFont;
00921     const CFont* iStaconLabelFont;
00922     const CFont* iRightPaneLabelFont;
00923     TBool iPopupVisible;
00924     TBitFlags iFlags;
CAknsBasicBackgroundControlContext* iBgContext;
CAknsLayeredBackgroundControlContext* iStaconBgContext;
00933     CAknsMaskedLayerBackgroundControlContext* iMLBgContext;
00934     CAknsMaskedLayerBackgroundControlContext* iStaconBgContextTop;
00935     CAknsMaskedLayerBackgroundControlContext* iStaconBgContextBottom;
TAknsItemID iBgIID;
00940     CPeriodic* iTimer;
TAknsItemID iClockIndicBgIID;
00947     TBool       iIsClockIndicBgIIDSet;
00949     CEikCbaExtension* iExtension;
00950     };
00959 class CEikCbaButton : public CAknControl
00960     {
00961 public:
00965     struct SButtonOptions
00966         {
00967         TInt iCommandId;
00968         TBool iDimmed;
00969         };
00970 public:
~CEikCbaButton();
00981     void ConstructL(TGulAlignmentValue aAlignment);
00982 public:
00988     void AddCommandL(const TDesC& aText);
00996     void PushCommandL(TInt aCommandId, const TDesC& aText);
01003     TInt PopCommand();
01010     void RemoveCommand(TInt aCommandId);
01015     void RemovePreviousCommand();
01022     void SwitchToShortTextL(TBool aShortText);
01029     void SetLabelFont(const CFont* aLabelFont);
01034     void TruncateLabelText();
01039     TBool IsEmptyText() const;
01041 public:
01048     void SetContainerWindowL(const CCoeControl& aContainer);
01056     void ConstructFromResourceL(TResourceReader& aReader, TGulAlignmentValue anAlignment);
01064     TSize MinimumSize();
01072     void SetDimmed(TBool aDimmed);
01080     IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);
01082 public:
01088     void SetImage(CEikImage &aImage);
01093     void ReplaceImageByLabel();
01100     inline TBool IsImageOn() const {return iDoImage;};
01105     void ConstructEmptyButtonL();
01107 protected:
01114     TInt IndexFromCommandId(TInt aCommandId);
01121     void UpdateLabelText(TPtrC aLabelText);
01123 private: 
01130     TInt CountComponentControls() const;
01139     CCoeControl* ComponentControl(TInt aIndex) const;
01145     void SizeChanged();
01150     IMPORT_C void* ExtensionInterface( TUid aInterface );
01152 public: // new functions
01159     TBool PressedDown() const;
01169     void SetPressedDown( const TBool aPressedDown );
01179     void SetTextBitmapMode( TBool aEnableBitmap );
01191     void DrawToContext(
01192         CBitmapContext& aContext,
01193         CBitmapContext& aMaskContext,
01194         const TPoint& aOffset ) const;
01201     inline TPtrC GetFullLabelText() { return iFullLabelText;}
01203 private:    
01204     void PrepareImageL();
01206 protected:
01207     TBuf<KMaxCbaLabelLength> iFullLabelText;
01208     TPtrC iLongLabelText;
01209     TPtrC iShortLabelText;
01210     CEikLabel* iLabel;
01211     CDesCArray* iText;
01212     CArrayFix<SButtonOptions>* iButtonOptions;
01213     CEikImage* iImage;
01215     const CFbsBitmap* iMask;
01217     CFbsBitmap* iSfeMask;
01218     TBool iDoImage;
01220     TBool iUseTextBitmap;
01222     TBool iPressedDown;
01223     };
01231 class CEikEnhancedCbaButton : public CEikCbaButton
01232     {
01233 public:
CEikEnhancedCbaButton();
~CEikEnhancedCbaButton();
01249     TInt CommandType() const;
01256     void SetCommandType(const TInt aCommandType);
01263     TInt CommandId() const; 
01270     void ConstructFromResourceL(TResourceReader& aReader);
01275     void ConstructEmptyButtonL();
01282     TPtrC* LabelText();
01284 private: // data
01285     TInt iCommandType; 
01286     TInt iCommandId;
01287     };
01297 NONSHARABLE_CLASS(CEikCommandTable) : public CBase
01298     {
01299 public:
01305     static CEikCommandTable* NewL();
01312     static CEikCommandTable* NewLC();
01317     ~CEikCommandTable();    
01325     TInt AddCommandL(CEikEnhancedCbaButton* aButton);
01333     TBool IsCommandPlaced(const TInt aCommandId) const;
01342     void ReplaceCommandL(const TInt aCommandId, const TInt aResourceId);
CEikEnhancedCbaButton* Command(const TInt aCommandIndex);
01355     void Reset();
01357 private: // member functions
01361     CEikCommandTable();
01366     void ConstructL();
01368 private: // data
01370     TFixedArray<CEikEnhancedCbaButton*, KMaxButtonsInCommandTable> iCommandButtons;
01373     RArray< RArray<TInt> > iPriorities; 
01374     };
01376 #endif // __EIKCBA_H__