inc/screensaverindicatortext.h
branchRCL_3
changeset 26 e8d784ac1a4b
parent 0 040fcad49f44
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/inc/screensaverindicatortext.h	Wed Sep 01 12:30:40 2010 +0100
@@ -0,0 +1,117 @@
+/*
+* Copyright (c) 2003 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:   CScreensaverIndicatorText declaration.
+*
+*/
+
+
+
+#ifndef C_SCREENSAVERINDICATORTEXT_H
+#define C_SCREENSAVERINDICATORTEXT_H
+
+#include "screensaverindicator.h"
+
+class CScreensaverIndicatorText : public CScreensaverIndicator
+    {
+public:
+    
+    /**
+    * Draw the indicator. it should be implemented by the derived class
+    */
+    virtual void Draw( CWindowGc& aGc ) const;
+    
+    /**
+    * two-phased constructor  
+    * 
+    * @param aReader the resource read of the STRUCT 
+    * SCREENSAVER_PARAMETERS_ARRAY defined by ourself
+    * @param aBgColor the background color of display screen
+    * @param aTextColor the text color
+    */
+    virtual void ConstructL( TResourceReader &aReader, TUint32 aBgColor, TUint aTextColor );
+            
+    /**
+    * Set the parameters of drawing
+    * 
+    * @param aCorner the position of the lefttop of the indicator
+    * @param aParentRect
+    */
+    virtual void SetupDrawingParameters( const TPoint& aCorner, const TRect& aParentRect );
+            
+    /**
+    * Check if indicator is visible or not
+    * 
+    * @return TBool
+    */
+    virtual TBool CheckVisibilityConditions() const;
+    
+    /**
+    * Get the payload through the property
+    * 
+    * @param aPayload the reference to the payload  
+    */
+    virtual void Payload( TIndicatorPayload& aPayload ) const;
+    
+    /**
+    * Set the property through the payload
+    * 
+    * @param aPayload
+    */
+    virtual void SetPayload( const TIndicatorPayload& aPayload );
+
+    /**
+    * Sets text position and font
+    */
+    virtual void SetTextLayout( TAknLayoutText& aLayout, TInt aX = -1 );
+
+    /**
+    * Returns the width where whole text fits
+    */
+    virtual TInt PreferredWidth();
+
+    /**
+    * Set available width
+    */ 
+    virtual void SetWidth( TInt aWidth );
+
+    /**
+    * Set x-position of indicator
+    */ 
+    virtual void SetXPos( TInt aX );
+    
+private:
+    
+    /**
+    * The text should be displayed
+    */
+    TBuf16<KMaxPayloadTextLength> iText;
+    
+    /**
+    * The font of the text
+    * Not owned.
+    */
+    const CFont *iFont;
+    
+    /**
+    * Rect inside which text is drawn
+    */
+    TRect iTextRect;
+    
+    /**
+    * Text baseline offset from text rect top
+    */
+    TInt iTextOffset; 
+    };
+
+#endif // C_SCREENSAVERINDICATORTEXT_H