Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs of taskbar button and wxAppProgressIndicator.

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@77643 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
2014-09-10 14:58:31 +00:00
parent b4ee657f41
commit 2f98230bd8
2 changed files with 56 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
interface/wx/appprog.h Normal file
View File

@@ -0,0 +1,55 @@
/////////////////////////////////////////////////////////////////////////////
// Name: taskbarbutton.h
// Purpose: interface of wxAppProgressIndicator
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxAppProgressIndicator
A helper class that can be used to update the progress bar in the taskbar button.
@library{wxcore}
@category{misc}
@onlyfor{wxmsw}
@see wxTaskBarButton
@since 3.1.0
*/
class WXDLLIMPEXP_CORE wxAppProgressIndicator
{
public:
/**
Constructs the wxAppProgressIndicator.
@param parent
The parent window of wxAppProgressIndicator. Note that the
window should has taskbar button showing. If parent is NULL,
the progress will reflect on the taskbar buttons of all the
top level windows.
@param maxValue
*/
wxAppProgressIndicator(wxWindow* parent = NULL, int maxValue = 100);
virtual ~wxAppProgressIndicator();
/**
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 range.
*/
void SetValue(int value);
/**
Set the progress range in taskbar button of parent window.
*/
void SetRange(int range);
/**
Makes the progress bar run in indeterminate mode.
*/
bool Pulse();
};

49
interface/wx/taskbarbutton.h
View File

@@ -1,6 +1,6 @@
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
// Name: taskbarbutton.h // Name: taskbarbutton.h
// Purpose: interface of wxTaskBarButton // Purpose: Interface of taskbar buttons features.
// Author: wxWidgets team // Author: wxWidgets team
// Licence: wxWindows licence // Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
@@ -331,53 +331,6 @@ public:
virtual wxThumbBarButton* RemoveThumbBarButton(int id); virtual wxThumbBarButton* RemoveThumbBarButton(int id);
}; };
/**
@class wxAppProgressIndicator
A helper class that can be used to update the progress bar in the taskbar button.
@library{wxcore}
@category{misc}
@onlyfor{wxmsw}
@see wxTaskBarButton
@since 3.1.0
*/
class WXDLLIMPEXP_CORE wxAppProgressIndicator
{
public:
/**
Constructs the wxAppProgressIndicator.
@param parent
The parent window of wxAppProgressIndicator. Note that the
window should has taskbar button showing.
@param maxValue
*/
wxAppProgressIndicator(wxWindow* parent, int maxValue);
virtual ~wxAppProgressIndicator();
/**
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 range.
*/
void SetValue(int value);
/**
Set the progress range in taskbar button of parent window.
*/
void SetRange(int range);
/**
Makes the progress bar run in indeterminate mode.
*/
bool Pulse();
};
/** /**
Type of jump list item. Type of jump list item.