File: LongRunningOperationMessage.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 (57 lines) | stat: -rw-r--r-- 954 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
54
55
56
57
#pragma once

#include "imessagebus.h"

namespace radiant
{

enum class OperationEvent
{
	Started,
	Finished,
};

/**
 * Message object sent to the MessageBus when one of the
 * modules are performing a long-running operation.
 *
 * UI modules can react to this by showing a blocking
 * window, depending on the event type as returned by getType().
 *
 * See also ScopedLongRunningOperation.h
 */
class LongRunningOperationMessage :
	public radiant::IMessage
{
private:
	OperationEvent _event;

	std::string _message;

public:
	LongRunningOperationMessage(OperationEvent ev) :
		LongRunningOperationMessage(ev, std::string())
	{}

	LongRunningOperationMessage(OperationEvent ev, const std::string& message) :
		_event(ev),
		_message(message)
	{}

	std::size_t getId() const override
	{
		return Type::LongRunningOperation;
	}

	OperationEvent getType() const
	{
		return _event;
	}

	const std::string& getMessage() const
	{
		return _message;
	}
};

}