phonebookui/phonebookservices/inc/cntabstractserviceprovider.h
branchRCL_3
changeset 19 5b6f26637ad3
equal deleted inserted replaced
18:d4f567ce2e7c 19:5b6f26637ad3
       
     1 /*
       
     2  * Copyright (c) 2009 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: Abstract interface for highway providers used in phonebookservices.
       
    15  *
       
    16  */
       
    17 
       
    18 #ifndef CNTABSTRACTSERVICEPROVIDER_H
       
    19 #define CNTABSTRACTSERVICEPROVIDER_H
       
    20 
       
    21 
       
    22 QTM_USE_NAMESPACE
       
    23 
       
    24 /*!
       
    25  * Abstract interface for highway providers used in phonebookservices.
       
    26  */
       
    27 class CntAbstractServiceProvider
       
    28 {
       
    29 public:
       
    30 
       
    31     /*!
       
    32      Complete the Qt Highway service (through a XQServiceProvider instance).
       
    33      Closes the app after the completing is done (message sending to client is done).
       
    34      */
       
    35     virtual void CompleteServiceAndCloseApp(const QVariant& retValue) = 0;
       
    36 
       
    37     /*!
       
    38      If this method has been called, then the argument in a call to CompleteServiceAndCloseApp() 
       
    39      can be ignored by concrete provider.
       
    40      */
       
    41     virtual void overrideReturnValue(const QVariant& retValue) { Q_UNUSED(retValue) };
       
    42     
       
    43     /*!
       
    44      By default sub views are allowed to exit the service, override this and return false to
       
    45      restrict this functionality.
       
    46      */
       
    47     virtual bool allowSubViewsExit() { return true; };
       
    48 
       
    49 };
       
    50 
       
    51 #endif /* CNTABSTRACTSERVICEPROVIDER_H */