williamr@4: /*
williamr@4: * Copyright (c) 2006-2007 Nokia Corporation and/or its subsidiary(-ies).
williamr@4: * All rights reserved.
williamr@4: * This component and the accompanying materials are made available
williamr@4: * under the terms of "Eclipse Public License v1.0"
williamr@4: * which accompanies this distribution, and is available
williamr@4: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4: *
williamr@4: * Initial Contributors:
williamr@4: * Nokia Corporation - initial contribution.
williamr@4: *
williamr@4: * Contributors:
williamr@4: *
williamr@4: * Description:  A parameter class for a find operation.
williamr@4: *
williamr@4: */
williamr@4: 
williamr@4: 
williamr@4: #ifndef T_TVPBKWORDPARSERCALLBACKPARAM_H
williamr@4: #define T_TVPBKWORDPARSERCALLBACKPARAM_H
williamr@4: 
williamr@4: #include <e32def.h>
williamr@4: 
williamr@4: /**
williamr@4:  * A parameter class for a find operation.
williamr@4:  *
williamr@4:  * The parameter is used in TCallBack parameter to the client when it uses
williamr@4:  * the find operation of the contact manager. The find operations will
williamr@4:  * then leave the parsing of words to clients responsibility.
williamr@4:  * The Virtual Phonebook store implementation will set the iStringToParse
williamr@4:  * and client then fills the iWordArray.
williamr@4:  *
williamr@4:  * @see CVPbkContactManager::FindL
williamr@4:  */
williamr@4: struct TVPbkWordParserCallbackParam
williamr@4:     {
williamr@4:     /**
williamr@4:      * Constructor.
williamr@4:      *
williamr@4:      * @param aStringToParse a string that must be parsed to iWordArray
williamr@4:      * @param aWordArray an array for parsed words
williamr@4:      */
williamr@4:     inline TVPbkWordParserCallbackParam( const TDesC* aStringToParse, 
williamr@4:         CDesCArray* aWordArray ) 
williamr@4:         :   iStringToParse( aStringToParse ), 
williamr@4:             iWordArray( aWordArray ) {}
williamr@4: 
williamr@4:     /**
williamr@4:      * Not Own: a string that client must parse.
williamr@4:      */
williamr@4:     const TDesC* iStringToParse;
williamr@4: 
williamr@4:     /**
williamr@4:      * Not Own: an array for parsed words.
williamr@4:      */
williamr@4:     CDesCArray* iWordArray;
williamr@4:     };
williamr@4: 
williamr@4: #endif // T_TVPBKWORDPARSERCALLBACKPARAM_H