src/wx/wx_util.h

   1 /*
   2     Copyright (C) 2012-2015 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 #ifdef __WXGTK__
  35 #include <gtk/gtk.h>
  36 #endif
  37
  38 class FilePickerCtrl;
  39 class wxSpinCtrl;
  40 class wxSpinCtrlDouble;
  41 class wxGridBagSizer;
  42 class wxSplashScreen;
  43
  44 #define DCPOMATIC_SIZER_X_GAP 8
  45 #define DCPOMATIC_SIZER_Y_GAP 8
  46 #define DCPOMATIC_SIZER_GAP 8
  47 #define DCPOMATIC_DIALOG_BORDER 12
  48
  49 /** Spacing to use between buttons in a vertical line */
  50 #ifdef DCPOMATIC_OSX
  51 #define DCPOMATIC_BUTTON_STACK_GAP 2
  52 #else
  53 #define DCPOMATIC_BUTTON_STACK_GAP 0
  54 #endif
  55
  56 #ifdef DCPOMATIC_LINUX
  57 #define DCPOMATIC_RTAUDIO_API RtAudio::LINUX_PULSE
  58 #endif
  59 #ifdef DCPOMATIC_WINDOWS
  60 #define DCPOMATIC_RTAUDIO_API RtAudio::WINDOWS_DS
  61 #endif
  62 #ifdef DCPOMATIC_OSX
  63 #define DCPOMATIC_RTAUDIO_API RtAudio::MACOSX_CORE
  64 #endif
  65
  66 /** i18n macro to support strings like Context|String
  67  *  so that `String' can be translated to different things
  68  *  in different contexts.
  69  */
  70 #define S_(x) context_translation(x)
  71
  72 extern void error_dialog (wxWindow *, wxString, boost::optional<wxString> e = boost::optional<wxString>());
  73 extern void message_dialog (wxWindow *, wxString);
  74 extern bool confirm_dialog (wxWindow *, wxString);
  75 extern wxStaticText* add_label_to_sizer (wxSizer *, wxWindow *, wxString, bool left, int prop = 0);
  76 extern wxStaticText* add_label_to_sizer (wxGridBagSizer *, wxWindow *, wxString, bool, wxGBPosition, wxGBSpan span = wxDefaultSpan);
  77 extern std::string wx_to_std (wxString);
  78 extern wxString std_to_wx (std::string);
  79 extern void dcpomatic_setup_i18n ();
  80 extern wxString context_translation (wxString);
  81 extern std::string string_client_data (wxClientData* o);
  82 extern wxString time_to_timecode (DCPTime t, double fps);
  83 extern void setup_audio_channels_choice (wxChoice* choice, int minimum);
  84 extern wxSplashScreen* maybe_show_splash ();
  85 extern boost::filesystem::path path_from_file_dialog (wxFileDialog* dialog, std::string extension);
  86 extern double calculate_mark_interval (double start);
  87
  88 extern void checked_set (FilePickerCtrl* widget, boost::filesystem::path value);
  89 extern void checked_set (wxSpinCtrl* widget, int value);
  90 extern void checked_set (wxSpinCtrlDouble* widget, double value);
  91 extern void checked_set (wxChoice* widget, int value);
  92 extern void checked_set (wxChoice* widget, std::string value);
  93 extern void checked_set (wxChoice* widget, std::vector<std::pair<std::string, std::string> > items);
  94 extern void checked_set (wxTextCtrl* widget, std::string value);
  95 extern void checked_set (wxTextCtrl* widget, wxString value);
  96 extern void checked_set (wxCheckBox* widget, bool value);
  97 extern void checked_set (wxRadioButton* widget, bool value);
  98 extern void checked_set (wxStaticText* widget, std::string value);
  99 extern void checked_set (wxStaticText* widget, wxString value);
 100
 101 extern int wx_get (wxChoice* widget);
 102 extern int wx_get (wxSpinCtrl* widget);
 103 extern double wx_get (wxSpinCtrlDouble* widget);
 104
 105 /* GTK 2.24.17 has a buggy GtkFileChooserButton and it was put in Ubuntu 13.04.
 106    This also seems to apply to 2.24.20 in Ubuntu 13.10 and 2.24.23 in Ubuntu 14.04.
 107    Use our own dir picker as this is the least bad option I can think of.
 108 */
 109 #if defined(__WXMSW__) || (GTK_MAJOR_VERSION == 2 && GTK_MINOR_VERSION == 24 && (GTK_MICRO_VERSION == 17 || GTK_MICRO_VERSION == 20 || GTK_MICRO_VERSION == 23))
 110 #define DCPOMATIC_USE_OWN_PICKER
 111 #endif
 112
 113 #endif