ShuttleGui.cpp File Reference

Implements ShuttleGui, ShuttleGuiBase and InvisiblePanel. More...

#include "ShuttleGui.h"
#include "IteratorX.h"
#include "Prefs.h"
#include "ShuttlePrefs.h"
#include "SpinControl.h"
#include "Theme.h"
#include <wx/setup.h>
#include <wx/wx.h>
#include <wx/wxprec.h>
#include <wx/grid.h>
#include <wx/listctrl.h>
#include <wx/notebook.h>
#include <wx/simplebook.h>
#include <wx/treectrl.h>
#include <wx/spinctrl.h>
#include <wx/stattext.h>
#include <wx/bmpbuttn.h>
#include <wx/wrapsizer.h>
#include "ReadOnlyText.h"
#include "wxPanelWrapper.h"
#include "wxTextCtrlWrapper.h"
#include "AllThemeResources.h"

Include dependency graph for ShuttleGui.cpp:

Go to the source code of this file.

Classes
class	InvisiblePanel
	An InvisiblePanel is a panel which does not repaint its own background. More...

Functions
void	SetIfCreated (wxChoice *&Var, wxChoice *Val)
void	SetIfCreated (wxTextCtrl *&Var, wxTextCtrl *Val)
void	SetIfCreated (wxStaticText *&Var, wxStaticText *Val)
std::unique_ptr< wxSizer >	CreateStdButtonSizer (wxWindow *parent, long buttons, wxWindow *extra)
TranslatableStrings	Msgids (const EnumValueSymbol strings[], size_t nStrings)
	Convenience function often useful when adding choice controls. More...
TranslatableStrings	Msgids (const std::vector< EnumValueSymbol > &strings)
	Convenience function often useful when adding choice controls. More...

Detailed Description

Implements ShuttleGui, ShuttleGuiBase and InvisiblePanel.

Definition in file ShuttleGui.cpp.

Function Documentation

CreateStdButtonSizer()

std::unique_ptr< wxSizer > CreateStdButtonSizer	(	wxWindow *	parent,
		long	buttons,
		wxWindow *	extra
	)

Definition at line 2352 of file ShuttleGui.cpp.

{
   wxASSERT(parent != NULL); // To justify safenew
 
   int margin;
   {
#if defined(__WXMAC__)
      margin = 12;
#elif defined(__WXGTK20__)
      margin = 12;
#elif defined(__WXMSW__)
      wxButton b(parent, 0, wxEmptyString);
      margin = b.ConvertDialogToPixels(wxSize(2, 0)).x;
#else
      wxButton b(parent, 0, wxEmptyString);
      margin = b->ConvertDialogToPixels(wxSize(4, 0)).x;
#endif
   }
 
   wxButton *b = NULL;
   auto bs = std::make_unique<wxStdDialogButtonSizer>();
 
   const auto makeButton =
   [parent]( wxWindowID id, const wxString label = {} ) {
      auto result = safenew wxButton( parent, id, label );
      result->SetName( result->GetLabel() );
      return result;
   };
 
   if( buttons & eOkButton )
   {
      b = makeButton( wxID_OK );
      b->SetDefault();
      bs->AddButton( b );
   }
 
   if( buttons & eCancelButton )
   {
      bs->AddButton( makeButton( wxID_CANCEL ) );
   }
 
   if( buttons & eYesButton )
   {
      b = makeButton( wxID_YES );
      b->SetDefault();
      bs->AddButton( b );
   }
 
   if( buttons & eNoButton )
   {
      bs->AddButton( makeButton( wxID_NO ) );
   }
 
   if( buttons & eApplyButton )
   {
      b = makeButton( wxID_APPLY );
      b->SetDefault();
      bs->AddButton( b );
   }
 
   if( buttons & eCloseButton )
   {
      bs->AddButton( makeButton( wxID_CANCEL, XO("&Close").Translation() ) );
   }
 
#if defined(__WXMSW__)
   // See below for explanation
   if( buttons & eHelpButton )
   {
      // Replace standard Help button with smaller icon button.
      // bs->AddButton(safenew wxButton(parent, wxID_HELP));
      b = safenew wxBitmapButton(parent, wxID_HELP, theTheme.Bitmap( bmpHelpIcon ));
      b->SetToolTip( XO("Help").Translation() );
      b->SetLabel(XO("Help").Translation());       // for screen readers
      b->SetName( b->GetLabel() );
      bs->AddButton( b );
   }
#endif
 
   if (buttons & ePreviewButton)
   {
      bs->Add( makeButton( ePreviewID, XO("&Preview").Translation() ),
         0, wxALIGN_CENTER | wxLEFT | wxRIGHT, margin);
   }
   if (buttons & ePreviewDryButton)
   {
      bs->Add( makeButton( ePreviewDryID, XO("Dry Previe&w").Translation() ),
         0, wxALIGN_CENTER | wxLEFT | wxRIGHT, margin);
      bs->Add( 20, 0 );
   }
 
   if( buttons & eSettingsButton )
   {
      bs->Add( makeButton( eSettingsID, XO("&Settings").Translation() ),
         0, wxALIGN_CENTER | wxLEFT | wxRIGHT, margin);
      bs->Add( 20, 0 );
   }
 
   if( extra )
   {
      bs->Add( extra, 0, wxALIGN_CENTER | wxLEFT | wxRIGHT, margin );
      bs->Add( 40, 0 );
   }
 
   bs->AddStretchSpacer();
   bs->Realize();
 
   size_t lastLastSpacer = 0;
   size_t lastSpacer = 0;
   wxSizerItemList & list = bs->GetChildren();
   for( size_t i = 0, cnt = list.size(); i < cnt; i++ )
   {
      if( list[i]->IsSpacer() )
      {
         lastSpacer = i;
      }
      else
      {
         lastLastSpacer = lastSpacer;
      }
   }
 
   // Add any buttons that need to cuddle up to the right hand cluster
   if( buttons & eDebugButton )
   {
      b = makeButton( eDebugID, XO("Debu&g").Translation() );
      bs->Insert( ++lastLastSpacer, b, 0, wxALIGN_CENTER | wxLEFT | wxRIGHT, margin );
   }
 
#if !defined(__WXMSW__)
   // Bug #2432: Couldn't find GTK guidelines, but Mac HIGs state:
   //
   //    View style                                            Help button position
   //    Dialog with dismissal buttons (like OK and Cancel).   Lower-left corner, vertically aligned with the dismissal buttons.
   //    Dialog without dismissal buttons.                     Lower-left or lower-right corner.
   //    Preference window or pane.                            Lower-left or lower-right corner.
   //
   // So, we're gonna cheat a little and use the lower-right corner.
   if( buttons & eHelpButton )
   {
      // Replace standard Help button with smaller icon button.
      // bs->AddButton(safenew wxButton(parent, wxID_HELP));
      b = safenew wxBitmapButton(parent, wxID_HELP, theTheme.Bitmap( bmpHelpIcon ));
      b->SetToolTip( XO("Help").Translation() );
      b->SetLabel(XO("Help").Translation());       // for screen readers
      b->SetName( b->GetLabel() );
      bs->Add( b, 0, wxALIGN_CENTER );
   }
#endif
 
 
   auto s = std::make_unique<wxBoxSizer>( wxVERTICAL );
   s->Add( bs.release(), 1, wxEXPAND | wxALL, 7 );
   s->Add( 0, 3 );   // a little extra space
 
   return std::unique_ptr<wxSizer>{ s.release() };
}

