1 /*

     2 * Copyright (c) 2004-2005 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:  Parameter class definitions.

    15 *

    16 */

    17 

    18 

    19 #ifndef CPHCLTIMAGEPARAMS_H

    20 #define CPHCLTIMAGEPARAMS_H

    21 

    22 #include    <e32std.h>

    23 #include    <e32base.h>

    24 

    25 

    26 // Number of images in max.

    27 const TInt KPhCltImagesArrayLen = 10; 

    28 

    29 

    30 /**

    31 * Enumerates image type.

    32 * 

    33 * @since 3.0.

    34 * 

    35 * EPhCltVersionNotSet - not set version nbr.

    36 * EPhCltVersionVTStill - Video telephony still image.

    37 * EPhCltVersionOperatorLogo - Operator logo.

    38 * EPhCltTypeVTDefault - Video telephony default image when

    39 *                       VT still image is not in use.

    40 */

    41 enum TPhCltImageType

    42     {

    43     EPhCltTypeNotSet         = 0,

    44     EPhCltTypeVTStill        = 1,

    45     EPhCltTypeOperatorLogo   = 2,

    46     EPhCltTypeVTDefault      = 3

    47     };

    48     

    49     

    50 /**

    51 * Image handler uses TPhCltImageArray.

    52 * Identification is done according to the version number, and handled

    53 * accordingly.

    54 */

    55 struct TPhCltImageArray

    56     {

    57     TInt iImages[KPhCltImagesArrayLen];

    58     TInt iImageCount; 

    59     TPhCltImageType iType;

    60     };

    61 

    62 

    63 // CLASS DECLARATION

    64 /**

    65 *  Parameter storage class.

    66 *

    67 *  @lib PhoneClient.lib

    68 *  @since Series60 3.2

    69 */

    70 class CPhCltImageParams : public CBase

    71     {

    72     public:

    73         /**

    74          * Returns class type.

    75          * @return type number;

    76          */

    77         IMPORT_C virtual TPhCltImageType Type() const = 0;

    78 

    79         /**

    80          * Adds an image.

    81          * @param aHandle handle to an image.

    82          */

    83         virtual void AddImageL( TInt aHandle ) = 0;

    84 

    85         /**

    86          * Gets an image.

    87          * @param aIndex index of the image to get.

    88          * @return image handle

    89          */

    90         IMPORT_C virtual TInt GetImageL( const TInt aIndex ) const = 0;

    91 

    92         /**

    93          * Gets image count.

    94          * @return image count

    95          */

    96         IMPORT_C virtual TInt Count() const = 0;

    97 

    98         /**

    99         * Get all the images

   100         * @return package buffered image struct

   101         */

   102         virtual TPckgBuf< TPhCltImageArray >& Images() = 0;

   103     };

   104 

   105 #endif // CPHCLTIMAGEPARAMS_H