videocollection/videocollectionview/inc/videocollectionuiloader.h
author hgs
Fri, 16 Apr 2010 18:13:14 +0300
changeset 36 8aed59de29f9
parent 35 3738fe97f027
child 38 ff53afa8ad05
permissions -rw-r--r--
201015
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
30
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:
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef _VIDEOCOLLECTIONUILOADER_H_
hgs
parents:
diff changeset
    19
#define _VIDEOCOLLECTIONUILOADER_H_
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
// System includes
hgs
parents:
diff changeset
    22
#include <hbdocumentloader.h>
34
hgs
parents: 30
diff changeset
    23
#include <qhash.h>
hgs
parents: 30
diff changeset
    24
#include <qmap.h>
36
hgs
parents: 35
diff changeset
    25
#include <qset.h>
30
hgs
parents:
diff changeset
    26
36
hgs
parents: 35
diff changeset
    27
#include "videocollectionuiloaderdef.h"
35
hgs
parents: 34
diff changeset
    28
hgs
parents: 34
diff changeset
    29
// Forward declarations
34
hgs
parents: 30
diff changeset
    30
class QActionGroup;
hgs
parents: 30
diff changeset
    31
class HbAction;
30
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
// Class declaration
34
hgs
parents: 30
diff changeset
    34
class VideoCollectionUiLoader:
hgs
parents: 30
diff changeset
    35
    public QObject,
hgs
parents: 30
diff changeset
    36
    public HbDocumentLoader
