wvuing/wvuiprocess/Inc/MCAOpenChatsPC.h
changeset 0 094583676ce7
equal deleted inserted replaced
-1:000000000000 0:094583676ce7
       
     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:  Openchats (Tab items)
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef MCAOPENCHATSPC_H
       
    21 #define MCAOPENCHATSPC_H
       
    22 
       
    23 
       
    24 //includes
       
    25 #include "TEnumsPC.h"
       
    26 
       
    27 
       
    28 //forward declarations
       
    29 class MCAArrayItemPC;
       
    30 
       
    31 
       
    32 // CLASS DECLARATION
       
    33 
       
    34 /**
       
    35  *  Interface for tab related items
       
    36  *
       
    37  *  @lib wvuiprocessng.dll
       
    38  *  @since 3.2
       
    39  */
       
    40 class MCAOpenChatsPC
       
    41     {
       
    42 
       
    43     public:
       
    44 
       
    45         /**
       
    46          * GetIdentification: returns the Identification
       
    47          * @param aIndex - Index of the item for which Identification
       
    48          *                 is required
       
    49          * @return TPtrC - Identification
       
    50          */
       
    51         virtual const TPtrC GetIdentification( TInt aIndex ) = 0;
       
    52 
       
    53 
       
    54         /**
       
    55          * GetWvId: returns the WV user ID
       
    56          * @param aIndex - Index of the item for which WvId
       
    57          *                 is required
       
    58          * @return TPtrC - WV user ID
       
    59          */
       
    60         virtual const TPtrC GetId( TInt aIndex ) = 0;
       
    61 
       
    62 
       
    63         /**
       
    64          * GetType: returns the type of the item
       
    65          * @param aIndex - Index of the item for which type
       
    66          *                 is required
       
    67          * @return TEnumsPC::TTabType - conversation/invitation/group
       
    68          */
       
    69         virtual TEnumsPC::TItem GetType( TInt aIndex ) = 0;
       
    70 
       
    71 
       
    72 
       
    73 
       
    74         /**
       
    75          * Count: Returns the number of items
       
    76          * @return TInt - Total number of openchats item
       
    77          */
       
    78         virtual TInt Count() const = 0;
       
    79 
       
    80 
       
    81         /**
       
    82          * SetActiveItem: Sets the item as the current active one
       
    83          * @param aIndex - Index of the item
       
    84          * @return void
       
    85          */
       
    86         virtual void SetActiveItem( const TInt aIndex ) = 0;
       
    87 
       
    88         virtual void GetActiveItem( TDesC*& aId, TEnumsPC::TItem& aType ) = 0;
       
    89 
       
    90 
       
    91         /**
       
    92          * SetInvitationIdentification: Sets the title for invitation items
       
    93          * @param aIdentification - Ptr to the invitaion title
       
    94          *							Ownership should not be transferred
       
    95          * @return void
       
    96          */
       
    97         virtual void SetInvitationIdentification( TDesC* aIdentification ) = 0;
       
    98 
       
    99 
       
   100 
       
   101         /**
       
   102          * Virtual destructor
       
   103          */
       
   104         virtual ~MCAOpenChatsPC()
       
   105             {
       
   106             };
       
   107 
       
   108 
       
   109     };
       
   110 
       
   111 #endif      // MCAOPENCHATSPC_H
       
   112 
       
   113 // End of File