ShuttleGui Class Reference

Derived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI. More...

#include <ShuttleGui.h>

Inheritance diagram for ShuttleGui:

Collaboration diagram for ShuttleGui:

Public Member Functions
	ShuttleGui (wxWindow *pParent, teShuttleMode ShuttleMode, bool vertical=true, wxSize minSize={ 250, 100 })
	~ShuttleGui (void)
ShuttleGui &	Optional (bool &bVar)
ShuttleGui &	Id (int id)
ShuttleGui &	Focus (bool focused=true)
ShuttleGui &	Disable (bool disabled=true)
ShuttleGui &	ToolTip (const TranslatableString &tip)
ShuttleGui &	Name (const TranslatableString &name)
ShuttleGui &	NameSuffix (const TranslatableString &suffix)
template<typename Factory >
ShuttleGui &	Validator (const Factory &f)
template<typename V , typename... Args>
ShuttleGui &	Validator (Args &&...args)
template<typename Tag , typename Argument , typename Handler >
auto	ConnectRoot (wxEventTypeTag< Tag > eventType, void(Handler::*func)(Argument &)) -> std::enable_if_t< std::is_base_of_v< Argument, Tag >, ShuttleGui & >
ShuttleGui &	Position (int flags)
ShuttleGui &	Size (wxSize size)
ShuttleGui &	Prop (int iProp)
ShuttleGui &	Style (long iStyle)
ShuttleGui &	MinSize ()
ShuttleGui &	MinSize (wxSize sz)
void	AddStandardButtons (long buttons=eOkButton|eCancelButton, wxWindow *extra=NULL)
wxSizerItem *	AddSpace (int width, int height, int prop=0)
wxSizerItem *	AddSpace (int size)
teShuttleMode	GetMode ()
Public Member Functions inherited from ShuttleGuiBase
	ShuttleGuiBase (wxWindow *pParent, teShuttleMode ShuttleMode, bool vertical, wxSize minSize)
virtual	~ShuttleGuiBase ()
void	Init (bool vertical, wxSize minSize)
void	ResetId ()
void	HandleOptionality (const TranslatableString &Prompt)
wxStaticText *	AddPrompt (const TranslatableString &Prompt, int wrapWidth=0)
	Right aligned text string. More...
void	AddUnits (const TranslatableString &Prompt, int wrapWidth=0)
	Left aligned text string. More...
void	AddTitle (const TranslatableString &Prompt, int wrapWidth=0)
	Centred text string. More...
wxWindow *	AddWindow (wxWindow *pWindow, int PositionFlags=wxALIGN_CENTRE)
wxSlider *	AddSlider (const TranslatableString &Prompt, int pos, int Max, int Min=0)
wxSlider *	AddVSlider (const TranslatableString &Prompt, int pos, int Max)
wxSpinCtrl *	AddSpinCtrl (const TranslatableString &Prompt, int Value, int Max, int Min)
SpinControl *	AddSpinControl (const wxSize &size, const TranslatableString &Prompt, double Value, double Max, double Min)
wxTreeCtrl *	AddTree ()
wxRadioButton *	AddRadioButton (const TranslatableString &Prompt, int selector=0, int initValue=0)
wxRadioButton *	AddRadioButtonToGroup (const TranslatableString &Prompt, int selector=1, int initValue=0)
wxButton *	AddButton (const TranslatableString &Text, int PositionFlags=wxALIGN_CENTRE, bool setDefault=false)
wxBitmapButton *	AddBitmapButton (const wxBitmap &Bitmap, int PositionFlags=wxALIGN_CENTRE, bool setDefault=false)
wxStaticText *	AddVariableText (const TranslatableString &Str, bool bCenter=false, int PositionFlags=0, int wrapWidth=0)
ReadOnlyText *	AddReadOnlyText (const TranslatableString &Caption, const wxString &Value)
wxTextCtrl *	AddTextBox (const TranslatableString &Caption, const wxString &Value, const int nChars)
wxTextCtrl *	AddNumericTextBox (const TranslatableString &Caption, const wxString &Value, const int nChars, bool acceptEnter=false)
wxTextCtrl *	AddTextWindow (const wxString &Value)
	Multiline text box that grows. More...
