aboutsummaryrefslogtreecommitdiffstats
path: root/examples/winextras/musicplayer/doc/src/qtwinextras-musicplayer.qdoc
diff options
context:
space:
mode:
authorTor Arne Vestbø <tor.arne.vestbo@qt.io>2021-05-27 13:48:50 +0200
committerTor Arne Vestbø <tor.arne.vestbo@qt.io>2021-06-07 16:15:41 +0200
commitdb1ceebe72b806375c6cf4e4cafd8e8f81ad9dd9 (patch)
treeb0eb01720e15806cb145590b941c13cc786fd2b7 /examples/winextras/musicplayer/doc/src/qtwinextras-musicplayer.qdoc
parentb61f0209c4ea9f92deaaa1828223f35c7fdb80e4 (diff)
Remove module and add note about current status in Qt 6HEADdev
See QTBUG-89564 for overview and replacements for the APIs. The Qt 6 porting guide will be updated to explain how to move away from the removed module. The 5.15 branch is still available for anyone wanting to look at or incorporate code in their own projects. Task-number: QTBUG-89564 Change-Id: I1f0afc5ba3e694623fbbb51f10967321e81f32c9 Reviewed-by: Oliver Wolff <oliver.wolff@qt.io>
Diffstat (limited to 'examples/winextras/musicplayer/doc/src/qtwinextras-musicplayer.qdoc')
-rw-r--r--examples/winextras/musicplayer/doc/src/qtwinextras-musicplayer.qdoc106
1 files changed, 0 insertions, 106 deletions
diff --git a/examples/winextras/musicplayer/doc/src/qtwinextras-musicplayer.qdoc b/examples/winextras/musicplayer/doc/src/qtwinextras-musicplayer.qdoc
deleted file mode 100644
index c27ec0f..0000000
--- a/examples/winextras/musicplayer/doc/src/qtwinextras-musicplayer.qdoc
+++ /dev/null
@@ -1,106 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2015 The Qt Company Ltd.
-** Contact: http://www.qt.io/licensing/
-**
-** 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 The Qt Company. For licensing terms
-** and conditions see https://www.qt.io/terms-conditions. For further
-** information use the contact form at https://www.qt.io/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: https://www.gnu.org/licenses/fdl-1.3.html.
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-/*!
- \example musicplayer
- \title Music Player
- \ingroup examples-qtwinextras
- \brief Demonstrates managing Windows DWM features, jump lists,
- taskbar button overlay, and thumbnail toolbar.
-
- \image qtwinextras-musicplayer-composited.png Screenshot of the Music Player example
-
- The Music Player example demonstrates how to use the various features
- provided by the QtWinExtras module.
-
- \note The example uses QMediaPlayer from the QtMultimedia module to play
- the music, but this article focuses on the parts where QtWinExtras features
- are used.
-
- \section1 DWM Features
-
- The example uses Windows DWM (Desktop Window Manager) features to visually
- integrate the window content to the window frame and to make the main window
- and the volume popup translucent and blurred.
-
- \section1 Jump List
-
- The example creates a custom jump list to provide the user with fast
- access to recently played music files.
-
- \snippet musicplayer/musicplayer.cpp 4
-
- To enable the application jump list to show the desired recent files,
- the corresponding file types are registered using the following helper
- function.
-
- \snippet musicplayer/main.cpp 0
-
- \section1 Taskbar Overlay and Progress
-
- The example uses Windows Taskbar for two things; it sets an overlay icon
- that represents the current music playback state, and it indicates the
- playback progress in the taskbar button.
-
- \image qtwinextras-musicplayer-taskbar.png Screenshot of the Music Player taskbar
-
- The following snippets show how the taskbar button is prepared.
-
- For the taskbar and the thumbnail toolbar to work, a native window handle
- must be set by passing an instance of \c QWindow to
- \c QWinTaskbarButton::setWindow() or \c QWinThumbnailToolBar::setWindow(),
- respectively. This instance is created in the process of \c QWidget::show()
- and can be retrieved by calling \c QWidget::windowHandle() afterwards.
- We override \c QWidget::showEvent() for this purpose:
-
- \snippet musicplayer/musicplayer.cpp 7
-
- The playback progress is wired directly to the taskbar progress indicator
- by using signals and slots.
-
- \snippet musicplayer/musicplayer.cpp 5
-
- The overlay icon and the progress indicator are updated whenever the state
- of the music playback changes.
-
- \snippet musicplayer/musicplayer.cpp 2
-
- \section1 Thumbnail Toolbar
-
- \image qtwinextras-musicplayer-thumbnail.png Screenshot of the Music Player thumbnail
-
- The Windows Thumbnail Toolbar is used for providing basic music playback
- controls. These controls can be used to control the application without
- having to activate the application.
-
- \snippet musicplayer/musicplayer.cpp 6
-
- The buttons in the thumbnail toolbar are updated accordingly whenever the state
- of the music playback changes.
-
- \snippet musicplayer/musicplayer.cpp 3
-*/