satengine/satserver/Engine/inc/MSatSIconAPI.h
author hgs
Fri, 15 Oct 2010 13:21:28 +0300
changeset 53 25b8d29b7c59
parent 33 8d5d7fcf9b59
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2004-2008 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:  Interface for accesing icon data in SIM.
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
#ifndef MSATSICONAPI_H
hgs
parents:
diff changeset
    21
#define MSATSICONAPI_H
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
//  INCLUDES
hgs
parents:
diff changeset
    24
#include <e32std.h>
hgs
parents:
diff changeset
    25
#include <etelsat.h>
hgs
parents:
diff changeset
    26
#include "MSatIconObserver.h"
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
// CLASS DECLARATION
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
/**
hgs
parents:
diff changeset
    31
*  Interface for accessing icon data in SIM.
hgs
parents:
diff changeset
    32
*
hgs
parents:
diff changeset
    33
*  @lib SatEngine.lib
hgs
parents:
diff changeset
    34
*  @since 2.6
hgs
parents:
diff changeset
    35
*/
hgs
parents:
diff changeset
    36
class MSatSIconAPI
hgs
parents:
diff changeset
    37
    {
hgs
parents:
diff changeset
    38
    public:  // Constructors and destructor
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
        /**
hgs
parents:
diff changeset
    41
        * Destructor.
hgs
parents:
diff changeset
    42
        */
hgs
parents:
diff changeset
    43
        virtual ~MSatSIconAPI() {};
hgs
parents:
diff changeset
    44
hgs
parents:
diff changeset
    45
    public: // New functions
hgs
parents:
diff changeset
    46
hgs
parents:
diff changeset
    47
        /**
hgs
parents:
diff changeset
    48
        * Gets the icon info from SIM.
hgs
parents:
diff changeset
    49
        * @param aRecordNumber Specifies the EF_IMG in SIM.
hgs
parents:
diff changeset
    50
        * @param aIconEf Contains the icon informations from SIM in returning
hgs
parents:
diff changeset
    51
        * of the method.
hgs
parents:
diff changeset
    52
        * @param aObserver Observer for icon info get completion.
hgs
parents:
diff changeset
    53
        */
hgs
parents:
diff changeset
    54
        virtual void GetIconInfo(
hgs
parents:
diff changeset
    55
            TUint8 aRecordNumber,
hgs
parents:
diff changeset
    56
            RSat::TIcon& aIconEf,
hgs
parents:
diff changeset
    57
            MSatIconObserver& aObserver ) = 0;
hgs
parents:
diff changeset
    58
hgs
parents:
diff changeset
    59
        /**
hgs
parents:
diff changeset
    60
        * Gets the icon image.
hgs
parents:
diff changeset
    61
        * @param aInstance Informatio of the icon, which data is
hgs
parents:
diff changeset
    62
        * fetched from SIM.
hgs
parents:
diff changeset
    63
        * @param aInstance Contains the icon data from SIM in returning of the
hgs
parents:
diff changeset
    64
        * method.
hgs
parents:
diff changeset
    65
        * @param aObserver Observer for icon image get completion.
hgs
parents:
diff changeset
    66
        */
hgs
parents:
diff changeset
    67
        virtual void GetIconInstance(
hgs
parents:
diff changeset
    68
            const RSat::TInstanceInfoV3& aInstanceInfo,
hgs
parents:
diff changeset
    69
            TDes8& aInstance,
hgs
parents:
diff changeset
    70
            MSatIconObserver& aObserver ) = 0;
hgs
parents:
diff changeset
    71
hgs
parents:
diff changeset
    72
        /**
hgs
parents:
diff changeset
    73
        * Gets color lookup table of the icon.
hgs
parents:
diff changeset
    74
        * @param aInstanceNumber Image instance number.
hgs
parents:
diff changeset
    75
        * @param aOffset Offset of the clut.
hgs
parents:
diff changeset
    76
        * @param aClut Contains the Clut of the icon in returning of the
hgs
parents:
diff changeset
    77
        * method.
hgs
parents:
diff changeset
    78
        * @param aObserver Observer for clut get completion.
hgs
parents:
diff changeset
    79
        */
hgs
parents:
diff changeset
    80
        virtual void GetClut(
hgs
parents:
diff changeset
    81
            TUint aInstanceNumber,
hgs
parents:
diff changeset
    82
            TUint aOffset,
hgs
parents:
diff changeset
    83
            TDes8& aClut,
hgs
parents:
diff changeset
    84
            MSatIconObserver& aObserver ) = 0;
hgs
parents:
diff changeset
    85
        /*
hgs
parents:
diff changeset
    86
         * Set a mode to determine whether to fetch icons from NAA syncronously
hgs
parents:
diff changeset
    87
         * or asynchronously.
hgs
parents:
diff changeset
    88
         *
hgs
parents:
diff changeset
    89
         * @param aMode Synchronous or asynchronous mode. Icons would be
hgs
parents:
diff changeset
    90
         * fetched from NAA in sychronous mode if SAT UI was closed by
hgs
parents:
diff changeset
    91
         * using the End Key. Otherwise, in asynchronous mode.
hgs
parents:
diff changeset
    92
         * @return None
hgs
parents:
diff changeset
    93
         */
hgs
parents:
diff changeset
    94
        virtual void SetIconFetchingMode( TBool aMode ) = 0;
hgs
parents:
diff changeset
    95
hgs
parents:
diff changeset
    96
    protected:
hgs
parents:
diff changeset
    97
hgs
parents:
diff changeset
    98
        // Constructor
hgs
parents:
diff changeset
    99
        MSatSIconAPI() {};
hgs
parents:
diff changeset
   100
hgs
parents:
diff changeset
   101
    private:
hgs
parents:
diff changeset
   102
hgs
parents:
diff changeset
   103
        // Prohibit copy constructor if not deriving from CBase.
hgs
parents:
diff changeset
   104
        MSatSIconAPI( const MSatSIconAPI& );
hgs
parents:
diff changeset
   105
hgs
parents:
diff changeset
   106
        // Prohibit assigment operator if not deriving from CBase.
hgs
parents:
diff changeset
   107
        MSatSIconAPI& operator=( const MSatSIconAPI& );
hgs
parents:
diff changeset
   108
hgs
parents:
diff changeset
   109
    };
hgs
parents:
diff changeset
   110
hgs
parents:
diff changeset
   111
#endif      // MSATSICONAPI_H
hgs
parents:
diff changeset
   112
hgs
parents:
diff changeset
   113
// End of File