contentstorage/casrv/cawidgetscanner/inc/cawidgetstoragehandler.h
author hgs
Fri, 30 Apr 2010 15:22:08 +0300
changeset 93 82b66994846c
parent 87 9d806967057c
child 94 dbb8300717f7
permissions -rw-r--r--
201017
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
*
93
hgs
parents: 87
diff changeset
    14
* Description:
85
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:
87
hgs
parents: 86
diff changeset
    41
    CA_STORAGE_TEST_FRIEND_CLASS    (T_CaWidgetScanner)
85
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
     */
93
hgs
parents: 87
diff changeset
    49
    static CCaWidgetStorageHandler* NewL( CCaStorageProxy* aStorage,
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    50
            RFs& aFs );
93
hgs
parents: 87
diff changeset
    51
    static CCaWidgetStorageHandler* NewLC( CCaStorageProxy* aStorage,
85
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();
93
hgs
parents: 87
diff changeset
    58
85
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
     */
93
hgs
parents: 87
diff changeset
    63
    void SynchronizeL( const RWidgetArray& aWidgets );
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    64
93
hgs
parents: 87
diff changeset
    65
85
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.
93
hgs
parents: 87
diff changeset
    70
     * @param aWidget widget to be added
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    71
     */
93
hgs
parents: 87
diff changeset
    72
    void AddL( const CCaWidgetDescription* aWidget );
85
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.
93
hgs
parents: 87
diff changeset
    76
     * @param aWidget widget to be updated
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    77
     */
93
hgs
parents: 87
diff changeset
    78
    void UpdateL( const CCaWidgetDescription* aWidget, TUint aEntryId );
hgs
parents: 87
diff changeset
    79
85
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 );
93
hgs
parents: 87
diff changeset
    85
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( ) ;
93
hgs
parents: 87
diff changeset
    90
85
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
     */
93
hgs
parents: 87
diff changeset
    94
    void FetchWidgetsL( );
85
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 );
93
hgs
parents: 87
diff changeset
   101
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   102
    /**
93
hgs
parents: 87
diff changeset
   103
     * Set missing flag for an entry.
hgs
parents: 87
diff changeset
   104
     * @param aWidget widget.
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   105
     */
93
hgs
parents: 87
diff changeset
   106
    void SetMissingFlagL( const CCaWidgetDescription * aWidget );
hgs
parents: 87
diff changeset
   107
hgs
parents: 87
diff changeset
   108
    /**
hgs
parents: 87
diff changeset
   109
     * Clear missing flag for an entry.
hgs
parents: 87
diff changeset
   110
     * @param aWidget widget.
hgs
parents: 87
diff changeset
   111
     */
hgs
parents: 87
diff changeset
   112
    void ClearVisibleFlagL( const CCaWidgetDescription* aWidget );
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   113
7feec50967db 201003_02
hgs
parents:
diff changeset
   114
private:
7feec50967db 201003_02
hgs
parents:
diff changeset
   115
7feec50967db 201003_02
hgs
parents:
diff changeset
   116
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   117
     * C++ default constructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
   118
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   119
    CCaWidgetStorageHandler( CCaStorageProxy* aStorage, RFs& aFs );
7feec50967db 201003_02
hgs
parents:
diff changeset
   120
7feec50967db 201003_02
hgs
parents:
diff changeset
   121
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   122
     * By default Symbian 2nd phase constructor is private.
7feec50967db 201003_02
hgs
parents:
diff changeset
   123
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   124
    void ConstructL( );
7feec50967db 201003_02
hgs
parents:
diff changeset
   125
93
hgs
parents: 87
diff changeset
   126
    /**
hgs
parents: 87
diff changeset
   127
     * Check if mass storage is not in use.
hgs
parents: 87
diff changeset
   128
     * @return true if mass storage is not in use.
hgs
parents: 87
diff changeset
   129
     */
hgs
parents: 87
diff changeset
   130
    TBool MassStorageNotInUse();
hgs
parents: 87
diff changeset
   131
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   132
private:
93
hgs
parents: 87
diff changeset
   133
    // Data
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   134
7feec50967db 201003_02
hgs
parents:
diff changeset
   135
    /*
7feec50967db 201003_02
hgs
parents:
diff changeset
   136
     * Content Storage. Not Own
7feec50967db 201003_02
hgs
parents:
diff changeset
   137
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   138
    CCaStorageProxy* iStorage;
93
hgs
parents: 87
diff changeset
   139
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   140
    /*
7feec50967db 201003_02
hgs
parents:
diff changeset
   141
     * File server. Not own
7feec50967db 201003_02
hgs
parents:
diff changeset
   142
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   143
    RFs iFs;
93
hgs
parents: 87
diff changeset
   144
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   145
    /*
7feec50967db 201003_02
hgs
parents:
diff changeset
   146
     * Widgets. Own.
7feec50967db 201003_02
hgs
parents:
diff changeset
   147
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   148
    RWidgetArray iWidgets;
93
hgs
parents: 87
diff changeset
   149
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   150
    /*
7feec50967db 201003_02
hgs
parents:
diff changeset
   151
     * Indexes updated during last add operation. Own.
7feec50967db 201003_02
hgs
parents:
diff changeset
   152
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   153
    RArray<TInt> iUpdatedIndexes;
93
hgs
parents: 87
diff changeset
   154
hgs
parents: 87
diff changeset
   155
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   156
    };
7feec50967db 201003_02
hgs
parents:
diff changeset
   157
7feec50967db 201003_02
hgs
parents:
diff changeset
   158
#endif      // C_WIDGETSTORAGEHANDLER_H
7feec50967db 201003_02
hgs
parents:
diff changeset
   159
// End of File