phoneapp/phoneuiutils/inc/tphonecmdparambitmap.h
changeset 0 5f000ab63145
equal deleted inserted replaced
-1:000000000000 0:5f000ab63145
       
     1 /*
       
     2 * Copyright (c) 2002 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:  Command parameter class for Bitmap objects
       
    15 *     
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef TPHONECMDPARAMBITMAP_H
       
    21 #define TPHONECMDPARAMBITMAP_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include <fbs.h>
       
    25 #include "tphonecommandparam.h"
       
    26 
       
    27 // CLASS DECLARATION
       
    28 
       
    29 /**
       
    30 *  A concrete parameter class for passing a CFbsBitmap around. This
       
    31 *  is used for various purposes where CFbsBitmap is useful. 
       
    32 */
       
    33 class TPhoneCmdParamBitmap : public TPhoneUICommandParam
       
    34     {
       
    35     public:  
       
    36         
       
    37         /**
       
    38         * C++ default constructor.
       
    39         */
       
    40         IMPORT_C TPhoneCmdParamBitmap();
       
    41 
       
    42         /**
       
    43         * Sets the Bitmap value.
       
    44         * @param aBitmap is the bitmap.
       
    45         */
       
    46         IMPORT_C void SetBitmap( CFbsBitmap* aBitmap );
       
    47 
       
    48         /**
       
    49         * Returns the Bitmap.
       
    50         * @return Returns the Bitmap
       
    51         */
       
    52         IMPORT_C CFbsBitmap* Bitmap() const;
       
    53 
       
    54         /**
       
    55         * Sets the mask bitmap value.
       
    56         * @param aMaskBitmap is the masking bitmap.
       
    57         */
       
    58         IMPORT_C void SetMaskBitmap( CFbsBitmap* aMaskBitmap );
       
    59 
       
    60         /**
       
    61         * Returns the mask bitmap.
       
    62         * @return Returns the mask bitmap
       
    63         */
       
    64         IMPORT_C CFbsBitmap* MaskBitmap() const;
       
    65 
       
    66 
       
    67     private:    
       
    68         
       
    69         /**
       
    70         * Pointer to bitmap
       
    71         */
       
    72         CFbsBitmap* iBitmap;
       
    73 
       
    74         /**
       
    75         * Pointer to masking bitmap
       
    76         */
       
    77         CFbsBitmap* iMaskBitmap;
       
    78 
       
    79     };
       
    80 
       
    81 #endif      // TPHONECMDPARAMBITMAP_H 
       
    82             
       
    83 // End of File