eikfrlbd.h

00001 /*
00002 * ============================================================================
00003 *  Name        : Eikfrlbd.h
00004 *  Part of     : Avkon
00005 *  Description : 
00006 *  Version     : 
00007 *
00008 *  Copyright © 2002-2006 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 //
00020 // EIKFRLBD.H
00021 //
00022 // Copyright (c) 2001 Symbian Ltd.  All rights reserved.
00023 //
00024 #if !defined(__EIKFRLBD_H__)
00025 #define __EIKFRLBD_H__
00026 
00027 #include <e32base.h>
00028 #include <gdi.h>
00030 #include <eiklbd.h>
00031 #include <eikfrlb.h>
00032 #include <avkon.hrh>
00033 #include <aknsdrawutils.h> // for TAknsQsnTextColorsIndex
00034 #include <babitflags.h>    // for TBitFlags32
00036 class CWindowGc;
00037 class CGulIcon;
00038 class CFormattedCellListBoxDataExtension;
00039 class MAknsControlContext;
00040 class TAknsItemID;
00041 class CAknLayoutData;
00042 class CAknsEffectAnim;
00043 class TAknTextLineLayout;
00044 class TAknWindowLineLayout;
00045 class TAknTextComponentLayout;
00046 class TAknWindowComponentLayout;
00056 class MListBoxAnimBackgroundDrawer
00057     {
00058     public:
00063         virtual TBool DrawHighlightAnimBackground( CFbsBitGc& aGc ) const = 0;
00064     };
00090 class CFormattedCellListBoxData : public CListBoxData
00091     {
00092     friend class CFormattedCellListBoxDataExtension;
00094 public:
00096     //INNER CLASS DECLARATION
00097     /*
00098      * A container class for storage of colour values.                           
00099      * Used by @c CFormattedCellListBoxData.
00100      */
00101     class TColors
00102         {
00104     public:
00109         IMPORT_C TColors();
00111     public:
00116         TRgb iText;
00121         TRgb iBack;
00126         TRgb iHighlightedText;
00131         TRgb iHighlightedBack;
00139         TRgb iRightSeparatorColor;
00140         };
00142 public:
00149     IMPORT_C static CFormattedCellListBoxData* NewL();
00154     IMPORT_C ~CFormattedCellListBoxData();
00156 public:
00164     IMPORT_C const TColors& SubCellColors(TInt aSubCellIndex) const;
00172     IMPORT_C void SetSubCellColorsL(TInt aSubCellIndex, const TColors &aColors);
00180     IMPORT_C TInt SubCellBaselinePos(TInt aSubCellIndex) const;
00188     IMPORT_C void SetSubCellBaselinePosL(TInt aSubCellIndex, TInt aPos);
00196     IMPORT_C TSize SubCellSize(TInt aSubCellIndex) const;
00204     IMPORT_C void SetSubCellSizeL(TInt aSubCellIndex, TSize aSize);
00212     IMPORT_C TPoint SubCellPosition(TInt aSubCellIndex) const;
00220     IMPORT_C void SetSubCellPositionL(TInt aSubCellIndex, TPoint aPosition);
00229     IMPORT_C TBool SubCellIsTransparent(TInt aSubCellIndex) const;
00237     IMPORT_C void SetTransparentSubCellL(TInt aSubCellIndex, 
00238                                          TBool aIsTransparent);
00248     IMPORT_C TBool SubCellIsNotAlwaysDrawn(TInt aSubCellIndex) const;
00256     IMPORT_C void SetNotAlwaysDrawnSubCellL(TInt aSubCellIndex,
00257                                             TBool aIsNotAlwaysDrawn);
00265     IMPORT_C TMargins SubCellMargins(TInt aSubCellIndex) const;
00273     IMPORT_C void SetSubCellMarginsL(TInt aSubCellIndex, TMargins aMargins);
00281     IMPORT_C const CFont* SubCellFont(TInt aSubCellIndex) const;
00289     IMPORT_C void SetSubCellFontL(TInt aSubCellIndex, const CFont* aFont);
00297     IMPORT_C CGraphicsContext::TTextAlign SubCellAlignment(TInt aSubCellIndex)
00298         const;
00306     IMPORT_C void SetSubCellAlignmentL(TInt aSubCellIndex,
00307                                        CGraphicsContext::TTextAlign aAlign);
00317     IMPORT_C TBool SubCellIsGraphics(TInt aSubCellIndex) const;
00327     IMPORT_C void SetGraphicsSubCellL(TInt aSubCellIndex, TBool aIsGraphics);
00335     IMPORT_C CGraphicsContext::TPenStyle 
SubCellRightSeparatorStyle(TInt aColumn) const;
00345     IMPORT_C void SetSubCellRightSeparatorStyleL(TInt aSubCell,
00346                                             CGraphicsContext::TPenStyle aStyle);
00359     IMPORT_C TInt SubCellTextClipGap(TInt aSubCellIndex) const;
00368     IMPORT_C void SetSubCellTextClipGapL(TInt aSubCellIndex, TInt aGap);
00376     IMPORT_C TBool SkinEnabled() const;
00386     IMPORT_C void SetSkinEnabledL(TBool aEnabled);
00395     IMPORT_C TBool SubCellIsNumberCell(TInt aSubCellIndex) const;
00404     IMPORT_C void SetNumberCellL(TInt aSubCellIndex, TBool aIsNumberCell);
00409     IMPORT_C CArrayPtr<CGulIcon>* IconArray() const;
00423     IMPORT_C void SetIconArrayL(CArrayPtr<CGulIcon>* aArray);
00437     IMPORT_C void SetIconArray(CArrayPtr<CGulIcon>* aArray);
00446     IMPORT_C CFont* Font(const TListItemProperties& aItemProperties,
00447                          TInt aSubCellIndex) const;
00464     IMPORT_C virtual void Draw(TListItemProperties aProperties,
00465                                CWindowGc& aGc,
00466                                const TDesC* aText,
00467                                const TRect& aRect,
00468                                TBool aHighlight,
00469                                const TColors& aColors) const;
00478     IMPORT_C TBool UseSubCellColors(TInt aSubCell) const;
00487     IMPORT_C CCoeControl* Control() const;
00497     IMPORT_C void SetControl(CCoeControl* aControlOrNull);
00505     IMPORT_C MAknsControlContext* SkinBackgroundContext() const;
00513     IMPORT_C void SetBackgroundSkinStyle(const TAknsItemID *aId,
00514                                          const TRect &aRect);
00523     IMPORT_C void SetSkinStyle(const TAknsItemID* aId, const TRect& aTileRect);
00531     IMPORT_C void SetSkinParentPos(const TPoint& aPos);
00540     IMPORT_C void SetListEndSkinStyle(const TAknsItemID *listEndId,
00541                                       const TRect &aRect);
00549     IMPORT_C TBool RespectFocus() const;
00557     IMPORT_C void SetRespectFocus(TBool aBool);
00566     IMPORT_C void SetSkinHighlightFrame(const TAknsItemID* aFrameId,
00567                                         const TAknsItemID* aFrameCenterId);
00575     IMPORT_C void SetSkinPopupFrame(const TAknsItemID* aFrameId, 
00576                                     const TAknsItemID* aFrameCenterId);
00585     IMPORT_C void SetSkinPopupFramePosition(const TRect& aOuterRect,
00586                                             const TRect& aInnerRect);
00602     IMPORT_C void UseLogicalToVisualConversion( TBool aUseConversion );
00609     IMPORT_C void EnableMarqueeL(TBool aEnable);
00616 #ifdef __WINS__
00617     IMPORT_C const TBool IsMarqueeOn();
00618 #else
00619     IMPORT_C TBool IsMarqueeOn();
00620 #endif // __WINS__
00621 
00626     void FocusGained();
00633     void FocusLost();
00640     void HandleResourceChange( TInt aType );
00650     IMPORT_C const CAknsEffectAnim* HighlightAnim() const;
00657     IMPORT_C void AboutToDrawHighlightAnim() const;
00666     IMPORT_C void SetHighlightAnimBackgroundDrawer( 
MListBoxAnimBackgroundDrawer* aDrawer );
00676     IMPORT_C void SetItemCellSize( const TSize& aSize );
00683     IMPORT_C TBool HasHighlightAnim() const;
00708     IMPORT_C TBool DrawHighlightAnim( CBitmapContext& aGc, const TRect& aRect ) const;
00714     void CreatePictographInterfaceL();
00720     void CreateMarqueeControlL();
00725     void ResetMarquee();
00732     TInt CurrentMarqueeItemIndex();
00739     void SetCurrentMarqueeItemIndex(TInt aIndex);
00749     void SetCurrentItemIndex(TInt aIndex);
00751     // previous method was used both as current item index AND as currently
00752     // drawn item index. Not really good idea.
00753     void SetCurrentlyDrawnItemIndex( TInt aIndex );
00762     IMPORT_C void SetSubCellFontForRowL(TInt aRowIndex, 
00763                                         TInt aSubCellIndex, 
00764                                         const CFont* aFont);
00773     IMPORT_C const CFont* RowAndSubCellFont(TInt aRow, 
00774                                             TInt aSubCellIndex) const;
00782     IMPORT_C void SetDrawBackground(const TBool aDrawBackground);
00790     TBool IsBackgroundDrawingEnabled() const;
00798     void SetDrawScrollbarBackground(const TBool aDrawBackground);
00806     TBool IsScrollbarBackgroundDrawingEnabled() const;
00813     IMPORT_C void SetSeparatorLinePosition(TAknSeparatorLinePosition aPosition);
00820     IMPORT_C TAknSeparatorLinePosition SeparatorLinePosition() const;
00830     IMPORT_C CAknLayoutData* LayoutData() const;
00841     IMPORT_C TBool LayoutInit() const;
00852     IMPORT_C void SetLayoutInit(TBool aValue);
00863     IMPORT_C void SetSubcellUnderlined( TBitFlags32 aUnderlinedCells );
00876     void UseHighlightIconSwapping( TBool aUse );
00877     TBool UseHighlightIconSwapping() const;
00879     // next methods are only used inside the drawing algorithm.
00880     // The set methods are also const because they do not change observable behavior of the system.
00881     TSize SubCellRealSize(TInt aSubCellIndex) const;
00882     void SetSubCellRealSize(TInt aSubCellIndex, TSize aRealSize) const;
00883     //
00884     TSize SubCellRealTextSize(TInt aSubCellIndex) const;
00885     void SetSubCellRealTextSize(TInt aSubCellIndex, TSize aRealSize) const;
00888     struct SSubCell
00889         {
00890         SSubCell() { }
00891         TInt iSubCell; // Must be first entry
00893         TInt iWidth;
00894         TMargins iMargin;
00895         const CFont* iBaseFont;
00896         TInt iActualFontIndex;
00897         TBool iGraphics;
00898         TBool iTransparent;
00899         TBool iNotAlwaysDrawn;
00900         CGraphicsContext::TTextAlign iAlign;
00901         CGraphicsContext::TPenStyle iRightSeparatorStyle;
00903         TPoint iPosition;
00904         TInt iBaseline;
00905         TSize iSize;
00907         TBool iUseSubCellColors; // this is set if someone calls SetSubCellColorsL()
00908         TColors iColors;
00909         TInt iTextClipGap;
00911         TBool iNumberCell;
00912         // the next ones change during drawing algorithm
00913         __MUTABLE TSize iRealSize;
00914         __MUTABLE TSize iRealTextSize;
00915         };
00917 protected:
00922     IMPORT_C CFormattedCellListBoxData();
00928     IMPORT_C void ConstructLD();
00937     IMPORT_C void ConstructLD(const TAknsItemID& aAnimationIID);
00954     IMPORT_C void DrawFormatted(TListItemProperties aProperties,
00955                                 CWindowGc& aGc,
00956                                 const TDesC* aText,
00957                                 const TRect& aRect,
00958                                 TBool aHighlight,
00959                                 const TColors& aColors) const;
00972     void DrawFormattedSimple( TListItemProperties& aProperties,
00973                               CWindowGc& aGc,
00974                               const TDesC* aText,
00975                               const TRect& aRect,
00976                               TBool aHighlight,
00977                               const TColors& aColors ) const;
00978 private:
00982     void DrawFormattedOld( TListItemProperties& aProperties,
00983                            CWindowGc& aGc,
00984                            const TDesC* aText,
00985                            const TRect& aItemRect,
00986                            TBool aHighlight,
00987                            const TColors& aColors ) const;
00992     void BitBltColored( CWindowGc&      aGc,
00993                         TBool           aHighlight,
00994                         const CGulIcon* aIcon,
00995                         TInt            aSubcell,
00996                         TBool           aColorIcon,
00997                         const TRect&    aGraphicRect ) const;
01000 public:
01014     IMPORT_C void SetMarqueeParams(const TInt aLoops,
01015                                    const TInt aScrollAmount, 
01016                                    const TInt aScrollDelay, 
01017                                    const TInt aInterval);
01023     void SetClippedByWrap( TUint32 aClippedCells, TBool aUseClippedByWrap );
01030     IMPORT_C TUint32 CurrentItemTextWasClipped() const;
01032 protected: // non-exported!
CFormattedCellListBoxDataExtension* Extension();
CFormattedCellListBoxDataExtension* Extension() const;
01050 public:
01059     void DrawDefaultHighlight(CWindowGc &aGc,
01060                               const TRect &aItemRect,
01061                               TBool aHighlight) const;
01071     void DrawSettingHighlight(CWindowGc &aGc,
01072                               const TRect &aItemRect,
01073                               TBool aHighlight) const;
01083     void DrawPopupHighlight(CWindowGc &aGc,
01084                             const TRect &aItemRect,
01085                             TBool aHighlight) const;
01092     void DrawPopupFrame(CWindowGc &aGc) const;
01100     void SetWordWrappedSubcellIndices( TInt aFirstIndex, TInt aSecondIndex );
01109     IMPORT_C void SetSubCellIconSize(TInt aIndex, TSize aSize);
01118     TSize GetSubCellIconSize(TInt aIndex);
01126     void SetupSkinContextL();
01135     void SetESSTextColor( TAknsQsnTextColorsIndex aIndex );
01144     void SetESSHighlightedTextColor( TAknsQsnTextColorsIndex aIndex );
01153     void SetGraphicSubCellL(TInt aSubCell, const TAknWindowLineLayout& aGraphicLayout);
01164     void SetTextSubCellL(TInt aSubCell,const TAknTextLineLayout& aTextLayout);
01178     void SetConditionalSubCellL(TInt aSubCell,
01179                                 const TAknTextLineLayout& aTextLayout,
01180                                 TInt aAffectedSubCell);
01187     TBool UsesScalableLayoutData() const;
01191     void  UseScalableLayoutData( TBool aUse );
01196     void SetStretchableGraphicSubCellL(TInt aSubCell, 
01197                                        const TAknWindowComponentLayout& aNormalLayout, 
01198                                        const TAknWindowComponentLayout& aStretchedLayout);
01202     void SetStretchableTextSubCellL(TInt aSubCell,                                      
01203                                        const TAknTextComponentLayout& aNormalLayout, 
01204                                        const TAknTextComponentLayout& aStretchedLayout);
01208     void SetStretchableConditionalSubCellL(TInt aSubCell,
01209                                            const TAknTextComponentLayout& aNormalLayout,
01210                                            const TAknTextComponentLayout& aStretchedLayout,
01211                                            TInt aNormalSubCell,
01212                                            TInt aStretchedSubCell );
01216     void ResetSLSubCellArray();                                           
01221     void EnableStretching(const TBool aEnabled);
01225     TBool StretchingEnabled() const;
01229     void HideSecondRow(const TBool aHide);
01233     TBool SecondRowHidden() const;
01237     void SubCellsMightIntersect( const TBool aMightIntersect );
01239     // Drop shadows can be toggled on/off in
01240     // "transparent" lists (eg. transparent camera setting page).
01241     // ETrue = on, EFalse = off
01245     void ToggleDropShadows( const TBool aEnable );
01247     // changes tactile feedback behaviour
01248     // ETrue  - feedback for any item
01249     // EFalse - feedback for focused item only
01253     void SetFeedbackForAllItems( TBool aFeedbackForAllItems );
01254     // gets tactile feedback behaviour
01255     // ETrue  - feedback for any item
01256     // EFalse - feedback for focused item only
01260     TBool FeedbackForAllItems();
01262 private:
01263     void DoConstructL( const TAknsItemID& aAnimationIID );
01265     const TColors &Colors(TInt aItemIndex, TInt aSubCell) const;
01266     TInt LastSubCell() const;
01267     void AddSubCellL(TInt aSubCell);
SSubCell& At(TInt aArrayIndex);
01269     const SSubCell& At(TInt aArrayIndex) const;
01270     TInt FindSubCellIndex(TInt& aArrayIndex,TInt aSubCell) const;
01271     void FindSubCellIndexOrAddL(TInt& aArrayIndex,TInt aSubCell);
01272     TInt AddActualFontL(const CFont* aBaseFont);
01273     void SetUnderlineStyle( TListItemProperties aProperties, CWindowGc& aGc, TInt aSubCell ) const;
01274     void CheckIfSubCellsIntersect( TAknTextLineLayout* aLayouts, TBool* aResults, const TDesC& aText, const TRect& aItemRect ) const;
01276 private:
01277     CArrayFix<SSubCell>* iSubCellArray;
01278     CArrayPtr<CGulIcon>* iIconArray;
01279     friend class CFormattedCellListBoxItemDrawer; // this is for "lastsubcell" -access.
TColors defaultcolors;
CFormattedCellListBoxDataExtension *iExtension; 
01282     };
01284 // CLASS DECLARATION
01292 class CSettingItemEditingListBoxData : public CFormattedCellListBoxData
01293     {
01294 public:
01295     IMPORT_C static CSettingItemEditingListBoxData* NewL();
01296     IMPORT_C virtual void Draw(TListItemProperties aProperties,
01297                    CWindowGc& aGc,
01298                    const TDesC* aText,
01299                    const TRect& aRect,
01300                    TBool aHighlight,
01301                    const TColors& aColors) const;
01302     };
01304 // CLASS DECLARATION
01312 class CFormGraphicListBoxData : public CFormattedCellListBoxData
01313     {
01314 public:
01315     IMPORT_C static CFormGraphicListBoxData* NewL();
01316     IMPORT_C virtual void Draw(TListItemProperties aProperties,
01317                    CWindowGc& aGc,
01318                    const TDesC* aText,
01319                    const TRect& aRect,
01320                    TBool aHighlight,
01321                    const TColors& aColors) const;
01322     };
01325 // CLASS DECLARATION
01333 class CPopupFormattedListBoxData : public CFormattedCellListBoxData
01334     {
01335 public:
01336     IMPORT_C static CPopupFormattedListBoxData* NewL();
01337     IMPORT_C virtual void Draw(TListItemProperties aProperties,
01338                    CWindowGc& aGc,
01339                    const TDesC* aText,
01340                    const TRect& aRect,
01341                    TBool aHighlight,
01342                    const TColors& aColors) const;
01343     };
01351 class CFormattedCellGridData : public CFormattedCellListBoxData
01352     {
01354 public:
01359     IMPORT_C static CFormattedCellGridData* NewL();
01374     IMPORT_C virtual void Draw(TListItemProperties aProperties,
01375                                CWindowGc& aGc,
01376                                const TDesC* aText,
01377                                const TRect& aRect,
01378                                TBool aHighlight,
01379                                const TColors& aColors) const;
01380     };
01382 #endif  // __EIKFRLBD_H__
01383