wxAppProgressIndicator Class Reference

#include <wx/taskbarbutton.h>

Detailed Description

A helper class that can be used to update the progress bar in the taskbar button.

Library:  wxCore

Category:  Miscellaneous

Availability:  only available for the wxMSW port.

See also

wxTaskBarButton

Public Member Functions
	wxAppProgressIndicator (WXWidget parent, int maxValue)
	Constructs the wxAppProgressIndicator. More...
virtual	~wxAppProgressIndicator ()
void	SetValue (int value)
	Set the progress value in taskbar button of parent window. More...
void	SetRange (int range)
	Set the progress range in taskbar button of parent window. More...
bool	Pulse ()
	Makes the progress bar run in indeterminate mode. More...

Constructor & Destructor Documentation

wxAppProgressIndicator::wxAppProgressIndicator	(	WXWidget	parent,
		int	maxValue
	)

Constructs the wxAppProgressIndicator.

Parameters

parent	The parent window handle of wxAppProgressIndicator. Note that the window should has taskbar button showing.
maxValue

virtual wxAppProgressIndicator::~wxAppProgressIndicator ( )

virtual

Member Function Documentation

bool wxAppProgressIndicator::Pulse

(

)

Makes the progress bar run in indeterminate mode.

void wxAppProgressIndicator::SetRange

(

int

range

)

Set the progress range in taskbar button of parent window.

void wxAppProgressIndicator::SetValue

(

int

value

)

Set the progress value in taskbar button of parent window.

Parameters

value

The new value of the progress meter. It should be less than or equal to the range.