src/wx/wx_util.h

   1 /*
   2     Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  21 /** @file src/wx/wx_util.h
  22  *  @brief Some utility functions and classes.
  23  */
  24
  25 #ifndef DCPOMATIC_WX_UTIL_H
  26 #define DCPOMATIC_WX_UTIL_H
  27
  28 #include "lib/dcpomatic_time.h"
  29 #include <wx/wx.h>
  30 #include <wx/gbsizer.h>
  31 #include <boost/function.hpp>
  32 #include <boost/thread.hpp>
  33 #include <boost/signals2.hpp>
  34
  35 class FilePickerCtrl;
  36 class wxDirPickerCtrl;
  37 class wxSpinCtrl;
  38 class wxSpinCtrlDouble;
  39 class wxGridBagSizer;
  40 class wxSplashScreen;
  41
  42 #define DCPOMATIC_SIZER_X_GAP 8
  43 #define DCPOMATIC_SIZER_Y_GAP 8
  44 #define DCPOMATIC_SIZER_GAP 8
  45 #define DCPOMATIC_DIALOG_BORDER 12
  46
  47 /** Spacing to use between buttons in a vertical line */
  48 #ifdef DCPOMATIC_OSX
  49 #define DCPOMATIC_BUTTON_STACK_GAP 2
  50 #else
  51 #define DCPOMATIC_BUTTON_STACK_GAP 0
  52 #endif
  53
  54 #ifdef DCPOMATIC_LINUX
  55 #define DCPOMATIC_RTAUDIO_API RtAudio::LINUX_PULSE
  56 #endif
  57 #ifdef DCPOMATIC_WINDOWS
  58 #define DCPOMATIC_RTAUDIO_API RtAudio::UNSPECIFIED
  59 #endif
  60 #ifdef DCPOMATIC_OSX
  61 #define DCPOMATIC_RTAUDIO_API RtAudio::MACOSX_CORE
  62 #endif
  63
  64 /** i18n macro to support strings like Context|String
  65  *  so that `String' can be translated to different things
  66  *  in different contexts.
  67  */
  68 #define S_(x) context_translation(x)
  69
  70 extern void error_dialog (wxWindow *, wxString, boost::optional<wxString> e = boost::optional<wxString>());
  71 extern void message_dialog (wxWindow *, wxString);
  72 extern bool confirm_dialog (wxWindow *, wxString);
  73 extern wxStaticText* create_label (wxWindow* p, wxString t, bool left);
  74 extern wxStaticText* add_label_to_sizer (wxSizer *, wxWindow *, wxString, bool left, int prop = 0, int flags = wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT);
  75 extern wxStaticText* add_label_to_vertical_sizer (wxSizer *, wxWindow *, wxString, bool left, int prop = 0, int flags = wxLEFT | wxRIGHT);
  76 extern wxStaticText* add_label_to_sizer (wxSizer *, wxStaticText *, bool left, int prop = 0, int flags = wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT);
  77 extern wxStaticText* add_label_to_sizer (wxGridBagSizer *, wxWindow *, wxString, bool, wxGBPosition, wxGBSpan span = wxDefaultSpan);
  78 extern wxStaticText* add_label_to_sizer (wxGridBagSizer *, wxStaticText *, bool, wxGBPosition, wxGBSpan span = wxDefaultSpan);
  79 extern std::string wx_to_std (wxString);
  80 extern wxString std_to_wx (std::string);
  81 extern void dcpomatic_setup_i18n ();
  82 extern wxString context_translation (wxString);
  83 extern std::string string_client_data (wxClientData* o);
  84 extern wxString time_to_timecode (DCPTime t, double fps);
  85 extern void setup_audio_channels_choice (wxChoice* choice, int minimum);
  86 extern wxSplashScreen* maybe_show_splash ();
  87 extern double calculate_mark_interval (double start);
  88 extern bool display_progress (wxString title, wxString task);
  89 extern bool report_errors_from_last_job (wxWindow* parent);
  90
  91 extern void checked_set (FilePickerCtrl* widget, boost::filesystem::path value);
  92 extern void checked_set (wxDirPickerCtrl* widget, boost::filesystem::path value);
  93 extern void checked_set (wxSpinCtrl* widget, int value);
  94 extern void checked_set (wxSpinCtrlDouble* widget, double value);
  95 extern void checked_set (wxChoice* widget, int value);
  96 extern void checked_set (wxChoice* widget, std::string value);
  97 extern void checked_set (wxChoice* widget, std::vector<std::pair<std::string, std::string> > items);
  98 extern void checked_set (wxTextCtrl* widget, std::string value);
  99 extern void checked_set (wxTextCtrl* widget, wxString value);
 100 extern void checked_set (wxCheckBox* widget, bool value);
 101 extern void checked_set (wxRadioButton* widget, bool value);
 102 extern void checked_set (wxStaticText* widget, std::string value);
 103 extern void checked_set (wxStaticText* widget, wxString value);
 104
 105 extern int wx_get (wxChoice* widget);
 106 extern int wx_get (wxSpinCtrl* widget);
 107 extern double wx_get (wxSpinCtrlDouble* widget);
 108
 109 #if defined(__WXMSW__)
 110 #define DCPOMATIC_USE_OWN_PICKER
 111 #endif
 112
 113 #endif