Hand-apply 077d2abb480a883119783db3f957f175e22e543b from master; stop more flickering...
[dcpomatic.git] / src / wx / wx_util.cc
1 /*
2     Copyright (C) 2012-2015 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 /** @file src/wx/wx_util.cc
21  *  @brief Some utility functions and classes.
22  */
23
24 #include <boost/thread.hpp>
25 #include <wx/filepicker.h>
26 #include <wx/spinctrl.h>
27 #include "lib/config.h"
28 #include "lib/util.h"
29 #include "wx_util.h"
30
31 using namespace std;
32 using namespace boost;
33
34 /** Add a wxStaticText to a wxSizer, aligning it at vertical centre.
35  *  @param s Sizer to add to.
36  *  @param p Parent window for the wxStaticText.
37  *  @param t Text for the wxStaticText.
38  *  @param left true if this label is a `left label'; ie the sort
39  *  of label which should be right-aligned on OS X.
40  *  @param prop Proportion to pass when calling Add() on the wxSizer.
41  */
42 wxStaticText *
43 #ifdef __WXOSX__
44 add_label_to_sizer (wxSizer* s, wxWindow* p, wxString t, bool left, int prop)
45 #else
46 add_label_to_sizer (wxSizer* s, wxWindow* p, wxString t, bool, int prop)
47 #endif
48 {
49         int flags = wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT;
50 #ifdef __WXOSX__
51         if (left) {
52                 flags |= wxALIGN_RIGHT;
53                 t += wxT (":");
54         }
55 #endif  
56         wxStaticText* m = new wxStaticText (p, wxID_ANY, t);
57         s->Add (m, prop, flags, 6);
58         return m;
59 }
60
61 wxStaticText *
62 #ifdef __WXOSX__
63 add_label_to_grid_bag_sizer (wxGridBagSizer* s, wxWindow* p, wxString t, bool left, wxGBPosition pos, wxGBSpan span)
64 #else
65 add_label_to_grid_bag_sizer (wxGridBagSizer* s, wxWindow* p, wxString t, bool, wxGBPosition pos, wxGBSpan span)
66 #endif
67 {
68         int flags = wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT;
69 #ifdef __WXOSX__
70         if (left) {
71                 flags |= wxALIGN_RIGHT;
72                 t += wxT (":");
73         }
74 #endif  
75         wxStaticText* m = new wxStaticText (p, wxID_ANY, t);
76         s->Add (m, pos, span, flags);
77         return m;
78 }
79
80 /** Pop up an error dialogue box.
81  *  @param parent Parent.
82  *  @param m Message.
83  */
84 void
85 error_dialog (wxWindow* parent, wxString m)
86 {
87         wxMessageDialog* d = new wxMessageDialog (parent, m, _("DCP-o-matic"), wxOK);
88         d->ShowModal ();
89         d->Destroy ();
90 }
91
92 bool
93 confirm_dialog (wxWindow* parent, wxString m)
94 {
95         wxMessageDialog* d = new wxMessageDialog (parent, m, _("DCP-o-matic"), wxYES_NO | wxICON_QUESTION);
96         int const r = d->ShowModal ();
97         d->Destroy ();
98         return r == wxID_YES;
99 }
100         
101
102 /** @param s wxWidgets string.
103  *  @return Corresponding STL string.
104  */
105 string
106 wx_to_std (wxString s)
107 {
108         return string (s.ToUTF8 ());
109 }
110
111 /** @param s STL string.
112  *  @return Corresponding wxWidgets string.
113  */
114 wxString
115 std_to_wx (string s)
116 {
117         return wxString (s.c_str(), wxConvUTF8);
118 }
119
120 string
121 string_client_data (wxClientData* o)
122 {
123         return wx_to_std (dynamic_cast<wxStringClientData*>(o)->GetData());
124 }
125
126 void
127 checked_set (wxFilePickerCtrl* widget, string value)
128 {
129         if (widget->GetPath() != std_to_wx (value)) {
130                 if (value.empty()) {
131                         /* Hack to make wxWidgets clear the control when we are passed
132                            an empty value.
133                         */
134                         value = " ";
135                 }
136                 widget->SetPath (std_to_wx (value));
137         }
138 }
139
140 void
141 checked_set (wxSpinCtrl* widget, int value)
142 {
143         if (widget->GetValue() != value) {
144                 widget->SetValue (value);
145         }
146 }
147
148 void
149 checked_set (wxSpinCtrlDouble* widget, double value)
150 {
151         /* XXX: completely arbitrary epsilon */
152         if (fabs (widget->GetValue() - value) > 1e-16) {
153                 widget->SetValue (value);
154         }
155 }
156
157 void
158 checked_set (wxChoice* widget, int value)
159 {
160         if (widget->GetSelection() != value) {
161                 widget->SetSelection (value);
162         }
163 }
164
165 void
166 checked_set (wxChoice* widget, string value)
167 {
168         wxClientData* o = 0;
169         if (widget->GetSelection() != -1) {
170                 o = widget->GetClientObject (widget->GetSelection ());
171         }
172         
173         if (!o || string_client_data(o) != value) {
174                 for (unsigned int i = 0; i < widget->GetCount(); ++i) {
175                         if (string_client_data (widget->GetClientObject (i)) == value) {
176                                 widget->SetSelection (i);
177                         }
178                 }
179         }
180 }
181
182 void
183 checked_set (wxTextCtrl* widget, string value)
184 {
185         if (widget->GetValue() != std_to_wx (value)) {
186                 widget->ChangeValue (std_to_wx (value));
187         }
188 }
189
190 void
191 checked_set (wxStaticText* widget, string value)
192 {
193         if (widget->GetLabel() != std_to_wx (value)) {
194                 widget->SetLabel (std_to_wx (value));
195         }
196 }
197
198 void
199 checked_set (wxStaticText* widget, wxString value)
200 {
201         if (widget->GetLabel() != value) {
202                 widget->SetLabel (value);
203         }
204 }
205
206 void
207 checked_set (wxCheckBox* widget, bool value)
208 {
209         if (widget->GetValue() != value) {
210                 widget->SetValue (value);
211         }
212 }
213
214 void
215 checked_set (wxRadioButton* widget, bool value)
216 {
217         if (widget->GetValue() != value) {
218                 widget->SetValue (value);
219         }
220 }
221
222 void
223 dcpomatic_setup_i18n ()
224 {
225         int language = wxLANGUAGE_DEFAULT;
226
227         boost::optional<string> config_lang = Config::instance()->language ();
228         if (config_lang && !config_lang->empty ()) {
229                 wxLanguageInfo const * li = wxLocale::FindLanguageInfo (std_to_wx (config_lang.get ()));
230                 if (li) {
231                         language = li->Language;
232                 }
233         }
234
235         wxLocale* locale = 0;
236         if (wxLocale::IsAvailable (language)) {
237                 locale = new wxLocale (language, wxLOCALE_LOAD_DEFAULT);
238
239 #ifdef DCPOMATIC_WINDOWS
240                 locale->AddCatalogLookupPathPrefix (std_to_wx (mo_path().string()));
241 #endif          
242
243 #ifdef DCPOMATIC_POSIX
244                 locale->AddCatalogLookupPathPrefix (POSIX_LOCALE_PREFIX);
245 #endif
246
247 #ifdef DCPOMATIC_LINUX
248                 /* We have to include the wxWidgets .mo in our distribution,
249                    so we rename it to avoid clashes with any other installation
250                    of wxWidgets.
251                 */
252                 locale->AddCatalog (wxT ("dcpomatic-wxstd"));
253 #endif          
254                 
255                 locale->AddCatalog (wxT ("libdcpomatic-wx"));
256                 locale->AddCatalog (wxT ("dcpomatic"));
257                 
258                 if (!locale->IsOk()) {
259                         delete locale;
260                         locale = new wxLocale (wxLANGUAGE_ENGLISH);
261                 }
262         }
263
264         if (locale) {
265                 dcpomatic_setup_gettext_i18n (wx_to_std (locale->GetCanonicalName ()));
266         }
267 }
268
269 int
270 wx_get (wxSpinCtrl* w)
271 {
272         return w->GetValue ();
273 }
274
275 int
276 wx_get (wxChoice* w)
277 {
278         return w->GetSelection ();
279 }
280
281 double
282 wx_get (wxSpinCtrlDouble* w)
283 {
284         return w->GetValue ();
285 }
286
287 /** @param s String of the form Context|String
288  *  @return translation, or String if no translation is available.
289  */
290 wxString
291 context_translation (wxString s)
292 {
293         wxString t = wxGetTranslation (s);
294         if (t == s) {
295                 /* No translation; strip the context */
296                 int c = t.Find (wxT ("|"));
297                 if (c != wxNOT_FOUND) {
298                         t = t.Mid (c + 1);
299                 }
300         }
301
302         return t;
303 }