videocollection/videocollectionwrapper/inc/videodeleteworker.h
author hgs
Fri, 03 Sep 2010 12:37:43 +0300
changeset 58 d2b028fd1f7d
parent 50 21fe8338c6bf
permissions -rw-r--r--
201035
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
34
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description: VideoDeleteWorker class definition*
hgs
parents:
diff changeset
    15
*/
hgs
parents:
diff changeset
    16
hgs
parents:
diff changeset
    17
#ifndef __VIDEODELETEWORKER_H__
hgs
parents:
diff changeset
    18
#define __VIDEODELETEWORKER_H__
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
// INCLUDES
hgs
parents:
diff changeset
    22
#include <QObject>
hgs
parents:
diff changeset
    23
#include <qvariant.h>
hgs
parents:
diff changeset
    24
#include <qset.h>
hgs
parents:
diff changeset
    25
#include <qlist.h>
hgs
parents:
diff changeset
    26
#include <e32const.h>
hgs
parents:
diff changeset
    27
#include <mpxitemid.h>
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
// FORWARD DECLARATIONS
hgs
parents:
diff changeset
    30
class QTimer;
hgs
parents:
diff changeset
    31
class VideoListDataModelPrivate;
hgs
parents:
diff changeset
    32
class VideoCollectionClient;
hgs
parents:
diff changeset
    33
hgs
parents:
diff changeset
    34
hgs
parents:
diff changeset
    35
