contentstorage/casrv/cawidgetscanner/inc/cawidgetstoragehandler.h
author hgs
Tue, 23 Mar 2010 23:17:02 +0200
changeset 85 7feec50967db
child 86 e492551a0d54
permissions -rw-r--r--
201003_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
85
7feec50967db 201003_02
hgs
parents:
diff changeset
     1
/*
7feec50967db 201003_02
hgs
parents:
diff changeset
     2
* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
7feec50967db 201003_02
hgs
parents:
diff changeset
     3
* All rights reserved.
7feec50967db 201003_02
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
7feec50967db 201003_02
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
7feec50967db 201003_02
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
7feec50967db 201003_02
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
7feec50967db 201003_02
hgs
parents:
diff changeset
     8
*
7feec50967db 201003_02
hgs
parents:
diff changeset
     9
* Initial Contributors:
7feec50967db 201003_02
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
7feec50967db 201003_02
hgs
parents:
diff changeset
    11
*
7feec50967db 201003_02
hgs
parents:
diff changeset
    12
* Contributors:
7feec50967db 201003_02
hgs
parents:
diff changeset
    13
*
7feec50967db 201003_02
hgs
parents:
diff changeset
    14
* Description:  
7feec50967db 201003_02
hgs
parents:
diff changeset
    15
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
    16
*/
7feec50967db 201003_02
hgs
parents:
diff changeset
    17
7feec50967db 201003_02
hgs
parents:
diff changeset
    18
7feec50967db 201003_02
hgs
parents:
diff changeset
    19
#ifndef C_WIDGETSTORAGEHANDLER_H
7feec50967db 201003_02
hgs
parents:
diff changeset
    20
#define C_WIDGETSTORAGEHANDLER_H
7feec50967db 201003_02
hgs
parents:
diff changeset
    21
7feec50967db 201003_02
hgs
parents:
diff changeset
    22
class CCaStorageProxy;
7feec50967db 201003_02
hgs
parents:
diff changeset
    23
class CCaWidgetDescription;
7feec50967db 201003_02
hgs
parents:
diff changeset
    24
7feec50967db 201003_02
hgs
parents:
diff changeset
    25
//  INCLUDES
7feec50967db 201003_02
hgs
parents:
diff changeset
    26
#include <e32base.h>
7feec50967db 201003_02
hgs
parents:
diff changeset
    27
#include "cawidgetdescription.h"
7feec50967db 201003_02
hgs
parents:
diff changeset
    28
#include "castorage_global.h"
7feec50967db 201003_02
hgs
parents:
diff changeset
    29
// CONSTANTS
7feec50967db 201003_02
hgs
parents:
diff changeset
    30
7feec50967db 201003_02
hgs
parents:
diff changeset
    31
// FORWARD DECLARATIONS
7feec50967db 201003_02
hgs
parents:
diff changeset
    32
7feec50967db 201003_02
hgs
parents:
diff changeset
    33
/**
7feec50967db 201003_02
hgs
parents:
diff changeset
    34
 *  Widget Parser
7feec50967db 201003_02
hgs
parents:
diff changeset
    35
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
    36
 *  @since Series Series60 5.x
7feec50967db 201003_02
hgs
parents:
diff changeset
    37
 */
7feec50967db 201003_02
hgs
parents:
diff changeset
    38
