videofeeds/vcnsuiengine/inc/vcxnscontentsearchif.h
changeset 0 96612d01cf9f
equal deleted inserted replaced
-1:000000000000 0:96612d01cf9f
       
     1 /*
       
     2 * Copyright (c) 2008 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: 
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 #ifndef M_VCXNSCONTENTSEARCHIF_H
       
    22 #define M_VCXNSCONTENTSEARCHIF_H
       
    23 
       
    24 // INCLUDES
       
    25 #include <e32base.h>
       
    26 
       
    27 class MVcxNsContentSearchObserver;
       
    28 
       
    29 // CLASS DECLARATION
       
    30 
       
    31 /**
       
    32 * Class MVcxNsContentSearchIf 
       
    33 * Interface for using search
       
    34 *
       
    35 * @lib vcxnsuiengine.lib
       
    36 */
       
    37 class MVcxNsContentSearchIf
       
    38     {
       
    39 
       
    40 public:
       
    41 
       
    42     /**
       
    43      * RegisterObserver.
       
    44      * @param aObserver Observer
       
    45      */
       
    46     virtual void RegisterObserver( MVcxNsContentSearchObserver* aObserver ) = 0;
       
    47 
       
    48     /**
       
    49      * DeRegisterObserver.
       
    50      * @param aObserver Observer
       
    51      */
       
    52     virtual void DeRegisterObserver( MVcxNsContentSearchObserver* aObserver ) = 0;
       
    53     
       
    54     /**
       
    55      * Starts the search with given keyword.
       
    56      * @param aSearchString Search string
       
    57      */
       
    58     virtual void SearchL( const TDesC& aSearchString ) = 0;
       
    59     
       
    60     /**
       
    61      * Cancel ongoing search.
       
    62      *
       
    63      */
       
    64     virtual void CancelSearchL( ) = 0;
       
    65     
       
    66     /**
       
    67      * Handle search related status messages.
       
    68      * @param aStatus Search status.
       
    69      * @param aInfo Information parameter.
       
    70      */
       
    71     virtual void HandleSearchMsgL( TInt aStatus, TInt aInfo ) = 0;
       
    72     
       
    73     /**
       
    74      * Handle search cancelled by user.
       
    75      */
       
    76     virtual void SearchCancelled() = 0;
       
    77     
       
    78     };
       
    79 
       
    80 #endif // MVCXNSAPPCATEGORYPROVIDERIF_H