Antares Simulator
Power System Simulator
Loading...
Searching...
No Matches
text.h
1/*
2** Copyright 2007-2024, RTE (https://www.rte-france.com)
3** See AUTHORS.txt
4** SPDX-License-Identifier: MPL-2.0
5** This file is part of Antares-Simulator,
6** Adequacy and Performance assessment for interconnected energy networks.
7**
8** Antares_Simulator is free software: you can redistribute it and/or modify
9** it under the terms of the Mozilla Public Licence 2.0 as published by
10** the Mozilla Foundation, either version 2 of the License, or
11** (at your option) any later version.
12**
13** Antares_Simulator is distributed in the hope that it will be useful,
14** but WITHOUT ANY WARRANTY; without even the implied warranty of
15** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16** Mozilla Public Licence 2.0 for more details.
17**
18** You should have received a copy of the Mozilla Public Licence 2.0
19** along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
20*/
21#ifndef __ANTARES_LIBS_STUDY_ACTION_TEXT_H__
22#define __ANTARES_LIBS_STUDY_ACTION_TEXT_H__
23
24#include <yuni/yuni.h>
25#include "action.h"
26
27namespace Antares
28{
29namespace Action
30{
34template<bool AutoExpandT = true>
35class Text : public IAction
36{
37public:
42
43public:
45
46
49 template<class StringT>
50 explicit Text(const StringT& text);
52 virtual ~Text();
54
55 virtual bool bold() const;
56
57 virtual bool autoExpand() const;
58
59 virtual bool canDoSomething() const;
60
61protected:
62 virtual bool prepareWL(Context& ctx);
63 virtual bool performWL(Context& ctx);
64
65}; // class IAction
66
67} // namespace Action
68} // namespace Antares
69
70#include "text.hxx"
71
72#endif // __ANTARES_LIBS_STUDY_ACTION_TEXT_H__
Definition context.h:38
Definition action.h:38
AncestorType::Ptr Ptr
The most suitable smart ptr for the class.
Definition action.h:43
AncestorType::ThreadingPolicy ThreadingPolicy
The threading policy.
Definition action.h:45
A dummy action, for displaying some text.
Definition text.h:36
virtual bool performWL(Context &ctx)
Perform the action.
Definition text.hxx:48
virtual ~Text()
Destructor.
Definition text.hxx:36
virtual bool prepareWL(Context &ctx)
Prepare the execution.
Definition text.hxx:41
IAction::ThreadingPolicy ThreadingPolicy
The threading policy.
Definition text.h:41
virtual bool bold() const
Get if the action should be represented with a bold font.
Definition text.hxx:54
virtual bool autoExpand() const
Auto-expand.
Definition text.hxx:60
IAction::Ptr Ptr
The most suitable smart ptr for the class.
Definition text.h:39
Text(const StringT &text)
Default constructor.
Definition text.hxx:30