File: ModalProgressDialog.h

package info (click to toggle)
darkradiant 3.9.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 41,080 kB
  • sloc: cpp: 264,743; ansic: 10,659; python: 1,852; xml: 1,650; sh: 92; makefile: 21
file content (53 lines) | stat: -rw-r--r-- 1,459 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
#pragma once

#include <wx/progdlg.h>
#include <string>
#include <memory>
#include <stdexcept>

namespace wxutil
{

class ModalProgressDialog :
	public wxProgressDialog
{
public:
	/** 
	 * Constructor accepts window to be modal for and the dialog title.
	 */
	ModalProgressDialog(const std::string& title, wxWindow* parent = nullptr);

	/**
	 * Exception thrown when cancel button is pressed.
	 */
	struct OperationAbortedException
	: public std::runtime_error
	{
		OperationAbortedException(const std::string& what)
		: std::runtime_error(what) {}
	};

	/**
	 * Set the completed fraction of the progress bar.
	 * If the user has clicked the Cancel button since the last update, this method
	 * will throw an exception to indicate an aborted operation.
	 */
	void setFraction(double fraction);

	/**
	 * Set the text to display in the label, and pulse the progress bar. If the
	 * user has clicked the Cancel button since the last update, this method
	 * will throw an exception to indicate an aborted operation.
	 */
	void setText(const std::string& text);

	/**
	 * Set the text to display in the label, and the completed fraction of the progress bar.
	 * If the user has clicked the Cancel button since the last update, this method
	 * will throw an exception to indicate an aborted operation.
	 */
	void setTextAndFraction(const std::string& text, double fraction);
};
typedef std::shared_ptr<ModalProgressDialog> ModalProgressDialogPtr;

} // namespace