C++11 tidying.
[dcpomatic.git] / src / wx / wx_util.h
index d942d8fa83f22f7e07de20e0997c6b5c0eb2bae7..97ddd51516420012ebfde3c82852ab8a25c0c0a9 100644 (file)
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
+
+/** @file src/wx/wx_util.h
+ *  @brief Some utility functions and classes.
+ */
+
+
 #ifndef DCPOMATIC_WX_UTIL_H
 #define DCPOMATIC_WX_UTIL_H
 
+
+#include "lib/dcpomatic_time.h"
+#include "lib/warnings.h"
+DCPOMATIC_DISABLE_WARNINGS
 #include <wx/wx.h>
+DCPOMATIC_ENABLE_WARNINGS
 #include <wx/gbsizer.h>
 #include <boost/function.hpp>
 #include <boost/thread.hpp>
-#ifdef __WXGTK__
-#include <gtk/gtk.h>
-#endif
+#include <boost/signals2.hpp>
+
 
-class wxFilePickerCtrl;
+class FilePickerCtrl;
+class wxDirPickerCtrl;
 class wxSpinCtrl;
+class wxSpinCtrlDouble;
 class wxGridBagSizer;
+class wxSplashScreen;
+class PasswordEntry;
+
 
 #define DCPOMATIC_SIZER_X_GAP 8
 #define DCPOMATIC_SIZER_Y_GAP 8
+#define DCPOMATIC_SIZER_GAP 8
 #define DCPOMATIC_DIALOG_BORDER 12
 
-/** @file src/wx/wx_util.h
- *  @brief Some utility functions and classes.
+/** Spacing to use between buttons in a vertical/horizontal line */
+#if defined(DCPOMATIC_OSX) || defined(__WXGTK3__)
+#define DCPOMATIC_BUTTON_STACK_GAP 2
+#else
+#define DCPOMATIC_BUTTON_STACK_GAP 0
+#endif
+
+#ifdef DCPOMATIC_LINUX
+#define DCPOMATIC_RTAUDIO_API RtAudio::LINUX_PULSE
+#endif
+#ifdef DCPOMATIC_WINDOWS
+#define DCPOMATIC_RTAUDIO_API RtAudio::UNSPECIFIED
+#endif
+#ifdef DCPOMATIC_OSX
+#define DCPOMATIC_RTAUDIO_API RtAudio::MACOSX_CORE
+#endif
+
+
+/** i18n macro to support strings like Context|String
+ *  so that `String' can be translated to different things
+ *  in different contexts.
  */
+#define S_(x) context_translation(x)
+
 
-extern void error_dialog (wxWindow *, wxString);
+extern void error_dialog (wxWindow *, wxString, boost::optional<wxString> e = boost::optional<wxString>());
+extern void message_dialog (wxWindow *, wxString);
 extern bool confirm_dialog (wxWindow *, wxString);
-extern wxStaticText* add_label_to_sizer (wxSizer *, wxWindow *, wxString, bool left, int prop = 0);
-extern wxStaticText* add_label_to_grid_bag_sizer (wxGridBagSizer *, wxWindow *, wxString, bool, wxGBPosition, wxGBSpan span = wxDefaultSpan);
+extern wxStaticText* create_label (wxWindow* p, wxString t, bool left);
+extern wxStaticText* add_label_to_sizer (wxSizer *, wxWindow *, wxString, bool left, int prop = 0, int flags = wxLEFT | wxRIGHT);
+extern wxStaticText* add_label_to_sizer (wxSizer *, wxStaticText *, bool left, int prop = 0, int flags = wxLEFT | wxRIGHT);
+extern wxStaticText* add_label_to_sizer (wxGridBagSizer *, wxWindow *, wxString, bool, wxGBPosition, wxGBSpan span = wxDefaultSpan);
+extern wxStaticText* add_label_to_sizer (wxGridBagSizer *, wxStaticText *, bool, wxGBPosition, wxGBSpan span = wxDefaultSpan);
 extern std::string wx_to_std (wxString);
 extern wxString std_to_wx (std::string);
 extern void dcpomatic_setup_i18n ();
+extern wxString context_translation (wxString);
+extern std::string string_client_data (wxClientData* o);
+extern wxString time_to_timecode (dcpomatic::DCPTime t, double fps);
+extern void setup_audio_channels_choice (wxChoice* choice, int minimum);
+extern wxSplashScreen* maybe_show_splash ();
+extern double calculate_mark_interval (double start);
+extern bool display_progress (wxString title, wxString task);
+extern bool report_errors_from_last_job (wxWindow* parent);
+extern wxString bitmap_path (std::string name);
+extern wxSize small_button_size (wxWindow* parent, wxString text);
 
-/** @class ThreadedStaticText
- *
- *  @brief A wxStaticText whose content is computed in a separate thread, to avoid holding
- *  up the GUI while work is done.
- */
-class ThreadedStaticText : public wxStaticText
+
+struct Offset
 {
-public:
-       ThreadedStaticText (wxWindow* parent, wxString initial, boost::function<std::string ()> fn);
-       ~ThreadedStaticText ();
-
-private:
-       void run (boost::function<std::string ()> fn);
-       void thread_finished (wxCommandEvent& ev);
-
-       /** Thread to do our work in */
-       boost::thread* _thread;
-       
-       static const int _update_event_id;
+       Offset (wxString n, int h, int m)
+               : name (n)
+               , hour (h)
+               , minute (m)
+       {}
+
+       wxString name;
+       int hour;
+       int minute;
 };
 
-extern std::string string_client_data (wxClientData* o);
+extern int get_offsets (std::vector<Offset>& offsets);
+
 
-extern void checked_set (wxFilePickerCtrl* widget, std::string value);
+extern void checked_set (FilePickerCtrl* widget, boost::filesystem::path value);
+extern void checked_set (wxDirPickerCtrl* widget, boost::filesystem::path value);
 extern void checked_set (wxSpinCtrl* widget, int value);
+extern void checked_set (wxSpinCtrlDouble* widget, double value);
 extern void checked_set (wxChoice* widget, int value);
 extern void checked_set (wxChoice* widget, std::string value);
+extern void checked_set (wxChoice* widget, std::vector<std::pair<std::string, std::string> > items);
 extern void checked_set (wxTextCtrl* widget, std::string value);
+extern void checked_set (wxTextCtrl* widget, wxString value);
+extern void checked_set (PasswordEntry* widget, std::string value);
 extern void checked_set (wxCheckBox* widget, bool value);
 extern void checked_set (wxRadioButton* widget, bool value);
 extern void checked_set (wxStaticText* widget, std::string value);
+extern void checked_set (wxStaticText* widget, wxString value);
 
-/* GTK 2.24.17 has a buggy GtkFileChooserButton and it was put in Ubuntu 13.04.
-   Use our own dir picker as this is the least bad option I can think of.
-*/
-#if defined(__WXMSW__) || (GTK_MAJOR_VERSION == 2 && GTK_MINOR_VERSION == 24 && GTK_MICRO_VERSION == 17)
-#define DCPOMATIC_USE_OWN_DIR_PICKER
+extern int wx_get (wxChoice* widget);
+extern int wx_get (wxSpinCtrl* widget);
+extern double wx_get (wxSpinCtrlDouble* widget);
+
+#if defined(__WXMSW__)
+#define DCPOMATIC_USE_OWN_PICKER
 #endif
 
+
 #endif