src/3rdparty/phonon/phonon/phonondefs.h
changeset 0 1918ee327afb
child 3 41300fa6a67c
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/3rdparty/phonon/phonon/phonondefs.h	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,144 @@
+/*  This file is part of the KDE project
+    Copyright (C) 2006-2007 Matthias Kretz <kretz@kde.org>
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) version 3, or any
+    later version accepted by the membership of KDE e.V. (or its
+    successor approved by the membership of KDE e.V.), Trolltech ASA 
+    (or its successors, if any) and the KDE Free Qt Foundation, which shall
+    act as a proxy defined in Section 6 of version 3 of the license.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public 
+    License along with this library.  If not, see <http://www.gnu.org/licenses/>.
+
+*/
+
+#ifndef PHONONDEFS_H
+#define PHONONDEFS_H
+
+#include <QtCore/QtGlobal>
+#include "phonon_export.h"
+
+QT_BEGIN_HEADER
+QT_BEGIN_NAMESPACE
+
+#ifdef PHONON_BACKEND_VERSION_4_3
+# ifndef PHONON_BACKEND_VERSION_4_2
+#  define PHONON_BACKEND_VERSION_4_2
+# endif
+#endif
+
+// the following inlines are correct - exclude per line doesn't work for multiline-macros so exclude
+// the whole file for inline checks
+//krazy:excludeall=inline
+#define K_DECLARE_PRIVATE(Class) \
+    inline Class##Private* k_func() { return reinterpret_cast<Class##Private *>(k_ptr); } \
+    inline const Class##Private* k_func() const { return reinterpret_cast<const Class##Private *>(k_ptr); } \
+    friend class Class##Private;
+
+/**
+ * \internal
+ * Used in class declarations to provide the needed functions. This is used for
+ * abstract base classes.
+ *
+ * \param classname The Name of the class this macro is used for.
+ *
+ * Example:
+ * \code
+ * class AbstractEffect : public QObject
+ * {
+ *   Q _OBJECT
+ *   Q_PROPERTY(int propertyA READ propertyA WRITE setPropertyA)
+ *   PHONON_ABSTRACTBASE(AbstractEffect)
+ *   public:
+ *     int propertyA() const;
+ *     void setPropertyA(int);
+ * };
+ * \endcode
+ *
+ * \see PHONON_OBJECT
+ * \see PHONON_HEIR
+ */
+#define PHONON_ABSTRACTBASE(classname) \
+protected: \
+    /**
+     * \internal
+     * Constructor that is called from derived classes.
+     *
+     * \param parent Standard QObject parent.
+     */ \
+    classname(classname ## Private &dd, QObject *parent); \
+private:
+
+/**
+ * \internal
+ * Used in class declarations to provide the needed functions. This is used for
+ * classes that inherit QObject directly.
+ *
+ * \param classname The Name of the class this macro is used for.
+ *
+ * Example:
+ * \code
+ * class EffectSettings : public QObject
+ * {
+ *   Q _OBJECT
+ *   Q_PROPERTY(int propertyA READ propertyA WRITE setPropertyA)
+ *   PHONON_OBJECT(EffectSettings)
+ *   public:
+ *     int propertyA() const;
+ *     void setPropertyA(int);
+ * };
+ * \endcode
+ *
+ * \see PHONON_ABSTRACTBASE
+ * \see PHONON_HEIR
+ */
+#define PHONON_OBJECT(classname) \
+public: \
+    /**
+     * Constructs an object with the given \p parent.
+     */ \
+    classname(QObject *parent = 0); \
+private:
+
+/**
+ * \internal
+ * Used in class declarations to provide the needed functions. This is used for
+ * classes that inherit another Phonon object.
+ *
+ * \param classname The Name of the class this macro is used for.
+ *
+ * Example:
+ * \code
+ * class ConcreteEffect : public AbstractEffect
+ * {
+ *   Q _OBJECT
+ *   Q_PROPERTY(int propertyB READ propertyB WRITE setPropertyB)
+ *   PHONON_HEIR(ConcreteEffect)
+ *   public:
+ *     int propertyB() const;
+ *     void setPropertyB(int);
+ * };
+ * \endcode
+ *
+ * \see PHONON_ABSTRACTBASE
+ * \see PHONON_OBJECT
+ */
+#define PHONON_HEIR(classname) \
+public: \
+    /**
+     * Constructs an object with the given \p parent.
+     */ \
+    classname(QObject *parent = 0); \
+
+QT_END_NAMESPACE
+QT_END_HEADER
+
+#endif // PHONONDEFS_H