src/wx/wx_util.h

   1 /*
   2     Copyright (C) 2012-2021 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
  22 /** @file src/wx/wx_util.h
  23  *  @brief Some utility functions and classes.
  24  */
  25
  26
  27 #ifndef DCPOMATIC_WX_UTIL_H
  28 #define DCPOMATIC_WX_UTIL_H
  29
  30
  31 #include "wx_ptr.h"
  32 #include "lib/config.h"
  33 #include "lib/dcpomatic_time.h"
  34 #include <dcp/utc_offset.h>
  35 #include <dcp/warnings.h>
  36 LIBDCP_DISABLE_WARNINGS
  37 #include <wx/gbsizer.h>
  38 #include <wx/wx.h>
  39 LIBDCP_ENABLE_WARNINGS
  40 #include <boost/signals2.hpp>
  41 #include <boost/thread.hpp>
  42
  43
  44 class FilePickerCtrl;
  45 class LanguageTagWidget;
  46 class RegionSubtagWidget;
  47 class wxDirPickerCtrl;
  48 class wxSpinCtrl;
  49 class wxSpinCtrlDouble;
  50 class wxGridBagSizer;
  51 class wxSplashScreen;
  52 class PasswordEntry;
  53
  54
  55 #define DCPOMATIC_SIZER_X_GAP 8
  56 #define DCPOMATIC_SIZER_Y_GAP 8
  57 #define DCPOMATIC_SIZER_GAP 8
  58 #define DCPOMATIC_DIALOG_BORDER 12
  59 #ifdef __WXGTK3__
  60 #define DCPOMATIC_SPIN_CTRL_WIDTH 124
  61 #else
  62 #define DCPOMATIC_SPIN_CTRL_WIDTH 56
  63 #endif
  64
  65 /** Amount by which you need to bottom-pad text next to a checkbox in order
  66  *  for the text baselines to be aligned.
  67  */
  68 #ifdef DCPOMATIC_OSX
  69 #define DCPOMATIC_CHECKBOX_BOTTOM_PAD 2
  70 #else
  71 #define DCPOMATIC_CHECKBOX_BOTTOM_PAD 0
  72 #endif
  73
  74 #define DCPOMATIC_SUBHEADING_TOP_PAD 16
  75
  76 /** Amount by which you need to top-pad a choice to make it line up, in some cases */
  77 #ifdef DCPOMATIC_OSX
  78 #define DCPOMATIC_CHOICE_TOP_PAD 2
  79 #else
  80 #define DCPOMATIC_CHOICE_TOP_PAD 0
  81 #endif
  82
  83 /** Spacing to use between buttons in a vertical/horizontal line */
  84 #if defined(DCPOMATIC_OSX) || defined(__WXGTK3__)
  85 #define DCPOMATIC_BUTTON_STACK_GAP 2
  86 #else
  87 #define DCPOMATIC_BUTTON_STACK_GAP 0
  88 #endif
  89
  90 #ifdef DCPOMATIC_LINUX
  91 #define DCPOMATIC_RTAUDIO_API RtAudio::LINUX_PULSE
  92 #endif
  93 #ifdef DCPOMATIC_WINDOWS
  94 #define DCPOMATIC_RTAUDIO_API RtAudio::UNSPECIFIED
  95 #endif
  96 #ifdef DCPOMATIC_OSX
  97 #define DCPOMATIC_RTAUDIO_API RtAudio::MACOSX_CORE
  98 #endif
  99
 100
 101 /** i18n macro to support strings like Context|String
 102  *  so that `String' can be translated to different things
 103  *  in different contexts.
 104  */
 105 #define S_(x) context_translation(x)
 106
 107
 108 extern void error_dialog (wxWindow *, wxString, boost::optional<wxString> e = boost::optional<wxString>());
 109 extern void message_dialog (wxWindow *, wxString);
 110 extern bool confirm_dialog (wxWindow *, wxString);
 111 extern wxStaticText* create_label (wxWindow* p, wxString t, bool left);
 112 extern wxStaticText* add_label_to_sizer (wxSizer *, wxWindow *, wxString, bool left, int prop = 0, int flags = wxLEFT | wxRIGHT);
 113 extern wxStaticText* add_label_to_sizer (wxSizer *, wxStaticText *, bool left, int prop = 0, int flags = wxLEFT | wxRIGHT);
 114 extern wxStaticText* add_label_to_sizer(wxGridBagSizer *, wxWindow *, wxString, bool, wxGBPosition, wxGBSpan span = wxDefaultSpan, bool indent = false);
 115 extern wxStaticText* add_label_to_sizer (wxGridBagSizer *, wxStaticText *, bool, wxGBPosition, wxGBSpan span = wxDefaultSpan);
 116 extern std::string wx_to_std (wxString);
 117 extern wxString std_to_wx (std::string);
 118 extern void dcpomatic_setup_i18n ();
 119 extern wxString context_translation (wxString);
 120 extern std::string string_client_data (wxClientData* o);
 121 extern wxString time_to_timecode (dcpomatic::DCPTime t, double fps);
 122 extern void setup_audio_channels_choice (wxChoice* choice, int minimum);
 123 extern wxSplashScreen* maybe_show_splash();
 124 extern double calculate_mark_interval (double start);
 125 extern bool display_progress (wxString title, wxString task);
 126 extern bool report_errors_from_last_job (wxWindow* parent);
 127 extern wxString bitmap_path (std::string name);
 128 extern wxString icon_path(std::string name);
 129 extern wxSize small_button_size (wxWindow* parent, wxString text);
 130 extern bool gui_is_dark ();
 131 extern double dpi_scale_factor (wxWindow* window);
 132 extern int search_ctrl_height ();
 133 extern void report_config_load_failure(wxWindow* parent, Config::LoadFailure what);
 134
 135
 136 struct Offset
 137 {
 138         Offset(wxString name_, dcp::UTCOffset offset_)
 139                 : name(name_)
 140                 , offset(offset_)
 141         {}
 142
 143         wxString name;
 144         dcp::UTCOffset offset;
 145 };
 146
 147 extern int get_offsets (std::vector<Offset>& offsets);
 148
 149
 150 extern void checked_set (FilePickerCtrl* widget, boost::filesystem::path value);
 151 extern void checked_set (wxDirPickerCtrl* widget, boost::filesystem::path value);
 152 extern void checked_set (wxSpinCtrl* widget, int value);
 153 extern void checked_set (wxSpinCtrlDouble* widget, double value);
 154 extern void checked_set (wxChoice* widget, int value);
 155 extern void checked_set (wxChoice* widget, std::string value);
 156 extern void checked_set (wxChoice* widget, std::vector<std::pair<std::string, std::string> > items);
 157 extern void checked_set (wxTextCtrl* widget, std::string value);
 158 extern void checked_set (wxTextCtrl* widget, wxString value);
 159 extern void checked_set (PasswordEntry* widget, std::string value);
 160 extern void checked_set (wxCheckBox* widget, bool value);
 161 extern void checked_set (wxRadioButton* widget, bool value);
 162 extern void checked_set (wxStaticText* widget, std::string value);
 163 extern void checked_set (wxStaticText* widget, wxString value);
 164 extern void checked_set(LanguageTagWidget* widget, dcp::LanguageTag value);
 165 extern void checked_set(LanguageTagWidget* widget, boost::optional<dcp::LanguageTag> value);
 166 extern void checked_set(RegionSubtagWidget* widget, boost::optional<dcp::LanguageTag::RegionSubtag> value);
 167
 168 extern int wx_get (wxChoice* widget);
 169 extern int wx_get (wxSpinCtrl* widget);
 170 extern double wx_get (wxSpinCtrlDouble* widget);
 171
 172 #ifdef DCPOMATIC_WINDOWS
 173 #define DCPOMATIC_USE_OWN_PICKER
 174 #endif
 175
 176
 177 #endif