wxListBox *	AddListBox (const wxArrayStringEx &choices)
wxListCtrl *	AddListControl (std::initializer_list< const ListControlColumn > columns={}, long listControlStyles=0)
wxListCtrl *	AddListControlReportMode (std::initializer_list< const ListControlColumn > columns={}, long listControlStyles=0)
wxGrid *	AddGrid ()
wxCheckBox *	AddCheckBox (const TranslatableString &Prompt, bool Selected)
wxCheckBox *	AddCheckBoxOnRight (const TranslatableString &Prompt, bool Selected)
wxCheckBox *	AddCheckBox (const TranslatableString &Prompt, const wxChar *)=delete
wxCheckBox *	AddCheckBox (const TranslatableString &Prompt, const char *)=delete
wxCheckBox *	AddCheckBoxOnRight (const TranslatableString &Prompt, const wxChar *)=delete
wxCheckBox *	AddCheckBoxOnRight (const TranslatableString &Prompt, const char *)=delete
wxComboBox *	AddCombo (const TranslatableString &Prompt, const wxString &Selected, const wxArrayStringEx &choices)
wxChoice *	AddChoice (const TranslatableString &Prompt, const TranslatableStrings &choices, int Selected=-1)
wxChoice *	AddChoice (const TranslatableString &Prompt, const TranslatableStrings &choices, const TranslatableString &selected)
void	AddIcon (wxBitmap *pBmp)
void	AddFixedText (const TranslatableString &Str, bool bCenter=false, int wrapWidth=0)
void	AddConstTextBox (const TranslatableString &Caption, const TranslatableString &Value)
	Single line text box of fixed size. More...
void	StartHorizontalLay (int PositionFlags=wxALIGN_CENTRE, int iProp=1)
void	EndHorizontalLay ()
void	StartVerticalLay (int iProp=1)
void	StartVerticalLay (int PositionFlags, int iProp)
void	EndVerticalLay ()
void	StartWrapLay (int PositionFlags=wxEXPAND, int iProp=0)
void	EndWrapLay ()
wxScrolledWindow *	StartScroller (int iStyle=0)
void	EndScroller ()
wxPanel *	StartPanel (int iStyle=0)
void	EndPanel ()
void	StartMultiColumn (int nCols, int PositionFlags=wxALIGN_LEFT)
void	EndMultiColumn ()
void	StartTwoColumn ()
void	EndTwoColumn ()
void	StartThreeColumn ()
void	EndThreeColumn ()
wxStaticBox *	StartStatic (const TranslatableString &Str, int iProp=0)
void	EndStatic ()
wxNotebook *	StartNotebook ()
void	EndNotebook ()
wxSimplebook *	StartSimplebook ()
void	EndSimplebook ()
wxNotebookPage *	StartNotebookPage (const TranslatableString &Name)
void	EndNotebookPage ()
wxPanel *	StartInvisiblePanel (int border=0)
void	EndInvisiblePanel ()
void	StartRadioButtonGroup (ChoiceSetting &Setting)
	Call this before any TieRadioButton calls. More...
void	EndRadioButtonGroup ()
bool	DoStep (int iStep)
int	TranslateToIndex (const wxString &Value, const wxArrayStringEx &Choices)
	String-to-Index. More...
wxString	TranslateFromIndex (const int nIn, const wxArrayStringEx &Choices)
	Index-to-String. More...
