2 Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 /** @file src/wx/wx_util.cc
22 * @brief Some utility functions and classes.
26 #include "file_picker_ctrl.h"
27 #include "lib/config.h"
29 #include "lib/cross.h"
30 #include <dcp/locale_convert.h>
31 #include <wx/spinctrl.h>
32 #include <wx/splash.h>
33 #include <boost/thread.hpp>
36 using namespace boost;
37 using dcp::locale_convert;
39 /** Add a wxStaticText to a wxSizer, aligning it at vertical centre.
40 * @param s Sizer to add to.
41 * @param p Parent window for the wxStaticText.
42 * @param t Text for the wxStaticText.
43 * @param left true if this label is a `left label'; ie the sort
44 * of label which should be right-aligned on OS X.
45 * @param prop Proportion to pass when calling Add() on the wxSizer.
49 add_label_to_sizer (wxSizer* s, wxWindow* p, wxString t, bool left, int prop)
51 add_label_to_sizer (wxSizer* s, wxWindow* p, wxString t, bool, int prop)
54 int flags = wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT;
57 flags |= wxALIGN_RIGHT;
61 wxStaticText* m = new wxStaticText (p, wxID_ANY, t);
62 s->Add (m, prop, flags, 6);
68 add_label_to_sizer (wxGridBagSizer* s, wxWindow* p, wxString t, bool left, wxGBPosition pos, wxGBSpan span)
70 add_label_to_sizer (wxGridBagSizer* s, wxWindow* p, wxString t, bool, wxGBPosition pos, wxGBSpan span)
73 int flags = wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT;
76 flags |= wxALIGN_RIGHT;
80 wxStaticText* m = new wxStaticText (p, wxID_ANY, t);
81 s->Add (m, pos, span, flags);
85 /** Pop up an error dialogue box.
86 * @param parent Parent.
90 error_dialog (wxWindow* parent, wxString m)
92 wxMessageDialog* d = new wxMessageDialog (parent, m, _("DCP-o-matic"), wxOK | wxICON_ERROR);
97 /** Pop up an error dialogue box.
98 * @param parent Parent.
102 message_dialog (wxWindow* parent, wxString m)
104 wxMessageDialog* d = new wxMessageDialog (parent, m, _("DCP-o-matic"), wxOK | wxICON_INFORMATION);
110 confirm_dialog (wxWindow* parent, wxString m)
112 wxMessageDialog* d = new wxMessageDialog (parent, m, _("DCP-o-matic"), wxYES_NO | wxICON_QUESTION);
113 int const r = d->ShowModal ();
115 return r == wxID_YES;
119 /** @param s wxWidgets string.
120 * @return Corresponding STL string.
123 wx_to_std (wxString s)
125 return string (s.ToUTF8 ());
128 /** @param s STL string.
129 * @return Corresponding wxWidgets string.
134 return wxString (s.c_str(), wxConvUTF8);
138 string_client_data (wxClientData* o)
140 return wx_to_std (dynamic_cast<wxStringClientData*>(o)->GetData());
144 checked_set (FilePickerCtrl* widget, boost::filesystem::path value)
146 if (widget->GetPath() != std_to_wx (value.string())) {
148 /* Hack to make wxWidgets clear the control when we are passed
153 widget->SetPath (std_to_wx (value.string()));
158 checked_set (wxSpinCtrl* widget, int value)
160 if (widget->GetValue() != value) {
161 widget->SetValue (value);
166 checked_set (wxSpinCtrlDouble* widget, double value)
168 /* XXX: completely arbitrary epsilon */
169 if (fabs (widget->GetValue() - value) > 1e-16) {
170 widget->SetValue (value);
175 checked_set (wxChoice* widget, int value)
177 if (widget->GetSelection() != value) {
178 widget->SetSelection (value);
183 checked_set (wxChoice* widget, string value)
186 if (widget->GetSelection() != -1) {
187 o = widget->GetClientObject (widget->GetSelection ());
190 if (!o || string_client_data(o) != value) {
191 for (unsigned int i = 0; i < widget->GetCount(); ++i) {
192 if (string_client_data (widget->GetClientObject (i)) == value) {
193 widget->SetSelection (i);
200 checked_set (wxChoice* widget, vector<pair<string, string> > items)
202 vector<pair<string, string> > current;
203 for (unsigned int i = 0; i < widget->GetCount(); ++i) {
206 wx_to_std (widget->GetString (i)),
207 string_client_data (widget->GetClientObject (i))
212 if (current == items) {
217 for (vector<pair<string, string> >::const_iterator i = items.begin(); i != items.end(); ++i) {
218 widget->Append (std_to_wx (i->first), new wxStringClientData (std_to_wx (i->second)));
223 checked_set (wxTextCtrl* widget, string value)
225 if (widget->GetValue() != std_to_wx (value)) {
226 widget->ChangeValue (std_to_wx (value));
231 checked_set (wxTextCtrl* widget, wxString value)
233 if (widget->GetValue() != value) {
234 widget->ChangeValue (value);
239 checked_set (wxStaticText* widget, string value)
241 if (widget->GetLabel() != std_to_wx (value)) {
242 widget->SetLabel (std_to_wx (value));
247 checked_set (wxStaticText* widget, wxString value)
249 if (widget->GetLabel() != value) {
250 widget->SetLabel (value);
255 checked_set (wxCheckBox* widget, bool value)
257 if (widget->GetValue() != value) {
258 widget->SetValue (value);
263 checked_set (wxRadioButton* widget, bool value)
265 if (widget->GetValue() != value) {
266 widget->SetValue (value);
271 dcpomatic_setup_i18n ()
273 int language = wxLANGUAGE_DEFAULT;
275 boost::optional<string> config_lang = Config::instance()->language ();
276 if (config_lang && !config_lang->empty ()) {
277 wxLanguageInfo const * li = wxLocale::FindLanguageInfo (std_to_wx (config_lang.get ()));
279 language = li->Language;
283 wxLocale* locale = 0;
284 if (wxLocale::IsAvailable (language)) {
285 locale = new wxLocale (language, wxLOCALE_LOAD_DEFAULT);
287 #ifdef DCPOMATIC_WINDOWS
288 locale->AddCatalogLookupPathPrefix (std_to_wx (mo_path().string()));
291 #ifdef DCPOMATIC_LINUX
292 locale->AddCatalogLookupPathPrefix (LINUX_LOCALE_PREFIX);
294 /* We have to include the wxWidgets .mo in our distribution,
295 so we rename it to avoid clashes with any other installation
298 locale->AddCatalog (wxT ("dcpomatic2-wxstd"));
301 locale->AddCatalog (wxT ("libdcpomatic2-wx"));
302 locale->AddCatalog (wxT ("dcpomatic2"));
304 if (!locale->IsOk()) {
306 locale = new wxLocale (wxLANGUAGE_ENGLISH);
311 dcpomatic_setup_gettext_i18n (wx_to_std (locale->GetCanonicalName ()));
316 wx_get (wxSpinCtrl* w)
318 return w->GetValue ();
324 return w->GetSelection ();
328 wx_get (wxSpinCtrlDouble* w)
330 return w->GetValue ();
333 /** @param s String of the form Context|String
334 * @return translation, or String if no translation is available.
337 context_translation (wxString s)
339 wxString t = wxGetTranslation (s);
341 /* No translation; strip the context */
342 int c = t.Find (wxT ("|"));
343 if (c != wxNOT_FOUND) {
352 time_to_timecode (DCPTime t, double fps)
354 double w = t.seconds ();
355 int const h = (w / 3600);
357 int const m = (w / 60);
359 int const s = floor (w);
361 int const f = lrint (w * fps);
362 return wxString::Format (wxT("%02d:%02d:%02d.%02d"), h, m, s, f);
366 setup_audio_channels_choice (wxChoice* choice, int minimum)
368 vector<pair<string, string> > items;
369 for (int i = minimum; i <= 16; i += 2) {
371 items.push_back (make_pair (wx_to_std (_("2 - stereo")), locale_convert<string> (i)));
373 items.push_back (make_pair (wx_to_std (_("4 - L/C/R/Lfe")), locale_convert<string> (i)));
375 items.push_back (make_pair (wx_to_std (_("6 - 5.1")), locale_convert<string> (i)));
377 items.push_back (make_pair (wx_to_std (_("8 - 5.1/HI/VI")), locale_convert<string> (i)));
378 } else if (i == 12) {
379 items.push_back (make_pair (wx_to_std (_("12 - 7.1/HI/VI")), locale_convert<string> (i)));
381 items.push_back (make_pair (locale_convert<string> (i), locale_convert<string> (i)));
385 checked_set (choice, items);
391 wxSplashScreen* splash = 0;
393 if (!Config::have_existing ("config.xml")) {
395 boost::filesystem::path p = shared_path () / "splash.png";
396 if (bitmap.LoadFile (std_to_wx (p.string ()), wxBITMAP_TYPE_PNG)) {
397 splash = new wxSplashScreen (bitmap, wxSPLASH_CENTRE_ON_SCREEN | wxSPLASH_NO_TIMEOUT, 0, 0, -1);
401 } catch (boost::filesystem::filesystem_error& e) {
402 /* Maybe we couldn't find the splash image; never mind */
408 boost::filesystem::path
409 path_from_file_dialog (wxFileDialog* dialog, string extension)
411 return boost::filesystem::path(wx_to_std(dialog->GetPath())).replace_extension(extension);