From aafc759c4aa8b8b2b9fc3c3c0631ada7d084fe31 Mon Sep 17 00:00:00 2001 From: Bryan Petty Date: Wed, 10 Sep 2014 14:56:46 +0000 Subject: [PATCH] [Docs] Update docs. Author: Chaobin Zhang git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@77633 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/wx/gauge.h | 4 ++++ interface/wx/taskbarbutton.h | 18 ++++++++++++------ 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/interface/wx/gauge.h b/interface/wx/gauge.h index 71879d9ab2..61a4614fa1 100644 --- a/interface/wx/gauge.h +++ b/interface/wx/gauge.h @@ -18,6 +18,10 @@ // QT only, display current completed percentage (text default format "%p%") #define wxGA_TEXT 0x0040 +// Available since Windows 7 only. With this style, the value of guage will +// reflect on the taskbar button. +#define wxGA_PROGRESS 0x0010 + /** @class wxGauge diff --git a/interface/wx/taskbarbutton.h b/interface/wx/taskbarbutton.h index 8939e73e7a..ca9bc4461a 100644 --- a/interface/wx/taskbarbutton.h +++ b/interface/wx/taskbarbutton.h @@ -347,23 +347,29 @@ public: Constructs the wxAppProgressIndicator. @param parent - The parent window of wxAppProgressIndicator. + The parent window handle of wxAppProgressIndicator. Note that the + window should has taskbar button showing. @param maxValue */ - wxAppProgressIndicator(wxTopLevelWindow *parent, int maxValue); + wxAppProgressIndicator(WXWidget parent, int maxValue); virtual ~wxAppProgressIndicator(); /** - Updates the progress in taskbar button of parent window. + Set the progress value in taskbar button of parent window. @param value The new value of the progress meter. It should be less than or equal - to the maximum value given to the constructor. + to the range. */ - bool Update(int value); + void SetValue(int value); /** - Like Update() but makes the progress bar run in indeterminate mode. + Set the progress range in taskbar button of parent window. + */ + void SetRange(int range); + + /** + Makes the progress bar run in indeterminate mode. */ bool Pulse(); };