Aknslider.h

00001 /*
00002 * ============================================================================
00003 *  Name         : CAknSlider from aknslider.h
00004 *  Part of      : Avkon
00005 *  Description  : Slider editor class
00006 *  Version      : %version: e003sa02#38 %
00007 *
00008 *  Copyright ?2005-2006 Nokia. All rights reserved.
00009 *  This material, including documentation and any related 
00010 *  computer programs, is protected by copyright controlled by 
00011 *  Nokia. All rights are reserved. Copying, including 
00012 *  reproducing, storing, adapting or translating, any 
00013 *  or all of this material requires the prior written consent of 
00014 *  Nokia. This material also contains confidential 
00015 *  information which may not be disclosed to others without the 
00016 *  prior written consent of Nokia.
00017 * ============================================================================
00018 */
00020 #ifndef __AKNSLIDER_H__
00021 #define __AKNSLIDER_H__
00022 
00023 // INCLUDES
00024 #include <eikbctrl.h>
00025 #include <eiklabel.h>
00026 #include <eikimage.h>
00027 #include <avkon.hrh> // For TAknOrientation
00029 // CONSTANTS
00031 // The following is max. length of the entire formatted value text including
00032 // number, special characters and supplied text.
00033 const TInt KValueLabelTextMaxLength = 30;
00035 // Forward declarations
00036 class CGulIcon;
00037 class MAknsSkinInstance;
00038 class CAknSliderExtension;
00039 class CAknSliderData;
00040 struct TAknSliderGfx;
00042 // CLASS DECLARATION
00043 class CAknSlider : public CEikBorderedControl
00044     {
00045 public: // Enumerations
00051     enum TSliderGfxElements
00052         {
EElemEmptyLeftCap,
EElemEmptyRightCap,
EElemEmptyLine,
EElemFilledLine,
EElemFilledLeftCap,
EElemFilledRightCap,
EElemMarker,
EElemTickMark,
EElemMarkerSelected
00100         };
00107     enum
00108         {
EPosFilling  = 0x01,
EPosMarker   = 0x02            
00127         };
00134     enum
00135         {
EDragMarkerStart  = 1000,
EDragMarkerEnd
00144         };
00146 public:
00150     IMPORT_C CAknSlider();
00155     IMPORT_C ~CAknSlider();
00166     IMPORT_C void SetValueL( TInt aValue );
00173     IMPORT_C TInt Value() const;
00182     IMPORT_C void SetRange( TInt aMinimumValue, TInt aMaximumValue );
00192     IMPORT_C void GetRange( TInt& aMinimumValue, TInt& aMaximumValue );
00200     IMPORT_C void SetStepSize( TInt aStepSize );
00207     IMPORT_C void SetMinimumTextL( const TDesC& aText );
00214     IMPORT_C void SetMaximumTextL( const TDesC& aText );
00221     IMPORT_C void SetDecimalPlaces( TInt aDecimalPlaces );
00228     IMPORT_C TInt DecimalPlaces() const;
00261     IMPORT_C void SetGraphics( TInt aElement,
00262                                CFbsBitmap* aBitmap,
00263                                CFbsBitmap* aMask );
00277     IMPORT_C void UseDefaultGraphics( TInt aElement );
00293     IMPORT_C TBool UsesDefaultGraphics( TInt aElement ) const;
00312     IMPORT_C void SetPositionIndicators( TUint32 aFlags );
00322     IMPORT_C TUint32 PositionIndicators() const;
00331     IMPORT_C TAknOrientation Orientation() const;
00342     IMPORT_C void SetTicksEnabled( TBool aStatus );
00351     IMPORT_C TBool TicksEnabled() const;
00363     IMPORT_C void SetTickInterval( TUint aInterval );
00372     IMPORT_C TUint TickInterval() const;
00385     IMPORT_C static CFbsBitmap* CreateBitmapL( TInt aValue,
00386                                                TInt aResourceId );
00399     IMPORT_C static CFbsBitmap* CreateBitmapL( TInt aValue,
00400                                                TInt aMinimumValue,
00401                                                TInt aMaximumValue );
00413     IMPORT_C static CGulIcon* CreateSetStyleListBoxIconL( TInt aValue,
00414                                                           TInt aResourceId );
00426     IMPORT_C static CGulIcon* CreateSetStyleListBoxIconL( TInt aValue,
00427                                                           TInt aMinimumValue,
00428                                                           TInt aMaximumValue );
00434     IMPORT_C void EnableDrag();
00436 public:
00443     TSize MinimumSize();
00452     TKeyResponse OfferKeyEventL( const TKeyEvent& aKeyEvent,
00453                                  TEventCode aType );
00460     IMPORT_C void ConstructFromResourceL( TResourceReader& aReader );
00469     IMPORT_C void ConstructFromResourceL( CCoeControl* aParent,
00470                                           TInt aValue,
00471                                           TResourceReader& aReader );
00478     IMPORT_C void HandleResourceChange( TInt aType );
00480 public:
00487     IMPORT_C TInt NumberOfLines() const;
00499     IMPORT_C static HBufC* CreateValueTextInHBufCL( TInt aValue,
00500                                                     TInt aResourceId );
00502     void SuppressDrawing( TBool aSuppress );
00504 protected:
00508     void SizeChanged();
00515     void Draw( const TRect& aRect ) const;
00522     IMPORT_C virtual TInt CountComponentControls() const;
00530     IMPORT_C virtual CCoeControl* ComponentControl( TInt aIndex ) const;
00532 public:
00538     IMPORT_C void HandlePointerEventL( const TPointerEvent& aPointerEvent );
00539     TInt StepSize() const;
00541 private:
00545     IMPORT_C void* ExtensionInterface( TUid aInterface );
00547 protected:
00551     IMPORT_C void SetValueTextL();
00553 public:
00560     void ReportMarkerDragEvent( TBool aEnable );
00562 private:
00567     void ConstructL();
00569     void InitializeBitmapsL();
00580     static void DoSetValueTextL( TDes& valueBuf, TInt aValue,
00581                                  const CAknSliderData& aResourceData );
00589     CAknSliderData* SliderData() const;
00606     static void FormatWithOrWithoutTokenL( TDes& aOutput,
00607                                            const TDesC& aFormat,
00608                                            const TDesC& aValue );
00610     // layout methods
00611     void FormSliderLayout1();
00612     void FormSliderLayout2();
00613     void FormSliderLayout3();
00614     void SettingsItemSliderLayout();
00615     void VerticalSliderLayout();
00616     void HorizontalSliderLayout();
00617     void MIDPFormSliderLayout();
00619     void SetLabelColor();
00622     void CreateDecoratorImageFromResourceL( TInt aImageResourceId );
00624     // Internal access methods
00625     TInt Layout() const;
00626     TInt MaximumValue() const;
00627     TInt MinimumValue() const;
00628     TInt Range() const;
00630     // Starts a timer for feedback effect visualization.
00631     void StartTimerL();
00633     // Callback for feedback effect.
00634     static TInt IndicationDrawCallbackL( TAny* aThis );
00636     // Implementation of the feedback effect.
00637     void SmallDirectionIndicationL();
00639     void DrawHorizontalTickMarks( CWindowGc& aGc ) const;
00640     void DrawVerticalTickMarks( CWindowGc& aGc ) const;
00642     void TranslateValueL( TInt aDelta, TBool aFeedback = EFalse );
00644     void GetMarkerRect( TRect& aRect ) const;
00645     TSize MarkerSize() const;
00646     TPoint MarkerPos() const;
00648     void DrawHorizontal( TBool aDrawMarker ) const;
00649     void DrawVertical( TBool aDrawMarker ) const;
00651     void DrawHorizontalLine( CWindowGc& aGc ) const;
00652     void DrawVerticalLine( CWindowGc& aGc ) const;
00654     void FetchGfx( TAknSliderGfx& aGfx, TInt aElement, const TSize& aSize ) const;
00656     // calculate the correct value according to the input point
00657     TInt CalcAlignedValue( const TPoint& aPoint ); 
00659 private:
CEikImage* iImage;
CEikLabel* iValueLabel;
CEikLabel* iMinLabel;
CEikLabel* iMaxLabel;
00664     CFbsBitmap* iMarkerBmp;
00665     CFbsBitmap* iMarkerMaskBmp;
00666     TRect iMarkerArea;
00667     TRect iLineRect;
00668     TInt iValue;
00669     TBool iEditable;
00670     TRgb iColor;
00672     // Not used, kept for binary compatibility. Another pointer with same name
00673     // in iData is really used
00674     HBufC* iSingularText;
00676     CAknSliderData* iData;
00677     CAknSliderExtension* iExt;
00679     TInt iSpare[4];
00680 };
00682 #endif // __AKNSLIDER_H__
00683 
00684 // End of File