ProgressFrame Class Reference

A frame for displaying progress indications and dialogs. More...

#include <progress_frame.h>

Inheritance diagram for ProgressFrame:

Public Slots
struct progdlg *	showProgress (const QString &title, bool animate, bool terminate_is_stop, bool *stop_flag, int value=0)
	Shows a progress indicator with a title.
struct progdlg *	showBusy (bool animate, bool terminate_is_stop, bool *stop_flag)
	Shows a busy/indeterminate progress indicator.
void	setValue (int value)
	Sets the current progress value.
void	hide ()
	Hides the progress frame.

Signals
void	showRequested (bool animate, bool terminate_is_stop, bool *stop_flag)
	Signal emitted to request showing the progress frame.
void	valueChanged (int value)
	Signal emitted when the progress value changes.
void	maximumValueChanged (int value)
	Signal emitted when the maximum progress value changes.
void	setHidden ()
	Signal emitted to hide the progress frame.
void	stopLoading ()
	Signal emitted to request stopping the current loading operation.

Public Member Functions
	ProgressFrame (QWidget *parent=0)
	Constructs a new ProgressFrame object.
	~ProgressFrame ()
	Destroys the ProgressFrame object.
void	captureFileClosing ()
	Handles the event when the capture file is closing.

Static Public Member Functions
static void	addToButtonBox (QDialogButtonBox *button_box, QObject *main_window)
	Adds the progress frame to a dialog button box.

Protected Member Functions
void	timerEvent (QTimerEvent *event)
	Handles timer events.

Detailed Description

A frame for displaying progress indications and dialogs.

Constructor & Destructor Documentation

ProgressFrame()

ProgressFrame::ProgressFrame ( QWidget *  parent = 0 )

explicit

Constructs a new ProgressFrame object.

Parameters

parent

The parent widget.

Member Function Documentation

addToButtonBox()

void ProgressFrame::addToButtonBox ( QDialogButtonBox *  button_box, QObject *  main_window  )

static

Adds the progress frame to a dialog button box.

Parameters

button_box	Pointer to the dialog button box.
main_window	Pointer to the main window object.

maximumValueChanged

void ProgressFrame::maximumValueChanged ( int  value )

signal

Signal emitted when the maximum progress value changes.

Parameters

value

The new maximum value.

setValue

void ProgressFrame::setValue ( int  value )

slot

Sets the current progress value.

Parameters

value

The new progress value.

showBusy

progdlg * ProgressFrame::showBusy ( bool  animate, bool  terminate_is_stop, bool *  stop_flag  )

slot

Shows a busy/indeterminate progress indicator.

Parameters

animate	True to animate the progress indicator.
terminate_is_stop	True if terminating acts as a stop action.
stop_flag	Pointer to a boolean flag used to indicate a stop request.

Returns

A pointer to the progdlg structure.

showProgress

struct progdlg * ProgressFrame::showProgress ( const QString &  title, bool  animate, bool  terminate_is_stop, bool *  stop_flag, int  value = 0  )

slot

Shows a progress indicator with a title.

Parameters

title	The title of the progress dialog.
animate	True to animate the progress indicator.
terminate_is_stop	True if terminating acts as a stop action.
stop_flag	Pointer to a boolean flag used to indicate a stop request.
value	The initial progress value.

Returns

A pointer to the progdlg structure.

showRequested

void ProgressFrame::showRequested ( bool  animate, bool  terminate_is_stop, bool *  stop_flag  )

signal

Signal emitted to request showing the progress frame.

Parameters

animate	True to animate the progress indicator.
terminate_is_stop	True if terminating acts as a stop action.
stop_flag	Pointer to the stop flag.

timerEvent()

void ProgressFrame::timerEvent ( QTimerEvent *  event )

protected

Handles timer events.

Parameters

event

Pointer to the timer event.

valueChanged

void ProgressFrame::valueChanged ( int  value )

signal

Signal emitted when the progress value changes.

Parameters

value

The new progress value.

---

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

• /builds/wireshark/wireshark/ui/qt/progress_frame.h
• /builds/wireshark/wireshark/ui/qt/progress_frame.cpp