1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/app/TVPbkWordParserCallbackParam.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,59 @@
     1.4 +/*
     1.5 +* Copyright (c) 2006-2007 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:  A parameter class for a find operation.
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +#ifndef T_TVPBKWORDPARSERCALLBACKPARAM_H
    1.23 +#define T_TVPBKWORDPARSERCALLBACKPARAM_H
    1.24 +
    1.25 +#include <e32def.h>
    1.26 +
    1.27 +/**
    1.28 + * A parameter class for a find operation.
    1.29 + *
    1.30 + * The parameter is used in TCallBack parameter to the client when it uses
    1.31 + * the find operation of the contact manager. The find operations will
    1.32 + * then leave the parsing of words to clients responsibility.
    1.33 + * The Virtual Phonebook store implementation will set the iStringToParse
    1.34 + * and client then fills the iWordArray.
    1.35 + *
    1.36 + * @see CVPbkContactManager::FindL
    1.37 + */
    1.38 +struct TVPbkWordParserCallbackParam
    1.39 +    {
    1.40 +    /**
    1.41 +     * Constructor.
    1.42 +     *
    1.43 +     * @param aStringToParse a string that must be parsed to iWordArray
    1.44 +     * @param aWordArray an array for parsed words
    1.45 +     */
    1.46 +    inline TVPbkWordParserCallbackParam( const TDesC* aStringToParse, 
    1.47 +        CDesCArray* aWordArray ) 
    1.48 +        :   iStringToParse( aStringToParse ), 
    1.49 +            iWordArray( aWordArray ) {}
    1.50 +
    1.51 +    /**
    1.52 +     * Not Own: a string that client must parse.
    1.53 +     */
    1.54 +    const TDesC* iStringToParse;
    1.55 +
    1.56 +    /**
    1.57 +     * Not Own: an array for parsed words.
    1.58 +     */
    1.59 +    CDesCArray* iWordArray;
    1.60 +    };
    1.61 +
    1.62 +#endif // T_TVPBKWORDPARSERCALLBACKPARAM_H