ProgressStatusBar Class Reference

class for showing a status bar with progress, the progress bar is always in the last field of the statusbar More...

#include <ProgressStatusBar.h>

Inheritance diagram for ProgressStatusBar:

Public Member Functions
	ProgressStatusBar (wxWindow *parent, wxWindowID id, long style=wxST_SIZEGRIP, const wxString &name="statusBar")
	constructor, create the gauge internal
	~ProgressStatusBar ()
	destructor, clean up all stuff
void	OnSize (wxSizeEvent &event)
	size change handler, correctly position gauge when size has changed
void	SetProgress (int progress)
	update progress bar
int	GetProgress ()
	return current progress value, should be in range 0 - 100, or -1 if the progress gauge is hidden

Private Attributes
wxGauge *	m_progress
int	m_progressValue

Detailed Description

class for showing a status bar with progress, the progress bar is always in the last field of the statusbar

Definition at line 35 of file ProgressStatusBar.h.

Constructor & Destructor Documentation

ProgressStatusBar()

ProgressStatusBar::ProgressStatusBar	(	wxWindow *	parent,
		wxWindowID	id,
		long	style = wxST_SIZEGRIP,
		const wxString &	name = "statusBar"
	)

constructor, create the gauge internal

Definition at line 30 of file ProgressStatusBar.cpp.

References m_progress, OnSize(), SetProgress(), and threshold().

~ProgressStatusBar()

ProgressStatusBar::~ProgressStatusBar

(

)

destructor, clean up all stuff

Definition at line 37 of file ProgressStatusBar.cpp.

References m_progress.

Member Function Documentation

GetProgress()

int ProgressStatusBar::GetProgress

(

)

return current progress value, should be in range 0 - 100, or -1 if the progress gauge is hidden

Definition at line 65 of file ProgressStatusBar.cpp.

References m_progressValue.

Referenced by BatchFrame::UpdateTaskBarProgressBar().

OnSize()

void ProgressStatusBar::OnSize

(

wxSizeEvent &

event

)

size change handler, correctly position gauge when size has changed

Definition at line 45 of file ProgressStatusBar.cpp.

References m_progress, and threshold().

Referenced by ProgressStatusBar().

SetProgress()

void ProgressStatusBar::SetProgress

(

int

progress

)

update progress bar

Parameters

progress

sets the progress, range 0 - 100, a value of -1 will hide the progress control

Definition at line 57 of file ProgressStatusBar.cpp.

References m_progress, m_progressValue, and threshold().

Referenced by BatchFrame::OnProgress(), and ProgressStatusBar().

Member Data Documentation

m_progress

wxGauge* ProgressStatusBar::m_progress

private

Definition at line 51 of file ProgressStatusBar.h.

Referenced by OnSize(), ProgressStatusBar(), SetProgress(), and ~ProgressStatusBar().

m_progressValue

int ProgressStatusBar::m_progressValue

private

Definition at line 52 of file ProgressStatusBar.h.

Referenced by GetProgress(), and SetProgress().

---

The documentation for this class was generated from the following files:

• hugin1/ptbatcher/ProgressStatusBar.h
• hugin1/ptbatcher/ProgressStatusBar.cpp