Antares Simulator
Power System Simulator
local-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_LOCAL_FRAME_H__
22 #define __ANTARES_COMMON_COMPONENTS_FRAME_LOCAL_FRAME_H__
23 
24 #include <yuni/yuni.h>
25 #include "../../wx-wrapper.h"
26 #include <wx/frame.h>
27 #include "frame.h"
28 
29 namespace Antares::Component::Frame
30 {
31 class WxLocalFrame: public wxFrame, public IFrame
32 {
33 public:
34  WxLocalFrame();
35  WxLocalFrame(wxWindow* parent,
36  wxWindowID id,
37  const wxString& title,
38  const wxPoint& pos = wxDefaultPosition,
39  const wxSize& size = wxDefaultSize,
40  long style = wxDEFAULT_FRAME_STYLE,
41  const wxString& name = wxT("registered-frame"));
42 
43  virtual ~WxLocalFrame();
44 
45  virtual bool Destroy() override;
46 
47  virtual bool excludeFromMenu() override;
48  virtual void updateOpenWindowsMenu() override;
49  virtual void frameRaise() override;
50  virtual Yuni::String frameTitle() const override;
51  virtual int frameID() const override;
52 
53  // Override Frame title
54  virtual void SetTitle(const wxString& title) override;
55 
56 }; // class WxLocalFrame
57 
58 } // namespace Antares::Component::Frame
59 
60 #endif // __ANTARES_COMMON_COMPONENTS_FRAME_LOCAL_FRAME_H__
Interface for all registered frames, external or not.
Definition: frame.h:34
Definition: local-frame.h:32
virtual Yuni::String frameTitle() const override
Get the frame title.
Definition: local-frame.cpp:83
virtual void frameRaise() override
Raise the frame to the top level.
Definition: local-frame.cpp:78