Antares Simulator
Power System Simulator
frame.h
1 /*
2  * Copyright 2007-2025, 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_COMMON_COMPONENTS_FRAME_FRAME_H__
22 #define __ANTARES_COMMON_COMPONENTS_FRAME_FRAME_H__
23 
24 #include <yuni/yuni.h>
25 #include <yuni/string.h>
26 #include <vector>
27 
28 namespace Antares::Component::Frame
29 {
33 class IFrame
34 {
35 public:
37  using Vector = std::vector<IFrame*>;
38 
39 public:
43  virtual void frameRaise() = 0;
44 
48  virtual Yuni::String frameTitle() const = 0;
49 
53  virtual bool excludeFromMenu() = 0;
54  virtual void updateOpenWindowsMenu() = 0;
55  virtual int frameID() const = 0;
56 
57 }; // class IFrame
58 
59 } // namespace Antares::Component::Frame
60 
61 #endif // __ANTARES_COMMON_COMPONENTS_FRAME_FRAME_H__
Interface for all registered frames, external or not.
Definition: frame.h:34
virtual Yuni::String frameTitle() const =0
Get the frame title.
std::vector< IFrame * > Vector
Vector.
Definition: frame.h:37
virtual void frameRaise()=0
Raise the frame to the top level.