class CCaWidgetStorageHandler : public CBase
7feec50967db 201003_02
hgs
parents:
diff changeset
    39
    {
7feec50967db 201003_02
hgs
parents:
diff changeset
    40
public:
7feec50967db 201003_02
hgs
parents:
diff changeset
    41
	CA_STORAGE_TEST_FRIEND_CLASS    (T_CaHSWidgetScanner)
7feec50967db 201003_02
hgs
parents:
diff changeset
    42
7feec50967db 201003_02
hgs
parents:
diff changeset
    43
public:
7feec50967db 201003_02
hgs
parents:
diff changeset
    44
    // Constructors and destructor
7feec50967db 201003_02
hgs
parents:
diff changeset
    45
7feec50967db 201003_02
hgs
parents:
diff changeset
    46
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    47
     * Two-phased constructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
    48
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    49
    static CCaWidgetStorageHandler* NewL( CCaStorageProxy* aStorage, 
7feec50967db 201003_02
hgs
parents:
diff changeset
    50
            RFs& aFs );
7feec50967db 201003_02
hgs
parents:
diff changeset
    51
    static CCaWidgetStorageHandler* NewLC( CCaStorageProxy* aStorage, 
7feec50967db 201003_02
hgs
parents:
diff changeset
    52
            RFs& aFs );
7feec50967db 201003_02
hgs
parents:
diff changeset
    53
7feec50967db 201003_02
hgs
parents:
diff changeset
    54
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    55
     * Destructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
    56
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    57
    virtual ~CCaWidgetStorageHandler();
7feec50967db 201003_02
hgs
parents:
diff changeset
    58
 
7feec50967db 201003_02
hgs
parents:
diff changeset
    59
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    60
     * Synchronizes widgets
7feec50967db 201003_02
hgs
parents:
diff changeset
    61
     * @param aWidgets widgets to synchronize
7feec50967db 201003_02
hgs
parents:
diff changeset
    62
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    63
    void SynchronizeL( const RWidgetArray& aWidgets ); 
7feec50967db 201003_02
hgs
parents:
diff changeset
    64
7feec50967db 201003_02
hgs
parents:
diff changeset
    65
    
7feec50967db 201003_02
hgs
parents:
diff changeset
    66
private:
7feec50967db 201003_02
hgs
parents:
diff changeset
    67
7feec50967db 201003_02
hgs
parents:
diff changeset
    68
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    69
     * Adds widget to storage.
7feec50967db 201003_02
hgs
parents:
diff changeset
    70
     * @param aWidget widget to be added 
7feec50967db 201003_02
hgs
parents:
diff changeset
    71
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    72
    void AddL( const CCaWidgetDescription* aWidget ); 
7feec50967db 201003_02
hgs
parents:
diff changeset
    73
7feec50967db 201003_02
hgs
parents:
diff changeset
    74
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    75
     * Updates widget in storage.
7feec50967db 201003_02
hgs
parents:
diff changeset
    76
     * @param aWidget widget to be updated 
7feec50967db 201003_02
hgs
parents:
diff changeset
    77
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    78
    void UpdateL( const CCaWidgetDescription* aWidget, TUint aEntryId ); 
7feec50967db 201003_02
hgs
parents:
diff changeset
    79
    
7feec50967db 201003_02
hgs
parents:
diff changeset
    80
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    81
     * Add/Updates widgets in DB
7feec50967db 201003_02
hgs
parents:
diff changeset
    82
     * @param aWidgets widgets to add
7feec50967db 201003_02
hgs
parents:
diff changeset
    83
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    84
    void AddWidgetsL( const RWidgetArray& aWidgets );
7feec50967db 201003_02
hgs
parents:
diff changeset
    85
 
7feec50967db 201003_02
hgs
parents:
diff changeset
    86
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    87
     * Removes widgets from DB
7feec50967db 201003_02
hgs
parents:
diff changeset
    88
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    89
    void RemoveWidgetsL( ) ;
7feec50967db 201003_02
hgs
parents:
diff changeset
    90
    
7feec50967db 201003_02
hgs
parents:
diff changeset
    91
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    92
     * Fetch widgets from content storage
7feec50967db 201003_02
hgs
parents:
diff changeset
    93
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    94
    void FetchWidgetsL( ); 
7feec50967db 201003_02
hgs
parents:
diff changeset
    95
7feec50967db 201003_02
hgs
parents:
diff changeset
    96
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    97
     * Add widget to download collection
7feec50967db 201003_02
hgs
parents:
diff changeset
    98
     * @param aEntry entry containing widget information
7feec50967db 201003_02
hgs
parents:
diff changeset
    99
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   100
    void AddWidgetToDownloadCollectionL( const CCaInnerEntry* aEntry );
7feec50967db 201003_02
hgs
parents:
diff changeset
   101
    
7feec50967db 201003_02
hgs
parents:
diff changeset
   102
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   103
     * Sets missing flag for an entry
7feec50967db 201003_02
hgs
parents:
diff changeset
   104
     * @param aWidget widget
7feec50967db 201003_02
hgs
parents:
diff changeset
   105
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   106
    void SetMissingFlagL( const CCaWidgetDescription * aWidget ); 
7feec50967db 201003_02
hgs
parents:
diff changeset
   107
7feec50967db 201003_02
hgs
parents:
diff changeset
   108
private:
7feec50967db 201003_02
hgs
parents:
diff changeset
   109
7feec50967db 201003_02
hgs
parents:
diff changeset
   110
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   111
     * C++ default constructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
   112
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   113
    CCaWidgetStorageHandler( CCaStorageProxy* aStorage, RFs& aFs );
7feec50967db 201003_02
hgs
parents:
diff changeset
   114
7feec50967db 201003_02
hgs
parents:
diff changeset
   115
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   116
     * By default Symbian 2nd phase constructor is private.
7feec50967db 201003_02
hgs
parents:
diff changeset
   117
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   118
    void ConstructL( );
7feec50967db 201003_02
hgs
parents:
diff changeset
   119
7feec50967db 201003_02
hgs
parents:
diff changeset
   120
private:
7feec50967db 201003_02
hgs
parents:
diff changeset
   121
    // Data    
7feec50967db 201003_02
hgs
parents:
diff changeset
   122
7feec50967db 201003_02
hgs
parents:
diff changeset
   123
    /*
7feec50967db 201003_02
hgs
parents:
diff changeset
   124
     * Content Storage. Not Own
7feec50967db 201003_02
hgs
parents:
diff changeset
   125
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   126
    CCaStorageProxy* iStorage;
7feec50967db 201003_02
hgs
parents:
diff changeset
   127
    
7feec50967db 201003_02
hgs
parents:
diff changeset
   128
    /*
7feec50967db 201003_02
hgs
parents:
diff changeset
   129
     * File server. Not own
7feec50967db 201003_02
hgs
parents:
diff changeset
   130
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   131
    RFs iFs;
7feec50967db 201003_02
hgs
parents:
diff changeset
   132
    
7feec50967db 201003_02
hgs
parents:
diff changeset
   133
    /*
7feec50967db 201003_02
hgs
parents:
diff changeset
   134
     * Widgets. Own.
7feec50967db 201003_02
hgs
parents:
diff changeset
   135
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   136
    RWidgetArray iWidgets;
7feec50967db 201003_02
hgs
parents:
diff changeset
   137
    
7feec50967db 201003_02
hgs
parents:
diff changeset
   138
    /*
7feec50967db 201003_02
hgs
parents:
diff changeset
   139
     * Indexes updated during last add operation. Own.
7feec50967db 201003_02
hgs
parents:
diff changeset
   140
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   141
    RArray<TInt> iUpdatedIndexes;
7feec50967db 201003_02
hgs
parents:
diff changeset
   142
    
7feec50967db 201003_02
hgs
parents:
diff changeset
   143
    
7feec50967db 201003_02
hgs
parents:
diff changeset
   144
    };
7feec50967db 201003_02
hgs
parents:
diff changeset
   145
7feec50967db 201003_02
hgs
parents:
diff changeset
   146
#endif      // C_WIDGETSTORAGEHANDLER_H
7feec50967db 201003_02
hgs
parents:
diff changeset
   147
// End of File