EIKSCRLB.H

00001 // EIKSCRLB.H
00002 //
00003 // Copyright (c) 1997-2006 Symbian Ltd.  All rights reserved.
00004 //
00006 #if !defined(__EIKSCRLB_H__)
00007 #define __EIKSCRLB_H__
00008 
00009 #if !defined(__EIKBCTRL_H__)
00010 #include <eikbctrl.h>
00011 #endif
00012 
00013 #if !defined(__EIKSBOBS_H__)
00014 #include <eiksbobs.h>
00015 #endif
00016 
00017 #if !defined(__AKNSCBUT_H__)
00018 #include <aknscbut.h>
00019 #endif
00020 
00021 #include <lafpublc.h>
00023 class CEikCba;
00024 class CAknDoubleSpanScrollIndicator;
00025 class CEikScrollBarExtensionImpl;
00026 class CEikScrollBarExtension;
00027 class CAknDoubleSpanScrollBarExtension;
00029 const TInt KEikScrollEventFromVBar=0;
00030 const TInt KEikScrollEventFromHBar=0x01;
00031 const TInt KEikScrollEventBarMask=0x01;
00033 // sets all bits in EButtonsXxx range
00034 const TInt KButtonPositionMask=KLafScrollBarButtonPositionMask; 
00036 // sets all bits in determining which components exist
00037 const TInt KDisplayComponentsMask=0x1f; 
00047 class TEikScrollBarModel
00048     {
00050 public:
00056     inline TEikScrollBarModel();
00068     IMPORT_C TEikScrollBarModel(TInt aScrollSpan,
00069                                 TInt aThumbSpan=0,
00070                                 TInt aThumbPosition=0);
00080     IMPORT_C TBool operator==(const TEikScrollBarModel aModel) const;
00089     inline TBool operator!=(const TEikScrollBarModel aModel) const; 
00091 public:
00099     IMPORT_C TBool ScrollBarUseful() const;
00107     IMPORT_C TInt MaxThumbPos() const;
00113     IMPORT_C void CheckBounds();
00120     enum TEikScrollBarModelType
00121         {
EEikScrollBarModel               = 0x00000000,
EAknDoubleSpanScrollBarModel     = 0x80000000
00128         };        
TEikScrollBarModel::TEikScrollBarModelType ScrollBarModelType() const;
00136 public:
00139     TInt iScrollSpan;
00142     TInt iThumbSpan;
00145     TInt iThumbPosition;            
00146     };
00148 inline TEikScrollBarModel::TEikScrollBarModel() {}
00149 inline TBool TEikScrollBarModel::operator!=(const TEikScrollBarModel aModel) const { return !(*this==aModel); }
00152 //
00153 // TAknDoubleSpanScrollBarModel class
00154 //
00155 // This class is binary compatible with TEikScrollBarModel and can
00156 // be used in places where TEikScrollBarModel is used but few restrictions exist:
00157 //
00158 // - Base class (TEikScrollBarModel) public members must NOT be accessed directly.
00159 // - Base class (TEikScrollBarModel) public methods must NOT be called.
00160 //
00161 // If this model is not supported by the scrollbar system, then values are stored
00162 // as in the base class for compatibility resons. See ModelIsSupported()-method 
00163 // documentation for more information.
00164 //
00165 class TAknDoubleSpanScrollBarModel : public TEikScrollBarModel
00166         {
00168 public:
00173     IMPORT_C TAknDoubleSpanScrollBarModel();
00201     IMPORT_C TAknDoubleSpanScrollBarModel(const TEikScrollBarModel& aEikModel);
00227     IMPORT_C void SetScrollSpan(TInt aValue);    // Size of the scrolled list. 
00228     IMPORT_C void SetFocusPosition(TInt aValue); // Position of the current field in the list.
00229     IMPORT_C void SetWindowSize(TInt aValue);    // Size of the visible part of the list. 
00230     IMPORT_C void SetFieldSize(TInt aValue);     // Size of the current field. (Optional double span)
00231     IMPORT_C void SetFieldPosition(TInt aValue); // Position inside the current field. (Optional double span)  
00246     IMPORT_C TInt ScrollSpan() const;    // Size of the scrolled list.
00247     IMPORT_C TInt FocusPosition() const; // Position of the current field in the list.
00248     IMPORT_C TInt WindowSize() const;    // Size of the visible part of the list. 
00249     IMPORT_C TInt FieldSize() const;     // Size of the current field. (Optional double span)
00250     IMPORT_C TInt FieldPosition() const; // Position inside the current field. (Optional double span)
00271     static TBool ModelIsSupported();
00273 private:   
00281     TUint16 Scale() const;
00290     void SetScale(TUint16 aScale);    
00292 private:   
00300     TInt16 ScrollSpanValue() const;
00301     TInt16 FocusPositionValue() const;
00302     TInt16 FieldPositionValue() const;
00303     TInt16 FieldSizeValue() const;
00304     TInt16 WindowSizeValue() const;
00313     void SetScrollSpanValue(TInt16 aValue);
00314     void SetFocusPositionValue(TInt16 aValue);
00315     void SetFieldPositionValue(TInt16 aValue);
00316     void SetFieldSizeValue(TInt16 aValue);
00317     void SetWindowSizeValue(TInt16 aValue);
00326     TInt16 LowBytes(TInt aInt) const;
00335     TInt16 HighBytes(TInt aInt) const;
00345     void SetLowBytes(TInt& aInt, TInt16 aValue);
00354     void SetHighBytes(TInt& aInt, TInt16 aValue);
00365     TInt16 PrepareScaledValue(TInt aNonScaledValue);
00375     void ReScale(TUint16 aNewScale);
00385     void SetScrollBarModelType(TEikScrollBarModelType aModelType);
00396     TInt CheckMinMaxValue(TInt aValue);
00397     };
00400 //
00401 // CEikScrollBar
00402 //
00404 class CEikScrollThumb;
00405 class CEikScrollBarFrame;
00414 class CEikScrollBar : public CEikBorderedControl, public MCoeControlObserver
00415         {
00416 friend class CEikScrollBarExtension;
00417 friend class CAknDoubleSpanScrollBarExtension;
00419 public:
00422     enum TOrientation
00423         {
EVertical = SLafScrollBar::EVertical,
EHorizontal = SLafScrollBar::EHorizontal
00429         };
00432     enum TScrollBarType
00433         {
ENormalScrollBar =0x0,
EArrowHead =0x200,
EDoubleSpan =0x400
00446         };
00452     enum TEikScrollBarFlags
00453         {
EEikScrollBarDefaultBehaviour = 
SLafScrollBar::EEikScrollBarDefaultBehaviour,
EEikScrollBarNoNudgeButtons =
SLafScrollBar::EEikScrollBarNoNudgeButtons,
EEikScrollBarHasPageButtons =
SLafScrollBar::EEikScrollBarHasPageButtons, 
EEikScrollBarHasHomeEndButtons =
SLafScrollBar::EEikScrollBarHasHomeEndButtons,
EEikScrollBarNoShaftOrThumb =
SLafScrollBar::EEikScrollBarNoShaftOrThumb, 
EEikScrollBarShaftButNoThumb =
SLafScrollBar::EEikScrollBarShaftButNoThumb,        
EButtonsAtStartOfShaft =
SLafScrollBar::EButtonsAtStartOfShaft,      
EButtonsAtEndOfShaft =
SLafScrollBar::EButtonsAtEndOfShaft,                        
EButtonsEitherSideOfShaft =
SLafScrollBar::EButtonsEitherSideOfShaft,
ENoAutoDimming =
SLafScrollBar::ENoAutoDimming,
EEnableNudgeButtons = 0x0200,
EDisableExpandedTouchArea = 0x0400
00505         };
00508      enum TScrollBarExtensionAreaType
00509         {
ENormalExpandedTouchArea,
EScaleExpandedTouchArea,
ENoExpandedTouchArea
00518         };
00519     typedef TEikScrollBarFlags TAknScrollBarFlags;
00521 public:
00526     IMPORT_C ~CEikScrollBar();
00531     IMPORT_C CEikScrollBar();
00533 public:
00545     IMPORT_C virtual void ConstructL(
MEikScrollBarObserver* aScrollBarObserver,
00547                 const CCoeControl* aParent,
TOrientation aOrientation,
00549                 TInt aLength,
00550                 TInt aScrollBarFlags=EEikScrollBarDefaultBehaviour);
00557     IMPORT_C void SetLengthL(TInt aLength);
00564     IMPORT_C void SetModelL(const TEikScrollBarModel* aModel);
00571     IMPORT_C void SetModel(const TEikScrollBarModel* aModel);
00579     IMPORT_C void SetLengthAndModelL(TInt aLength,
00580                                      const TEikScrollBarModel* aModel);
00587     IMPORT_C void SetModelThumbPosition(TInt aThumbPos);
00594     IMPORT_C void SetFocusPosToThumbPos(TInt aFocusPosition);
00601     IMPORT_C static TInt DefaultScrollBarBreadth();
00610     void SetScrollBarObserver(MEikScrollBarObserver* aScrollBarObserver);
00615     inline const TEikScrollBarModel* Model() const;
00624     IMPORT_C TInt ThumbPosition() const;
00632     IMPORT_C TInt ScrollBarBreadth() const;
00641     IMPORT_C static TInt MinVisibleLength(const TInt aScrollBarFlags);
00648     IMPORT_C void SetDecreaseButtonsDimmed(TBool aDimmed);
00655     IMPORT_C void SetIncreaseButtonsDimmed(TBool aDimmed);
00662     IMPORT_C void SetAllButtonsDimmed(TBool aDimmed);
00672     inline CAknScrollButton* IncreaseNudgeButton() const;
00682     inline CAknScrollButton* DecreaseNudgeButton() const;
00684     // This function should only be used by CEikCba
00693     IMPORT_C void SetContainingCba(CEikCba* aCba);
00707     IMPORT_C void MakeVisible(TBool aVisible);
00709     // 
00717     IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);
00729     IMPORT_C void SetExtensionAreaType(TScrollBarExtensionAreaType aType);
00730 protected:      
00744     IMPORT_C CCoeControl* ComponentControl(TInt aIndex) const;
00753     IMPORT_C TInt CountComponentControls() const;
00755 private: // from MCoeControlObserver
00756     IMPORT_C virtual void HandleControlEventL(CCoeControl* aControl, 
00757                                               TCoeEvent aEventType);
00758 private: // virtual - reserved from CCoeControl
00759     IMPORT_C virtual void Reserved_2();
00760 private:
00764     IMPORT_C void* ExtensionInterface( TUid aInterface );
00766 protected:
00779     friend class CEikScrollBarFrame;
00781     // enums
00786     enum TPrivateScrollBarFlags
00787         {
ENoComponentsToDisplay          =0x10000,
EIncreaseButtonsDimmed          =0x20000,
EDecreaseButtonsDimmed          =0x40000
00797         };
00800     enum TPointerDownOn
00801         {
ENone,
EHomeButton,
EDecreasePageButton,
EDecreaseNudgeButton,
EDecreaseShaft,
EThumb,
EIncreaseShaft,
EIncreaseNudgeButton,
EIncreasePageButton,
EEndButton
00831         };
00834     enum TShaftRedrawRequired
00835         {
ENoRedrawRequired,
ERedrawShaft
00841         };
00844     enum TWhichButtons
00845         {
EIncreaseOnly,
EDecreaseOnly,
EAll
00854         };
00861     struct SEikScrollBarButtons
00862         {
00864         CAknScrollButton* iDecreaseNudge;
00867         CAknScrollButton* iIncreaseNudge;
00868         };
00871 private:
00872     // construction/destruction
00873     IMPORT_C virtual void CreateButtonL(CAknScrollButton*& aButton,
CAknScrollButton::TType aType);
00876     void SizeChanged();
00878     // set state functions
00879     void DoSetModel(const TEikScrollBarModel* aModel);
CEikCba* Cba() const;
00883     // These functions are for use only be CEikScrollBarFrame (a friend class)
00884     void AddExternalFrameL(CEikScrollBarFrame* aFrame);
00885     void RemoveExternalFrame(CEikScrollBarFrame* aFrame);
00887     void DisconnectExternalFrames();
00889 protected:
00894     void CreateRequiredComponentsL();
00901     void DestroyButton(CAknScrollButton*& aButton);
00908     IMPORT_C virtual void SetButtonPositionL(CAknScrollButton* aButton);
00910 public:
TScrollBarType ScrollBarType();
00919 public:
00922     TDblQueLink iSBLink;
00924 protected:
00927     SEikScrollBarButtons iButtons;
00930     TOrientation iOrientation;
00932 private:
TEikScrollBarModel iModel;
00935 protected:    
00938     CEikScrollBarExtensionImpl* iExtension;
00939   };
00952 class CEikArrowHeadScrollBar : public CEikScrollBar
00953         {
00954 public:
00955         IMPORT_C CEikArrowHeadScrollBar(CCoeControl* aParentWindow);
00956         IMPORT_C ~CEikArrowHeadScrollBar();
00957 public: // from CEikScrollBar
00958         IMPORT_C void ConstructL(MEikScrollBarObserver* aScrollBarObserver,const CCoeControl* aParent,
TOrientation aOrientation,TInt aLength,TInt aScrollBarFlags=EEikScrollBarDefaultBehaviour);
00960 public: // From CCoeControl
00961     IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);      
00962 private: // from CEikScrollBar
00963         void CreateButtonL(CAknScrollButton*& aButton,CAknScrollButton::TType aType);
00964         void SetButtonPositionL(CAknScrollButton* aButton);
00965 private:
00966 private:
00970     IMPORT_C void* ExtensionInterface( TUid aInterface );
00971 private:
00972         CCoeControl* iParentControl;
00973     TInt iSpare;
00974         };
00991 class CAknDoubleSpanScrollBar : public CEikScrollBar
00992         {
00993 public:
00994         IMPORT_C CAknDoubleSpanScrollBar(CCoeControl* aParentWindow);
00995         IMPORT_C ~CAknDoubleSpanScrollBar();
01005     IMPORT_C void SetFixedLayoutRect(TRect aScrollBarRect);
01019     IMPORT_C void ConstructL(TBool aWindowOwning, MEikScrollBarObserver* aScrollBarObserver,const CCoeControl* aParent,
TOrientation aOrientation,TInt aLength,TInt aScrollBarFlags=EEikScrollBarDefaultBehaviour);
01031     IMPORT_C void SetScrollPopupInfoTextL( const TDesC& aText );
01039     TRect FixedLayoutRect();
01041 public: // from CEikScrollBar
01042         IMPORT_C void ConstructL(MEikScrollBarObserver* aScrollBarObserver,const CCoeControl* aParent,
TOrientation aOrientation,TInt aLength,TInt aScrollBarFlags=EEikScrollBarDefaultBehaviour);
01044     IMPORT_C void MakeVisible(TBool aVisible);
01046 public: // from CCoeControl
01047     IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);    
01049 protected: // from CCoeControl
01050         IMPORT_C CCoeControl* ComponentControl(TInt aIndex) const;
01051     IMPORT_C TInt CountComponentControls() const;
01053 private:  // from CCoeControl
01054     IMPORT_C void SizeChanged();
01056 public:
01058         TBool DrawBackgroundState();
01060         void DrawBackground(TBool aDrawHorizontal);
01062 private:
01066     IMPORT_C void* ExtensionInterface( TUid aInterface );
01067 private: // from CEikScrollBar
01068         void CreateButtonL(CAknScrollButton*& aButton,CAknScrollButton::TType aType);
01069         void SetButtonPositionL(CAknScrollButton* aButton);
01078     void SetTransparentBackground(TBool aTransparentBackground);
01083     TRect ExtensionArea() const;
01084 private:
01085         CCoeControl* iParentControl;
01086     TInt iSpare;
01087         };
01090 //
01091 // Inlines
01092 //
01095 inline const TEikScrollBarModel* CEikScrollBar::Model() const
01096         { return &iModel; }
01098 inline CAknScrollButton* CEikScrollBar::IncreaseNudgeButton() const
01099         { return iButtons.iIncreaseNudge; }
01101 inline CAknScrollButton* CEikScrollBar::DecreaseNudgeButton() const
01102         { return iButtons.iDecreaseNudge; }
01105 #endif