landmarksui/uicontrols/inc/MLmkListMemento.h
branchRCL_3
changeset 18 870918037e16
parent 0 522cd55cc3d7
equal deleted inserted replaced
17:1fc85118c3ae 18:870918037e16
       
     1 /*
       
     2 * Copyright (c) 2004 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:    LandmarksUi Content File -    Interface for storing and restoring listbox UI status
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 
       
    22 
       
    23 
       
    24 #ifndef MLMKLISTMEMENTO_H
       
    25 #define MLMKLISTMEMENTO_H
       
    26 
       
    27 //  INCLUDES
       
    28 #include <e32base.h>
       
    29 
       
    30 // FORWARD DECLARATIONS
       
    31 class CEikListBox;
       
    32 class CLmkListProviderBase;
       
    33 
       
    34 // CLASS DECLARATION
       
    35 
       
    36 /**
       
    37 * MLmkListMemento class. Interface for storing and restoring
       
    38 * listbox UI status (e.g. current item index).
       
    39 * Methods in this class are non-leaving since this functionality is
       
    40 * just supplementary, error situations should be handled by memento.
       
    41 */
       
    42 class MLmkListMemento
       
    43     {
       
    44     public: // Constructors and destructors
       
    45         /**
       
    46         * Destructor
       
    47         */
       
    48         virtual ~MLmkListMemento() {};
       
    49 
       
    50     public: // New functions
       
    51         /**
       
    52         * Store listbox state
       
    53         * @param aListbox
       
    54         * @param aProvider
       
    55         * @param aFiltered
       
    56         */
       
    57         virtual void Store( const CEikListBox& aListBox,
       
    58                             const CLmkListProviderBase& aProvider,
       
    59                             TBool aFiltered ) = 0;
       
    60 
       
    61         /**
       
    62         * Restore listbox state
       
    63         * @param aListbox
       
    64         * @param aProvider
       
    65         * @param aFiltered
       
    66         */
       
    67         virtual void Restore( const CEikListBox& aListBox,
       
    68                               const CLmkListProviderBase& aProvider,
       
    69                               TBool aFiltered ) = 0;
       
    70     };
       
    71 
       
    72 #endif      // MLMKLISTMEMENTO_H
       
    73 
       
    74 // End of File