wxTextCtrl *	TieTextBox (const TranslatableString &Caption, wxString &Value, const int nChars=0)
wxTextCtrl *	TieTextBox (const TranslatableString &Prompt, int &Selected, const int nChars=0)
wxTextCtrl *	TieTextBox (const TranslatableString &Prompt, double &Value, const int nChars=0)
wxTextCtrl *	TieNumericTextBox (const TranslatableString &Prompt, int &Value, const int nChars=0, bool acceptEnter=false)
wxTextCtrl *	TieNumericTextBox (const TranslatableString &Prompt, double &Value, const int nChars=0, bool acceptEnter=false)
wxCheckBox *	TieCheckBox (const TranslatableString &Prompt, bool &Var)
wxCheckBox *	TieCheckBoxOnRight (const TranslatableString &Prompt, bool &Var)
wxChoice *	TieChoice (const TranslatableString &Prompt, TranslatableString &Selected, const TranslatableStrings &choices)
wxChoice *	TieChoice (const TranslatableString &Prompt, int &Selected, const TranslatableStrings &choices)
wxSlider *	TieSlider (const TranslatableString &Prompt, int &pos, const int max, const int min=0)
wxSlider *	TieSlider (const TranslatableString &Prompt, double &pos, const double max, const double min=0.0)
wxSlider *	TieSlider (const TranslatableString &Prompt, float &pos, const float fMin, const float fMax)
wxSlider *	TieVSlider (const TranslatableString &Prompt, float &pos, const float fMin, const float fMax)
wxRadioButton *	TieRadioButton ()
	This function must be within a StartRadioButtonGroup - EndRadioButtonGroup pair. More...
wxSpinCtrl *	TieSpinCtrl (const TranslatableString &Prompt, int &Value, const int max, const int min=0)
SpinControl *	TieSpinControl (const wxSize &size, const TranslatableString &Prompt, double &Value, const double max, const double min=0)
virtual wxCheckBox *	TieCheckBox (const TranslatableString &Prompt, const BoolSetting &Setting)
virtual wxCheckBox *	TieCheckBoxOnRight (const TranslatableString &Prompt, const BoolSetting &Setting)
virtual wxChoice *	TieChoice (const TranslatableString &Prompt, ChoiceSetting &choiceSetting)
virtual wxChoice *	TieNumberAsChoice (const TranslatableString &Prompt, IntSetting &Setting, const TranslatableStrings &Choices, const std::vector< int > *pInternalChoices=nullptr, int iNoMatchSelector=0)
virtual wxTextCtrl *	TieTextBox (const TranslatableString &Prompt, const StringSetting &Setting, const int nChars)
virtual wxTextCtrl *	TieIntegerTextBox (const TranslatableString &Prompt, const IntSetting &Setting, const int nChars)
virtual wxTextCtrl *	TieNumericTextBox (const TranslatableString &Prompt, const DoubleSetting &Setting, const int nChars, bool acceptEnter=false)
virtual wxSlider *	TieSlider (const TranslatableString &Prompt, const IntSetting &Setting, const int max, const int min=0)
virtual wxSpinCtrl *	TieSpinCtrl (const TranslatableString &Prompt, const IntSetting &Setting, const int max, const int min)
void	SetBorder (int Border)
int	GetBorder () const noexcept
void	SetSizerProportion (int iProp)
void	SetStretchyCol (int i)
	Used to modify an already placed FlexGridSizer to make a column stretchy. More...
void	SetStretchyRow (int i)
	Used to modify an already placed FlexGridSizer to make a row stretchy. More...
wxWindow *	GetParent ()
ShuttleGuiBase &	Prop (int iProp)
void	UseUpId ()
wxSizer *	GetSizer ()

Static Public Member Functions
static void	SetMinSize (wxWindow *window, const TranslatableStrings &items)
static void	SetMinSize (wxWindow *window, const wxArrayStringEx &items)
Static Public Member Functions inherited from ShuttleGuiBase
static void	ApplyItem (int step, const DialogDefinition::Item &item, wxWindow *pWind, wxWindow *pDlg)

Additional Inherited Members
Protected Member Functions inherited from ShuttleGuiBase
void	SetProportions (int Default)
void	PushSizer ()
void	PopSizer ()
void	UpdateSizersCore (bool bPrepend, int Flags, bool prompt=false)
void	UpdateSizers ()
void	UpdateSizersC ()
void	UpdateSizersAtStart ()
long	GetStyle (long Style)
Protected Attributes inherited from ShuttleGuiBase
wxWindow *const	mpDlg
wxSizer *	pSizerStack [nMaxNestedSizers]
std::unique_ptr< ShuttlePrefs >	mpShuttle
int	miNoMatchSelector
teShuttleMode	mShuttleMode
	Used in choices to determine which item to use on no match. More...
