emailuis/uicomponents/inc/fsalfwatermark.h
branchRCL_3
changeset 25 3533d4323edc
parent 0 8466d47a6819
equal deleted inserted replaced
24:d189ee25cf9d 25:3533d4323edc
       
     1 /*
       
     2 * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Alf Watermark object
       
    15  *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef C_FSALFWATERMARK_H
       
    21 #define C_FSALFWATERMARK_H
       
    22 //<cmail> SF
       
    23 #include <alf/alfvisual.h>
       
    24 #include <alf/alftexture.h>
       
    25 #include <alf/alfdecklayout.h>
       
    26 //</cmail>
       
    27 
       
    28 /**
       
    29  *  Class used for placing watermark.
       
    30  *
       
    31  *  @lib fs_generic
       
    32  */
       
    33 
       
    34 NONSHARABLE_CLASS(CFsAlfWatermark) : public CBase
       
    35     {
       
    36     
       
    37 public:
       
    38 
       
    39     /**
       
    40      * Factory method.
       
    41      * 
       
    42      * @param aParentControl Parent control for watermark layout.
       
    43      * @param aParentLayout ParentLayout for watermarkLayout.
       
    44      */
       
    45     static CFsAlfWatermark* NewL( CAlfControl& aParentControl, 
       
    46             CAlfLayout& aParentLayout );
       
    47 
       
    48     /**
       
    49      * C++ destructor.
       
    50      */
       
    51     virtual ~CFsAlfWatermark();
       
    52 
       
    53     /**
       
    54      * Returns the position of the watermark.
       
    55      * 
       
    56      * @return Reference to the object holding position of watermark.
       
    57      */
       
    58     TAlfTimedPoint Pos();
       
    59     
       
    60     /**
       
    61      * Returns the size of the watermark.
       
    62      * 
       
    63      * @return Reference to the object holding size of watermark.
       
    64      */
       
    65     TAlfTimedPoint Size();
       
    66     
       
    67     /**
       
    68      * Returns opacity of the watermark.
       
    69      * 
       
    70      * @return Reference to the object holding opacity of watermark.
       
    71      */
       
    72     TAlfTimedValue& Opacity();
       
    73     
       
    74     /**
       
    75      * Sets the texture for watermark.
       
    76      * 
       
    77      * @param aTexture Reference to the new watermark texture.
       
    78      */
       
    79     // <cmail>
       
    80     void SetWatermarkTextureL( CAlfTexture& aTexture );
       
    81     // </cmail>
       
    82     
       
    83 private:
       
    84 
       
    85     /**
       
    86      * 2nd phase constructor.
       
    87      * 
       
    88      * @param aParentControl Parent control for watermark layout.
       
    89      * @param aParentLayout ParentLayout for watermarkLayout.
       
    90      */
       
    91     void ConstructL( CAlfControl& aParentControl, CAlfLayout& aParentLayout );
       
    92 
       
    93     /**
       
    94      * C++ constructor.
       
    95      */
       
    96     CFsAlfWatermark();
       
    97 
       
    98 private:
       
    99 
       
   100     /**
       
   101      * Pointer to the watermark layout.
       
   102      * Own.
       
   103      */
       
   104     CAlfDeckLayout* iWatermarkLayout;
       
   105     
       
   106     /**
       
   107      * Pointer to the watermark texture.
       
   108      * Not own.
       
   109      */
       
   110     CAlfTexture* iWatermarkTexture;
       
   111 
       
   112     };
       
   113 
       
   114 
       
   115 #endif /*C_FSALFWATERMARK_H*/