Doc: Adding Qt Multimedia Widgets documentation.
-added landing page and module page -linked to Qt Multimedia and Qt Widgets -excluded multimediawidgets dir from the Qt Multimedia documentation Task-number: QTBUG-29339 Change-Id: Iaa8dc4117505d5635b8cab97ed5c10e9c4a289e6 Reviewed-by: Lars Knoll <lars.knoll@digia.com> Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com>
This commit is contained in:
Jerome Pasion
committed by
The Qt Project
The Qt Project
parent
fb6e49f33f
commit
f641bda2e7
@@ -29,7 +29,7 @@ qhp.qtmultimedia.subprojects.qmltypes.indexTitle = Qt Multimedia QML Types
|
||||
qhp.qtmultimedia.subprojects.qmltypes.selectors = fake:qmlclass
|
||||
qhp.qtmultimedia.subprojects.qmltypes.sortPages = true
|
||||
|
||||
exampledirs += ../../../examples \
|
||||
exampledirs += ../../../examples/multimedia \
|
||||
snippets
|
||||
|
||||
headerdirs += ../..
|
||||
@@ -38,6 +38,6 @@ imagedirs += src/images \
|
||||
|
||||
sourcedirs += ../..
|
||||
|
||||
excludedirs +=
|
||||
excludedirs += ../../multimediawidgets
|
||||
|
||||
depends += qtcore qtdoc qtquick qtqml
|
||||
depends += qtcore qtdoc qtquick qtqml qtmultimediawidgets
|
||||
|
||||
@@ -32,6 +32,8 @@
|
||||
|
||||
Qt Multimedia is an essential module that provides a rich set of QML types and C++ classes to handle multimedia content. It also provides necessary APIs to access the camera and radio functionality.
|
||||
|
||||
The \l{Qt Multimedia Widgets} module provides widget based multimedia classes.
|
||||
|
||||
\section1 Getting started
|
||||
|
||||
The QML types can be imported into your applciation using the following import statement in your \c {.qml} file.
|
||||
|
||||
43
src/multimediawidgets/doc/qtmultimediawidgets.qdocconf
Normal file
43
src/multimediawidgets/doc/qtmultimediawidgets.qdocconf
Normal file
@@ -0,0 +1,43 @@
|
||||
include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
|
||||
|
||||
project = qtmultimediawidgets
|
||||
description = Qt Multimedia Widgets Documentation
|
||||
url = http://qt-project.org/doc/qt-$QT_VER/qtmultimediawidgets
|
||||
version = $QT_VERSION
|
||||
|
||||
# The following parameters are for creating a qhp file, the qhelpgenerator
|
||||
# program can convert the qhp file into a qch file which can be opened in
|
||||
# Qt Assistant and/or Qt Creator.
|
||||
|
||||
# Defines the name of the project. You cannot use operators (+, =, -) in
|
||||
# the name. Properties for this project are set using a qhp.<projectname>.property
|
||||
# format.
|
||||
qhp.projects = qtmultimediawidgets
|
||||
qhp.qtmultimediawidgets.file = qtmultimediawidgets.qhp
|
||||
qhp.qtmultimediawidgets.namespace = org.qt-project.qtmultimediawidgets.$QT_VERSION_TAG
|
||||
qhp.qtmultimediawidgets.indexTitle = Qt Multimedia
|
||||
qhp.qtmultimediawidgets.virtualFolder = qtmultimediawidgets
|
||||
|
||||
# For listing child nodes in Qt Creator or Assistant.
|
||||
qhp.qtmultimediawidgets.subprojects = classes qmltypes
|
||||
qhp.qtmultimediawidgets.subprojects.classes.title = C++ Classes
|
||||
qhp.qtmultimediawidgets.subprojects.classes.indexTitle = Qt Multimedia Widgets C++ Classes
|
||||
qhp.qtmultimediawidgets.subprojects.classes.selectors = class fake:headerfile
|
||||
qhp.qtmultimediawidgets.subprojects.classes.sortPages = true
|
||||
qhp.qtmultimediawidgets.subprojects.qmltypes.title = QML Types
|
||||
qhp.qtmultimediawidgets.subprojects.qmltypes.indexTitle = Qt Multimedia Widgets QML Types
|
||||
qhp.qtmultimediawidgets.subprojects.qmltypes.selectors = fake:qmlclass
|
||||
qhp.qtmultimediawidgets.subprojects.qmltypes.sortPages = true
|
||||
|
||||
exampledirs += ../../../examples/multimediawidgets \
|
||||
snippets
|
||||
|
||||
headerdirs += ../
|
||||
|
||||
imagedirs += \
|
||||
|
||||
sourcedirs += ../
|
||||
|
||||
excludedirs +=
|
||||
|
||||
depends += qtcore qtdoc qtquick qtqml qtmultimedia qtwidgets qtgui
|
||||
67
src/multimediawidgets/doc/src/qtmultimediawidgets-index.qdoc
Normal file
67
src/multimediawidgets/doc/src/qtmultimediawidgets-index.qdoc
Normal file
@@ -0,0 +1,67 @@
|
||||
/****************************************************************************
|
||||
**
|
||||
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
|
||||
** Contact: http://www.qt-project.org/legal
|
||||
**
|
||||
** This file is part of the documentation of the Qt Toolkit.
|
||||
**
|
||||
** $QT_BEGIN_LICENSE:FDL$
|
||||
** Commercial License Usage
|
||||
** Licensees holding valid commercial Qt licenses may use this file in
|
||||
** accordance with the commercial license agreement provided with the
|
||||
** Software or, alternatively, in accordance with the terms contained in
|
||||
** a written agreement between you and Digia. For licensing terms and
|
||||
** conditions see http://qt.digia.com/licensing. For further information
|
||||
** use the contact form at http://qt.digia.com/contact-us.
|
||||
**
|
||||
** GNU Free Documentation License Usage
|
||||
** Alternatively, this file may be used under the terms of the GNU Free
|
||||
** Documentation License version 1.3 as published by the Free Software
|
||||
** Foundation and appearing in the file included in the packaging of
|
||||
** this file. Please review the following information to ensure
|
||||
** the GNU Free Documentation License version 1.3 requirements
|
||||
** will be met: http://www.gnu.org/copyleft/fdl.html.
|
||||
** $QT_END_LICENSE$
|
||||
**
|
||||
****************************************************************************/
|
||||
|
||||
/*!
|
||||
\page qtmultimediawidgets-index.html
|
||||
\title Qt Multimedia Widgets
|
||||
\brief An essential module which provides multimedia-related widgets.
|
||||
|
||||
Qt Multimedia Widgets provides additional multimedia-related widgets and
|
||||
controls. The classes expand the capabilities of the \l{Qt Multimedia} and
|
||||
\l{Qt Widgets} modules.
|
||||
|
||||
\section1 Getting Started
|
||||
|
||||
To enable Qt Multimedia Widgets in a project, add this directive into the
|
||||
C++ files:
|
||||
\code
|
||||
#include <QtMultimediaWidgets>
|
||||
\endcode
|
||||
|
||||
To link against the C++ libraries, add the following to your \c qmake project
|
||||
file:
|
||||
\code
|
||||
QT += multimediawidgets
|
||||
\endcode
|
||||
|
||||
\section1 Related Information
|
||||
|
||||
\section2 Reference
|
||||
\list
|
||||
\li \l{Qt Multimedia Widgets C++ Classes}{C++ Classes}
|
||||
\endlist
|
||||
|
||||
\section2 Examples
|
||||
\list
|
||||
\li \l{QML Camera Example}
|
||||
\li \l{Camera Example}
|
||||
\li \l{Media Player Example}
|
||||
\li \l{Video Graphics Item Example}
|
||||
\li \l{Video Widget Example}
|
||||
\endlist
|
||||
|
||||
*/
|
||||
47
src/multimediawidgets/doc/src/qtmultimediawidgets.qdoc
Normal file
47
src/multimediawidgets/doc/src/qtmultimediawidgets.qdoc
Normal file
@@ -0,0 +1,47 @@
|
||||
/****************************************************************************
|
||||
**
|
||||
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
|
||||
** Contact: http://www.qt-project.org/legal
|
||||
**
|
||||
** This file is part of the documentation of the Qt Toolkit.
|
||||
**
|
||||
** $QT_BEGIN_LICENSE:FDL$
|
||||
** Commercial License Usage
|
||||
** Licensees holding valid commercial Qt licenses may use this file in
|
||||
** accordance with the commercial license agreement provided with the
|
||||
** Software or, alternatively, in accordance with the terms contained in
|
||||
** a written agreement between you and Digia. For licensing terms and
|
||||
** conditions see http://qt.digia.com/licensing. For further information
|
||||
** use the contact form at http://qt.digia.com/contact-us.
|
||||
**
|
||||
** GNU Free Documentation License Usage
|
||||
** Alternatively, this file may be used under the terms of the GNU Free
|
||||
** Documentation License version 1.3 as published by the Free Software
|
||||
** Foundation and appearing in the file included in the packaging of
|
||||
** this file. Please review the following information to ensure
|
||||
** the GNU Free Documentation License version 1.3 requirements
|
||||
** will be met: http://www.gnu.org/copyleft/fdl.html.
|
||||
** $QT_END_LICENSE$
|
||||
**
|
||||
****************************************************************************/
|
||||
|
||||
/*!
|
||||
\module QtMultimediaWidgets
|
||||
\title Qt Multimedia Widgets C++ Classes
|
||||
\brief Classes provided by the Qt Multimedia Widgets module.
|
||||
|
||||
These classes are part of the \l{Qt Multimedia Widgets} module.
|
||||
|
||||
To enable Qt Multimedia Widgets in a project, add this directive into the
|
||||
C++ files:
|
||||
\code
|
||||
#include <QtMultimediaWidgets>
|
||||
\endcode
|
||||
|
||||
To link against the C++ libraries, add the following to your \c qmake project
|
||||
file:
|
||||
\code
|
||||
QT += multimediawidgets
|
||||
\endcode
|
||||
|
||||
*/
|
||||
@@ -7,6 +7,8 @@ qtHaveModule(opengl):!contains(QT_CONFIG, opengles1) {
|
||||
DEFINES += QT_NO_OPENGL
|
||||
}
|
||||
|
||||
QMAKE_DOCS = $$PWD/doc/qtmultimediawidgets.qdocconf
|
||||
|
||||
load(qt_module)
|
||||
|
||||
PRIVATE_HEADERS += \
|
||||
@@ -52,4 +54,3 @@ maemo6 {
|
||||
}
|
||||
|
||||
HEADERS += $$PUBLIC_HEADERS $$PRIVATE_HEADERS
|
||||
|
||||
|
||||
@@ -203,7 +203,7 @@ void QGraphicsVideoItemPrivate::_q_serviceDestroyed()
|
||||
|
||||
\brief The QGraphicsVideoItem class provides a graphics item which display video produced by a QMediaObject.
|
||||
|
||||
\inmodule QtMultimedia
|
||||
\inmodule QtMultimediaWidgets
|
||||
\ingroup multimedia
|
||||
|
||||
Attaching a QGraphicsVideoItem to a QMediaObject allows it to display
|
||||
|
||||
Reference in New Issue
Block a user