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