30
hgs
parents:
diff changeset
    37
{
34
hgs
parents: 30
diff changeset
    38
    Q_OBJECT
hgs
parents: 30
diff changeset
    39
    
36
hgs
parents: 35
diff changeset
    40
public:
34
hgs
parents: 30
diff changeset
    41
    /** actions used in menus and toolbars */
hgs
parents: 30
diff changeset
    42
    enum ActionIds
hgs
parents: 30
diff changeset
    43
    {
hgs
parents: 30
diff changeset
    44
        EActionSortBy          =  1,
hgs
parents: 30
diff changeset
    45
        EActionSortByDate,
hgs
parents: 30
diff changeset
    46
        EActionSortByName,
hgs
parents: 30
diff changeset
    47
        EACtionSortByItemCount,
hgs
parents: 30
diff changeset
    48
        EActionSortBySize,
hgs
parents: 30
diff changeset
    49
        EActionNewCollection,
hgs
parents: 30
diff changeset
    50
        EActionAddToCollection,
hgs
parents: 30
diff changeset
    51
        EActionDelete,
hgs
parents: 30
diff changeset
    52
        ETBActionAllVideos,
hgs
parents: 30
diff changeset
    53
        ETBActionCollections,
hgs
parents: 30
diff changeset
    54
        ETBActionServices,
hgs
parents: 30
diff changeset
    55
        ETBActionAddVideos,
35
hgs
parents: 34
diff changeset
    56
        ETBActionRemoveVideos
34
hgs
parents: 30
diff changeset
    57
    };
hgs
parents: 30
diff changeset
    58
    
30
hgs
parents:
diff changeset
    59
public:
34
hgs
parents: 30
diff changeset
    60
    /**
hgs
parents: 30
diff changeset
    61
     * C++ constructor.
hgs
parents: 30
diff changeset
    62
     */
30
hgs
parents:
diff changeset
    63
    VideoCollectionUiLoader();
34
hgs
parents: 30
diff changeset
    64
    
hgs
parents: 30
diff changeset
    65
    /**
hgs
parents: 30
diff changeset
    66
     * C++ destructor.
hgs
parents: 30
diff changeset
    67
     */
hgs
parents: 30
diff changeset
    68
    virtual ~VideoCollectionUiLoader();
hgs
parents: 30
diff changeset
    69
    
hgs
parents: 30
diff changeset
    70
    /**
36
hgs
parents: 35
diff changeset
    71
     * Adds data to ui loader loading queue.
34
hgs
parents: 30
diff changeset
    72
     */
36
hgs
parents: 35
diff changeset
    73
    void addData(QList<VideoCollectionUiLoaderParam> params,
34
hgs
parents: 30
diff changeset
    74
        QObject *receiver,
36
hgs
parents: 35
diff changeset
    75
        const char *slot);
hgs
parents: 35
diff changeset
    76
    
30
hgs
parents:
diff changeset
    77
    /**
hgs
parents:
diff changeset
    78
     * Returns the requested widget casted to correct type
hgs
parents:
diff changeset
    79
     *
hgs
parents:
diff changeset
    80
     * @param name Name of the widget
hgs
parents:
diff changeset
    81
     * @return Pointer to the widget
hgs
parents:
diff changeset
    82
     */
hgs
parents:
diff changeset
    83
    template<class T>
34
hgs
parents: 30
diff changeset
    84
    T* findWidget(const QString &name)
30
hgs
parents:
diff changeset
    85
    {
34
hgs
parents: 30
diff changeset
    86
        return qobject_cast<T*>(doFindWidget(name));
30
hgs
parents:
diff changeset
    87
    }
hgs
parents:
diff changeset
    88
hgs
parents:
diff changeset
    89
    /**
hgs
parents:
diff changeset
    90
     * Returns the requested object casted to correct type
hgs
parents:
diff changeset
    91
     *
hgs
parents:
diff changeset
    92
     * @param name Name of the object
hgs
parents:
diff changeset
    93
     * @return Pointer to the object
hgs
parents:
diff changeset
    94
     */
hgs
parents:
diff changeset
    95
    template<class T>
34
hgs
parents: 30
diff changeset
    96
    T* findObject(const QString &name)
30
hgs
parents:
diff changeset
    97
    {
34
hgs
parents: 30
diff changeset
    98
        return qobject_cast<T*>(doFindObject(name));
30
hgs
parents:
diff changeset
    99
    }
34
hgs
parents: 30
diff changeset
   100
    
hgs
parents: 30
diff changeset
   101
    /**
hgs
parents: 30
diff changeset
   102
     * Set video services in use.
hgs
parents: 30
diff changeset
   103
     */
hgs
parents: 30
diff changeset
   104
    void setIsService(bool isService);
35
hgs
parents: 34
diff changeset
   105
    
hgs
parents: 34
diff changeset
   106
    /**
hgs
parents: 34
diff changeset
   107
     * load
hgs
parents: 34
diff changeset
   108
     */
36
hgs
parents: 35
diff changeset
   109
    void load(const QString &fileName, bool *ok = 0);
35
hgs
parents: 34
diff changeset
   110
hgs
parents: 34
diff changeset
   111
    /**
hgs
parents: 34
diff changeset
   112
     * load
hgs
parents: 34
diff changeset
   113
     */
36
hgs
parents: 35
diff changeset
   114
    void load(const QString &fileName, const QString &section , bool *ok = 0);
hgs
parents: 35
diff changeset
   115
    
hgs
parents: 35
diff changeset
   116
public slots:
34
hgs
parents: 30
diff changeset
   117
    /**
36
hgs
parents: 35
diff changeset
   118
     * Starts loading ui components belonging to the defined phase.
34
hgs
parents: 30
diff changeset
   119
     */
36
hgs
parents: 35
diff changeset
   120
    void loadPhase(int loadPhase);
hgs
parents: 35
diff changeset
   121
    
hgs
parents: 35
diff changeset
   122
private slots:
hgs
parents: 35
diff changeset
   123
    /**
hgs
parents: 35
diff changeset
   124
     * Remove object from list since it has been already deleted.
hgs
parents: 35
diff changeset
   125
     */
hgs
parents: 35
diff changeset
   126
    void removeOrphanFromList(QObject *object);
hgs
parents: 35
diff changeset
   127
    
hgs
parents: 35
diff changeset
   128
signals:
34
hgs
parents: 30
diff changeset
   129
    /**
hgs
parents: 30
diff changeset
   130
     * Signals that object has been loaded asynchonously.
hgs
parents: 30
diff changeset
   131
     * 
hgs
parents: 30
diff changeset
   132
     * @param object, Object which was loaded.
hgs
parents: 30
diff changeset
   133
     * @param name, Name of the object in document.
hgs
parents: 30
diff changeset
   134
     * @return None.
hgs
parents: 30
diff changeset
   135
     */
hgs
parents: 30
diff changeset
   136
    void objectReady(QObject *object, const QString &name);
36
hgs
parents: 35
diff changeset
   137
    
hgs
parents: 35
diff changeset
   138
protected:
34
hgs
parents: 30
diff changeset
   139
hgs
parents: 30
diff changeset
   140
    /**
hgs
parents: 30
diff changeset
   141
     * Loads widget from document.
hgs
parents: 30
diff changeset
   142
     * 
hgs
parents: 30
diff changeset
   143
     * @param name, Widget name.
hgs
parents: 30
diff changeset
   144
     * @return QGraphicsWidget*.
hgs
parents: 30
diff changeset
   145
     */
hgs
parents: 30
diff changeset
   146
    QGraphicsWidget* doFindWidget(const QString &name);
hgs
parents: 30
diff changeset
   147
    
hgs
parents: 30
diff changeset
   148
    /**
hgs
parents: 30
diff changeset
   149
     * Loads object from document.
hgs
parents: 30
diff changeset
   150
     * 
36
hgs
parents: 35
diff changeset
   151
     * @param name, Object name.
hgs
parents: 35
diff changeset
   152
     * @return QObject*.
34
hgs
parents: 30
diff changeset
   153
     */
hgs
parents: 30
diff changeset
   154
    QObject* doFindObject(const QString &name);
hgs
parents: 30
diff changeset
   155
    
hgs
parents: 30
diff changeset
   156
    /**
hgs
parents: 30
diff changeset
   157
     * Adds a ui section to async loading queue.
hgs
parents: 30
diff changeset
   158
     */
36
hgs
parents: 35
diff changeset
   159
    void addToQueue(VideoCollectionUiLoaderParam &param,
hgs
parents: 35
diff changeset
   160
        QObject *receiver,
hgs
parents: 35
diff changeset
   161
        const char *slot);
34
hgs
parents: 30
diff changeset
   162
    
hgs
parents: 30
diff changeset
   163
    /**
36
hgs
parents: 35
diff changeset
   164
     * Finds an object or widget from docml based on the parameter.
34
hgs
parents: 30
diff changeset
   165
     */
36
hgs
parents: 35
diff changeset
   166
    QObject* getObject(const VideoCollectionUiLoaderParam &param);
hgs
parents: 35
diff changeset
   167
    
hgs
parents: 35
diff changeset
   168
    /**
hgs
parents: 35
diff changeset
   169
     * Loads and prepares docml and sections if found from param.
hgs
parents: 35
diff changeset
   170
     */
hgs
parents: 35
diff changeset
   171
    bool prepareDocmlAndSection(const char *docml, const char *section);
34
hgs
parents: 30
diff changeset
   172
    
hgs
parents: 30
diff changeset
   173
    /**
hgs
parents: 30
diff changeset
   174
     * Init a specific object.
hgs
parents: 30
diff changeset
   175
     */
36
hgs
parents: 35
diff changeset
   176
    void initObject(QObject *object, const QString& name);
hgs
parents: 35
diff changeset
   177
    
hgs
parents: 35
diff changeset
   178
    /**
hgs
parents: 35
diff changeset
   179
     * Execute ui loader request.
hgs
parents: 35
diff changeset
   180
     */
hgs
parents: 35
diff changeset
   181
    QObject* executeRequest(const VideoCollectionUiLoaderParam &param);
hgs
parents: 35
diff changeset
   182
    
hgs
parents: 35
diff changeset
   183
    /**
hgs
parents: 35
diff changeset
   184
     * Gets index of the item in queue, if one found.
hgs
parents: 35
diff changeset
   185
     */
hgs
parents: 35
diff changeset
   186
    int indexInQueue(const QString &name);
hgs
parents: 35
diff changeset
   187
    
hgs
parents: 35
diff changeset
   188
    /**
hgs
parents: 35
diff changeset
   189
     * Removes request from queue.
hgs
parents: 35
diff changeset
   190
     */
hgs
parents: 35
diff changeset
   191
    void removeFromQueue(const QString &name);
34
hgs
parents: 30
diff changeset
   192
    
hgs
parents: 30
diff changeset
   193
private:
hgs
parents: 30
diff changeset
   194
    /** from QObject */
hgs
parents: 30
diff changeset
   195
    void timerEvent(QTimerEvent *event); 
hgs
parents: 30
diff changeset
   196
    
hgs
parents: 30
diff changeset
   197
    /** from HbDocumentLoader */
hgs
parents: 30
diff changeset
   198
    QObject *createObject(const QString& type, const QString &name);
hgs
parents: 30
diff changeset
   199
    
hgs
parents: 30
diff changeset
   200
private:
hgs
parents: 30
diff changeset
   201
    /**
hgs
parents: 30
diff changeset
   202
     * Run next async find request from queue.
hgs
parents: 30
diff changeset
   203
     */
hgs
parents: 30
diff changeset
   204
    void runNext();
hgs
parents: 30
diff changeset
   205
    
hgs
parents: 30
diff changeset
   206
    /**
hgs
parents: 30
diff changeset
   207
     * Check that set params are valid.
hgs
parents: 30
diff changeset
   208
     */
36
hgs
parents: 35
diff changeset
   209
    bool isValid(const VideoCollectionUiLoaderParam &param);
hgs
parents: 35
diff changeset
   210
    
hgs
parents: 35
diff changeset
   211
    /**
hgs
parents: 35
diff changeset
   212
     * Store object without a parent. 
hgs
parents: 35
diff changeset
   213
     */
hgs
parents: 35
diff changeset
   214
    void storeOrphans(const QObjectList &list);
34
hgs
parents: 30
diff changeset
   215
    
hgs
parents: 30
diff changeset
   216
private:
hgs
parents: 30
diff changeset
   217
    /** async queue */
36
hgs
parents: 35
diff changeset
   218
    QList<VideoCollectionUiLoaderParam> mQueue;
34
hgs
parents: 30
diff changeset
   219
    
hgs
parents: 30
diff changeset
   220
    /** timer id */
hgs
parents: 30
diff changeset
   221
    int mTimerId;
hgs
parents: 30
diff changeset
   222
    
36
hgs
parents: 35
diff changeset
   223
    /** list of initialized objects */
34
hgs
parents: 30
diff changeset
   224
    QHash<QString, QObject*> mObjects;
hgs
parents: 30
diff changeset
   225
    
hgs
parents: 30
diff changeset
   226
    /** menu actions */
hgs
parents: 30
diff changeset
   227
    QMap<ActionIds, HbAction*> mMenuActions;
hgs
parents: 30
diff changeset
   228
    
hgs
parents: 30
diff changeset
   229
    /** toolbar actions */
hgs
parents: 30
diff changeset
   230
    QMap<ActionIds, HbAction*> mToolbarActions;
hgs
parents: 30
diff changeset
   231
    
36
hgs
parents: 35
diff changeset
   232
    /** loaded docmls */
hgs
parents: 35
diff changeset
   233
    QSet<QString> mDocmls;
hgs
parents: 35
diff changeset
   234
    
hgs
parents: 35
diff changeset
   235
    /** loaded sections */
hgs
parents: 35
diff changeset
   236
    QSet<QString> mSections;
35
hgs
parents: 34
diff changeset
   237
    
34
hgs
parents: 30
diff changeset
   238
    /** action group for "sort by" actions */
hgs
parents: 30
diff changeset
   239
    QActionGroup* mSortGroup;
hgs
parents: 30
diff changeset
   240
    
hgs
parents: 30
diff changeset
   241
    /** is service */
hgs
parents: 30
diff changeset
   242
    bool mIsService;
36
hgs
parents: 35
diff changeset
   243
    
hgs
parents: 35
diff changeset
   244
    /** load phases currently active */
hgs
parents: 35
diff changeset
   245
    QSet<int> mPhases;
hgs
parents: 35
diff changeset
   246
    
hgs
parents: 35
diff changeset
   247
    /**
hgs
parents: 35
diff changeset
   248
     * objects without a parent - these needs to be deleted manually unless
hgs
parents: 35
diff changeset
   249
     * a parent is set.
hgs
parents: 35
diff changeset
   250
     */
hgs
parents: 35
diff changeset
   251
    QObjectList mOrphans;
30
hgs
parents:
diff changeset
   252
};
hgs
parents:
diff changeset
   253
hgs
parents:
diff changeset
   254
#endif // _VIDEOCOLLECTIONUILOADER_H_