References ThemeBase::Bitmap(), eApplyButton, eCancelButton, eCloseButton, eDebugButton, eDebugID, eHelpButton, eNoButton, eOkButton, ePreviewButton, ePreviewDryButton, ePreviewDryID, ePreviewID, eSettingsButton, eSettingsID, eYesButton, id, label, safenew, theTheme, and XO().

Referenced by ShuttleGui::AddStandardButtons().

Here is the call graph for this function:

Here is the caller graph for this function:

Msgids() [1/2]

TranslatableStrings Msgids	(	const EnumValueSymbol	strings[],
		size_t	nStrings
	)

Convenience function often useful when adding choice controls.

Definition at line 2588 of file ShuttleGui.cpp.

{
   return transform_range<TranslatableStrings>(
      strings, strings + nStrings,
      std::mem_fn( &EnumValueSymbol::Msgid )
   );
}

References ComponentInterfaceSymbol::Msgid().

Referenced by NyquistEffect::BuildEffectWindow(), Msgids(), EffectDistortion::Editor::PopulateOrExchange(), DragCommand::PopulateOrExchange(), GetInfoCommand::PopulateOrExchange(), GetTrackInfoCommand::PopulateOrExchange(), HelpCommand::PopulateOrExchange(), SelectTimeCommand::PopulateOrExchange(), SelectTracksCommand::PopulateOrExchange(), SetClipCommand::PopulateOrExchange(), SetTrackVisualsCommand::PopulateOrExchange(), SpectrumPrefs::PopulateOrExchange(), WaveformPrefs::PopulateOrExchange(), EqualizationUI::PopulateOrExchange(), EffectLoudness::PopulateOrExchange(), EffectNoise::PopulateOrExchange(), EffectScienFilter::PopulateOrExchange(), EffectToneGen::PopulateOrExchange(), and EffectTruncSilence::PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

Msgids() [2/2]

TranslatableStrings Msgids

(

const std::vector< EnumValueSymbol > &

strings

)

Convenience function often useful when adding choice controls.

Definition at line 2597 of file ShuttleGui.cpp.

{
   return Msgids( strings.data(), strings.size() );
}

References Msgids().

Here is the call graph for this function:

SetIfCreated() [1/3]

void SetIfCreated	(	wxChoice *&	Var,
		wxChoice *	Val
	)

Definition at line 2295 of file ShuttleGui.cpp.

{
   if( Val != NULL )
      Var = Val;
};

SetIfCreated() [2/3]

void SetIfCreated	(	wxStaticText *&	Var,
		wxStaticText *	Val
	)

Definition at line 2305 of file ShuttleGui.cpp.

{
   if( Val != NULL )
      Var = Val;
};

SetIfCreated() [3/3]

void SetIfCreated	(	wxTextCtrl *&	Var,
		wxTextCtrl *	Val
	)

Definition at line 2300 of file ShuttleGui.cpp.

{
   if( Val != NULL )
      Var = Val;
};