videocollection/videocollectionwrapper/inc/videocollectionwrapper.h
author hgs
Fri, 16 Apr 2010 18:13:14 +0300
changeset 36 8aed59de29f9
parent 34 bbb98528c666
child 40 13331705e488
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:   VideoCollectionWrapper class definition
hgs
parents:
diff changeset
    15
* 
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef __VIDEOCOLLECTIONWRAPPER_H__
hgs
parents:
diff changeset
    19
#define __VIDEOCOLLECTIONWRAPPER_H__
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
// INCLUDES
hgs
parents:
diff changeset
    23
#include <QObject>
hgs
parents:
diff changeset
    24
#include <qabstractitemmodel.h>
36
hgs
parents: 34
diff changeset
    25
#include "videocollectioncommon.h"
30
hgs
parents:
diff changeset
    26
#include "videocollectionexport.h"
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
// FORWARD DECLARATIONS
hgs
parents:
diff changeset
    29
class VideoCollectionWrapperPrivate;
hgs
parents:
diff changeset
    30
class VideoSortFilterProxyModel;
hgs
parents:
diff changeset
    31
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
/**
hgs
parents:
diff changeset
    34
 * Class is used as an interface of the video collection QT wrapper.
hgs
parents:
diff changeset
    35
 * 
36
hgs
parents: 34
diff changeset
    36
 * Singleton instance is deleted when application ends
30
hgs
parents:
diff changeset
    37
 * 
hgs
parents:
diff changeset
    38
 * * Usage:
hgs
parents:
diff changeset
    39
 *  @code
36
hgs
parents: 34
diff changeset
    40
 *  #include "videocollectioncommon.h"
30
hgs
parents:
diff changeset
    41
 *  #include "videocollectionwrapper.h"
hgs
parents:
diff changeset
    42
 *  #include "videosortfilterproxymodel.h"
hgs
parents:
diff changeset
    43
 *  
hgs
parents:
diff changeset
    44
 *  ...
hgs
parents:
diff changeset
    45
 *  ////
hgs
parents:
diff changeset
    46
 *  // Getting the instances
hgs
parents:
diff changeset
    47
 *  ////
36
hgs
parents: 34
diff changeset
    48
 *  VideoCollectionWrapper &wrapper = VideoCollectionWrapper::instance();
hgs
parents: 34
diff changeset
    49
 *  // getting all videos model
hgs
parents: 34
diff changeset
    50
 *  VideoSortFilterProxyModel *model = wrapper.getModel(VideoCollectionCommon::EModelTypeAllVideos);
30
hgs
parents:
diff changeset
    51
 *  ...
hgs
parents:
diff changeset
    52
 *  ////
hgs
parents:
diff changeset
    53
 *  // Opening collection and start fetching video item data
hgs
parents:
diff changeset
    54
 *  ////
hgs
parents:
diff changeset
    55
 *  if(model)
hgs
parents:
diff changeset
    56
 *  {
36
hgs
parents: 34
diff changeset
    57
 *      mModel.open(VideoCollectionCommon::ELevelVideos);
30
hgs
parents:
diff changeset
    58
 *  }
hgs
parents:
diff changeset
    59
 *  // see model documentation for the open funtionality
hgs
parents:
diff changeset
    60
 * 
hgs
parents:
diff changeset
    61
 *  @endcode
hgs
parents:
diff changeset
    62
 * 
hgs
parents:
diff changeset
    63
 */
hgs
parents:
diff changeset
    64
