epoc32/include/app/TVPbkWordParserCallbackParam.h
branchSymbian3
changeset 4 837f303aceeb
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
       
     1 /*
       
     2 * Copyright (c) 2006-2007 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:  A parameter class for a find operation.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef T_TVPBKWORDPARSERCALLBACKPARAM_H
       
    20 #define T_TVPBKWORDPARSERCALLBACKPARAM_H
       
    21 
       
    22 #include <e32def.h>
       
    23 
       
    24 /**
       
    25  * A parameter class for a find operation.
       
    26  *
       
    27  * The parameter is used in TCallBack parameter to the client when it uses
       
    28  * the find operation of the contact manager. The find operations will
       
    29  * then leave the parsing of words to clients responsibility.
       
    30  * The Virtual Phonebook store implementation will set the iStringToParse
       
    31  * and client then fills the iWordArray.
       
    32  *
       
    33  * @see CVPbkContactManager::FindL
       
    34  */
       
    35 struct TVPbkWordParserCallbackParam
       
    36     {
       
    37     /**
       
    38      * Constructor.
       
    39      *
       
    40      * @param aStringToParse a string that must be parsed to iWordArray
       
    41      * @param aWordArray an array for parsed words
       
    42      */
       
    43     inline TVPbkWordParserCallbackParam( const TDesC* aStringToParse, 
       
    44         CDesCArray* aWordArray ) 
       
    45         :   iStringToParse( aStringToParse ), 
       
    46             iWordArray( aWordArray ) {}
       
    47 
       
    48     /**
       
    49      * Not Own: a string that client must parse.
       
    50      */
       
    51     const TDesC* iStringToParse;
       
    52 
       
    53     /**
       
    54      * Not Own: an array for parsed words.
       
    55      */
       
    56     CDesCArray* iWordArray;
       
    57     };
       
    58 
       
    59 #endif // T_TVPBKWORDPARSERCALLBACKPARAM_H