videocollection/videocollectionwrapper/tsrc/testvideoproxymodelallvideos/stub/inc/videoproxymodelgeneric.h
author hgs
Mon, 20 Sep 2010 18:25:37 +0300
changeset 63 4707a0db12f6
parent 58 d2b028fd1f7d
permissions -rw-r--r--
201037
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
58
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: stub VideoProxyModelGeneric class definition
hgs
parents:
diff changeset
    15
* 
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef VIDEOPROXYMODELGENERIC_H
hgs
parents:
diff changeset
    19
#define VIDEOPROXYMODELGENERIC_H
hgs
parents:
diff changeset
    20
    
hgs
parents:
diff changeset
    21
// INCLUDES
hgs
parents:
diff changeset
    22
#include <e32const.h>
hgs
parents:
diff changeset
    23
#include <mpxitemid.h>
hgs
parents:
diff changeset
    24
#include <QModelIndex>
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
class VideoListDataModel;
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
// CLASS DECLARATION
hgs
parents:
diff changeset
    29
class VideoProxyModelGeneric : public QObject 
hgs
parents:
diff changeset
    30
{
hgs
parents:
diff changeset
    31
    Q_OBJECT
hgs
parents:
diff changeset
    32
    
hgs
parents:
diff changeset
    33
public: 
hgs
parents:
diff changeset
    34
    
hgs
parents:
diff changeset
    35
    /**
hgs
parents:
diff changeset
    36
     * Contructor.
hgs
parents:
diff changeset
    37
     *
hgs
parents:
diff changeset
    38
     * @param QObject parent object.
hgs
parents:
diff changeset
    39
     */
hgs
parents:
diff changeset
    40
    VideoProxyModelGeneric(QObject *parent = 0);
hgs
parents:
diff changeset
    41
    
hgs
parents:
diff changeset
    42
    /**
hgs
parents:
diff changeset
    43
     * Destructor.
hgs
parents:
diff changeset
    44
     *
hgs
parents:
diff changeset
    45
     */
hgs
parents:
diff changeset
    46
    virtual ~VideoProxyModelGeneric();
hgs
parents:
diff changeset
    47
63
hgs
parents: 58
diff changeset
    48
    /**
hgs
parents: 58
diff changeset
    49
     * Initializes model. Sets the given sourceModel as source model 
hgs
parents: 58
diff changeset
    50
     * for this proxy model.
hgs
parents: 58
diff changeset
    51
     * 
hgs
parents: 58
diff changeset
    52
     * @param sourceModel the source model
hgs
parents: 58
diff changeset
    53
     * 
hgs
parents: 58
diff changeset
    54
     * @return int 0 if initialization was ok. 
hgs
parents: 58
diff changeset
    55
     */
hgs
parents: 58
diff changeset
    56
    virtual int initialize(VideoListDataModel *sourceModel);
hgs
parents: 58
diff changeset
    57
58
hgs
parents:
diff changeset
    58
public:
hgs
parents:
diff changeset
    59
    
hgs
parents:
diff changeset
    60
    /**
hgs
parents:
diff changeset
    61
    * Opens the defined item. This is quite abstract as depending
hgs
parents:
diff changeset
    62
    * on the type of the item, the behaviour or result could be
hgs
parents:
diff changeset
    63
    * quite different.
hgs
parents:
diff changeset
    64
    * 
hgs
parents:
diff changeset
    65
    * @param item id id of the item to be opened
hgs
parents:
diff changeset
    66
    * @return int 0 succeeds, <0 if opening does not succeed.
hgs
parents:
diff changeset
    67
    */    
hgs
parents:
diff changeset
    68
    virtual int openItem(TMPXItemId mediaId);
hgs
parents:
diff changeset
    69
        
hgs
parents:
diff changeset
    70
	/**
hgs
parents:
diff changeset
    71
	 * Gets the currently opened item.
hgs
parents:
diff changeset
    72
	 * 
hgs
parents:
diff changeset
    73
	 * @param None.
hgs
parents:
diff changeset
    74
	 * @return TMPXItemId.
hgs
parents:
diff changeset
    75
	 */
hgs
parents:
diff changeset
    76
    virtual TMPXItemId getOpenItem() const;
hgs
parents:
diff changeset
    77
    
hgs
parents:
diff changeset
    78
    /**
hgs
parents:
diff changeset
    79
     * Compares items based in the role setted before sorting. From QSortFilterProxyModel.
hgs
parents:
diff changeset
    80
     *  
hgs
parents:
diff changeset
    81
     */
hgs
parents:
diff changeset
    82
    virtual bool lessThan(const QModelIndex & left, const QModelIndex & right) const;
hgs
parents:
diff changeset
    83
    
hgs
parents:
diff changeset
    84
    /**
hgs
parents:
diff changeset
    85
     * Filtering functionality. Called by the FW. From QSortFilterProxyModel.
hgs
parents:
diff changeset
    86
     *  
hgs
parents:
diff changeset
    87
     * @param source_row row to check
hgs
parents:
diff changeset
    88
     * @param source_parent row's parent
hgs
parents:
diff changeset
    89
     * 
hgs
parents:
diff changeset
    90
     * @return bool row accepted(true) or not accepted(false)
hgs
parents:
diff changeset
    91
     */
hgs
parents:
diff changeset
    92
    virtual bool filterAcceptsRow(int source_row, const QModelIndex & source_parent) const;
hgs
parents:
diff changeset
    93
hgs
parents:
diff changeset
    94
    /**
hgs
parents:
diff changeset
    95
     * Connects all signals emitted from or throught this object.
hgs
parents:
diff changeset
    96
     * 
hgs
parents:
diff changeset
    97
     * @return bool
hgs
parents:
diff changeset
    98
     */
hgs
parents:
diff changeset
    99
    virtual bool connectSignals();
hgs
parents:
diff changeset
   100
    
hgs
parents:
diff changeset
   101
    /**
hgs
parents:
diff changeset
   102
     * Disconnects all signals.
hgs
parents:
diff changeset
   103
     */
hgs
parents:
diff changeset
   104
    void disconnectSignals();
hgs
parents:
diff changeset
   105
    
hgs
parents:
diff changeset
   106
    /**
hgs
parents:
diff changeset
   107
     * Does actual sorting and emits sortingReady.
hgs
parents:
diff changeset
   108
     *  
hgs
parents:
diff changeset
   109
     */
hgs
parents:
diff changeset
   110
    virtual void processSorting();
hgs
parents:
diff changeset
   111
    
hgs
parents:
diff changeset
   112
    /**
hgs
parents:
diff changeset
   113
     * Returns sourceModel;
hgs
parents:
diff changeset
   114
     */
hgs
parents:
diff changeset
   115
    virtual const VideoListDataModel *sourceModel() const;
hgs
parents:
diff changeset
   116
    
63
hgs
parents: 58
diff changeset
   117
    /**
hgs
parents: 58
diff changeset
   118
     * sets item id filter used in generic proxy model
hgs
parents: 58
diff changeset
   119
     * while filtering rows. 
hgs
parents: 58
diff changeset
   120
     * 
hgs
parents: 58
diff changeset
   121
     * If provided filterValue -flag is true, we filter off items that 
hgs
parents: 58
diff changeset
   122
     * do not exist in container indicated as itemId. 
hgs
parents: 58
diff changeset
   123
     * If false, filtering works other way around. 
hgs
parents: 58
diff changeset
   124
     * 
hgs
parents: 58
diff changeset
   125
     * 
hgs
parents: 58
diff changeset
   126
     * @param filterValue item id used as filter
hgs
parents: 58
diff changeset
   127
     * @param filterValue
hgs
parents: 58
diff changeset
   128
     */
hgs
parents: 58
diff changeset
   129
    virtual void setGenericIdFilter(const TMPXItemId &itemId, bool filterValue);
hgs
parents: 58
diff changeset
   130
    
hgs
parents: 58
diff changeset
   131
    /**
hgs
parents: 58
diff changeset
   132
     * Set album in use and invalidates filtering.
hgs
parents: 58
diff changeset
   133
     * 
hgs
parents: 58
diff changeset
   134
     * @param albumId album id
hgs
parents: 58
diff changeset
   135
     */
hgs
parents: 58
diff changeset
   136
    virtual void setAlbumInUse(const TMPXItemId &albumId);
hgs
parents: 58
diff changeset
   137
    
58
hgs
parents:
diff changeset
   138
public:
hgs
parents:
diff changeset
   139
    static int mOpenItemCallCount;
hgs
parents:
diff changeset
   140
    static int mGetOpenItemCallCount;
hgs
parents:
diff changeset
   141
    static int mLessThanCallCount;
hgs
parents:
diff changeset
   142
    static int mFilterAcceptsRowCallCount;
hgs
parents:
diff changeset
   143
    static int mConnectSignalsCallCount;
hgs
parents:
diff changeset
   144
    static int mDisconnectSignalsCallCount;
hgs
parents:
diff changeset
   145
    static int mProcessSortingCallCount;
hgs
parents:
diff changeset
   146
hgs
parents:
diff changeset
   147
public:
hgs
parents:
diff changeset
   148
hgs
parents:
diff changeset
   149
    /**
hgs
parents:
diff changeset
   150
     * Pointer to the actual model.
hgs
parents:
diff changeset
   151
     */
hgs
parents:
diff changeset
   152
    VideoListDataModel *mModel;
hgs
parents:
diff changeset
   153
    
hgs
parents:
diff changeset
   154
    /**
hgs
parents:
diff changeset
   155
     * Collection client.
hgs
parents:
diff changeset
   156
     */
hgs
parents:
diff changeset
   157
    int mCollectionClient;
hgs
parents:
diff changeset
   158
};
hgs
parents:
diff changeset
   159
hgs
parents:
diff changeset
   160
#endif // VIDEOPROXYMODELGENERIC_H