aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@digia.com>2013-07-30 15:05:47 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-07-31 14:08:00 +0200
commit3b412c597c03e805d999364803ae07e564451504 (patch)
treeabcae159397dc68bf65bdafbd2569a9a5dc23a0c
parentfc3dbb5c78d0f7c6eafc4cc0a0e253404e1794f5 (diff)
Doc: edit qtwinextras module documentation
Added a lot of articles, fixed typos and grammar errors, enforced the Qt doc writing style, and used standard wording for qdoc commands. Change-Id: Ia644907e5d8454ddd789ab214a93fe7524aaf206 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com> Reviewed-by: Geir Vattekar <geir.vattekar@digia.com> Reviewed-by: Jake Petroules <jake.petroules@petroules.com>
-rw-r--r--src/imports/winextras/JumpDestination.qml2
-rw-r--r--src/imports/winextras/JumpLink.qml8
-rw-r--r--src/imports/winextras/qquickjumplist.cpp10
-rw-r--r--src/imports/winextras/qquickwindwmfeatures.cpp18
-rw-r--r--src/imports/winextras/qquickwintaskbarbutton.cpp23
-rw-r--r--src/winextras/doc/src/qtwinextras-index.qdoc12
-rw-r--r--src/winextras/doc/src/qtwinextras-module-cpp.qdoc8
-rw-r--r--src/winextras/doc/src/qtwinextras-module-qml.qdoc2
-rw-r--r--src/winextras/qjumplist.cpp193
-rw-r--r--src/winextras/qwinfunctions.cpp166
-rw-r--r--src/winextras/qwintaskbarbutton.cpp57
11 files changed, 306 insertions, 193 deletions
diff --git a/src/imports/winextras/JumpDestination.qml b/src/imports/winextras/JumpDestination.qml
index 5625e5e..44c7aa0 100644
--- a/src/imports/winextras/JumpDestination.qml
+++ b/src/imports/winextras/JumpDestination.qml
@@ -55,7 +55,7 @@ JumpListItem {
/*!
\qmlproperty string JumpDestination::filePath
- Path of the file.
+ The path to the file.
*/
property string filePath
}
diff --git a/src/imports/winextras/JumpLink.qml b/src/imports/winextras/JumpLink.qml
index e7d779d..37d14ab 100644
--- a/src/imports/winextras/JumpLink.qml
+++ b/src/imports/winextras/JumpLink.qml
@@ -55,14 +55,14 @@ JumpListItem {
/*!
\qmlproperty string JumpLink::iconPath
- Path to link icon.
+ The path to a link icon.
*/
property string iconPath
/*!
\qmlproperty string JumpLink::executablePath
- Path to executable file.
+ The path to an executable file.
*/
property string executablePath
@@ -76,14 +76,14 @@ JumpListItem {
/*!
\qmlproperty string JumpLink::description
- Description of the link.
+ The description of the link.
*/
property string description
/*!
\qmlproperty string JumpLink::title
- Title of the link.
+ The title of the link.
*/
property string title
}
diff --git a/src/imports/winextras/qquickjumplist.cpp b/src/imports/winextras/qquickjumplist.cpp
index 11cdfb9..e4caeaf 100644
--- a/src/imports/winextras/qquickjumplist.cpp
+++ b/src/imports/winextras/qquickjumplist.cpp
@@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickJumpList
\inqmlmodule QtWinExtras
- \brief The JumpList item allows modifying application Jump List.
+ \brief Enables you to modify the application Jump List.
*/
/*!
@@ -85,7 +85,7 @@ QQmlListProperty<QQuickJumpListCategory> QQuickJumpList::destinations()
/*!
\qmlproperty bool JumpList::showFrequentCategory
- Contains true if 'frequent' category is shown, false otherwise.
+ Contains true if the \e Frequent category is shown; otherwise false.
*/
bool QQuickJumpList::showFrequentCategory() const
{
@@ -100,7 +100,7 @@ void QQuickJumpList::setShowFrequentCategory(bool show)
/*!
\qmlproperty bool JumpList::showRecentCategory
- Contains true if 'recent' category is shown, false otherwise.
+ Contains true if the \e Recent category is shown; otherwise false.
*/
bool QQuickJumpList::showRecentCategory() const
{
@@ -174,7 +174,7 @@ QQuickJumpListCategory::~QQuickJumpListCategory()
/*!
\qmlproperty object JumpCategory::destinations
- Destinations in this category.
+ The destinations in this category.
*/
QQmlListProperty<QQuickJumpListItem> QQuickJumpListCategory::destinations()
{
@@ -189,7 +189,7 @@ void QQuickJumpListCategory::setTitle(const QString &title)
/*!
\qmlproperty string JumpCategory::title
- Title of the category.
+ The title of the category.
*/
QString QQuickJumpListCategory::title() const
{
diff --git a/src/imports/winextras/qquickwindwmfeatures.cpp b/src/imports/winextras/qquickwindwmfeatures.cpp
index cbdbbb9..0f4068a 100644
--- a/src/imports/winextras/qquickwindwmfeatures.cpp
+++ b/src/imports/winextras/qquickwindwmfeatures.cpp
@@ -54,7 +54,8 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickWinDwmFeatures
\inqmlmodule QtWinExtras
- \brief The WinDwmFeatures item allows extending glass frame into client area, as well as controlling behavior of Aero Peek and Flip3D.
+ \brief Enables you to extend a glass frame into the client area, as well as
+ to control the behavior of Aero Peek and Flip3D.
*/
/*!
@@ -102,7 +103,7 @@ bool QQuickWinDwmFeatures::colorizationOpaqueBlend() const
/*!
\qmlproperty int WinDwmFeatures::topGlassMargin
- Top glass frame height. Default value is 0.
+ The top glass frame margin. The default value is 0.
*/
void QQuickWinDwmFeatures::setTopGlassMargin(int margin)
{
@@ -114,7 +115,7 @@ void QQuickWinDwmFeatures::setTopGlassMargin(int margin)
/*!
\qmlproperty int WinDwmFeatures::rightGlassMargin
- Right glass frame width. Default value is 0.
+ The right glass frame margin. The default value is 0.
*/
void QQuickWinDwmFeatures::setRightGlassMargin(int margin)
{
@@ -126,7 +127,7 @@ void QQuickWinDwmFeatures::setRightGlassMargin(int margin)
/*!
\qmlproperty int WinDwmFeatures::bottomGlassMargin
- Bottom glass frame height. Default value is 0.
+ The bottom glass frame margin. The default value is 0.
*/
void QQuickWinDwmFeatures::setBottomGlassMargin(int margin)
{
@@ -138,7 +139,7 @@ void QQuickWinDwmFeatures::setBottomGlassMargin(int margin)
/*!
\qmlproperty int WinDwmFeatures::leftGlassMargin
- Left glass frame width. Default value is 0.
+ The left glass frame margin. The default value is 0.
*/
void QQuickWinDwmFeatures::setLeftGlassMargin(int margin)
{
@@ -195,8 +196,9 @@ void QQuickWinDwmFeatures::setExcludedFromPeek(bool exclude)
/*!
\qmlproperty bool WinDwmFeatures::peekDisallowed
- Default is false. Set this to \c true if you want to forbid Aero Peek when user hovers mouse on window thumbnail.
- */
+ Set this value to true if you want to forbid Aero Peek when the user hovers
+ the mouse over the window thumbnail. The default value is false.
+*/
bool QQuickWinDwmFeatures::peekDisallowed() const
{
Q_D(const QQuickWinDwmFeatures);
@@ -221,7 +223,7 @@ void QQuickWinDwmFeatures::setPeekDisallowed(bool disallow)
/*!
\qmlproperty WinDwmFeatures::Flip3DPolicy WinDwmFeatures::flip3DPolicy
- Contains current Flip3D policy for the window.
+ The current Flip3D policy for the window.
*/
QQuickWinDwmFeatures::Flip3DPolicy QQuickWinDwmFeatures::flip3DPolicy() const
{
diff --git a/src/imports/winextras/qquickwintaskbarbutton.cpp b/src/imports/winextras/qquickwintaskbarbutton.cpp
index 52555f5..24ec347 100644
--- a/src/imports/winextras/qquickwintaskbarbutton.cpp
+++ b/src/imports/winextras/qquickwintaskbarbutton.cpp
@@ -50,7 +50,9 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickWinTaskbarButton
\inqmlmodule QtWinExtras
- \brief The WinTaskbarButton item allows setting overlay icons on a button, displaying progress indicator and adding small toolbar to window thumbnail popup..
+ \brief Enables you to set overlay icons on a taskbar button, to display a
+ progress indicator, and to add a small toolbar to the window thumbnail
+ popup.
\sa QWinTaskbarButton
*/
@@ -82,7 +84,7 @@ void QQuickWinTaskbarButton::setProgressMinimum(int min)
/*!
\qmlproperty int WinTaskbarButton::progressMaximum
- Maximum progress value.
+ The maximum progress value.
*/
int QQuickWinTaskbarButton::progressMaximum() const
{
@@ -97,7 +99,7 @@ void QQuickWinTaskbarButton::setProgressMaximum(int max)
/*!
\qmlproperty int WinTaskbarButton::progressValue
- Displayed progress value.
+ The displayed progress value.
*/
int QQuickWinTaskbarButton::progressValue() const
{
@@ -112,7 +114,7 @@ void QQuickWinTaskbarButton::setProgressValue(int progress)
/*!
\qmlproperty string WinTaskbarButton::icon
- Overlay icon path.
+ The overlay icon path.
*/
QString QQuickWinTaskbarButton::overlayIcon() const
{
@@ -128,7 +130,7 @@ void QQuickWinTaskbarButton::setOverlayIcon(const QString &path)
/*!
\qmlproperty int WinTaskbarButton::iconDescription
- Accessibility description for overlay icon.
+ The accessibility description for the overlay icon.
*/
QString QQuickWinTaskbarButton::iconDescription() const
{
@@ -144,22 +146,23 @@ void QQuickWinTaskbarButton::setIconDescription(const QString &descr)
/*!
\qmlproperty enumeration WinTaskbarButton::progressState
- State of progress indicator.
+ The state of the progress indicator.
The state can be one of the following:
\table
\header \li Value \li Description
\row \li NoProgressState
- \li No progress indicator.
+ \li No progress indicator is displayed.
\row \li IndeterminateState
\li The progress indicator cycles repeatedly.
\row \li NormalState
- \li
+ \li The progress indicator is green.
\row \li PausedState
- \li Indicator turns yellow. Use that to show that operation has been paused, but can be continued.
+ \li The progress indicator turns yellow. Use this state to show that the
+ operation has been paused, but it can be continued.
\row \li ErrorState
- \li Indicator turns red.
+ \li The progress indicator turns red.
\endtable
*/
QWinTaskbarButton::ProgressState QQuickWinTaskbarButton::progressState() const
diff --git a/src/winextras/doc/src/qtwinextras-index.qdoc b/src/winextras/doc/src/qtwinextras-index.qdoc
index 5f8aafc..0272154 100644
--- a/src/winextras/doc/src/qtwinextras-index.qdoc
+++ b/src/winextras/doc/src/qtwinextras-index.qdoc
@@ -28,13 +28,19 @@
/*!
\page qtwinextras-index.html
\title Qt Windows Extras
- \brief The Qt Windows Extras module provides classes and functions which allow using some Windows APIs in Qt-way.
+ \brief Provides classes and functions for using some Windows APIs in a Qt way
- The Qt Windows Extras module provides classes and functions which allow using some Windows APIs in Qt-way, including but no limiting to type conversion functions.
+ Qt Windows Extras provide classes and functions that enable you to use
+ miscellaneous Windows-specific functions. For example, you can convert Qt
+ objects to Windows object handles and manipulate DWM glass frames.
+
+ In addition, you can use features introduced with Windows 7, such as Aero
+ Peek, Jump Lists, or a progress indicator on a taskbar button.
\section1 Getting Started
- To include the definitions of the module's classes and functions, use the following directive:
+ To include the definitions of the module's classes and functions, use the
+ following directive:
\snippet code/use-qtwinextras.cpp include
diff --git a/src/winextras/doc/src/qtwinextras-module-cpp.qdoc b/src/winextras/doc/src/qtwinextras-module-cpp.qdoc
index c0b31d6..9dc80e4 100644
--- a/src/winextras/doc/src/qtwinextras-module-cpp.qdoc
+++ b/src/winextras/doc/src/qtwinextras-module-cpp.qdoc
@@ -28,12 +28,14 @@
/*!
\module QtWinExtras
\title Qt Windows Extras C++ Classes
- \brief The Qt Windows Extras module provides classes and functions which allow using some Windows APIs in Qt-way.
+ \brief Provides classes and functions for using some Windows APIs in a Qt way
\ingroup modules
\ingroup technology-apis
- The namespaces contain Windows-specific functions for type conversion and DWM glass frame manipulation.
+ The QWinExtras namespace contains Windows-specific functions for type
+ conversions and DWM glass frame manipulation.
- The classes provided allow using features, introduced with Windows 7, like JumpLists or progress indicator on taskbar button.
+ The classes enable you to use features introduced with Windows 7, such as
+ Jump Lists or a progress indicator on a taskbar button.
*/
diff --git a/src/winextras/doc/src/qtwinextras-module-qml.qdoc b/src/winextras/doc/src/qtwinextras-module-qml.qdoc
index d702360..fbc3565 100644
--- a/src/winextras/doc/src/qtwinextras-module-qml.qdoc
+++ b/src/winextras/doc/src/qtwinextras-module-qml.qdoc
@@ -29,7 +29,7 @@
\qmlmodule QtWinExtras
\title Qt Windows Extras QML Types
\ingroup qmlmodules
- \brief Enables use of MS Windows features with QML.
+ \brief Enables the use of Windows features with QML.
\section1 QML Types
*/
diff --git a/src/winextras/qjumplist.cpp b/src/winextras/qjumplist.cpp
index aa82c21..868f6af 100644
--- a/src/winextras/qjumplist.cpp
+++ b/src/winextras/qjumplist.cpp
@@ -71,14 +71,14 @@ public:
\inmodule QtWinExtras
\since 5.2
\inheaderfile QJumpList
- \brief This class represents Jump List destination or link.
+ \brief The QJumpListItem class represents a Jump List destination or link.
Objects of this class are returned by QJumpList::removedDestinations()
- and can also be used to add items to Jump List.
+ and can also be used to add items to a Jump List.
*/
/*!
- Constructs a QJumpListItem with specified \a type.
+ Constructs a QJumpListItem with the specified \a type.
*/
QJumpListItem::QJumpListItem(QJumpListItem::Type type) :
d_ptr(new QJumpListItemPrivate)
@@ -94,7 +94,7 @@ QJumpListItem::~QJumpListItem()
}
/*!
- Sets item \a type.
+ Sets the item \a type.
*/
void QJumpListItem::setType(QJumpListItem::Type type)
{
@@ -103,7 +103,7 @@ void QJumpListItem::setType(QJumpListItem::Type type)
}
/*!
- Returns item type.
+ Returns the item type.
*/
QJumpListItem::Type QJumpListItem::type() const
{
@@ -112,11 +112,19 @@ QJumpListItem::Type QJumpListItem::type() const
}
/*!
- Sets item \a filePath, meaning of which depends on type of this item.
+ Sets the item \a filePath, the meaning of which depends on the type of this
+ item:
- If item type is QJumpListItem::Destination, then \a filePath is path to a file, which can be opened by application.
+ \list
- If item type is QJumpListItem::Link, then \a filePath is path to an executable, which will be executed when this item is clicked by user.
+ \li If the item type is QJumpListItem::Destination, \a filePath is the
+ path to a file that can be opened by an application.
+
+ \li If the item type is QJumpListItem::Link, \a filePath is the path to
+ an executable that is executed when this item is clicked by the
+ user.
+
+ \endlist
\sa setWorkingDirectory(), setArguments()
*/
@@ -127,7 +135,7 @@ void QJumpListItem::setFilePath(const QString &filePath)
}
/*!
- Returns file path, set by setFilePath().
+ Returns the file path set by setFilePath().
*/
QString QJumpListItem::filePath() const
{
@@ -136,9 +144,9 @@ QString QJumpListItem::filePath() const
}
/*!
- Sets working directory path of this item using \a workingDirectory provided.
+ Sets the path to the working directory of this item to \a workingDirectory.
- This value is used only if type of this item is QJumpListItem::Link.
+ This value is used only if the type of this item is QJumpListItem::Link.
\sa setFilePath()
*/
@@ -149,7 +157,7 @@ void QJumpListItem::setWorkingDirectory(const QString &workingDirectory)
}
/*!
- Returns working directory path.
+ Returns the working directory path.
*/
QString QJumpListItem::workingDirectory() const
{
@@ -158,9 +166,9 @@ QString QJumpListItem::workingDirectory() const
}
/*!
- Sets \a icon of this item.
+ Sets the \a icon of this item.
- This value is used only if type of this item is QJumpListItem::Link.
+ This value is used only if the type of this item is QJumpListItem::Link.
*/
void QJumpListItem::setIcon(const QIcon &icon)
{
@@ -169,7 +177,7 @@ void QJumpListItem::setIcon(const QIcon &icon)
}
/*!
- Returns icon set for this item.
+ Returns the icon set for this item.
*/
QIcon QJumpListItem::icon() const
{
@@ -178,9 +186,9 @@ QIcon QJumpListItem::icon() const
}
/*!
- Sets \a title of this item.
+ Sets the \a title of this item.
- This value is used only if type of this item is QJumpListItem::Link.
+ This value is used only if the type of this item is QJumpListItem::Link.
*/
void QJumpListItem::setTitle(const QString &title)
{
@@ -189,7 +197,7 @@ void QJumpListItem::setTitle(const QString &title)
}
/*!
- Returns title of this item.
+ Returns the title of this item.
*/
QString QJumpListItem::title() const
{
@@ -198,9 +206,9 @@ QString QJumpListItem::title() const
}
/*!
- Sets \a description for this item.
+ Sets a \a description for this item.
- This value is used only if type of this item is QJumpListItem::Link.
+ This value is used only if the type of this item is QJumpListItem::Link.
*/
void QJumpListItem::setDescription(const QString &description)
{
@@ -209,7 +217,7 @@ void QJumpListItem::setDescription(const QString &description)
}
/*!
- Returns description of this item.
+ Returns the description of this item.
*/
QString QJumpListItem::description() const
{
@@ -220,7 +228,7 @@ QString QJumpListItem::description() const
/*!
Sets command-line \a arguments for this item.
- This value is used only if type of this item is QJumpListItem::Link.
+ This value is used only if the type of this item is QJumpListItem::Link.
\sa setFilePath()
*/
@@ -231,7 +239,7 @@ void QJumpListItem::setArguments(const QStringList &arguments)
}
/*!
- Returns command-line arguments of this item.
+ Returns the command-line arguments of this item.
*/
QStringList QJumpListItem::arguments() const
{
@@ -537,22 +545,36 @@ public:
/*!
\class QJumpList
\inmodule QtWinExtras
- \brief This class represents a transparent wrapper around Windows Jump Lists.
+ \brief The QJumpList class represents a transparent wrapper around Windows
+ Jump Lists.
\since 5.2
- An application can use Jump Lists to provide user with faster access to files or display shortcuts to tasks or commands.
+ An application can use Jump Lists to provide users with faster access to
+ files or to display shortcuts to tasks or commands.
\image jumplist.png Jump List
- \b Destinations — categorized shortucts to files and URLs which application can handle and even links to another applications.
- Windows provides two standard categories, which can be added to custom Jump List, in addition to ones that application can create by itself.
- \b Recent and \b Frequent — so called 'known' categories — are populated automatically by Windows when application
- uses QFileDialog::getOpenFileName function or when the application is launched to open a file from Windos Shell.
- \note in order for application to be able to add destinations to its Jump Lists it should associate itself with
- file types it can handle.
+ \list
+
+ \li \b Destinations — categorized shortcuts to files and URLs that the
+ application can handle and even links to other applications.
+ Windows provides two standard categories that can be added to the
+ custom Jump List, in addition to the ones that the application can
+ create itself.
+ \li \b Recent and \b Frequent — so called \e known categories that are
+ populated automatically by Windows when the application uses the
+ QFileDialog::getOpenFileName() function or when the application is
+ launched to open a file from the Windows shell.
+
+ \li \b Tasks — shortcuts to application functionality. An application
+ can display its most frequently used context-independent functions
+ on task lists.
+
+ \endlist
- \b Tasks — shortcuts to application functionality. Application can display there its most frequently used context-independent functions.
+ \note To be able to add destinations to its Jump Lists, the application
+ should associate itself with the file types it can handle.
\section3 Example
@@ -564,14 +586,18 @@ public:
This enum specifies QJumpListItem type, changing its meaning for QJumpList.
- \value Unknown Invalid item type.
- \value Destination Item acts as link to file which application can open.
- \value Link Item represends a link to some application.
- \value Separator Item becomes a separator. Used only for task list.
+ \value Unknown
+ Invalid item type.
+ \value Destination
+ Item acts as a link to a file that the application can open.
+ \value Link
+ Item represents a link to some application.
+ \value Separator
+ Item becomes a separator. This value is used only for task lists.
*/
/*!
- Constructs a QJumpList with parent object \a parent.
+ Constructs a QJumpList with the parent object \a parent.
*/
QJumpList::QJumpList(QObject *parent) :
QObject(parent), d_ptr(new QJumpListPrivate)
@@ -582,8 +608,8 @@ QJumpList::QJumpList(QObject *parent) :
}
/*!
- Destroys the QJumpList. If commit() or abort() were not called for corresponding begin() call
- thenJump List building is aborted.
+ Destroys the QJumpList. If commit() or abort() were not called for the
+ corresponding begin() call, building the Jump List is aborted.
*/
QJumpList::~QJumpList()
{
@@ -596,8 +622,8 @@ QJumpList::~QJumpList()
/*!
Initiates Jump List building.
- This method must be called before adding any item.
- Returns true in success and false otherwise.
+ This method must be called before adding Jump List items.
+ Returns true if successful; otherwise returns false.
*/
bool QJumpList::begin()
{
@@ -619,7 +645,7 @@ bool QJumpList::begin()
/*!
Completes Jump List building, initiated by begin(), and displays it.
- Returns true in success and false otherwise.
+ Returns true if successful; otherwise returns false.
*/
bool QJumpList::commit()
{
@@ -646,8 +672,9 @@ bool QJumpList::commit()
}
/*!
- Aborts Jump List building initiated by begin() leving currently active Jump List unchanged.
- Returns true on success and false otherwise.
+ Aborts Jump List building initiated by begin() and leaves the currently
+ active Jump List unchanged.
+ Returns true if successful; otherwise returns false.
*/
bool QJumpList::abort()
{
@@ -663,8 +690,8 @@ bool QJumpList::abort()
}
/*!
- Clears application Jump List.
- Returns true on success and false otherwise.
+ Clears the application Jump List.
+ Returns true if successful; otherwise returns false.
*/
bool QJumpList::clear()
{
@@ -682,10 +709,11 @@ bool QJumpList::clear()
return result;
}
/*!
- Specifies a unique AppUserModelID \a appId for the application whose custom Jump List will be built using this object.
+ Specifies a unique AppUserModelID \a appId for the application whose custom
+ Jump List will be built using this object.
This is optional.
This method must be called before begin().
- Returns true in success and false otherwise.
+ Returns true if successful; otherwise returns false.
*/
bool QJumpList::setApplicationId(const QString &appId)
{
@@ -702,7 +730,8 @@ bool QJumpList::setApplicationId(const QString &appId)
}
/*!
- Retrieves destinations which were removed by user and must not be added again.
+ Retrieves destinations that were removed by the user and must not be added
+ again.
Adding a group with removed destinations will fail.
*/
QList<QJumpListItem *> QJumpList::removedDestinations() const
@@ -716,7 +745,8 @@ QList<QJumpListItem *> QJumpList::removedDestinations() const
}
/*!
- Returns the number of items which Jump List will display. This is configured by user.
+ Returns the number of items that the Jump List will display. This is
+ configured by the user.
*/
int QJumpList::capacity() const
{
@@ -726,9 +756,9 @@ int QJumpList::capacity() const
/*!
\property QJumpList::isRecentCategoryShown
- \brief whether to show 'Recent' known category.
+ \brief whether to show the known Recent category
- This property's default is false.
+ The default value of this property is false.
Changes to this property are applied only after commit() is called.
*/
void QJumpList::setRecentCategoryShown(bool show)
@@ -745,9 +775,9 @@ bool QJumpList::isRecentCategoryShown() const
/*!
\property QJumpList::isFrequentCategoryShown
- \brief whether to show 'Recent' known category.
+ \brief whether to show the known Frequent category
- This property's default is false.
+ The default value of this property is false.
Changes to this property are applied only after commit() is called.
*/
void QJumpList::setFrequentCategoryShown(bool show)
@@ -763,9 +793,9 @@ bool QJumpList::isFrequentCategoryShown() const
}
/*!
- Declares building of a custom category with specified \a title.
+ Declares the building of a custom category with the specified \a title.
- begin() must be called before call to this method.
+ begin() must be called before calling this method.
*/
void QJumpList::beginCategory(const QString &title)
{
@@ -782,9 +812,9 @@ void QJumpList::beginCategory(const QString &title)
}
/*!
- Declares building of a task list.
+ Declares the building of a task list.
- begin() must be called before call to this method.
+ begin() must be called before calling this method.
*/
void QJumpList::beginTasks()
{
@@ -799,10 +829,10 @@ void QJumpList::beginTasks()
}
/*!
- Adds a \a item to Jump List.
+ Adds an \a item to the Jump List.
- beginCategory() or beginTasks() should be called before call to this method.
- Returns true in success and false otherwise.
+ beginCategory() or beginTasks() should be called before calling this method.
+ Returns true if successful; otherwise returns false.
*/
bool QJumpList::addItem(QJumpListItem *item)
{
@@ -816,9 +846,9 @@ bool QJumpList::addItem(QJumpListItem *item)
}
/*!
- Adds a destination to Jump List pointing to \a filePath provided.
+ Adds a destination to the Jump List pointing to \a filePath.
- beginCategory() or beginTasks() should be called before call to this method.
+ beginCategory() or beginTasks() should be called before calling this method.
*/
void QJumpList::addDestination(const QString &filePath)
{
@@ -832,11 +862,12 @@ void QJumpList::addDestination(const QString &filePath)
}
/*!
- \overload addLink(const QIcon &icon, const QString &title, const QString &description, const QString &workingDirectory, const QString &executablePath, const QStringList &arguments)
+ \overload addLink()
- Adds a link to to JumpList using \a title, \a executablePath and optional \a arguments provided.
+ Adds a link to the Jump List using \a title, \a executablePath, and
+ optionally \a arguments.
- beginCategory() or beginTasks() should be called before call to this method.
+ beginCategory() or beginTasks() should be called before calling this method.
*/
void QJumpList::addLink(const QString &title, const QString &executablePath, const QStringList &arguments)
{
@@ -844,11 +875,12 @@ void QJumpList::addLink(const QString &title, const QString &executablePath, con
}
/*!
- \overload addLink(const QIcon &icon, const QString &title, const QString &description, const QString &workingDirectory, const QString &executablePath, const QStringList &arguments)
+ \overload addLink()
- Adds a link to to JumpList using \a title, \a description, \a executablePath and optional \a arguments provided.
+ Adds a link to the Jump List using \a title, \a description,
+ \a executablePath, and optionally \a arguments.
- beginCategory() or beginTasks() should be called before call to this method.
+ beginCategory() or beginTasks() should be called before calling this method.
*/
void QJumpList::addLink(const QString &title, const QString &description, const QString &executablePath, const QStringList &arguments)
{
@@ -856,11 +888,12 @@ void QJumpList::addLink(const QString &title, const QString &description, const
}
/*!
- \overload addLink(const QIcon &icon, const QString &title, const QString &description, const QString &workingDirectory, const QString &executablePath, const QStringList &arguments)
+ \overload addLink()
- Adds a link to to JumpList using \a icon, \a title, \a executablePath and optional \a arguments provided.
+ Adds a link to the Jump List using \a icon, \a title, \a executablePath, and
+ optionally \a arguments.
- beginCategory() or beginTasks() should be called before call to this method.
+ beginCategory() or beginTasks() should be called before calling this method.
*/
void QJumpList::addLink(const QIcon &icon, const QString &title, const QString &executablePath, const QStringList &arguments)
{
@@ -868,11 +901,12 @@ void QJumpList::addLink(const QIcon &icon, const QString &title, const QString &
}
/*!
- \overload addLink(const QIcon &icon, const QString &title, const QString &description, const QString &workingDirectory, const QString &executablePath, const QStringList &arguments)
+ \overload addLink()
- Adds a link to to JumpList using \a icon, \a title, \a description, \a executablePath and optional \a arguments provided.
+ Adds a link to the Jump List using \a icon, \a title, \a description,
+ \a executablePath, and optionally \a arguments.
- beginCategory() or beginTasks() should be called before call to this method.
+ beginCategory() or beginTasks() should be called before calling this method.
*/
void QJumpList::addLink(const QIcon &icon, const QString &title, const QString &description, const QString &executablePath, const QStringList &arguments)
{
@@ -880,9 +914,10 @@ void QJumpList::addLink(const QIcon &icon, const QString &title, const QString &
}
/*!
- Adds a link to to JumpList using \a icon, \a title, \a description, \a workingDirectory, \a executablePath and \a arguments provided.
+ Adds a link to the Jump List using \a icon, \a title, \a description,
+ \a workingDirectory, \a executablePath, and \a arguments.
- beginCategory() or beginTasks() should be called before call to this method.
+ beginCategory() or beginTasks() should be called before calling this method.
*/
void QJumpList::addLink(const QIcon &icon, const QString &title, const QString &description, const QString &workingDirectory, const QString &executablePath, const QStringList &arguments)
{
@@ -901,9 +936,9 @@ void QJumpList::addLink(const QIcon &icon, const QString &title, const QString &
}
/*!
- Adds separator to Jump List.
+ Adds a separator to the Jump List.
- beginTasks() should be called before call to this method.
+ beginTasks() should be called before calling this method.
*/
void QJumpList::addSeparator()
{
diff --git a/src/winextras/qwinfunctions.cpp b/src/winextras/qwinfunctions.cpp
index 95b3fed..15fd23d 100644
--- a/src/winextras/qwinfunctions.cpp
+++ b/src/winextras/qwinfunctions.cpp
@@ -74,24 +74,39 @@ Q_GUI_EXPORT QPixmap qt_pixmapFromWinHICON(HICON icon);
\section2 Type Conversion
- The QWinExtras namespace provides functions with the help of which Qt objects of classes such as QPixmap or QImage
- can be converted to Windows HBITMAP or HICON handle and vice versa.
+ The QWinExtras namespace provides functions to convert Qt objects of classes
+ such as QPixmap or QImage to Windows HBITMAP or HICON handles, and vice
+ versa.
\section2 DWM and Glass Frame
- The glass frame firstly introduced with Windows Vista can be easily manipulated using extendFrameIntoClientArea() and enableBlurBehindWindow() functions.
- Windows 8 lost glass effect, but applications still can integrate their windows into system frame.
- Applications can use that feature to visually separate window controls from the rest if it or focus user's attention on window content.
+ You can determine whether a window is included in the DWM Flip3D rendering.
- \image glass.png Glass frame extended into client area of a window.
+ The glass frame that was first introduced with Windows Vista can be easily
+ manipulated using the extendFrameIntoClientArea() and
+ enableBlurBehindWindow() functions. Windows 8 lost the glass effect, but
+ applications can still integrate their windows into the system frame to
+ visually separate window controls from the rest of the window or to focus
+ the user's attention on window content.
- Windows 7 \b {Aero Peek} feature gives user power of X-ray vision allowing user to peer past all open windows straight to desktop and gadgets placed there.
- An application can use the setWindowExcludedFromPeek function to exclude it's window from Aero Peek to allow user to view window contents without him actually switching to it.
- That behavior, for example, can be enabled for a gadget-like window of for a window which constantly displays some monitoring data.
+ \image glass.png "Glass frame extended into client area of a window"
- \note The Aero Peek is disabled in Windows 8 by defalut but can be enabled by user.
+ \section2 Aero Peek
+
+ The Windows 7 \b {Aero Peek} feature gives the users the powers of X-ray
+ vision that enable them to peek past all open windows straight at the
+ desktop and the gadgets placed there. They can view the contents of a window
+ without actually switching to it. You can enable Aero Peek for a
+ gadget-like window or for a window that constantly displays monitoring data.
+
+ You can use the setWindowExcludedFromPeek() function to exclude an
+ application window from Aero Peek.
+
+ \note Aero Peek is disabled in Windows 8 by default but can be enabled
+ by the user.
+
+ \image peek-on.png "A window excluded from Aero Peek"
- \image peek-on.png A window excluded from Aero Peek
*/
/*!
@@ -111,7 +126,7 @@ HBITMAP QWinExtras::createMask(const QBitmap &bitmap)
/*!
\since 5.2
- Creates a \c HBITMAP equivalent to the QPixmap \a p,
+ Creates a \c HBITMAP equivalent of the QPixmap \a p,
based on the given \a format. Returns the \c HBITMAP handle.
It is the caller's responsibility to free the \c HBITMAP data
@@ -140,7 +155,7 @@ QPixmap QWinExtras::fromHBITMAP(HBITMAP bitmap, QWinExtras::HBitmapFormat format
/*!
\since 5.2
- Creates a \c HICON equivalent to the QPixmap \a p.
+ Creates a \c HICON equivalent of the QPixmap \a p.
Returns the \c HICON handle.
It is the caller's responsibility to free the \c HICON data after use.
@@ -157,7 +172,7 @@ HICON QWinExtras::toHICON(const QPixmap &p)
Returns a QImage that is equivalent to the
given \a bitmap. The conversion is based on the specified \c HDC context \a hdc
- using specified \a width and \a height.
+ using the specified \a width and \a height.
\sa toHBITMAP()
*/
@@ -238,8 +253,8 @@ QRegion QWinExtras::fromHRGN(HRGN hrgn)
/*!
\since 5.2
- Returns a message string which explains \a hresult error id specified or empty string
- if explanation cannot be found.
+ Returns a message string that explains the \a hresult error id specified or
+ an empty string if the explanation cannot be found.
*/
QString QWinExtras::stringFromHresult(HRESULT hresult)
{
@@ -255,7 +270,8 @@ QString QWinExtras::stringFromHresult(HRESULT hresult)
/*!
\since 5.2
- Returns code name of \a hresult error id specified (usually WinAPI macros name) or empty string if message is unknown.
+ Returns the code name of the \a hresult error id specified (usually the name
+ of the WinAPI macro) or an empty string if the message is unknown.
*/
QString QWinExtras::errorStringFromHresult(HRESULT hresult)
{
@@ -1445,7 +1461,9 @@ QString QWinExtras::errorStringFromHresult(HRESULT hresult)
/*!
\since 5.2
- Returns DWM colorization color. After function returns the optional \a opaqueBlend will contain true if the color is an opaque blend and false otherwise.
+ Returns the DWM colorization color. After the function returns, the optional
+ \a opaqueBlend will contain true if the color is an opaque blend and false
+ otherwise.
*/
QColor QWinExtras::colorizationColor(bool *opaqueBlend)
{
@@ -1462,9 +1480,10 @@ QColor QWinExtras::colorizationColor(bool *opaqueBlend)
/*!
\since 5.2
- Returns real colorization color, set by user, using undocumented registry key.
- API-based function \c getColorizationColor() returns a alpha-blended color which is often more like semitransparent gray
- than something similar to what is chosen by user.
+ Returns the real colorization color, set by the user, using an undocumented
+ registry key. The API-based function \c getColorizationColor() returns an
+ alpha-blended color which often turns out a semitransparent gray rather
+ than something similar to what is chosen by the user.
\sa QWinExtras::colorizationColor()
*/
@@ -1490,7 +1509,7 @@ QColor QWinExtras::realColorizationColor()
/*!
\since 5.2
- Excludes the \a window from Aero Peek if \a exclude is \c true.
+ Excludes the specified \a window from Aero Peek if \a exclude is true.
*/
void QWinExtras::setWindowExcludedFromPeek(QWindow *window, bool exclude)
{
@@ -1508,7 +1527,7 @@ void QWinExtras::setWindowExcludedFromPeek(QWindow *window, bool exclude)
/*!
\since 5.2
- Returns true if the \a window is excluded from Aero Peek.
+ Returns true if the specified \a window is excluded from Aero Peek.
*/
bool QWinExtras::isWindowExcludedFromPeek(QWindow *window)
{
@@ -1527,7 +1546,9 @@ bool QWinExtras::isWindowExcludedFromPeek(QWindow *window)
/*!
\since 5.2
- Disables Aero Peek for the \a window when hovering taskbar thumbnail of the window with mouse pointer if \a disallow is true and allows otherwise.
+ Disables Aero Peek for the specified \a window when hovering over the
+ taskbar thumbnail of the window with the mouse pointer if \a disallow is
+ true; otherwise allows it.
The default is false.
*/
@@ -1547,7 +1568,8 @@ void QWinExtras::setWindowDisallowPeek(QWindow *window, bool disallow)
/*!
\since 5.2
- Returns true if Aero Peek is disallowed on thumbnail of this \a window.
+ Returns true if Aero Peek is disallowed on the thumbnail of the specified
+ \a window.
*/
bool QWinExtras::isWindowPeekDisallowed(QWindow *window)
{
@@ -1566,7 +1588,7 @@ bool QWinExtras::isWindowPeekDisallowed(QWindow *window)
/*!
\since 5.2
- Set Flip3D \a policy for \a window.
+ Sets the Flip3D policy \a policy for the specified \a window.
*/
void QWinExtras::setWindowFlip3DPolicy(QWindow *window, QWinExtras::WindowFlip3DPolicy policy)
{
@@ -1598,13 +1620,13 @@ void QWinExtras::setWindowFlip3DPolicy(QWindow *window, QWinExtras::WindowFlip3D
/*!
\fn QWinExtras::WindowFlip3DPolicy QWinExtras::windowFlip3DPolicy(QWidget *window)
\since 5.2
- \overload QWinExtras::WindowFlip3DPolicy QWinExtras::windowFlip3DPolicy()
+ \overload QWinExtras::windowFlip3DPolicy()
*/
/*!
\since 5.2
- Returns current Flip3D policy for \a window.
+ Returns the current Flip3D policy for the specified \a window.
*/
QWinExtras::WindowFlip3DPolicy QWinExtras::windowFlip3DPolicy(QWindow *window)
{
@@ -1643,13 +1665,17 @@ void qt_ExtendFrameIntoClientArea(QWindow *window, int left, int top, int right,
/*!
\since 5.2
- Extend glass frame into client area of the \a window using \a left, \a top, \a right and \a bottom margin values.
+ Extends the glass frame into the client area of the specified \a window
+ using the \a left, \a top, \a right, and \a bottom margin values.
- Pass -1 as values for any of the four margins to fully extend frame, creating "sheet of glass" effect.
+ Pass -1 as values for any of the four margins to fully extend the frame,
+ creating a \e {sheet of glass} effect.
- If you want extended frame to act like standard window border, you should handle that yourself.
+ If you want the extended frame to act like a standard window border, you
+ should handle that yourself.
- \note If the \a window is a QWidget handle, then you should set the Qt::WA_NoSystemBackground attribute to your widget.
+ \note If \a window is a QWidget handle, set the
+ Qt::WA_NoSystemBackground attribute for your widget.
\sa QWinExtras::resetExtendedFrame()
*/
@@ -1663,14 +1689,16 @@ void QWinExtras::extendFrameIntoClientArea(QWindow *window, int left, int top, i
\since 5.2
\overload QWinExtras::extendFrameIntoClientArea()
- Convenience overload which allows passing frame sizes in a \a margins structure.
+ Convenience overload that allows passing frame sizes in a \a margins
+ structure.
*/
/*!
\since 5.2
\overload QWinExtras::extendFrameIntoClientArea()
- Extend glass frame into client area of the \a window using \a margins provided.
+ Extends the glass frame into the client area of the specified \a window
+ using the specified \a margins.
*/
void QWinExtras::extendFrameIntoClientArea(QWindow *window, const QMargins &margins)
{
@@ -1686,11 +1714,13 @@ void QWinExtras::extendFrameIntoClientArea(QWindow *window, const QMargins &marg
/*!
\since 5.2
- Resets glass frame and restores \a window attributes.
+ Resets the glass frame and restores the \a window attributes.
- This functions just calls \c extendFrameIntoClientArea() with margins set to 0 and is provided for convenience.
+ This convenience function calls extendFrameIntoClientArea() with margins set
+ to 0.
- \note You should unset the \c Qt::WA_NoSystemBackground attribute if you did that in order to \c extendFrameIntoClientArea() to work.
+ \note You must unset the Qt::WA_NoSystemBackground attribute for
+ extendFrameIntoClientArea() to work.
\sa QWinExtras::extendFrameIntoClientArea()
*/
@@ -1709,7 +1739,8 @@ void QWinExtras::resetExtendedFrame(QWindow *window)
/*!
\since 5.2
- Enables the blur effect for the \a window on a specified \a region.
+ Enables the blur effect for the specified \a region of the specified
+ \a window.
\sa disableBlurBehindWindow()
*/
@@ -1742,7 +1773,7 @@ void QWinExtras::enableBlurBehindWindow(QWindow *window, const QRegion &region)
/*!
\since 5.2
- Enables blur effect on a \a window.
+ Enables the blur effect for the specified \a window.
\sa disableBlurBehindWindow()
*/
@@ -1760,7 +1791,7 @@ void QWinExtras::enableBlurBehindWindow(QWindow *window)
/*!
\since 5.2
- Disables previuosly enabled blur effect on the \a window.
+ Disables the previously enabled blur effect for the specified \a window.
\sa enableBlurBehindWindow()
*/
@@ -1776,7 +1807,7 @@ void QWinExtras::disableBlurBehindWindow(QWindow *window)
/*!
\since 5.2
- Returns DWM composition state.
+ Returns the DWM composition state.
*/
bool QWinExtras::isCompositionEnabled()
{
@@ -1790,9 +1821,10 @@ bool QWinExtras::isCompositionEnabled()
/*!
\since 5.2
- Set whether Windows Desktop composition is \a enabled.
+ Sets whether the Windows Desktop composition is \a enabled.
- \note Underlying function declared deprecated as of Windows 8 and has no effect.
+ \note The underlying function was declared deprecated as of Windows 8 and
+ takes no effect.
*/
void QWinExtras::setCompositionEnabled(bool enabled)
{
@@ -1817,9 +1849,11 @@ bool QWinExtras::isCompositionOpaque()
/*!
\since 5.2
- Set Application User Model ID \a id.
+ Sets the Application User Model ID \a id.
- More at http://msdn.microsoft.com/en-us/library/windows/desktop/dd378459.aspx
+ For more information, see
+ \l{http://msdn.microsoft.com/en-us/library/windows/desktop/dd378459.aspx}
+ {Application User Model IDs}.
*/
void QWinExtras::setCurrentProcessExplicitAppUserModelID(const QString &id)
{
@@ -1869,9 +1903,13 @@ ITaskbarList2 *qt_createITaskbarList2()
/*!
\since 5.2
- Marks a \a window as full-screen in order to handle it correctly by the shell if \a fullscreen is true and removes the mark otherwise.
+ Marks the specified \a window as running in the full-screen mode if
+ \a fullscreen is true, so that the shell handles it correctly. Otherwise,
+ removes the mark.
- \note You don't usually need to call this function as Windows taskbar always tries to determine whether windows is fullscreen.
+ \note You do not usually need to call this function, because the Windows
+ taskbar always tries to determine whether a window is running in the
+ full-screen mode.
*/
void QWinExtras::markFullscreenWindow(QWindow *window, bool fullscreen)
{
@@ -1891,7 +1929,7 @@ void QWinExtras::markFullscreenWindow(QWindow *window, bool fullscreen)
/*!
\since 5.2
- Activates an item on the taskbar without activating \a window itself.
+ Activates an item on the taskbar without activating the \a window itself.
*/
void QWinExtras::taskbarActivateTab(QWindow *window)
{
@@ -1911,7 +1949,8 @@ void QWinExtras::taskbarActivateTab(QWindow *window)
/*!
\since 5.2
- Marks an item on the taskbar which represents \a window as active but not visually activates it.
+ Marks the item that represents the specified \a window on the taskbar
+ as active, but does not activate it visually.
*/
void QWinExtras::taskbarActivateTabAlt(QWindow *window)
{
@@ -1931,7 +1970,7 @@ void QWinExtras::taskbarActivateTabAlt(QWindow *window)
/*!
\since 5.2
- Adds an item for the \a window to taskbar.
+ Adds an item for the specified \a window to the taskbar.
*/
void QWinExtras::taskbarAddTab(QWindow *window)
{
@@ -1951,7 +1990,7 @@ void QWinExtras::taskbarAddTab(QWindow *window)
/*!
\since 5.2
- Removes the \a window from taskbar.
+ Removes the specified \a window from the taskbar.
*/
void QWinExtras::taskbarDeleteTab(QWindow *window)
{
@@ -1970,17 +2009,20 @@ void QWinExtras::taskbarDeleteTab(QWindow *window)
This enum defines how the conversion between \c
HBITMAP and QPixmap is performed.
- \value HBitmapNoAlpha The alpha channel is ignored and always treated as
+ \value HBitmapNoAlpha
+ The alpha channel is ignored and always treated as
being set to fully opaque. This is preferred if the \c HBITMAP is
used with standard GDI calls, such as \c BitBlt().
- \value HBitmapPremultipliedAlpha The \c HBITMAP is treated as having an
+ \value HBitmapPremultipliedAlpha
+ The \c HBITMAP is treated as having an
alpha channel and premultiplied colors. This is preferred if the
\c HBITMAP is accessed through the \c AlphaBlend() GDI function.
- \value HBitmapAlpha The \c HBITMAP is treated as having a plain alpha
+ \value HBitmapAlpha
+ The \c HBITMAP is treated as having a plain alpha
channel. This is the preferred format if the \c HBITMAP is going
- to be used as an application icon or systray icon.
+ to be used as an application icon or a systray icon.
\sa fromHBITMAP(), toHBITMAP()
*/
@@ -1990,11 +2032,19 @@ void QWinExtras::taskbarDeleteTab(QWindow *window)
\since 5.2
- \value FlipDefault Let the OS decide.
+ This enum type specifies the Flip3D window policy.
+
+ \value FlipDefault
+ Let the OS decide whether to include the window in the Flip3D
+ rendering.
- \value FlipExcludeAbove Exclude the window from Flip3D and display it above Flip3D.
+ \value FlipExcludeAbove
+ Exclude the window from Flip3D and display it above the Flip3D
+ rendering.
- \value FlipExcludeBelow Exclude the window from Flip3D and display it below Flip3D.
+ \value FlipExcludeBelow
+ Exclude the window from Flip3D and display it below the Flip3D
+ rendering.
\sa setWindowFlip3DPolicy()
*/
diff --git a/src/winextras/qwintaskbarbutton.cpp b/src/winextras/qwintaskbarbutton.cpp
index 55cd3ae..651a0ec 100644
--- a/src/winextras/qwintaskbarbutton.cpp
+++ b/src/winextras/qwintaskbarbutton.cpp
@@ -56,24 +56,36 @@ QT_BEGIN_NAMESPACE
/*!
\class QWinTaskbarButton
\inmodule QtWinExtras
- \brief The QWinTaskbarButton class represents Windows taskbar button for a window.
+ \brief The QWinTaskbarButton class represents the Windows taskbar button for
+ a window.
\since 5.2
- The QWinTaskbarButton class allows setting overlay icons on a button, displaying progress indicator and adding small toolbar to window thumbnail popup.
+ The QWinTaskbarButton class enables you to set overlay icons on a taskbar
+ button, to display a progress indicator, and to add a small toolbar to the
+ window thumbnail popup.
*/
/*!
\enum QWinTaskbarButton::ProgressState
- \value NoProgressState No progress indicator.
- \value IndeterminateState The progress indicator cycles repeatedly.
- \value NormalState
- \value PausedState Indicator turns yellow. Use that to show that operation has been paused, but can be continued.
- \value ErrorState Indicator turns red.
+
+ This enum type specifies the state of the progress indicator.
+
+ \value NoProgressState
+ No progress indicator is displayed.
+ \value IndeterminateState
+ The progress indicator cycles repeatedly.
+ \value NormalState
+ The progress indicator is green.
+ \value PausedState
+ The progress indicator turns yellow. Use this state to show that the
+ operation has been paused, but it can be continued.
+ \value ErrorState
+ The progress indicator turns red.
*/
/*!
- Constructs a QWinTaskbarButton with parent object \a parent.
+ Constructs a QWinTaskbarButton with the parent object \a parent.
*/
QWinTaskbarButton::QWinTaskbarButton(QObject *parent) :
QObject(parent), d_ptr(new QWinTaskbarButtonPrivate(this))
@@ -89,7 +101,8 @@ QWinTaskbarButton::~QWinTaskbarButton()
}
/*!
- Sets \a window, on taskbar button of which this QWinTaskbarButton will operate.
+ Sets the \a window whose taskbar button this QWinTaskbarButton will operate
+ on.
*/
void QWinTaskbarButton::setWindow(QWindow *window)
{
@@ -108,7 +121,7 @@ void QWinTaskbarButton::setWindow(QWindow *window)
/*!
\property QWinTaskbarButton::overlayIcon
- \brief holds overlay icon of the button.
+ \brief the overlay icon of the button
*/
QIcon QWinTaskbarButton::overlayIcon() const
{
@@ -118,7 +131,7 @@ QIcon QWinTaskbarButton::overlayIcon() const
/*!
\property QWinTaskbarButton::overlayIconAccessibilityDescription
- \brief holds the overlay icon accessibility description text.
+ \brief the overlay icon accessibility description text
*/
QString QWinTaskbarButton::overlayIconAccessibilityDescription() const
{
@@ -128,7 +141,7 @@ QString QWinTaskbarButton::overlayIconAccessibilityDescription() const
/*!
\property QWinTaskbarButton::progressState
- \brief holds progress state of the progress indicator.
+ \brief the progress state of the progress indicator
*/
QWinTaskbarButton::ProgressState QWinTaskbarButton::progressState() const
{
@@ -138,7 +151,7 @@ QWinTaskbarButton::ProgressState QWinTaskbarButton::progressState() const
/*!
\property QWinTaskbarButton::progressValue
- \brief holds the current progress value of the progress indicator.
+ \brief the current progress value of the progress indicator
*/
int QWinTaskbarButton::progressValue() const
{
@@ -148,7 +161,7 @@ int QWinTaskbarButton::progressValue() const
/*!
\property QWinTaskbarButton::progressMinimum
- \brief holds the minimum value of the progress indicator.
+ \brief the minimum value of the progress indicator
*/
int QWinTaskbarButton::progressMinimum() const
{
@@ -158,7 +171,7 @@ int QWinTaskbarButton::progressMinimum() const
/*!
\property QWinTaskbarButton::progressMaximum
- \brief holds the maximum value of the progress indicator.
+ \brief the maximum value of the progress indicator
*/
int QWinTaskbarButton::progressMaximum() const
{
@@ -168,7 +181,7 @@ int QWinTaskbarButton::progressMaximum() const
/*!
\internal
- Used to intercept TaskbarButtonCreated messages.
+ Intercepts TaskbarButtonCreated messages.
*/
bool QWinTaskbarButton::eventFilter(QObject *object, QEvent *event)
{
@@ -198,7 +211,7 @@ void QWinTaskbarButton::setOverlayIconAccessibilityDescription(const QString &de
}
/*!
- Clear previously set overlay icon.
+ Clears the previously set overlay icon.
\sa QWinTaskbarButton::setOverlayIcon()
*/
void QWinTaskbarButton::clearOverlayIcon()
@@ -251,7 +264,7 @@ void QWinTaskbarButton::setProgressMaximum(int max)
}
/*!
- Sets both \a minimum and \a maximum values.
+ Sets both the \a minimum and \a maximum values.
*/
void QWinTaskbarButton::setProgressRange(int minimum, int maximum)
{
@@ -270,7 +283,8 @@ void QWinTaskbarButton::setProgressRange(int minimum, int maximum)
/*!
Resets the progress indicator of this button.
- This function sets progress state to \c NoProgressState and rewinds progress value to minimum.
+ This function sets the progress state to \c NoProgressState and rewinds the
+ progress value to the minimum value.
*/
void QWinTaskbarButton::resetProgress()
{
@@ -372,13 +386,14 @@ void QWinTaskbarButtonPrivate::updateProgressValue()
/*!
\fn void QWinTaskbarButton::progressStateChanged(const ProgressState state)
- This signal is emitted when \c progressState property changes its value. The \a state argument contains the new value.
+ This signal is emitted when the \c progressState property changes its value.
+ The \a state argument contains the new value.
*/
/*!
\fn void QWinTaskbarButton::progressValueChanged(int value)
- This signal is emitted when progress indicator \a value changes.
+ This signal is emitted when the progress indicator \a value changes.
*/
QT_END_NAMESPACE