aboutsummaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2013-08-08 10:29:00 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-08-08 14:38:04 +0200
commit7089fdb9377b13e2af458b7a84b8fc2df42167b0 (patch)
tree23368cf0d55f580ec3208a7b862a12f3d0b869e0 /examples
parentee74a4c8b0d8563f994004395fe2b45fcdfef04e (diff)
Doc: Create documentation for Qt Windows Extras Examples
Initial documentation for the examples - A .qdoc file for each example (no detailed docs yet) - A new group page 'examples-qtwinextras' - Add examples section to module index page - New TOC entry 'Examples' for the QCH file - Fix example path in .qdocconf Change-Id: I2642e31e2eea361b47118b7b560d6c71d9780743 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'examples')
-rw-r--r--examples/winextras/dwmfeatures/doc/src/qtwinextras-example-dwmfeatures.qdoc38
-rw-r--r--examples/winextras/iconextractor/doc/src/qtwinextras-example-iconextractor.qdoc36
-rw-r--r--examples/winextras/jumplistexample/doc/src/qtwinextras-example-jumplist.qdoc36
-rw-r--r--examples/winextras/quickdwm/doc/src/qtwinextras-example-quickdwm.qdoc38
4 files changed, 148 insertions, 0 deletions
diff --git a/examples/winextras/dwmfeatures/doc/src/qtwinextras-example-dwmfeatures.qdoc b/examples/winextras/dwmfeatures/doc/src/qtwinextras-example-dwmfeatures.qdoc
new file mode 100644
index 0000000..8db6131
--- /dev/null
+++ b/examples/winextras/dwmfeatures/doc/src/qtwinextras-example-dwmfeatures.qdoc
@@ -0,0 +1,38 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+/*!
+ \title DWM Features
+ \ingroup examples-qtwinextras
+ \example dwmfeatures
+ \brief Demonstrates managing Windows DWM features.
+
+ This example shows how to use Desktop Window Manager (DWM) features
+ provided by the \l{Qt Windows Extras} module. These include
+ controlling the \l{DWM and Glass Frame}{Glass Frame} and \l{Aero Peek}
+ features for a Qt application.
+*/
diff --git a/examples/winextras/iconextractor/doc/src/qtwinextras-example-iconextractor.qdoc b/examples/winextras/iconextractor/doc/src/qtwinextras-example-iconextractor.qdoc
new file mode 100644
index 0000000..6a584f6
--- /dev/null
+++ b/examples/winextras/iconextractor/doc/src/qtwinextras-example-iconextractor.qdoc
@@ -0,0 +1,36 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+/*!
+ \title Icon Extractor
+ \ingroup examples-qtwinextras
+ \example iconextractor
+ \brief Demonstrates accessing icons contained in Windows binaries.
+
+ This example shows how to extract Windows icons from executables,
+ DLL or icon files, and write them out as numbered PNG files.
+*/
diff --git a/examples/winextras/jumplistexample/doc/src/qtwinextras-example-jumplist.qdoc b/examples/winextras/jumplistexample/doc/src/qtwinextras-example-jumplist.qdoc
new file mode 100644
index 0000000..1c45d79
--- /dev/null
+++ b/examples/winextras/jumplistexample/doc/src/qtwinextras-example-jumplist.qdoc
@@ -0,0 +1,36 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+/*!
+ \title Jump List
+ \ingroup examples-qtwinextras
+ \example jumplistexample
+ \brief Demonstrates managing jump lists for Windows task bar buttons.
+
+ This example shows how to implement a \l{Jump Lists}{jump list}
+ for the Windows task bar button of a Qt application.
+*/
diff --git a/examples/winextras/quickdwm/doc/src/qtwinextras-example-quickdwm.qdoc b/examples/winextras/quickdwm/doc/src/qtwinextras-example-quickdwm.qdoc
new file mode 100644
index 0000000..884aa26
--- /dev/null
+++ b/examples/winextras/quickdwm/doc/src/qtwinextras-example-quickdwm.qdoc
@@ -0,0 +1,38 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+/*!
+ \title Quick DWM
+ \ingroup examples-qtwinextras
+ \example quickdwm
+ \brief Demonstrates managing Windows DWM features from QML.
+
+ This example shows how to use the
+ \l{Qt Windows Extras QML Types}{QML types} provided by the
+ \l{Qt Windows Extras} module to manage Desktop Windows
+ Manager (DWM) features from a Qt Quick application.
+*/