1 /*

     2 * Copyright (c) 2006 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:  Represents the search data for UI

    15 *

    16 */

    17 

    18 

    19 #ifndef CCASEARCHDATAPC_H

    20 #define CCASEARCHDATAPC_H

    21 

    22 

    23 // INCLUDES

    24 #include	"MCASearchDataPC.h"

    25 

    26 

    27 //CLASS DECLARATION

    28 /**

    29 *  Search data representation for the UI.

    30 *

    31 *  @lib wvuiprocessng.lib

    32 *  @since 3.2

    33 */

    34 class CCASearchDataPC: public CBase,

    35             public MCASearchDataPC

    36     {

    37 

    38     public:

    39 

    40         /**

    41          * Symbian Two Phase Constructor

    42          * @param aSearchData : a reference to searchdata interface in the chat engine

    43          */

    44         static CCASearchDataPC* NewL( MCASearchData* aSearchData );

    45 

    46 

    47         /**

    48          * virtual destructor

    49          */

    50         virtual ~CCASearchDataPC();

    51 

    52     private:

    53 

    54         /**

    55          * default constructor

    56          * @param aSearchData : a reference to searchdata interface in the chat engine

    57          */

    58 

    59         CCASearchDataPC( MCASearchData* aSearchData );

    60 

    61 

    62     public:

    63 

    64         /**

    65          * Returns searched data.

    66          * @param aIndex specifies the index to the wanted data.

    67          * @return This is the search data.

    68          */

    69         TPtrC SearchData( TInt aIndex ) const ;

    70 

    71         /**

    72         * Returns the current search data count

    73         * ( I.e. maximum number of available items ).

    74         * @return Count of data items.

    75         */

    76         TInt SearchDataCount() const ;

    77 

    78         /**

    79         * The maximum amount of results available in the server.

    80         * @return The amount.

    81         */

    82         TInt HowManyResultsAvailable() const ;

    83 

    84         /**

    85          * Identification of contact. This is resolved from known

    86          * identifications.

    87          * Alias, nickname and contactId.

    88          * Nickname is shown if set.

    89          * @param aContactId Id of contact which identification needed.

    90          * @return Identification of contact.

    91          *      Alias if nickname is not set and alias is enabled.

    92          *      Wvid without domain and prefix if nickname does not

    93                 exists and alias is not enabled or not exists.

    94          */

    95         const TPtrC IdentificationL( const TDesC& aContactId ) ;

    96 

    97     private:

    98 

    99         /**

   100         * iDataInterface: a reference to searchdata interface in the chat engine

   101         * Doesnt Own

   102         */

   103         MCASearchData* iDataInterface;

   104 

   105     };

   106 

   107 #endif      // CCASEARCHDATAPC_H

   108 

   109 // End of File