OpenTTD

progress.h
Go to the documentation of this file.
1 /* $Id: progress.h 22820 2011-08-24 12:18:53Z rubidium $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8 */
9
12 #ifndef PROGRESS_H
13 #define PROGRESS_H
14
15 #include "thread/thread.h"
16
17 static const uint MODAL_PROGRESS_REDRAW_TIMEOUT = 200;
18
23 static inline bool HasModalProgress()
24 {
25 extern bool _in_modal_progress;
26 return _in_modal_progress;
27 }
28
29 bool IsFirstModalProgressLoop();
30 void SetModalProgress(bool state);
31
32 extern class ThreadMutex *_modal_progress_work_mutex;
33 extern class ThreadMutex *_modal_progress_paint_mutex;
34
35 #endif /* PROGRESS_H */
ThreadMutex
Cross-platform Mutex.
Definition: thread.h:56
SetModalProgress
void SetModalProgress(bool state)
Set the modal progress state.
Definition: progress.cpp:30
MODAL_PROGRESS_REDRAW_TIMEOUT
static const uint MODAL_PROGRESS_REDRAW_TIMEOUT
Timeout between redraws.
Definition: progress.h:17
_modal_progress_work_mutex
class ThreadMutex * _modal_progress_work_mutex
Rights for the performing work.
Definition: progress.cpp:21
thread.h
Base of all threads.
_modal_progress_paint_mutex
class ThreadMutex * _modal_progress_paint_mutex
Rights for the painting.
Definition: progress.cpp:23
_in_modal_progress
bool _in_modal_progress
Are we in a modal progress or not?
Definition: progress.cpp:18
IsFirstModalProgressLoop
bool IsFirstModalProgressLoop()
Check whether this is the first modal progress loop.
Definition: progress.cpp:41
HasModalProgress
static bool HasModalProgress()
Check if we are currently in a modal progress state.
Definition: progress.h:23