class VIDEOCOLLECTION_DLL_EXPORT VideoCollectionWrapper : public QObject         
hgs
parents:
diff changeset
    65
{    
hgs
parents:
diff changeset
    66
    /**
hgs
parents:
diff changeset
    67
     * define to be able to use signals and slots
hgs
parents:
diff changeset
    68
     */
hgs
parents:
diff changeset
    69
    Q_OBJECT
hgs
parents:
diff changeset
    70
    
hgs
parents:
diff changeset
    71
public: // Constructor
hgs
parents:
diff changeset
    72
    
hgs
parents:
diff changeset
    73
    /**
hgs
parents:
diff changeset
    74
     * Returns singleton instance for this class.
hgs
parents:
diff changeset
    75
     * 
hgs
parents:
diff changeset
    76
     * WARNING! Not safe to call this from destructor of another function scope static object!
hgs
parents:
diff changeset
    77
     * 
hgs
parents:
diff changeset
    78
     * @return The singleton instance.
hgs
parents:
diff changeset
    79
     */
34
hgs
parents: 30
diff changeset
    80
    static VideoCollectionWrapper &instance();  
30
hgs
parents:
diff changeset
    81
    
hgs
parents:
diff changeset
    82
	/**
hgs
parents:
diff changeset
    83
     * Returns pointer to model
hgs
parents:
diff changeset
    84
     * 
34
hgs
parents: 30
diff changeset
    85
     * @param type of the model
hgs
parents: 30
diff changeset
    86
     * 
30
hgs
parents:
diff changeset
    87
     * @return address to model or NULL if fails.
hgs
parents:
diff changeset
    88
     */    
36
hgs
parents: 34
diff changeset
    89
    VideoSortFilterProxyModel* getModel(VideoCollectionCommon::TModelType type);
30
hgs
parents:
diff changeset
    90
hgs
parents:
diff changeset
    91
    /**
hgs
parents:
diff changeset
    92
     * Method can be used by client to emit status signal
hgs
parents:
diff changeset
    93
     * containing status code from particular async status.
hgs
parents:
diff changeset
    94
     * 
hgs
parents:
diff changeset
    95
     * @param statusCode code of status
hgs
parents:
diff changeset
    96
     * 
hgs
parents:
diff changeset
    97
     * @param additional additional information for the code
hgs
parents:
diff changeset
    98
     */
hgs
parents:
diff changeset
    99
    void sendAsyncStatus(int statusCode, QVariant &additional);
hgs
parents:
diff changeset
   100
     
hgs
parents:
diff changeset
   101
signals:     
hgs
parents:
diff changeset
   102
hgs
parents:
diff changeset
   103
    /**
hgs
parents:
diff changeset
   104
     * Signal that can be emitted by the wrapper to indicate status
hgs
parents:
diff changeset
   105
     * of some async operation.
hgs
parents:
diff changeset
   106
     * 
hgs
parents:
diff changeset
   107
     * See videocollectioncommon.h for codes
hgs
parents:
diff changeset
   108
     * 
hgs
parents:
diff changeset
   109
     * @param status code of status
hgs
parents:
diff changeset
   110
     * 
hgs
parents:
diff changeset
   111
     * @param additional additional information for the code
hgs
parents:
diff changeset
   112
     */
hgs
parents:
diff changeset
   113
    void asyncStatus(int statusCode, QVariant &additional);
hgs
parents:
diff changeset
   114
hgs
parents:
diff changeset
   115
private:
hgs
parents:
diff changeset
   116
    
hgs
parents:
diff changeset
   117
    /**
hgs
parents:
diff changeset
   118
     * Private contructor.
hgs
parents:
diff changeset
   119
     */    
hgs
parents:
diff changeset
   120
    VideoCollectionWrapper(); 
hgs
parents:
diff changeset
   121
    
hgs
parents:
diff changeset
   122
    /**
hgs
parents:
diff changeset
   123
     * Private destructor.
hgs
parents:
diff changeset
   124
     *
hgs
parents:
diff changeset
   125
     */
hgs
parents:
diff changeset
   126
    virtual ~VideoCollectionWrapper();    
hgs
parents:
diff changeset
   127
    
hgs
parents:
diff changeset
   128
    /**
hgs
parents:
diff changeset
   129
     * disables copy-constructor and assingment operator
hgs
parents:
diff changeset
   130
     */
hgs
parents:
diff changeset
   131
    Q_DISABLE_COPY(VideoCollectionWrapper)    
hgs
parents:
diff changeset
   132
    
hgs
parents:
diff changeset
   133
private:
hgs
parents:
diff changeset
   134
hgs
parents:
diff changeset
   135
	/**
hgs
parents:
diff changeset
   136
     * d -pointer for actual implementation
hgs
parents:
diff changeset
   137
     */ 
hgs
parents:
diff changeset
   138
    VideoCollectionWrapperPrivate *d;
hgs
parents:
diff changeset
   139
hgs
parents:
diff changeset
   140
    /**
hgs
parents:
diff changeset
   141
     * Reference count.
hgs
parents:
diff changeset
   142
     */
hgs
parents:
diff changeset
   143
    int mReferenceCount;
hgs
parents:
diff changeset
   144
    
hgs
parents:
diff changeset
   145
};
hgs
parents:
diff changeset
   146
hgs
parents:
diff changeset
   147
#endif  // __VIDEOCOLLECTIONWRAPPER_H__
hgs
parents:
diff changeset
   148
hgs
parents:
diff changeset
   149
// End of file