Antares Simulator
Power System Simulator
lock.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_UI_COMMON_LOCK_H__
22 #define __ANTARES_UI_COMMON_LOCK_H__
23 
24 #include <yuni/yuni.h>
25 
26 namespace Antares
27 {
31 void GUIBeginUpdate();
32 
36 void GUIEndUpdate();
37 
41 bool GUIIsLock();
42 
44 uint GUILockRefCount();
45 
49 class GUILocker final
50 {
51 public:
52  GUILocker()
53  {
54  GUIBeginUpdate();
55  }
56 
57  ~GUILocker()
58  {
59  GUIEndUpdate();
60  }
61 };
62 
66 void GUIIsAboutToQuit();
67 
71 void GUIIsNoLongerQuitting();
72 
76 bool IsGUIAboutToQuit();
77 
78 } // namespace Antares
79 
80 #endif // __ANTARES_UI_COMMON_LOCK_H__
Lock / Unlock the GUI (RAII)
Definition: lock.h:50