30
|
1 |
/*
|
|
2 |
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
3 |
* All rights reserved.
|
|
4 |
* This component and the accompanying materials are made available
|
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
6 |
* which accompanies this distribution, and is available
|
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
8 |
*
|
|
9 |
* Initial Contributors:
|
|
10 |
* Nokia Corporation - initial contribution.
|
|
11 |
*
|
|
12 |
* Contributors:
|
|
13 |
*
|
|
14 |
* Description: VideoCollectionWrapper class definition
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
#ifndef __VIDEOCOLLECTIONWRAPPER_H__
|
|
19 |
#define __VIDEOCOLLECTIONWRAPPER_H__
|
|
20 |
|
|
21 |
|
|
22 |
// INCLUDES
|
|
23 |
#include <QObject>
|
|
24 |
#include <qabstractitemmodel.h>
|
36
|
25 |
#include "videocollectioncommon.h"
|
30
|
26 |
#include "videocollectionexport.h"
|
|
27 |
|
|
28 |
// FORWARD DECLARATIONS
|
|
29 |
class VideoCollectionWrapperPrivate;
|
|
30 |
class VideoSortFilterProxyModel;
|
|
31 |
|
|
32 |
|
|
33 |
/**
|
|
34 |
* Class is used as an interface of the video collection QT wrapper.
|
|
35 |
*
|
36
|
36 |
* Singleton instance is deleted when application ends
|
30
|
37 |
*
|
|
38 |
* * Usage:
|
|
39 |
* @code
|
36
|
40 |
* #include "videocollectioncommon.h"
|
30
|
41 |
* #include "videocollectionwrapper.h"
|
|
42 |
* #include "videosortfilterproxymodel.h"
|
|
43 |
*
|
|
44 |
* ...
|
|
45 |
* ////
|
|
46 |
* // Getting the instances
|
|
47 |
* ////
|
36
|
48 |
* VideoCollectionWrapper &wrapper = VideoCollectionWrapper::instance();
|
|
49 |
* // getting all videos model
|
|
50 |
* VideoSortFilterProxyModel *model = wrapper.getModel(VideoCollectionCommon::EModelTypeAllVideos);
|
30
|
51 |
* ...
|
|
52 |
* ////
|
|
53 |
* // Opening collection and start fetching video item data
|
|
54 |
* ////
|
|
55 |
* if(model)
|
|
56 |
* {
|
36
|
57 |
* mModel.open(VideoCollectionCommon::ELevelVideos);
|
30
|
58 |
* }
|
|
59 |
* // see model documentation for the open funtionality
|
|
60 |
*
|
|
61 |
* @endcode
|
|
62 |
*
|
|
63 |
*/
|
|
64 |
class VIDEOCOLLECTION_DLL_EXPORT VideoCollectionWrapper : public QObject
|
|
65 |
{
|
|
66 |
/**
|
|
67 |
* define to be able to use signals and slots
|
|
68 |
*/
|
|
69 |
Q_OBJECT
|
|
70 |
|
|
71 |
public: // Constructor
|
|
72 |
|
|
73 |
/**
|
|
74 |
* Returns singleton instance for this class.
|
|
75 |
*
|
|
76 |
* WARNING! Not safe to call this from destructor of another function scope static object!
|
|
77 |
*
|
|
78 |
* @return The singleton instance.
|
|
79 |
*/
|
34
|
80 |
static VideoCollectionWrapper &instance();
|
30
|
81 |
|
|
82 |
/**
|
40
|
83 |
* Returns pointer to model. Null if creation fails or if
|
|
84 |
* application is closing.
|
30
|
85 |
*
|
34
|
86 |
* @param type of the model
|
|
87 |
*
|
40
|
88 |
* @return address to model or NULL if fails or if application is closing.
|
30
|
89 |
*/
|
36
|
90 |
VideoSortFilterProxyModel* getModel(VideoCollectionCommon::TModelType type);
|
30
|
91 |
|
|
92 |
/**
|
|
93 |
* Method can be used by client to emit status signal
|
|
94 |
* containing status code from particular async status.
|
|
95 |
*
|
|
96 |
* @param statusCode code of status
|
|
97 |
*
|
|
98 |
* @param additional additional information for the code
|
|
99 |
*/
|
|
100 |
void sendAsyncStatus(int statusCode, QVariant &additional);
|
|
101 |
|
|
102 |
signals:
|
|
103 |
|
|
104 |
/**
|
|
105 |
* Signal that can be emitted by the wrapper to indicate status
|
|
106 |
* of some async operation.
|
|
107 |
*
|
|
108 |
* See videocollectioncommon.h for codes
|
|
109 |
*
|
|
110 |
* @param status code of status
|
|
111 |
*
|
|
112 |
* @param additional additional information for the code
|
|
113 |
*/
|
|
114 |
void asyncStatus(int statusCode, QVariant &additional);
|
|
115 |
|
|
116 |
private:
|
|
117 |
|
|
118 |
/**
|
|
119 |
* Private contructor.
|
|
120 |
*/
|
|
121 |
VideoCollectionWrapper();
|
|
122 |
|
|
123 |
/**
|
|
124 |
* Private destructor.
|
|
125 |
*
|
|
126 |
*/
|
|
127 |
virtual ~VideoCollectionWrapper();
|
|
128 |
|
|
129 |
/**
|
|
130 |
* disables copy-constructor and assingment operator
|
|
131 |
*/
|
|
132 |
Q_DISABLE_COPY(VideoCollectionWrapper)
|
|
133 |
|
|
134 |
private:
|
|
135 |
|
|
136 |
/**
|
|
137 |
* d -pointer for actual implementation
|
|
138 |
*/
|
|
139 |
VideoCollectionWrapperPrivate *d;
|
|
140 |
|
|
141 |
/**
|
|
142 |
* Reference count.
|
|
143 |
*/
|
|
144 |
int mReferenceCount;
|
|
145 |
|
|
146 |
};
|
|
147 |
|
|
148 |
#endif // __VIDEOCOLLECTIONWRAPPER_H__
|
|
149 |
|
|
150 |
// End of file
|