int	miSizerProp
int	mSizerDepth
int	miBorder
int	miProp
int	miId
int	miIdNext
int	miIdSetByUser
int	miPropSetByUser
bool *	mpbOptionalFlag
std::unique_ptr< wxSizer >	mpSubSizer
wxSizer *	mpSizer
wxWindow *	mpParent
wxWindow *	mpWind
DialogDefinition::Item	mItem

Detailed Description

Derived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI.

ShuttleGui extends the idea of the data Shuttle class to include creation of dialog controls. As part of this it provides an interface to sizers that leads to shorter more readable code.

It also allows the code that is used to create dialogs to be reused to shuttle information in and out.

Most of the ShuttleGui functions are actually defined in ShuttleGuiBase.

• wxWidgets widgets are dealt with by ShuttleGuiBase.
• Audacity specific widgets are dealt with by ShuttleGui

There is documentation on how to use this class in The Shuttle System

Definition at line 639 of file ShuttleGui.h.

Constructor & Destructor Documentation

ShuttleGui()

ShuttleGui::ShuttleGui	(	wxWindow *	pParent,
		teShuttleMode	ShuttleMode,
		bool	vertical = true,
		wxSize	minSize = { 250, 100 }
	)

Definition at line 2310 of file ShuttleGui.cpp.

   : ShuttleGuiBase( pParent, ShuttleMode, vertical, minSize )
{
   if( ShuttleMode == eIsCreatingFromPrefs )
   {
      mShuttleMode = eIsCreating;
      Init( vertical, minSize ); // Wasn't fully done in base constructor because it is only done when eIsCreating is set.
   }
   else if( ShuttleMode == eIsSavingToPrefs )
   {
      mShuttleMode = eIsGettingFromDialog;
   }
   else
   {
      return;
   }
 
   mpShuttle = std::make_unique<ShuttlePrefs>();
   // In this case the client is the GUI, so if creating we do want to
   // store in the client.
   mpShuttle->mbStoreInClient = (mShuttleMode == eIsCreating );
};

References eIsCreating, eIsCreatingFromPrefs, eIsGettingFromDialog, eIsSavingToPrefs, ShuttleGuiBase::Init(), ShuttleGuiBase::mpShuttle, and ShuttleGuiBase::mShuttleMode.

Here is the call graph for this function:

~ShuttleGui()

ShuttleGui::~ShuttleGui

(

void

)

Definition at line 2334 of file ShuttleGui.cpp.

{
}

Member Function Documentation

AddSpace() [1/2]

wxSizerItem * ShuttleGui::AddSpace ( int  size )

inline

Definition at line 752 of file ShuttleGui.h.

{ return AddSpace( size, size ); };

References AddSpace(), and size.

Referenced by AddSpace().

Here is the call graph for this function:

Here is the caller graph for this function:

AddSpace() [2/2]

wxSizerItem * ShuttleGui::AddSpace	(	int	width,
		int	height,
		int	prop = 0
	)

Definition at line 2524 of file ShuttleGui.cpp.

{
   if( mShuttleMode != eIsCreating )
      return NULL;
 
//   SetProportions(0);
  // return mpSizer->Add( width, height, miProp);
 
   return mpSizer->Add( width, height, prop );
}

References eIsCreating, ShuttleGuiBase::mpSizer, and ShuttleGuiBase::mShuttleMode.

Referenced by ErrorReportDialog::ErrorReportDialog(), audacity::cloud::audiocom::ShareAudioDialog::Populate(), audacity::cloud::audiocom::ShareAudioDialog::InitialStatePanel::PopulateInitialStatePanel(), PitchAndSpeedDialog::PopulateOrExchange(), and audacity::cloud::audiocom::ShareAudioDialog::ProgressPanel::PopulateProgressPanel().

Here is the caller graph for this function:

AddStandardButtons()

void ShuttleGui::AddStandardButtons	(	long	buttons = eOkButton | eCancelButton,
		wxWindow *	extra = NULL
	)

Definition at line 2509 of file ShuttleGui.cpp.

{
   if( mShuttleMode != eIsCreating )
      return;
 
   StartVerticalLay( false );
 
   miSizerProp = false;
   mpSubSizer = CreateStdButtonSizer( mpParent, buttons, extra );
   UpdateSizers();
   PopSizer();
 
   EndVerticalLay();
}

