Some doxygen documentation improvements.
[dcpomatic.git] / src / wx / wx_util.h
1 /*
2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #include <wx/wx.h>
21 #include <boost/function.hpp>
22 #include <boost/thread.hpp>
23
24 /** @file src/wx/wx_util.h
25  *  @brief Some utility functions and classes.
26  */
27
28 extern void error_dialog (wxWindow *, std::string);
29 extern wxStaticText* add_label_to_sizer (wxSizer *, wxWindow *, std::string, int prop = 0);
30 extern std::string wx_to_std (wxString);
31 extern wxString std_to_wx (std::string);
32
33 /** @class ThreadedStaticText
34  *
35  *  @brief A wxStaticText whose content is computed in a separate thread, to avoid holding
36  *  up the GUI while work is done.
37  */
38 class ThreadedStaticText : public wxStaticText
39 {
40 public:
41         ThreadedStaticText (wxWindow* parent, std::string initial, boost::function<std::string ()> fn);
42         ~ThreadedStaticText ();
43
44 private:
45         void run (boost::function<std::string ()> fn);
46         void thread_finished (wxCommandEvent& ev);
47
48         /** Thread to do our work in */
49         boost::thread* _thread;
50         
51         static const int _update_event_id;
52 };