services/terminalmodeservice_plat/inc/upnpterminalmodeicon.h
author hgs
Fri, 23 Jul 2010 08:57:49 +0300
changeset 24 e9457ebcc4df
permissions -rw-r--r--
201029
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
24
hgs
parents:
diff changeset
     1
/**
hgs
parents:
diff changeset
     2
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description: CUpnpTerminalModeIcon class declaration
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef __UPNPTERMINALMODEICON_H__
hgs
parents:
diff changeset
    19
#define __UPNPTERMINALMODEICON_H__
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
#include <e32base.h>   
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
// CLASS DECLARATION
hgs
parents:
diff changeset
    24
/**
hgs
parents:
diff changeset
    25
* This class encapsulates an icon used in any operation of the 
hgs
parents:
diff changeset
    26
* Terminal Mode Service implemented.
hgs
parents:
diff changeset
    27
* This represents device and application icons (as provided by Automotive Server).
hgs
parents:
diff changeset
    28
*/
hgs
parents:
diff changeset
    29
class CUpnpTerminalModeIcon : public CBase
hgs
parents:
diff changeset
    30
    {
hgs
parents:
diff changeset
    31
public:    
hgs
parents:
diff changeset
    32
    /**
hgs
parents:
diff changeset
    33
    * Standard Symbian Two-Phase constructor. Returns a pointer to the new element.
hgs
parents:
diff changeset
    34
    * @param aPath     icon path
hgs
parents:
diff changeset
    35
    * @param aWidth    icon width
hgs
parents:
diff changeset
    36
    * @param aHeight   icon height
hgs
parents:
diff changeset
    37
    * @param aDepth    icon depth
hgs
parents:
diff changeset
    38
    * @param aMimeType icon mime type
hgs
parents:
diff changeset
    39
    */    
hgs
parents:
diff changeset
    40
    IMPORT_C static CUpnpTerminalModeIcon* NewL(const TDesC16& aPath, const TInt aWidth,  
hgs
parents:
diff changeset
    41
                        const TInt aHeight,const TInt aDepth, const TDesC8& aMimeType );
hgs
parents:
diff changeset
    42
    /**
hgs
parents:
diff changeset
    43
    * Destructor. 
hgs
parents:
diff changeset
    44
    */
hgs
parents:
diff changeset
    45
    ~CUpnpTerminalModeIcon();
hgs
parents:
diff changeset
    46
     
hgs
parents:
diff changeset
    47
public: 
hgs
parents:
diff changeset
    48
    /**
hgs
parents:
diff changeset
    49
    * Returns the icon filename
hgs
parents:
diff changeset
    50
    * @return Returns the icon filename along with complete filepath.
hgs
parents:
diff changeset
    51
    */
hgs
parents:
diff changeset
    52
    inline const TDesC& IconFilename()const;
hgs
parents:
diff changeset
    53
    
hgs
parents:
diff changeset
    54
    /**
hgs
parents:
diff changeset
    55
    * Returns the width of the icon.
hgs
parents:
diff changeset
    56
    * @return Returns width in pixels or KErrNotFound
hgs
parents:
diff changeset
    57
    */
hgs
parents:
diff changeset
    58
    inline TInt Width()const;
hgs
parents:
diff changeset
    59
    
hgs
parents:
diff changeset
    60
    /**
hgs
parents:
diff changeset
    61
    * Returns the height of the icon.
hgs
parents:
diff changeset
    62
    * @return Returns height in pixels or KErrNotFound
hgs
parents:
diff changeset
    63
    */
hgs
parents:
diff changeset
    64
    inline TInt Height()const;
hgs
parents:
diff changeset
    65
    
hgs
parents:
diff changeset
    66
    /**
hgs
parents:
diff changeset
    67
    * Returns the color depth of the icon.
hgs
parents:
diff changeset
    68
    * @return Returns icon depth or KErrNotFound
hgs
parents:
diff changeset
    69
    */
hgs
parents:
diff changeset
    70
    inline TInt Depth()const;   
hgs
parents:
diff changeset
    71
    
hgs
parents:
diff changeset
    72
    /**
hgs
parents:
diff changeset
    73
    * Returns the mime type.
hgs
parents:
diff changeset
    74
    * @return Returns Icon mime type
hgs
parents:
diff changeset
    75
    */
hgs
parents:
diff changeset
    76
    inline const TDesC8& MimeType()const;
hgs
parents:
diff changeset
    77
    
hgs
parents:
diff changeset
    78
private:    
hgs
parents:
diff changeset
    79
    /**
hgs
parents:
diff changeset
    80
    * C++ default constructor.
hgs
parents:
diff changeset
    81
    * @param aWidth    icon width
hgs
parents:
diff changeset
    82
    * @param aHeight   icon height
hgs
parents:
diff changeset
    83
    * @param aDepth    icon depth 
hgs
parents:
diff changeset
    84
    */
hgs
parents:
diff changeset
    85
    CUpnpTerminalModeIcon( const TInt aWidth,const TInt aHeight,const TInt aDepth );
hgs
parents:
diff changeset
    86
    /**
hgs
parents:
diff changeset
    87
     * 2nd phase constructor
hgs
parents:
diff changeset
    88
     * @param aPath     icon path
hgs
parents:
diff changeset
    89
     * @param aMimeType icon mime type
hgs
parents:
diff changeset
    90
     */ 
hgs
parents:
diff changeset
    91
    void ConstructL( const TDesC16& aPath,const TDesC8& aMimeType );
hgs
parents:
diff changeset
    92
hgs
parents:
diff changeset
    93
private:    	
hgs
parents:
diff changeset
    94
    HBufC*                 iFilename;
hgs
parents:
diff changeset
    95
    TInt                   iIconWidth;
hgs
parents:
diff changeset
    96
    TInt                   iIconHeight;
hgs
parents:
diff changeset
    97
    TInt                   iIconDepth;
hgs
parents:
diff changeset
    98
    HBufC8*                iIconMimeType;
hgs
parents:
diff changeset
    99
    };
hgs
parents:
diff changeset
   100
hgs
parents:
diff changeset
   101
#include <upnpterminalmodeicon.inl>
hgs
parents:
diff changeset
   102
hgs
parents:
diff changeset
   103
#endif  //__UPNPTERMINALMODEICON_H__
hgs
parents:
diff changeset
   104
hgs
parents:
diff changeset
   105
// End of File