phonebookui/Phonebook/View/inc/MPbkFetchDlg.h
changeset 0 e686773b3f54
equal deleted inserted replaced
-1:000000000000 0:e686773b3f54
       
     1 /*
       
     2 * Copyright (c) 2002 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: 
       
    15 *     Fetch dialog page for Phonebook.
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef __MPbkFetchDlg_H__
       
    21 #define __MPbkFetchDlg_H__
       
    22 
       
    23 //  INCLUDES
       
    24 #include <e32std.h>
       
    25 #include <cntdef.h>
       
    26 
       
    27 //  FORWARD DECLARATIONS
       
    28 class CCoeControl;
       
    29 class CContactViewBase;
       
    30 class CPbkContactIdSet;
       
    31 class CPbkContactEngine;
       
    32 class MPbkFetchDlgPage;
       
    33 
       
    34 // CLASS DECLARATION
       
    35 
       
    36 /**
       
    37  * Phonebook fetch dialog interface. Used by MPbkFetchDlgPage implementation 
       
    38  * objects.
       
    39  * @see MPbkFetchDlgPage
       
    40  */
       
    41 class MPbkFetchDlg
       
    42     {
       
    43     public:
       
    44         /**
       
    45          * Returns a dialog control with id aCtrlId.
       
    46          */
       
    47         virtual CCoeControl* FetchDlgControl(TInt aCtrlId) const = 0;
       
    48 
       
    49         /**
       
    50          * Returns the contact view to use for names list contents.
       
    51          */
       
    52         virtual CContactViewBase& FetchDlgNamesView() const = 0;
       
    53 
       
    54         /**
       
    55          * Returns the current fetch dialog selection set.
       
    56          */
       
    57         virtual CPbkContactIdSet& FetchDlgSelection() = 0;
       
    58 
       
    59         /**
       
    60          * Displays an async error aError note in the UI.
       
    61          */
       
    62         virtual void FetchDlgHandleError(TInt aError) = 0;
       
    63 
       
    64         /**
       
    65          * Returns the rectangle to use for control.
       
    66          */
       
    67         virtual TRect FetchDlgClientRect() const = 0;
       
    68 
       
    69         /**
       
    70          * Returns the Phonebook engine.
       
    71          */
       
    72         virtual CPbkContactEngine& PbkEngine() = 0;
       
    73 
       
    74         /**
       
    75          * Called by a dialog page aPage when its state or contents
       
    76 		 * has changed.
       
    77          */
       
    78         virtual void FetchDlgPageChangedL(MPbkFetchDlgPage& aPage) = 0;        
       
    79 
       
    80     protected:
       
    81         /**
       
    82          * Protected destructor. Concrete fetch dialog objects are not
       
    83          * destroyed through this interface.
       
    84          */
       
    85         virtual ~MPbkFetchDlg() { }
       
    86     };
       
    87 
       
    88 #endif // __MPbkFetchDlg_H__
       
    89 
       
    90 // End of File