class VideoDeleteWorker : public QObject
hgs
parents:
diff changeset
    36
{    
hgs
parents:
diff changeset
    37
    /**
hgs
parents:
diff changeset
    38
     * define to be able to use signals and slots
hgs
parents:
diff changeset
    39
     */
hgs
parents:
diff changeset
    40
    Q_OBJECT
hgs
parents:
diff changeset
    41
    
hgs
parents:
diff changeset
    42
    /**
hgs
parents:
diff changeset
    43
     * disable copy-constructor and assignment operator
hgs
parents:
diff changeset
    44
     */
hgs
parents:
diff changeset
    45
	Q_DISABLE_COPY(VideoDeleteWorker) 
hgs
parents:
diff changeset
    46
    
hgs
parents:
diff changeset
    47
public: 
hgs
parents:
diff changeset
    48
hgs
parents:
diff changeset
    49
	/**
hgs
parents:
diff changeset
    50
	 * Default constructor
hgs
parents:
diff changeset
    51
     */
hgs
parents:
diff changeset
    52
    VideoDeleteWorker(VideoCollectionClient &collection, QObject *parent = 0);	
hgs
parents:
diff changeset
    53
	
hgs
parents:
diff changeset
    54
	/**
hgs
parents:
diff changeset
    55
     * Destructor
hgs
parents:
diff changeset
    56
     */
hgs
parents:
diff changeset
    57
	~VideoDeleteWorker();
hgs
parents:
diff changeset
    58
	
hgs
parents:
diff changeset
    59
	/**
hgs
parents:
diff changeset
    60
	 * Sets items into mRemoveBuffer. And starts deleting of items in 
hgs
parents:
diff changeset
    61
	 * blocks using mRequestWaitTimer interval
hgs
parents:
diff changeset
    62
	 * 
hgs
parents:
diff changeset
    63
	 * @param itemList items to be deleted
hgs
parents:
diff changeset
    64
	 */
hgs
parents:
diff changeset
    65
	void requestDelete(const QList<TMPXItemId> &itemList);
hgs
parents:
diff changeset
    66
	
hgs
parents:
diff changeset
    67
	/**
hgs
parents:
diff changeset
    68
	 * Removes item from the delete and pending buffer
hgs
parents:
diff changeset
    69
	 * 
hgs
parents:
diff changeset
    70
	 * @param itemId item id to removed
hgs
parents:
diff changeset
    71
	 * 
hgs
parents:
diff changeset
    72
	 * @returns a coutn of remaining requests
hgs
parents:
diff changeset
    73
	 */
hgs
parents:
diff changeset
    74
	int removeFromRequest(TMPXItemId &itemId);
hgs
parents:
diff changeset
    75
	
hgs
parents:
diff changeset
    76
	/**
hgs
parents:
diff changeset
    77
	 * returns true in case there are items at the delete buffer 
hgs
parents:
diff changeset
    78
	 * 
hgs
parents:
diff changeset
    79
	 * @return bool
hgs
parents:
diff changeset
    80
	 */
hgs
parents:
diff changeset
    81
	bool isDeleting();
hgs
parents:
diff changeset
    82
	
hgs
parents:
diff changeset
    83
	/**
hgs
parents:
diff changeset
    84
	 * Updates error status
hgs
parents:
diff changeset
    85
	 * 
hgs
parents:
diff changeset
    86
	 * @param status value to update
hgs
parents:
diff changeset
    87
	 * @param data data to update
hgs
parents:
diff changeset
    88
	 * 
hgs
parents:
diff changeset
    89
	 */
hgs
parents:
diff changeset
    90
	void updateStatus(int status, QVariant data);
hgs
parents:
diff changeset
    91
	
hgs
parents:
diff changeset
    92
	/**
hgs
parents:
diff changeset
    93
	 * returns latest status and data
hgs
parents:
diff changeset
    94
	 * 
hgs
parents:
diff changeset
    95
	 * @param data to return
hgs
parents:
diff changeset
    96
	 * 
hgs
parents:
diff changeset
    97
	 * @return status code
hgs
parents:
diff changeset
    98
	 */
hgs
parents:
diff changeset
    99
	int getLastStatus(QVariant &data);
hgs
parents:
diff changeset
   100
	
hgs
parents:
diff changeset
   101
	/**
hgs
parents:
diff changeset
   102
	 * method resets status and statusdatas
hgs
parents:
diff changeset
   103
	 */
hgs
parents:
diff changeset
   104
	void clearStatus();
hgs
parents:
diff changeset
   105
	
hgs
parents:
diff changeset
   106
public slots:
hgs
parents:
diff changeset
   107
hgs
parents:
diff changeset
   108
	/**
hgs
parents:
diff changeset
   109
     * Continues deleting in case there are items 
hgs
parents:
diff changeset
   110
     * yet to be deleted
hgs
parents:
diff changeset
   111
     */
hgs
parents:
diff changeset
   112
    void continueSlot();
hgs
parents:
diff changeset
   113
	
hgs
parents:
diff changeset
   114
private:
hgs
parents:
diff changeset
   115
	
hgs
parents:
diff changeset
   116
	/**
hgs
parents:
diff changeset
   117
	 * methods dumps all remaining deletes to collection
hgs
parents:
diff changeset
   118
	 * without caring the result codes.
hgs
parents:
diff changeset
   119
	 */
hgs
parents:
diff changeset
   120
	void flushAll();
hgs
parents:
diff changeset
   121
		
hgs
parents:
diff changeset
   122
private slots:
hgs
parents:
diff changeset
   123
hgs
parents:
diff changeset
   124
    /**
hgs
parents:
diff changeset
   125
     * creates a block of deleted items and calls collection 
hgs
parents:
diff changeset
   126
     * to startup deletion
hgs
parents:
diff changeset
   127
     */
hgs
parents:
diff changeset
   128
    void execDeleteBlockSlot();
hgs
parents:
diff changeset
   129
    
hgs
parents:
diff changeset
   130
    
hgs
parents:
diff changeset
   131
    
hgs
parents:
diff changeset
   132
signals:
hgs
parents:
diff changeset
   133
    
hgs
parents:
diff changeset
   134
    /**
hgs
parents:
diff changeset
   135
     * Emitted if some delete startup fails.
hgs
parents:
diff changeset
   136
     * 
50
hgs
parents: 34
diff changeset
   137
     * @param list of item ids whose deletion does not start
34
hgs
parents:
diff changeset
   138
     */
50
hgs
parents: 34
diff changeset
   139
    void deleteStartupFailed(QList<TMPXItemId>&);
34
hgs
parents:
diff changeset
   140
	
hgs
parents:
diff changeset
   141
private:
hgs
parents:
diff changeset
   142
    
hgs
parents:
diff changeset
   143
	/**
hgs
parents:
diff changeset
   144
     * reference to collection client.
hgs
parents:
diff changeset
   145
     * Not own.
hgs
parents:
diff changeset
   146
     */
hgs
parents:
diff changeset
   147
    VideoCollectionClient &mCollectionClient;
hgs
parents:
diff changeset
   148
	
hgs
parents:
diff changeset
   149
	/**
hgs
parents:
diff changeset
   150
	 * buffer for items to be removed 
hgs
parents:
diff changeset
   151
	 */
hgs
parents:
diff changeset
   152
	QSet<TMPXItemId> mRemoveBuffer;
hgs
parents:
diff changeset
   153
	
hgs
parents:
diff changeset
   154
	/**
hgs
parents:
diff changeset
   155
	 * timer whose interval is used between delete 
hgs
parents:
diff changeset
   156
	 * requests to collection
hgs
parents:
diff changeset
   157
	 */
hgs
parents:
diff changeset
   158
	QTimer *mRequestWaitTimer;
hgs
parents:
diff changeset
   159
	
hgs
parents:
diff changeset
   160
	/**
hgs
parents:
diff changeset
   161
	 * last error status 
hgs
parents:
diff changeset
   162
	 */
hgs
parents:
diff changeset
   163
	int mLastStatus;
hgs
parents:
diff changeset
   164
	
hgs
parents:
diff changeset
   165
	/**
hgs
parents:
diff changeset
   166
	 * last error data 
hgs
parents:
diff changeset
   167
	 */
hgs
parents:
diff changeset
   168
	QVariant mLastStatusData;
hgs
parents:
diff changeset
   169
   
hgs
parents:
diff changeset
   170
};
hgs
parents:
diff changeset
   171
#endif  // __VIDEODELETEWORKER_H__
hgs
parents:
diff changeset
   172
hgs
parents:
diff changeset
   173
// End of file
hgs
parents:
diff changeset
   174
    
hgs
parents:
diff changeset
   175
hgs
parents:
diff changeset
   176