radioapp/radiouiengine/inc/radiohistoryitem.h
branchRCL_3
changeset 19 cce62ebc198e
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/radioapp/radiouiengine/inc/radiohistoryitem.h	Tue Aug 31 15:15:02 2010 +0300
@@ -0,0 +1,95 @@
+/*
+* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+#ifndef RADIOHISTORYITEM_H
+#define RADIOHISTORYITEM_H
+
+// System includes
+#include <QSharedDataPointer>
+#include <QMetaType>
+
+// User includes
+#include "radiouiengineexport.h"
+
+// Forward declarations
+class RadioHistoryItemPrivate;
+
+/*!
+ * Radio history item implements a song recognized from the radio broadcast
+ */
+class UI_ENGINE_DLL_EXPORT RadioHistoryItem
+{
+public:
+
+    RadioHistoryItem();
+    RadioHistoryItem( const QString& artist, const QString& title );
+    RadioHistoryItem( const RadioHistoryItem& other );
+
+    ~RadioHistoryItem();
+
+    RadioHistoryItem& operator=( const RadioHistoryItem& other );
+
+    bool isValid() const;
+    void reset();
+
+    int id() const;
+
+    QString artist() const;
+    void setArtist( const QString& artist );
+
+    QString title() const;
+    void setTitle( const QString& title );
+
+    QString station() const;
+    void setStation( const QString& station );
+
+    uint frequency() const;
+    void setFrequency( uint frequency );
+
+    QString time() const;
+    void setCurrentTime();
+
+    bool isTagged() const;
+
+    bool isRecognizedByRds() const;
+
+private: // data
+
+    /*!
+     * Pointer to the implicitly shared private implementation
+     * Own.
+     */
+    QSharedDataPointer<RadioHistoryItemPrivate> mData;
+
+public:
+
+    /**
+     * Checks if the class is detached from implicitly shared data
+     * Required by many QT convenience functions for implicitly shared classes
+     */
+    bool isDetached() const;
+
+    typedef QSharedDataPointer<RadioHistoryItemPrivate> DataPtr;
+    inline DataPtr &data_ptr() { return mData; }
+
+};
+
+Q_DECLARE_TYPEINFO( RadioHistoryItem, Q_MOVABLE_TYPE );  // Can be moved around in memory by containers if necessary
+Q_DECLARE_SHARED( RadioHistoryItem )                     // Uses implicit sharing
+Q_DECLARE_METATYPE( RadioHistoryItem )                   // To be usable in a QVariant
+
+#endif // RADIOHISTORYITEM_H