References CreateStdButtonSizer(), eIsCreating, ShuttleGuiBase::EndVerticalLay(), ShuttleGuiBase::miSizerProp, ShuttleGuiBase::mpParent, ShuttleGuiBase::mpSubSizer, ShuttleGuiBase::mShuttleMode, ShuttleGuiBase::PopSizer(), ShuttleGuiBase::StartVerticalLay(), and ShuttleGuiBase::UpdateSizers().

Here is the call graph for this function:

ConnectRoot()

template<typename Tag , typename Argument , typename Handler >

auto ShuttleGui::ConnectRoot ( wxEventTypeTag< Tag >  eventType, void(Handler::*)(Argument &)  func  ) -> std::enable_if_t< std::is_base_of_v<Argument, Tag>, ShuttleGui& >

inline

Definition at line 708 of file ShuttleGui.h.

   {
      std::move( mItem ).ConnectRoot( eventType, func );
      return *this;
   }

References ConnectRoot().

Referenced by ConnectRoot().

Here is the call graph for this function:

Here is the caller graph for this function:

Disable()

ShuttleGui & ShuttleGui::Disable ( bool  disabled = true )

inline

Definition at line 659 of file ShuttleGui.h.

   {
      std::move( mItem ).Disable( disabled );
      return *this;
   }

References Disable().

Referenced by Disable().

Here is the call graph for this function:

Here is the caller graph for this function:

Focus()

ShuttleGui & ShuttleGui::Focus ( bool  focused = true )

inline

Definition at line 653 of file ShuttleGui.h.

   {
      std::move( mItem ).Focus( focused );
      return *this;
   }

References Focus().

Referenced by Focus().

Here is the call graph for this function:

Here is the caller graph for this function:

GetMode()

teShuttleMode ShuttleGui::GetMode ( )

inline

Definition at line 760 of file ShuttleGui.h.

{ return  mShuttleMode; };

Id()

ShuttleGui & ShuttleGui::Id

(

int

id

)

Definition at line 2339 of file ShuttleGui.cpp.

{
   miIdSetByUser = id;
   return *this;
}

References id, and ShuttleGuiBase::miIdSetByUser.

Referenced by PitchAndSpeedDialog::PopulateOrExchange().

Here is the caller graph for this function:

MinSize() [1/2]

ShuttleGui & ShuttleGui::MinSize ( )

inline

Definition at line 741 of file ShuttleGui.h.

      { std::move( mItem ).MinSize(); return *this; }

References MinSize().

Referenced by ErrorReportDialog::ErrorReportDialog(), and MinSize().

Here is the call graph for this function:

Here is the caller graph for this function:

MinSize() [2/2]

ShuttleGui & ShuttleGui::MinSize ( wxSize  sz )

inline

Definition at line 743 of file ShuttleGui.h.

      { std::move( mItem ).MinSize( sz ); return *this; }

References MinSize().

Here is the call graph for this function:

Name()

ShuttleGui & ShuttleGui::Name ( const TranslatableString &  name )

inline

Definition at line 672 of file ShuttleGui.h.

   {
      std::move( mItem ).Name( name );
      return *this;
   }

References Name(), and name.

Referenced by ErrorReportDialog::ErrorReportDialog(), Name(), and PitchAndSpeedDialog::PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

NameSuffix()

ShuttleGui & ShuttleGui::NameSuffix ( const TranslatableString &  suffix )

inline

Definition at line 680 of file ShuttleGui.h.

   {
      std::move( mItem ).NameSuffix( suffix );
      return *this;
   }

References NameSuffix().

Referenced by NameSuffix().

Here is the call graph for this function:

Here is the caller graph for this function:

Optional()

ShuttleGui & ShuttleGui::Optional

(

bool &

bVar

)

Definition at line 2345 of file ShuttleGui.cpp.

                                             {
   mpbOptionalFlag = &bVar;
   return *this;
};

References ShuttleGuiBase::mpbOptionalFlag.

Position()

ShuttleGui & ShuttleGui::Position ( int  flags )

inline

