videoutils_plat/videoconnutility_api/inc/ipvideo/tvcxconnutilnotifierparams.h
branchRCL_3
changeset 22 826cea16efd9
parent 21 798ee5f1972c
child 23 13a33d82ad98
equal deleted inserted replaced
21:798ee5f1972c 22:826cea16efd9
     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 the License "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:    data structure for passing messages between con utility and*
       
    15 */
       
    16 
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 #ifndef TVCXCONNUTILNOTIFIERPARAMS_
       
    22 #define TVCXCONNUTILNOTIFIERPARAMS_
       
    23 
       
    24 // Deprecation warning
       
    25 #warning This header file has been deprecated. Will be removed in one of the next SDK releases.
       
    26 
       
    27 /**
       
    28  * Max lenght of the string passed via message
       
    29  */
       
    30 const TInt KConnUtilMaxMsgLen = 255;
       
    31 
       
    32 /**
       
    33  * implementation UID for the notifier plugin that
       
    34  * videoconnutility uses
       
    35  */
       
    36 const TUid KVcxNotifierImplUid = { 0x20016BA5 };
       
    37 
       
    38 /**
       
    39 *  TVcxNotifierParams class. Class is used as message between 
       
    40 *  vcxconnectionutility and notifier plugin. Message is to be sent to notifier,
       
    41 *  when connection is being created for showing "connecting.." or similar msg and
       
    42 *  when connection creation is ready.
       
    43 *
       
    44 *  When connection is to be created, vcxconnectionutility sends message via through
       
    45 *  notifier server where it's passed to the notifier plugin with uid of KVcxNotifierImplUid
       
    46 *  vcxconnectionutility might pass additional message string to be shown in the dialogg
       
    47 *  with iMsg descriptor.
       
    48 * 
       
    49 *  Event can be either:
       
    50 *  - EConnecting (1), when notifier should show dialog asynchronously
       
    51 *  - EConnected (2), when vcxconnectionutility wants plugin to close dialog synchronously
       
    52 *  enums are defined in vcxconnectionutility.hrh
       
    53 * 
       
    54 * If plugin wants to nofify about closing of dialog before vcxconnectionutility wants it to be closed.
       
    55 * it should complete async dialog showing with result of KErrCancel.
       
    56 *  
       
    57 */
       
    58 class TVcxNotifierParams 
       
    59     {
       
    60     public:      
       
    61 
       
    62         enum TVcxNotifierEventId
       
    63             {
       
    64             EConnecting = 1,
       
    65             EConnected
       
    66             };
       
    67         
       
    68         /**
       
    69         * Event.
       
    70         */        
       
    71         TInt iEvent;
       
    72 
       
    73         /**
       
    74         * String message.
       
    75         */
       
    76         TBuf<KConnUtilMaxMsgLen> iMsg;        
       
    77     };
       
    78 
       
    79 
       
    80 
       
    81 #endif // TVCXCONNUTILNOTIFIERPARAMS_