ShuttleGui.h File Reference

#include <vector>
#include <wx/slider.h>
#include <wx/listbase.h>
#include "Internat.h"
#include "Prefs.h"
#include "WrappedType.h"
#include "ComponentInterfaceSymbol.h"
#include <optional>
#include <wx/statbox.h>
#include <wx/defs.h>

Include dependency graph for ShuttleGui.h:

Go to the source code of this file.

Classes
class	wxStaticBoxWrapper
class	wxSliderWrapper
struct	DialogDefinition::Item
class	ShuttleGuiBase
	Base class for shuttling data to and from a GUI. More...
struct	ShuttleGuiBase::ListControlColumn
class	ShuttleGui
	Derived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI. More...

Namespaces
namespace	DialogDefinition

Typedefs
typedef wxWindow	wxNotebookPage

Enumerations
enum	teShuttleMode {   eIsCreating , eIsGettingFromDialog , eIsSettingToDialog , eIsGettingMetadata ,   eIsCreatingFromPrefs , eIsSavingToPrefs }
enum	{   eOkButton = 0x0001 , eCancelButton = 0x0002 , eYesButton = 0x0004 , eNoButton = 0x0008 ,   eHelpButton = 0x0010 , ePreviewButton = 0x0020 , eDebugButton = 0x0040 , eSettingsButton = 0x0080 ,   ePreviewDryButton = 0x0100 , eApplyButton = 0x0200 , eCloseButton = 0x0400 }
enum	{   ePreviewID = wxID_PREVIEW , eDebugID = wxID_LOWEST - 2 , eSettingsID = wxID_LOWEST - 3 , ePreviewDryID = wxID_LOWEST - 4 ,   eCloseID = wxID_CANCEL }

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

Variables
const int	nMaxNestedSizers = 20

Typedef Documentation

wxNotebookPage

typedef wxWindow wxNotebookPage

Definition at line 61 of file ShuttleGui.h.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
eOkButton
eCancelButton
eYesButton
eNoButton
eHelpButton
ePreviewButton
eDebugButton
eSettingsButton
ePreviewDryButton
eApplyButton
eCloseButton

Definition at line 592 of file ShuttleGui.h.

{
   eOkButton      = 0x0001,
   eCancelButton  = 0x0002,
   eYesButton     = 0x0004,
   eNoButton      = 0x0008,
   eHelpButton    = 0x0010,
   ePreviewButton = 0x0020,
   eDebugButton   = 0x0040,
   eSettingsButton= 0x0080,
   ePreviewDryButton  = 0x0100,
   eApplyButton   = 0x0200,
   eCloseButton   = 0x0400,
};

anonymous enum

anonymous enum

Enumerator
ePreviewID
eDebugID
eSettingsID
ePreviewDryID
eCloseID

Definition at line 607 of file ShuttleGui.h.

{
   // ePreviewID     = wxID_LOWEST - 1,
   // But there is a wxID_PREVIEW
   ePreviewID     = wxID_PREVIEW,
 
   eDebugID       = wxID_LOWEST - 2,
   eSettingsID    = wxID_LOWEST - 3,
   ePreviewDryID  = wxID_LOWEST - 4,
   eCloseID       = wxID_CANCEL
};

teShuttleMode

enum teShuttleMode

Enumerator
eIsCreating
eIsGettingFromDialog
eIsSettingToDialog
eIsGettingMetadata
eIsCreatingFromPrefs
eIsSavingToPrefs

Definition at line 35 of file ShuttleGui.h.

{
   eIsCreating,
   eIsGettingFromDialog,
   eIsSettingToDialog,
   eIsGettingMetadata,
 
   // Next two are only ever seen in constructor.
   // After that they revert to one of the modes above.
   // They are used to achieve 'two step' operation,
   // where we transfer between two shuttles in one go.
   eIsCreatingFromPrefs,
   eIsSavingToPrefs
};

Function Documentation

CreateStdButtonSizer()

SHUTTLEGUI_API std::unique_ptr< wxSizer > CreateStdButtonSizer	(	wxWindow *	parent,
		long	buttons = eOkButton|eCancelButton,
		wxWindow *	extra = NULL
	)

Definition at line 2278 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]

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

Convenience function often useful when adding choice controls.

Definition at line 2514 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(), ScreenshotCommand::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]

SHUTTLEGUI_API TranslatableStrings Msgids

(

const std::vector< EnumValueSymbol > &

strings

)

Convenience function often useful when adding choice controls.

Definition at line 2523 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 2221 of file ShuttleGui.cpp.

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

SetIfCreated() [2/3]

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

Definition at line 2231 of file ShuttleGui.cpp.

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

SetIfCreated() [3/3]

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

Definition at line 2226 of file ShuttleGui.cpp.

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

Variable Documentation

nMaxNestedSizers

const int nMaxNestedSizers = 20

Definition at line 33 of file ShuttleGui.h.

Referenced by ShuttleGuiBase::PushSizer().