Definition at line 720 of file ShuttleGui.h.

   {
      std::move( mItem ).Position( flags );
      return *this;
   }

References Position().

Referenced by Position().

Here is the call graph for this function:

Here is the caller graph for this function:

Prop()

ShuttleGui & ShuttleGui::Prop ( int  iProp )

inline

Definition at line 733 of file ShuttleGui.h.

{ ShuttleGuiBase::Prop(iProp); return *this;}; // Has to be here too, to return a ShuttleGui and not a ShuttleGuiBase.

References ShuttleGuiBase::Prop().

Referenced by audacity::cloud::audiocom::ShareAudioDialog::InitialStatePanel::PopulateInitialStatePanel().

Here is the call graph for this function:

Here is the caller graph for this function:

SetMinSize() [1/2]

void ShuttleGui::SetMinSize ( wxWindow *  window, const TranslatableStrings &  items  )

static

Definition at line 2535 of file ShuttleGui.cpp.

{
   SetMinSize( window,
      transform_container<wxArrayStringEx>(
         items, std::mem_fn( &TranslatableString::StrippedTranslation ) ) );
}

References SetMinSize(), and TranslatableString::StrippedTranslation().

Referenced by DevicePrefs::OnDevice(), DevicePrefs::OnHost(), MidiIOPrefs::OnHost(), SetMinSize(), and ShuttleGuiBase::TieChoice().

Here is the call graph for this function:

Here is the caller graph for this function:

SetMinSize() [2/2]

void ShuttleGui::SetMinSize ( wxWindow *  window, const wxArrayStringEx &  items  )

static

Definition at line 2542 of file ShuttleGui.cpp.

{
   int maxw = 0;
 
   for( size_t i = 0; i < items.size(); i++ )
   {
      int x;
      int y;
 
      window->GetTextExtent(items[i], &x, &y );
      if( x > maxw )
      {
         maxw = x;
      }
   }
 
   // Would be nice to know the sizes of the button and borders, but this is
   // the best we can do for now.
#if defined(__WXMAC__)
   maxw += 50;
#elif defined(__WXMSW__)
   maxw += 50;
#elif defined(__WXGTK__)
   maxw += 50;
#else
   maxw += 50;
#endif
 
   window->SetMinSize( { maxw, -1 } );
}

Size()

ShuttleGui & ShuttleGui::Size ( wxSize  size )

inline

Definition at line 726 of file ShuttleGui.h.

   {
      std::move( mItem ).Size( size );
      return *this;
   }

References Size(), and size.

Referenced by Size().

Here is the call graph for this function:

Here is the caller graph for this function:

Style()

ShuttleGui & ShuttleGui::Style ( long  iStyle )

inline

Definition at line 735 of file ShuttleGui.h.

   {
      std::move( mItem ).Style( iStyle );
      return *this;
   }

References Style().

Referenced by ErrorReportDialog::ErrorReportDialog(), and Style().

Here is the call graph for this function:

Here is the caller graph for this function:

ToolTip()

ShuttleGui & ShuttleGui::ToolTip ( const TranslatableString &  tip )

inline

Definition at line 665 of file ShuttleGui.h.

   {
      std::move( mItem ).ToolTip( tip );
      return *this;
   }

References ToolTip().

Referenced by ToolTip().

Here is the call graph for this function:

Here is the caller graph for this function:

Validator() [1/2]

template<typename V , typename... Args>

ShuttleGui & ShuttleGui::Validator ( Args &&...  args )

inline

Definition at line 696 of file ShuttleGui.h.

   {
      if ( GetMode() == eIsCreating )
         std::move( mItem ).Validator<V>( std::forward<Args>(args)... );
      return *this;
   }

References eIsCreating, and Validator().

Here is the call graph for this function:

Validator() [2/2]

template<typename Factory >

ShuttleGui & ShuttleGui::Validator ( const Factory &  f )

inline

Definition at line 687 of file ShuttleGui.h.

   {
      if ( GetMode() == eIsCreating )
         std::move( mItem ).Validator( f );
      return *this;
   }

References eIsCreating, and Validator().

Referenced by Validator().

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• ShuttleGui.h
• ShuttleGui.cpp