ShuttleGuiBase Class Reference

Base class for shuttling data to and from a GUI. More...

#include <ShuttleGui.h>

Inheritance diagram for ShuttleGuiBase:

Collaboration diagram for ShuttleGuiBase:

Classes
struct	ListControlColumn

Public Member Functions
	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	ApplyItem (int step, const DialogDefinition::Item &item, wxWindow *pWind, wxWindow *pDlg)

Protected Member Functions
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
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

Private Member Functions
void	DoInsertListColumns (wxListCtrl *pListCtrl, long listControlStyles, std::initializer_list< const ListControlColumn > columns)
void	DoDataShuttle (const wxString &Name, WrappedType &WrappedRef)
wxCheckBox *	DoTieCheckBoxOnRight (const TranslatableString &Prompt, WrappedType &WrappedRef)
wxTextCtrl *	DoTieTextBox (const TranslatableString &Prompt, WrappedType &WrappedRef, const int nChars)
wxTextCtrl *	DoTieNumericTextBox (const TranslatableString &Prompt, WrappedType &WrappedRef, const int nChars, bool acceptEnter=false)
wxCheckBox *	DoTieCheckBox (const TranslatableString &Prompt, WrappedType &WrappedRef)
wxSlider *	DoTieSlider (const TranslatableString &Prompt, WrappedType &WrappedRef, const int max, const int min=0)
wxSpinCtrl *	DoTieSpinCtrl (const TranslatableString &Prompt, WrappedType &WrappedRef, const int max, const int min=0)
SpinControl *	DoTieSpinControl (const wxSize &size, const TranslatableString &Prompt, WrappedType &WrappedRef, const double max, const double min=0)
wxRadioButton *	DoAddRadioButton (const TranslatableString &Prompt, int style, int selector, int initValue)
	Unwrapped string value. More...

Private Attributes
std::vector< EnumValueSymbol >	mRadioSymbols
wxString	mRadioSettingName
std::optional< WrappedType >	mRadioValue
	The setting controlled by a group. More...
int	mRadioCount
	The wrapped value associated with the active radio button. More...
wxString	mRadioValueString
	The index of this radio item. -1 for none. More...

Detailed Description

Base class for shuttling data to and from a GUI.

see also ShuttleGui

Use the:

• Start / End methods for containers, like two-column-layout.
• Add methods if you are only interested in creating the controls.
• Tie methods if you also want to exchange data using ShuttleGui.

The code in this file is fairly repetitive. We are dealing with

• Many different types of Widget.
• Creation / Reading / Writing / Exporting / Importing
• int, float, string variants (for example of TextCtrl contents).

A technique used to reduce the size of the Tie functions is to have one generic Tie function that uses WrappedType for its data type. Type specific Tie functions themselves call the generic variant.

A second technique used to reduce the size of Tie functions only comes into play for two-step Tie functions. (A two step Tie function is one that transfers data between the registry and the GUI via an intermediate temporary variable). In the two step style, a function ShuttleGuiBase::DoStep() determines which transfers in the function are to be done, reducing repetitive if-then-else's.

Although unusual, these two techniques make the code easier to add to and much easier to check for correctness. The alternative 'more obvious' code that just repeats code as needed is considerably longer.

You would rarely use ShuttleGuiBase directly, instead you'd use ShuttleGui.

There is DOxygen documentation on how to use the ShuttleGui class in The Shuttle System .

Definition at line 240 of file ShuttleGui.h.

Constructor & Destructor Documentation

ShuttleGuiBase()

ShuttleGuiBase::ShuttleGuiBase	(	wxWindow *	pParent,
		teShuttleMode	ShuttleMode,
		bool	vertical,
		wxSize	minSize
	)

Definition at line 128 of file ShuttleGui.cpp.

   : mpDlg{ pParent }
{
   wxASSERT( (pParent != NULL ) || ( ShuttleMode != eIsCreating));
   mpbOptionalFlag = nullptr;
   mpParent = pParent;
   mShuttleMode = ShuttleMode;
   Init( vertical, minSize );
}

References eIsCreating, Init(), mpbOptionalFlag, mpParent, and mShuttleMode.

Here is the call graph for this function:

~ShuttleGuiBase()

ShuttleGuiBase::~ShuttleGuiBase ( )

virtual

Definition at line 139 of file ShuttleGui.cpp.

{
}

Member Function Documentation

AddBitmapButton()

wxBitmapButton * ShuttleGuiBase::AddBitmapButton	(	const wxBitmap &	Bitmap,
		int	PositionFlags = wxALIGN_CENTRE,
		bool	setDefault = false
	)

Definition at line 381 of file ShuttleGui.cpp.

{
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxBitmapButton);
   wxBitmapButton * pBtn;
   mpWind = pBtn = safenew wxBitmapButton(GetParent(), miId, Bitmap,
      wxDefaultPosition, wxDefaultSize, GetStyle( wxBU_AUTODRAW ) );
   pBtn->SetBackgroundColour(
      wxColour( 246,246,243));
//      wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE));
   miProp=0;
   UpdateSizersCore(false, PositionFlags | wxALL);
   if (setDefault)
      pBtn->SetDefault();
   return pBtn;
}

References eIsCreating, GetParent(), GetStyle(), miId, miProp, mpDlg, mpWind, mShuttleMode, safenew, UpdateSizersCore(), and UseUpId().

Here is the call graph for this function:

AddButton()

wxButton * ShuttleGuiBase::AddButton	(	const TranslatableString &	Text,
		int	PositionFlags = wxALIGN_CENTRE,
		bool	setDefault = false
	)

Definition at line 362 of file ShuttleGui.cpp.

{
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxButton);
   wxButton * pBtn;
   const auto translated = Text.Translation();
   mpWind = pBtn = safenew wxButton(GetParent(), miId,
      translated, wxDefaultPosition, wxDefaultSize,
      GetStyle( 0 ) );
   mpWind->SetName(wxStripMenuCodes(translated));
   miProp=0;
   UpdateSizersCore(false, PositionFlags | wxALL);
   if (setDefault)
      pBtn->SetDefault();
   return pBtn;
}

References eIsCreating, GetParent(), GetStyle(), miId, miProp, mpDlg, mpWind, mShuttleMode, safenew, TranslatableString::Translation(), UpdateSizersCore(), and UseUpId().

Referenced by audacity::cloud::audiocom::ShareAudioDialog::Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

AddCheckBox() [1/3]

wxCheckBox * ShuttleGuiBase::AddCheckBox	(	const TranslatableString &	Prompt,
		bool	Selected
	)

Definition at line 311 of file ShuttleGui.cpp.

{
   HandleOptionality( Prompt );
   auto realPrompt = Prompt.Translation();
   if( mpbOptionalFlag )
   {
      AddPrompt( {} );
      //realPrompt = wxT("");
   }
 
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxCheckBox);
   wxCheckBox * pCheckBox;
   miProp=0;
   mpWind = pCheckBox = safenew wxCheckBox(GetParent(), miId, realPrompt, wxDefaultPosition, wxDefaultSize,
      GetStyle( 0 ));
   pCheckBox->SetValue(Selected);
   if (realPrompt.empty()) {
      // NVDA 2018.3 does not read controls which are buttons, check boxes or radio buttons which have
      // an accessibility name which is empty. Bug 1980.
#if wxUSE_ACCESSIBILITY
      // so that name can be set on a standard control
      pCheckBox->SetAccessible(safenew WindowAccessible(pCheckBox));
#endif
      pCheckBox->SetName(wxT("\a"));      // non-empty string which screen readers do not read
   }
   UpdateSizers();
   return pCheckBox;
}

References AddPrompt(), eIsCreating, GetParent(), GetStyle(), HandleOptionality(), miId, miProp, mpbOptionalFlag, mpDlg, mpWind, mShuttleMode, safenew, TranslatableString::Translation(), UpdateSizers(), UseUpId(), and wxT().

Referenced by DoTieCheckBox().

Here is the call graph for this function:

Here is the caller graph for this function:

AddCheckBox() [2/3]

wxCheckBox * ShuttleGuiBase::AddCheckBox ( const TranslatableString &  Prompt, const char *    )

delete

AddCheckBox() [3/3]

wxCheckBox * ShuttleGuiBase::AddCheckBox ( const TranslatableString &  Prompt, const wxChar *    )

delete

AddCheckBoxOnRight() [1/3]

wxCheckBox * ShuttleGuiBase::AddCheckBoxOnRight	(	const TranslatableString &	Prompt,
		bool	Selected
	)

For a consistent two-column layout we want labels on the left and controls on the right. CheckBoxes break that rule, so we fake it by placing a static text label and then a tick box with an empty label.

Definition at line 345 of file ShuttleGui.cpp.

{
   HandleOptionality( Prompt );
   AddPrompt( Prompt );
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxCheckBox);
   wxCheckBox * pCheckBox;
   miProp=0;
   mpWind = pCheckBox = safenew wxCheckBox(GetParent(), miId, wxT(""), wxDefaultPosition, wxDefaultSize,
      GetStyle( 0 ));
   pCheckBox->SetValue(Selected);
   pCheckBox->SetName(Prompt.Stripped().Translation());
   UpdateSizers();
   return pCheckBox;
}

References AddPrompt(), eIsCreating, GetParent(), GetStyle(), HandleOptionality(), miId, miProp, mpDlg, mpWind, mShuttleMode, safenew, TranslatableString::Stripped(), TranslatableString::Translation(), UpdateSizers(), UseUpId(), and wxT().

Referenced by DoTieCheckBoxOnRight(), and TieCheckBoxOnRight().

Here is the call graph for this function:

Here is the caller graph for this function:

AddCheckBoxOnRight() [2/3]

wxCheckBox * ShuttleGuiBase::AddCheckBoxOnRight ( const TranslatableString &  Prompt, const char *    )

delete

AddCheckBoxOnRight() [3/3]

wxCheckBox * ShuttleGuiBase::AddCheckBoxOnRight ( const TranslatableString &  Prompt, const wxChar *    )

delete

AddChoice() [1/2]

wxChoice * ShuttleGuiBase::AddChoice	(	const TranslatableString &	Prompt,
		const TranslatableStrings &	choices,
		const TranslatableString &	selected
	)

Definition at line 435 of file ShuttleGui.cpp.

{
   return AddChoice(
      Prompt, choices, make_iterator_range( choices ).index( Selected ) );
}

References AddChoice(), and make_iterator_range().

Here is the call graph for this function:

AddChoice() [2/2]

wxChoice * ShuttleGuiBase::AddChoice	(	const TranslatableString &	Prompt,
		const TranslatableStrings &	choices,
		int	Selected = -1
	)

Definition at line 400 of file ShuttleGui.cpp.

{
   HandleOptionality( Prompt );
   AddPrompt( Prompt );
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxChoice);
   wxChoice * pChoice;
   miProp=0;
 
   mpWind = pChoice = safenew wxChoice(
      GetParent(),
      miId,
      wxDefaultPosition,
      wxDefaultSize,
      transform_container<wxArrayString>(
         choices, std::mem_fn( &TranslatableString::StrippedTranslation ) ),
      GetStyle( 0 ) );
 
   pChoice->SetMinSize( { 180, -1 } );// Use -1 for 'default size' - Platform specific.
#ifdef __WXMAC__
#if wxUSE_ACCESSIBILITY
   // so that name can be set on a standard control
   mpWind->SetAccessible(safenew WindowAccessible(mpWind));
#endif
#endif
   pChoice->SetName(Prompt.Stripped().Translation());
   if ( Selected >= 0 && Selected < (int)choices.size() )
      pChoice->SetSelection( Selected );
 
   UpdateSizers();
   return pChoice;
}

References AddPrompt(), eIsCreating, GetParent(), GetStyle(), HandleOptionality(), miId, miProp, mpDlg, mpWind, mShuttleMode, safenew, TranslatableString::Stripped(), TranslatableString::StrippedTranslation(), TranslatableString::Translation(), UpdateSizers(), and UseUpId().

Referenced by AddChoice(), and TieChoice().

Here is the call graph for this function:

Here is the caller graph for this function:

AddCombo()

wxComboBox * ShuttleGuiBase::AddCombo	(	const TranslatableString &	Prompt,
		const wxString &	Selected,
		const wxArrayStringEx &	choices
	)

Definition at line 519 of file ShuttleGui.cpp.

{
   const auto translated = Prompt.Translation();
   HandleOptionality( Prompt );
   AddPrompt( Prompt );
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxComboBox);
   wxComboBox * pCombo;
   miProp=0;
 
   int n = choices.size();
   if( n>50 ) n=50;
   int i;
   wxString Choices[50];
   for(i=0;i<n;i++)
   {
      Choices[i] = choices[i];
   }
 
   mpWind = pCombo = safenew wxComboBox(GetParent(), miId, Selected, wxDefaultPosition, wxDefaultSize,
      n, Choices, GetStyle( 0 ));
   mpWind->SetName(wxStripMenuCodes(translated));
 
   UpdateSizers();
   return pCombo;
}

References AddPrompt(), eIsCreating, GetParent(), GetStyle(), HandleOptionality(), miId, miProp, mpDlg, mpWind, mShuttleMode, safenew, TranslatableString::Translation(), UpdateSizers(), and UseUpId().

Here is the call graph for this function:

AddConstTextBox()

void ShuttleGuiBase::AddConstTextBox	(	const TranslatableString &	Caption,
		const TranslatableString &	Value
	)

Single line text box of fixed size.

Definition at line 758 of file ShuttleGui.cpp.

{
   HandleOptionality( Prompt );
   AddPrompt( Prompt );
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return;
//      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wx);
   miProp=0;
   UpdateSizers();
   miProp=0;
   const auto translatedValue = Value.Translation();
   mpWind = safenew wxStaticText(GetParent(), miId,
      translatedValue, wxDefaultPosition, wxDefaultSize,
      GetStyle( 0 ));
   mpWind->SetName(translatedValue); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
   UpdateSizers();
}

References AddPrompt(), eIsCreating, GetParent(), GetStyle(), HandleOptionality(), miId, miProp, mpWind, mShuttleMode, safenew, TranslatableString::Translation(), UpdateSizers(), and UseUpId().

Here is the call graph for this function:

AddFixedText()

void ShuttleGuiBase::AddFixedText	(	const TranslatableString &	Str,
		bool	bCenter = false,
		int	wrapWidth = 0
	)

Definition at line 442 of file ShuttleGui.cpp.

{
   const auto translated = Str.Translation();
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return;
   auto text = safenew wxStaticText(GetParent(),
      miId, translated, wxDefaultPosition, wxDefaultSize,
      GetStyle( wxALIGN_LEFT ));
   mpWind = text;
   if ( wrapWidth > 0 )
      text->Wrap( wrapWidth );
   mpWind->SetName(wxStripMenuCodes(translated)); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
   if( bCenter )
   {
      miProp=1;
      UpdateSizersC();
   }
   else
      UpdateSizers();
}

References eIsCreating, GetParent(), GetStyle(), miId, miProp, mpWind, mShuttleMode, safenew, TranslatableString::Translation(), UpdateSizers(), UpdateSizersC(), and UseUpId().

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

Here is the call graph for this function:

Here is the caller graph for this function:

AddGrid()

wxGrid * ShuttleGuiBase::AddGrid

(

)

Definition at line 793 of file ShuttleGui.cpp.

{
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxGrid);
   wxGrid * pGrid;
   SetProportions( 1 );
   mpWind = pGrid = safenew wxGrid(GetParent(), miId, wxDefaultPosition,
      wxDefaultSize, GetStyle( wxWANTS_CHARS ));
   pGrid->SetMinSize( wxSize( 120, 150 ));
   UpdateSizers();
   return pGrid;
}

References eIsCreating, GetParent(), GetStyle(), miId, mpDlg, mpWind, mShuttleMode, safenew, SetProportions(), UpdateSizers(), and UseUpId().

Here is the call graph for this function:

AddIcon()

void ShuttleGuiBase::AddIcon

(

wxBitmap *

pBmp

)

Definition at line 893 of file ShuttleGui.cpp.

{
   UseUpId();
   if( mShuttleMode != eIsCreating )
//      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wx);
      return;
   wxBitmapButton * pBtn;
   mpWind = pBtn = safenew wxBitmapButton(GetParent(), miId, *pBmp,
      wxDefaultPosition, wxDefaultSize, GetStyle( wxBU_AUTODRAW ) );
   pBtn->SetWindowStyle( wxBORDER_NONE  );
   pBtn->SetCanFocus(false);
   UpdateSizersC();
}

References eIsCreating, GetParent(), GetStyle(), miId, mpWind, mShuttleMode, safenew, UpdateSizersC(), and UseUpId().

Here is the call graph for this function:

AddListBox()

wxListBox * ShuttleGuiBase::AddListBox

(

const wxArrayStringEx &

choices

)

Definition at line 778 of file ShuttleGui.cpp.

{
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxListBox);
   wxListBox * pListBox;
   SetProportions( 1 );
   mpWind = pListBox = safenew wxListBox(GetParent(), miId,
      wxDefaultPosition, wxDefaultSize, choices, GetStyle(0));
   pListBox->SetMinSize( wxSize( 120,150 ));
   UpdateSizers();
   return pListBox;
}

References eIsCreating, GetParent(), GetStyle(), miId, mpDlg, mpWind, mShuttleMode, safenew, SetProportions(), UpdateSizers(), and UseUpId().

Here is the call graph for this function:

AddListControl()

wxListCtrl * ShuttleGuiBase::AddListControl	(	std::initializer_list< const ListControlColumn >	columns = {},
		long	listControlStyles = 0
	)

Definition at line 807 of file ShuttleGui.cpp.

{
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxListCtrl);
   wxListCtrl * pListCtrl;
   SetProportions( 1 );
   mpWind = pListCtrl = safenew wxListCtrl(GetParent(), miId,
      wxDefaultPosition, wxDefaultSize, GetStyle( wxLC_ICON ));
   pListCtrl->SetMinSize( wxSize( 120,150 ));
   UpdateSizers();
 
   DoInsertListColumns( pListCtrl, listControlStyles, columns );
 
   return pListCtrl;
}

References DoInsertListColumns(), eIsCreating, GetParent(), GetStyle(), miId, mpDlg, mpWind, mShuttleMode, safenew, SetProportions(), UpdateSizers(), and UseUpId().

Here is the call graph for this function:

AddListControlReportMode()

wxListCtrl * ShuttleGuiBase::AddListControlReportMode	(	std::initializer_list< const ListControlColumn >	columns = {},
		long	listControlStyles = 0
	)

Definition at line 827 of file ShuttleGui.cpp.

{
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxListCtrl);
   wxListCtrl * pListCtrl;
   SetProportions( 1 );
   mpWind = pListCtrl = safenew wxListCtrl(GetParent(), miId,
      wxDefaultPosition, wxSize(230,120),//wxDefaultSize,
      GetStyle( wxLC_REPORT | wxLC_HRULES | wxLC_VRULES ));
//   pListCtrl->SetMinSize( wxSize( 120,150 ));
   UpdateSizers();
 
   DoInsertListColumns( pListCtrl, listControlStyles, columns );
 
   return pListCtrl;
}

References DoInsertListColumns(), eIsCreating, GetParent(), GetStyle(), miId, mpDlg, mpWind, mShuttleMode, safenew, SetProportions(), UpdateSizers(), and UseUpId().

Here is the call graph for this function:

AddNumericTextBox()

wxTextCtrl * ShuttleGuiBase::AddNumericTextBox	(	const TranslatableString &	Caption,
		const wxString &	Value,
		const int	nChars,
		bool	acceptEnter = false
	)

Definition at line 695 of file ShuttleGui.cpp.

{
   const auto translated = Caption.Translation();
   HandleOptionality( Caption );
   AddPrompt( Caption );
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxTextCtrl);
   wxTextCtrl * pTextCtrl;
   wxSize Size(wxDefaultSize);
   if( nChars > 0 )
   {
      Size.SetWidth( nChars *5 );
   }
   miProp=0;
 
#ifdef EXPERIMENTAL_RIGHT_ALIGNED_TEXTBOXES
   long flags = wxTE_RIGHT;
#else
   long flags = wxTE_LEFT;
#endif
 
   if (acceptEnter)
      flags = wxTE_PROCESS_ENTER;
 
   wxTextValidator Validator(wxFILTER_NUMERIC);
   mpWind = pTextCtrl = safenew wxTextCtrl(GetParent(), miId, Value,
      wxDefaultPosition, Size, GetStyle( flags ),
      Validator // It's OK to pass this.  It will be cloned.
      );
#if wxUSE_ACCESSIBILITY
   // so that name can be set on a standard control
   mpWind->SetAccessible(safenew WindowAccessible(mpWind));
#endif
   mpWind->SetName(wxStripMenuCodes(translated));
   UpdateSizers();
   return pTextCtrl;
}

References AddPrompt(), eIsCreating, GetParent(), GetStyle(), HandleOptionality(), miId, miProp, mpDlg, mpWind, mShuttleMode, safenew, TranslatableString::Translation(), UpdateSizers(), and UseUpId().

Referenced by DoTieNumericTextBox().

Here is the call graph for this function:

Here is the caller graph for this function:

AddPrompt()

wxStaticText * ShuttleGuiBase::AddPrompt	(	const TranslatableString &	Prompt,
		int	wrapWidth = 0
	)

Right aligned text string.

Definition at line 238 of file ShuttleGui.cpp.

{
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxStaticText);
   //wxLogDebug( "Prompt: [%s] Id:%i (%i)", Prompt.c_str(), miId, miIdSetByUser ) ;
   if( mpbOptionalFlag ){
      bool * pVar = mpbOptionalFlag;
      mpbOptionalFlag = nullptr;
      TieCheckBox( {}, *pVar);
      //return;
   }
   if( Prompt.empty() )
      return nullptr;
   miProp=1;
   const auto translated = Prompt.Translation();
   auto text = safenew wxStaticText(GetParent(), -1, translated, wxDefaultPosition, wxDefaultSize,
      GetStyle( wxALIGN_RIGHT ));
   mpWind = text;
   if (wrapWidth > 0)
      text->Wrap(wrapWidth);
   mpWind->SetName(wxStripMenuCodes(translated)); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
   UpdateSizersCore( false, wxALL | wxALIGN_CENTRE_VERTICAL, true );
 
   return text;
}

References eIsCreating, TranslatableString::empty(), GetParent(), GetStyle(), miId, miProp, mpbOptionalFlag, mpDlg, mpWind, mShuttleMode, safenew, TieCheckBox(), TranslatableString::Translation(), and UpdateSizersCore().

Referenced by AddCheckBox(), AddCheckBoxOnRight(), AddChoice(), AddCombo(), AddConstTextBox(), AddNumericTextBox(), AddReadOnlyText(), AddSlider(), AddSpinControl(), AddSpinCtrl(), and AddTextBox().

Here is the call graph for this function:

Here is the caller graph for this function:

AddRadioButton()

wxRadioButton * ShuttleGuiBase::AddRadioButton	(	const TranslatableString &	Prompt,
		int	selector = 0,
		int	initValue = 0
	)

Definition at line 570 of file ShuttleGui.cpp.

{
   return DoAddRadioButton( Prompt, wxRB_GROUP, selector, initValue );
}

References DoAddRadioButton().

Here is the call graph for this function:

AddRadioButtonToGroup()

wxRadioButton * ShuttleGuiBase::AddRadioButtonToGroup	(	const TranslatableString &	Prompt,
		int	selector = 1,
		int	initValue = 0
	)

Definition at line 576 of file ShuttleGui.cpp.

{
   return DoAddRadioButton( Prompt, 0, selector, initValue );
}

References DoAddRadioButton().

Here is the call graph for this function:

AddReadOnlyText()

ReadOnlyText * ShuttleGuiBase::AddReadOnlyText	(	const TranslatableString &	Caption,
		const wxString &	Value
	)

Definition at line 498 of file ShuttleGui.cpp.

{
   const auto translated = Caption.Translation();
   auto style = GetStyle( wxBORDER_NONE );
   HandleOptionality( Caption );
   mItem.miStyle = wxALIGN_CENTER_VERTICAL;
   AddPrompt( Caption );
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), ReadOnlyText);
   ReadOnlyText * pReadOnlyText;
   miProp=0;
 
   mpWind = pReadOnlyText = safenew ReadOnlyText(GetParent(), miId, Value,
      wxDefaultPosition, wxDefaultSize, GetStyle( style ));
   mpWind->SetName(wxStripMenuCodes(translated));
   UpdateSizers();
   return pReadOnlyText;
}

References AddPrompt(), eIsCreating, GetParent(), GetStyle(), HandleOptionality(), miId, miProp, DialogDefinition::Item::miStyle, mItem, mpDlg, mpWind, mShuttleMode, safenew, anonymous_namespace{AudacityDontAskAgainMessageDialog.cpp}::style, TranslatableString::Translation(), UpdateSizers(), and UseUpId().

Here is the call graph for this function:

AddSlider()

wxSlider * ShuttleGuiBase::AddSlider	(	const TranslatableString &	Prompt,
		int	pos,
		int	Max,
		int	Min = 0
	)

Definition at line 591 of file ShuttleGui.cpp.

{
   HandleOptionality( Prompt );
   AddPrompt( Prompt );
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxSlider);
   wxSlider * pSlider;
   mpWind = pSlider = safenew wxSliderWrapper(GetParent(), miId,
      pos, Min, Max,
      wxDefaultPosition,
      // Bug2289:  On Linux at least, sliders like to be constructed with the
      // proper size, not reassigned size later
      ( ( mItem.mWindowSize == wxSize{} ) ? wxDefaultSize : mItem.mWindowSize ),
      GetStyle( wxSL_HORIZONTAL | wxSL_LABELS | wxSL_AUTOTICKS )
      );
#if wxUSE_ACCESSIBILITY
   // so that name can be set on a standard control
   mpWind->SetAccessible(safenew WindowAccessible(mpWind));
#endif
   mpWind->SetName(wxStripMenuCodes(Prompt.Translation()));
   miProp=1;
   UpdateSizers();
   return pSlider;
}

References AddPrompt(), eIsCreating, GetParent(), GetStyle(), HandleOptionality(), miId, miProp, mItem, mpDlg, mpWind, mShuttleMode, DialogDefinition::Item::mWindowSize, safenew, TranslatableString::Translation(), UpdateSizers(), and UseUpId().

Referenced by DoTieSlider().

Here is the call graph for this function:

Here is the caller graph for this function:

AddSpinControl()

SpinControl * ShuttleGuiBase::AddSpinControl	(	const wxSize &	size,
		const TranslatableString &	Prompt,
		double	Value,
		double	Max,
		double	Min
	)

Definition at line 640 of file ShuttleGui.cpp.

{
   const auto translated = Prompt.Translation();
   HandleOptionality( Prompt );
   AddPrompt( Prompt );
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return dynamic_cast<SpinControl*>(wxWindow::FindWindowById(miId, mpDlg));
   SpinControl * pSpinCtrl;
   mpWind = pSpinCtrl = safenew SpinControl(
      GetParent(), miId, Value, Min, Max, 1.0, true, wxDefaultPosition, size,
      Prompt);
   miProp=1;
   UpdateSizers();
   return pSpinCtrl;
}

References AddPrompt(), eIsCreating, GetParent(), HandleOptionality(), miId, miProp, mpDlg, mpWind, mShuttleMode, safenew, size, TranslatableString::Translation(), UpdateSizers(), and UseUpId().

Referenced by DoTieSpinControl().

Here is the call graph for this function:

Here is the caller graph for this function:

AddSpinCtrl()

wxSpinCtrl * ShuttleGuiBase::AddSpinCtrl	(	const TranslatableString &	Prompt,
		int	Value,
		int	Max,
		int	Min
	)

Definition at line 618 of file ShuttleGui.cpp.

{
   const auto translated = Prompt.Translation();
   HandleOptionality( Prompt );
   AddPrompt( Prompt );
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxSpinCtrl);
   wxSpinCtrl * pSpinCtrl;
   mpWind = pSpinCtrl = safenew wxSpinCtrl(GetParent(), miId,
      wxEmptyString,
      wxDefaultPosition, wxDefaultSize,
      GetStyle( wxSP_VERTICAL | wxSP_ARROW_KEYS ),
      Min, Max, Value
      );
   mpWind->SetName(wxStripMenuCodes(translated));
   miProp=1;
   UpdateSizers();
   return pSpinCtrl;
}

References AddPrompt(), eIsCreating, GetParent(), GetStyle(), HandleOptionality(), miId, miProp, mpDlg, mpWind, mShuttleMode, safenew, TranslatableString::Translation(), UpdateSizers(), and UseUpId().

Referenced by DoTieSpinCtrl().

Here is the call graph for this function:

Here is the caller graph for this function:

AddTextBox()

wxTextCtrl * ShuttleGuiBase::AddTextBox	(	const TranslatableString &	Caption,
		const wxString &	Value,
		const int	nChars
	)

Definition at line 659 of file ShuttleGui.cpp.

{
   const auto translated = Caption.Translation();
   HandleOptionality( Caption );
   AddPrompt( Caption );
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxTextCtrl);
   wxTextCtrl * pTextCtrl;
   wxSize Size(wxDefaultSize);
   if( nChars > 0 )
   {
      int width;
      mpDlg->GetTextExtent( wxT("9"), &width, nullptr );
      Size.SetWidth( nChars * width );
   }
   miProp=0;
 
#ifdef EXPERIMENTAL_RIGHT_ALIGNED_TEXTBOXES
   long flags = wxTE_RIGHT;
#else
   long flags = wxTE_LEFT;
#endif
 
   mpWind = pTextCtrl = safenew wxTextCtrlWrapper(GetParent(), miId, Value,
      wxDefaultPosition, Size, GetStyle( flags ));
#if wxUSE_ACCESSIBILITY
   // so that name can be set on a standard control
   mpWind->SetAccessible(safenew WindowAccessible(mpWind));
#endif
   mpWind->SetName(wxStripMenuCodes(translated));
   UpdateSizers();
   return pTextCtrl;
}

References AddPrompt(), eIsCreating, GetParent(), GetStyle(), HandleOptionality(), miId, miProp, mpDlg, mpWind, mShuttleMode, safenew, TranslatableString::Translation(), UpdateSizers(), UseUpId(), and wxT().

Referenced by DoTieTextBox(), ErrorReportDialog::ErrorReportDialog(), and audacity::cloud::audiocom::ShareAudioDialog::InitialStatePanel::PopulateInitialStatePanel().

Here is the call graph for this function:

Here is the caller graph for this function:

AddTextWindow()

wxTextCtrl * ShuttleGuiBase::AddTextWindow

(

const wxString &

Value

)

Multiline text box that grows.

Definition at line 737 of file ShuttleGui.cpp.

{
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxTextCtrl);
   wxTextCtrl * pTextCtrl;
   SetProportions( 1 );
   mpWind = pTextCtrl = safenew wxTextCtrl(GetParent(), miId, Value,
      wxDefaultPosition, wxDefaultSize, GetStyle( wxTE_MULTILINE ));
#if wxUSE_ACCESSIBILITY
   // so that name can be set on a standard control
   mpWind->SetAccessible(safenew WindowAccessible(mpWind));
#endif
   UpdateSizers();
   // Start off at start of window...
   pTextCtrl->SetInsertionPoint( 0 );
   pTextCtrl->ShowPosition( 0 );
   return pTextCtrl;
}

References eIsCreating, GetParent(), GetStyle(), miId, mpDlg, mpWind, mShuttleMode, safenew, SetProportions(), UpdateSizers(), and UseUpId().

Referenced by ErrorDialog::ErrorDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

AddTitle()

void ShuttleGuiBase::AddTitle	(	const TranslatableString &	Prompt,
		int	wrapWidth = 0
	)

Centred text string.

Definition at line 283 of file ShuttleGui.cpp.

{
   if( Prompt.empty() )
      return;
   if( mShuttleMode != eIsCreating )
      return;
   const auto translated = Prompt.Translation();
   auto text = safenew wxStaticText(GetParent(), -1, translated, wxDefaultPosition, wxDefaultSize,
      GetStyle( wxALIGN_CENTRE ));
   mpWind = text;
   if (wrapWidth > 0)
      text->Wrap(wrapWidth);
   mpWind->SetName(translated); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
   UpdateSizers();
}

References eIsCreating, TranslatableString::empty(), GetParent(), GetStyle(), mpWind, mShuttleMode, safenew, TranslatableString::Translation(), and UpdateSizers().

Here is the call graph for this function:

AddTree()

wxTreeCtrl * ShuttleGuiBase::AddTree

(

)

Definition at line 879 of file ShuttleGui.cpp.

{
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxTreeCtrl);
   wxTreeCtrl * pTreeCtrl;
   SetProportions( 1 );
   mpWind = pTreeCtrl = safenew wxTreeCtrl(GetParent(), miId, wxDefaultPosition, wxDefaultSize,
      GetStyle( wxTR_HAS_BUTTONS ));
   pTreeCtrl->SetMinSize( wxSize( 120,650 ));
   UpdateSizers();
   return pTreeCtrl;
}

References eIsCreating, GetParent(), GetStyle(), miId, mpDlg, mpWind, mShuttleMode, safenew, SetProportions(), UpdateSizers(), and UseUpId().

Here is the call graph for this function:

AddUnits()

void ShuttleGuiBase::AddUnits	(	const TranslatableString &	Prompt,
		int	wrapWidth = 0
	)

Left aligned text string.

Definition at line 265 of file ShuttleGui.cpp.

{
   if( Prompt.empty() )
      return;
   if( mShuttleMode != eIsCreating )
      return;
   miProp = 1;
   const auto translated = Prompt.Translation();
   auto text = safenew wxStaticText(GetParent(), -1, translated, wxDefaultPosition, wxDefaultSize,
      GetStyle( wxALIGN_LEFT ));
   mpWind = text;
   if (wrapWidth > 0)
      text->Wrap(wrapWidth);
   mpWind->SetName(translated); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
   UpdateSizersCore( false, wxALL | wxALIGN_CENTRE_VERTICAL );
}

References eIsCreating, TranslatableString::empty(), GetParent(), GetStyle(), miProp, mpWind, mShuttleMode, safenew, TranslatableString::Translation(), and UpdateSizersCore().

Here is the call graph for this function:

AddVariableText()

wxStaticText * ShuttleGuiBase::AddVariableText	(	const TranslatableString &	Str,
		bool	bCenter = false,
		int	PositionFlags = 0,
		int	wrapWidth = 0
	)

Definition at line 465 of file ShuttleGui.cpp.

{
   const auto translated = Str.Translation();
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxStaticText);
 
   wxStaticText *pStatic;
   auto text = pStatic = safenew wxStaticText(GetParent(), miId, translated,
      wxDefaultPosition, wxDefaultSize,
      GetStyle( wxALIGN_LEFT ));
   mpWind = text;
   if ( wrapWidth > 0 )
      text->Wrap( wrapWidth );
   mpWind->SetName(wxStripMenuCodes(translated)); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
   if( bCenter )
   {
      miProp=1;
      if( PositionFlags )
         UpdateSizersCore( false, PositionFlags );
      else
         UpdateSizersC();
   }
   else
      if( PositionFlags )
         UpdateSizersCore( false, PositionFlags );
      else
         UpdateSizers();
   return pStatic;
}

References eIsCreating, GetParent(), GetStyle(), miId, miProp, mpDlg, mpWind, mShuttleMode, safenew, TranslatableString::Translation(), UpdateSizers(), UpdateSizersC(), UpdateSizersCore(), and UseUpId().

Referenced by ErrorReportDialog::ErrorReportDialog(), and audacity::cloud::audiocom::ShareAudioDialog::ProgressPanel::PopulateProgressPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

AddVSlider()

wxSlider * ShuttleGuiBase::AddVSlider	(	const TranslatableString &	Prompt,
		int	pos,
		int	Max
	)

AddWindow()

wxWindow * ShuttleGuiBase::AddWindow	(	wxWindow *	pWindow,
		int	PositionFlags = wxALIGN_CENTRE
	)

Very generic 'Add' function. We can add anything we like. Useful for unique controls

Definition at line 301 of file ShuttleGui.cpp.

{
   if( mShuttleMode != eIsCreating )
      return pWindow;
   mpWind = pWindow;
   SetProportions( 0 );
   UpdateSizersCore(false, PositionFlags | wxALL);
   return pWindow;
}

References eIsCreating, mpWind, mShuttleMode, SetProportions(), and UpdateSizersCore().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ApplyItem()

void ShuttleGuiBase::ApplyItem ( int  step, const DialogDefinition::Item &  item, wxWindow *  pWind, wxWindow *  pDlg  )

static

Definition at line 2158 of file ShuttleGui.cpp.

{
   if ( step == 0 ) {
      // Do these steps before adding the window to the sizer
      if( item.mUseBestSize )
         pWind->SetMinSize( pWind->GetBestSize() );
      else if( item.mHasMinSize )
         pWind->SetMinSize( item.mMinSize );
 
      if ( item.mWindowSize != wxSize{} )
         pWind->SetSize( item.mWindowSize );
   }
   else if ( step == 1) {
      // Apply certain other optional window attributes here
 
      if ( item.mValidatorSetter )
         item.mValidatorSetter( pWind );
 
      if ( !item.mToolTip.empty() )
         pWind->SetToolTip( item.mToolTip.Translation() );
 
      if ( !item.mName.empty() ) {
         pWind->SetName( item.mName.Stripped().Translation() );
#ifndef __WXMAC__
         if (auto pButton = dynamic_cast< wxBitmapButton* >( pWind ))
            pButton->SetLabel(  item.mName.Translation() );
#endif
      }
 
      if ( !item.mNameSuffix.empty() )
         pWind->SetName(
            pWind->GetName() + " " + item.mNameSuffix.Translation() );
 
      if (item.mFocused)
         pWind->SetFocus();
 
      if (item.mDisabled)
         pWind->Enable( false );
 
      for (auto &pair : item.mRootConnections)
         pWind->Connect( pair.first, pair.second, nullptr, pDlg );
   }
}

References TranslatableString::empty(), DialogDefinition::Item::mDisabled, DialogDefinition::Item::mFocused, DialogDefinition::Item::mHasMinSize, DialogDefinition::Item::mMinSize, DialogDefinition::Item::mName, DialogDefinition::Item::mNameSuffix, DialogDefinition::Item::mRootConnections, DialogDefinition::Item::mToolTip, DialogDefinition::Item::mUseBestSize, DialogDefinition::Item::mValidatorSetter, DialogDefinition::Item::mWindowSize, TranslatableString::Stripped(), and TranslatableString::Translation().

Referenced by UpdateSizersCore().

Here is the call graph for this function:

Here is the caller graph for this function:

DoAddRadioButton()

wxRadioButton * ShuttleGuiBase::DoAddRadioButton ( const TranslatableString &  Prompt, int  style, int  selector, int  initValue  )

private

Unwrapped string value.

Todo:

This function and the next two, suitably adapted, could be used by TieRadioButton.

Definition at line 550 of file ShuttleGui.cpp.

{
   const auto translated = Prompt.Translation();
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxRadioButton);
   wxRadioButton * pRad;
   mpWind = pRad = safenew wxRadioButton(GetParent(), miId, translated,
      wxDefaultPosition, wxDefaultSize, GetStyle( style ) );
   mpWind->SetName(wxStripMenuCodes(translated));
   if ( style )
      pRad->SetValue( true );
   UpdateSizers();
   pRad->SetValue( selector == initValue );
   return pRad;
}

References eIsCreating, GetParent(), GetStyle(), miId, mpDlg, mpWind, mShuttleMode, safenew, anonymous_namespace{AudacityDontAskAgainMessageDialog.cpp}::style, TranslatableString::Translation(), UpdateSizers(), and UseUpId().

Referenced by AddRadioButton(), and AddRadioButtonToGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

DoDataShuttle()

void ShuttleGuiBase::DoDataShuttle ( const wxString &  Name, WrappedType &  WrappedRef  )

private

When we're exchanging with the configured shuttle rather than with the GUI We use this function.

Definition at line 1271 of file ShuttleGui.cpp.

{
    wxASSERT( mpShuttle );
    mpShuttle->TransferWrappedType( Name, WrappedRef );
}

References mpShuttle.

Referenced by EndRadioButtonGroup(), StartRadioButtonGroup(), TieCheckBox(), TieCheckBoxOnRight(), TieChoice(), TieIntegerTextBox(), TieNumericTextBox(), TieSlider(), TieSpinCtrl(), and TieTextBox().

Here is the caller graph for this function:

DoInsertListColumns()

void ShuttleGuiBase::DoInsertListColumns ( wxListCtrl *  pListCtrl, long  listControlStyles, std::initializer_list< const ListControlColumn >  columns  )

private

Definition at line 848 of file ShuttleGui.cpp.

{
   // Old comment from HistoryWindow.cpp follows
   // -- is it still correct for wxWidgets 3?
 
   // Do this BEFORE inserting the columns.  On the Mac at least, the
   // columns are deleted and later InsertItem()s will cause Audacity to crash.
   for ( auto style = 1l; style <= listControlStyles; style <<= 1 )
      if ( (style & listControlStyles) )
         pListCtrl->SetSingleStyle(style, true);
 
   long iCol = 0;
   bool dummyColumn =
      columns.size() > 0 && begin(columns)->format == wxLIST_FORMAT_RIGHT;
 
   //A dummy first column, which is then deleted, is a workaround -
   // under Windows the first column can't be right aligned.
   if (dummyColumn)
      pListCtrl->InsertColumn( iCol++, wxString{} );
 
   for (auto &column : columns)
      pListCtrl->InsertColumn(
         iCol++, column.heading.Translation(), column.format, column.width );
 
   if (dummyColumn)
      pListCtrl->DeleteColumn( 0 );
}

References details::begin(), and anonymous_namespace{AudacityDontAskAgainMessageDialog.cpp}::style.

Referenced by AddListControl(), and AddListControlReportMode().

Here is the call graph for this function:

Here is the caller graph for this function:

DoStep()

bool ShuttleGuiBase::DoStep

(

int

iStep

)

Code-Condenser function.

We have functions which need to do:

// Either: Values are coming in:
DoDataShuttle( SettingName, WrappedRef );
TieMyControl( Prompt, WrappedRef );
 
// Or: Values are going out:
TieMyControl( Prompt, WrappedRef );
DoDataShuttle( SettingName, WrappedRef );

So we make a list of all the possible steps, and have DoStep choose which ones are actually done, like this:

if( DoStep(1) ) DoFirstThing();
if( DoStep(2) ) DoSecondThing();
if( DoStep(3) ) DoThirdThing();

The repeated choice logic can then be taken out of those functions.

JKC: This paves the way for doing data validation too, though when we add that we will need to renumber the steps.

Definition at line 1891 of file ShuttleGui.cpp.

{
   // Get value and create
   if( mShuttleMode == eIsCreating )
   {
      return (iStep==1) || (iStep==2);
   }
   // Like creating, get the value and set.
   if( mShuttleMode == eIsSettingToDialog )
   {
      return (iStep==1) || (iStep==2);
   }
   if( mShuttleMode == eIsGettingFromDialog )
   {
      return (iStep==2) || (iStep==3);
   }
   if( mShuttleMode == eIsGettingMetadata )
      return iStep ==2;
   wxASSERT( false );
   return false;
}

References eIsCreating, eIsGettingFromDialog, eIsGettingMetadata, eIsSettingToDialog, and mShuttleMode.

Referenced by TieCheckBox(), TieCheckBoxOnRight(), TieChoice(), TieIntegerTextBox(), TieNumericTextBox(), TieSlider(), TieSpinCtrl(), and TieTextBox().

Here is the caller graph for this function:

DoTieCheckBox()

wxCheckBox * ShuttleGuiBase::DoTieCheckBox ( const TranslatableString &  Prompt, WrappedType &  WrappedRef  )

private

Definition at line 1283 of file ShuttleGui.cpp.

{
   HandleOptionality( Prompt );
   // The Add function does a UseUpId(), so don't do it here in that case.
   if( mShuttleMode == eIsCreating )
      return AddCheckBox( Prompt, WrappedRef.ReadAsString() == wxT("true"));
 
   UseUpId();
 
   wxWindow * pWnd      = wxWindow::FindWindowById( miId, mpDlg);
   wxCheckBox * pCheckBox = wxDynamicCast(pWnd, wxCheckBox);
 
   switch( mShuttleMode )
   {
   // IF setting internal storage from the controls.
   case eIsGettingMetadata:
      break;
   case eIsGettingFromDialog:
      {
         wxASSERT( pCheckBox );
         WrappedRef.WriteToAsBool( pCheckBox->GetValue() );
      }
      break;
   case eIsSettingToDialog:
      {
         wxASSERT( pCheckBox );
         pCheckBox->SetValue( WrappedRef.ReadAsBool() );
      }
      break;
   default:
      wxASSERT( false );
      break;
   }
   return pCheckBox;
}

References AddCheckBox(), eIsCreating, eIsGettingFromDialog, eIsGettingMetadata, eIsSettingToDialog, HandleOptionality(), miId, mpDlg, mShuttleMode, WrappedType::ReadAsBool(), WrappedType::ReadAsString(), UseUpId(), WrappedType::WriteToAsBool(), and wxT().

Referenced by TieCheckBox(), and TieCheckBoxOnRight().

Here is the call graph for this function:

Here is the caller graph for this function:

DoTieCheckBoxOnRight()

wxCheckBox * ShuttleGuiBase::DoTieCheckBoxOnRight ( const TranslatableString &  Prompt, WrappedType &  WrappedRef  )

private

Definition at line 1319 of file ShuttleGui.cpp.

{
   HandleOptionality( Prompt );
   // The Add function does a UseUpId(), so don't do it here in that case.
   if( mShuttleMode == eIsCreating )
      return AddCheckBoxOnRight( Prompt, WrappedRef.ReadAsString() == wxT("true"));
 
   UseUpId();
 
   wxWindow * pWnd      = wxWindow::FindWindowById( miId, mpDlg);
   wxCheckBox * pCheckBox = wxDynamicCast(pWnd, wxCheckBox);
 
   switch( mShuttleMode )
   {
   // IF setting internal storage from the controls.
   case eIsGettingMetadata:
      break;
   case eIsGettingFromDialog:
      {
         wxASSERT( pCheckBox );
         WrappedRef.WriteToAsBool( pCheckBox->GetValue() );
      }
      break;
   case eIsSettingToDialog:
      {
         wxASSERT( pCheckBox );
         pCheckBox->SetValue( WrappedRef.ReadAsBool() );
      }
      break;
   default:
      wxASSERT( false );
      break;
   }
   return pCheckBox;
}

References AddCheckBoxOnRight(), eIsCreating, eIsGettingFromDialog, eIsGettingMetadata, eIsSettingToDialog, HandleOptionality(), miId, mpDlg, mShuttleMode, WrappedType::ReadAsBool(), WrappedType::ReadAsString(), UseUpId(), WrappedType::WriteToAsBool(), and wxT().

Referenced by TieCheckBoxOnRight().

Here is the call graph for this function:

Here is the caller graph for this function:

DoTieNumericTextBox()

wxTextCtrl * ShuttleGuiBase::DoTieNumericTextBox ( const TranslatableString &  Prompt, WrappedType &  WrappedRef, const int  nChars, bool  acceptEnter = false  )

private

Definition at line 1471 of file ShuttleGui.cpp.

{
   HandleOptionality( Prompt );
   // The Add function does a UseUpId(), so don't do it here in that case.
   if( mShuttleMode == eIsCreating )
      return AddNumericTextBox( Prompt, WrappedRef.ReadAsString(), nChars, acceptEnter );
 
   UseUpId();
   wxTextCtrl * pTextBox=NULL;
 
   wxWindow * pWnd  = wxWindow::FindWindowById( miId, mpDlg);
   pTextBox = wxDynamicCast(pWnd, wxTextCtrl);
 
   switch( mShuttleMode )
   {
   // IF setting internal storage from the controls.
   case eIsGettingMetadata:
      break;
   case eIsGettingFromDialog:
      {
         wxASSERT( pTextBox );
         WrappedRef.WriteToAsString( pTextBox->GetValue() );
      }
      break;
   case eIsSettingToDialog:
      {
         wxASSERT( pTextBox );
         pTextBox->SetValue( WrappedRef.ReadAsString() );
      }
      break;
   default:
      wxASSERT( false );
      break;
   }
   return pTextBox;
}

References AddNumericTextBox(), eIsCreating, eIsGettingFromDialog, eIsGettingMetadata, eIsSettingToDialog, HandleOptionality(), miId, mpDlg, mShuttleMode, WrappedType::ReadAsString(), UseUpId(), and WrappedType::WriteToAsString().

Referenced by TieIntegerTextBox(), and TieNumericTextBox().

Here is the call graph for this function:

Here is the caller graph for this function:

DoTieSlider()

wxSlider * ShuttleGuiBase::DoTieSlider ( const TranslatableString &  Prompt, WrappedType &  WrappedRef, const int  max, const int  min = 0  )

private

Definition at line 1510 of file ShuttleGui.cpp.

{
   HandleOptionality( Prompt );
   // The Add function does a UseUpId(), so don't do it here in that case.
   if( mShuttleMode != eIsCreating )
      UseUpId();
   wxSlider * pSlider=NULL;
   switch( mShuttleMode )
   {
      case eIsCreating:
         {
            pSlider = AddSlider( Prompt, WrappedRef.ReadAsInt(), max, min );
         }
         break;
      // IF setting internal storage from the controls.
      case eIsGettingMetadata:
         break;
      case eIsGettingFromDialog:
         {
            wxWindow * pWnd  = wxWindow::FindWindowById( miId, mpDlg);
            pSlider = wxDynamicCast(pWnd, wxSlider);
            wxASSERT( pSlider );
            WrappedRef.WriteToAsInt( pSlider->GetValue() );
         }
         break;
      case eIsSettingToDialog:
         {
            wxWindow * pWnd  = wxWindow::FindWindowById( miId, mpDlg);
            pSlider = wxDynamicCast(pWnd, wxSlider);
            wxASSERT( pSlider );
            pSlider->SetValue( WrappedRef.ReadAsInt() );
         }
         break;
      default:
         wxASSERT( false );
         break;
   }
   return pSlider;
}

References AddSlider(), eIsCreating, eIsGettingFromDialog, eIsGettingMetadata, eIsSettingToDialog, HandleOptionality(), miId, min(), mpDlg, mShuttleMode, WrappedType::ReadAsInt(), UseUpId(), and WrappedType::WriteToAsInt().

Referenced by TieSlider().

Here is the call graph for this function:

Here is the caller graph for this function:

DoTieSpinControl()

SpinControl * ShuttleGuiBase::DoTieSpinControl ( const wxSize &  size, const TranslatableString &  Prompt, WrappedType &  WrappedRef, const double  max, const double  min = 0  )

private

Definition at line 1394 of file ShuttleGui.cpp.

{
   HandleOptionality( Prompt );
   // The Add function does a UseUpId(), so don't do it here in that case.
   if( mShuttleMode == eIsCreating )
      return AddSpinControl(size, Prompt, WrappedRef.ReadAsDouble(), max, min);
 
   UseUpId();
   SpinControl * pSpinCtrl=NULL;
 
   wxWindow * pWnd  = wxWindow::FindWindowById( miId, mpDlg);
   pSpinCtrl = dynamic_cast<SpinControl*>(pWnd);
 
   switch( mShuttleMode )
   {
      // IF setting internal storage from the controls.
   case eIsGettingMetadata:
      break;
   case eIsGettingFromDialog:
      {
         wxASSERT( pSpinCtrl );
         WrappedRef.WriteToAsDouble( pSpinCtrl->GetValue() );
      }
      break;
   case eIsSettingToDialog:
      {
         wxASSERT( pSpinCtrl );
         pSpinCtrl->SetValue( WrappedRef.ReadAsDouble() );
      }
      break;
   default:
      wxASSERT( false );
      break;
   }
   return pSpinCtrl;
}

References AddSpinControl(), eIsCreating, eIsGettingFromDialog, eIsGettingMetadata, eIsSettingToDialog, SpinControl::GetValue(), HandleOptionality(), miId, min(), mpDlg, mShuttleMode, WrappedType::ReadAsDouble(), SpinControl::SetValue(), size, UseUpId(), and WrappedType::WriteToAsDouble().

Referenced by TieSpinControl().

Here is the call graph for this function:

Here is the caller graph for this function:

DoTieSpinCtrl()

wxSpinCtrl * ShuttleGuiBase::DoTieSpinCtrl ( const TranslatableString &  Prompt, WrappedType &  WrappedRef, const int  max, const int  min = 0  )

private

Definition at line 1355 of file ShuttleGui.cpp.

{
   HandleOptionality( Prompt );
   // The Add function does a UseUpId(), so don't do it here in that case.
   if( mShuttleMode == eIsCreating )
      return AddSpinCtrl( Prompt, WrappedRef.ReadAsInt(), max, min );
 
   UseUpId();
   wxSpinCtrl * pSpinCtrl=NULL;
 
   wxWindow * pWnd  = wxWindow::FindWindowById( miId, mpDlg);
   pSpinCtrl = wxDynamicCast(pWnd, wxSpinCtrl);
 
   switch( mShuttleMode )
   {
      // IF setting internal storage from the controls.
   case eIsGettingMetadata:
      break;
   case eIsGettingFromDialog:
      {
         wxASSERT( pSpinCtrl );
         WrappedRef.WriteToAsInt( pSpinCtrl->GetValue() );
      }
      break;
   case eIsSettingToDialog:
      {
         wxASSERT( pSpinCtrl );
         pSpinCtrl->SetValue( WrappedRef.ReadAsInt() );
      }
      break;
   default:
      wxASSERT( false );
      break;
   }
   return pSpinCtrl;
}

References AddSpinCtrl(), eIsCreating, eIsGettingFromDialog, eIsGettingMetadata, eIsSettingToDialog, HandleOptionality(), miId, min(), mpDlg, mShuttleMode, WrappedType::ReadAsInt(), UseUpId(), and WrappedType::WriteToAsInt().

Referenced by TieSpinCtrl().

Here is the call graph for this function:

Here is the caller graph for this function:

DoTieTextBox()

wxTextCtrl * ShuttleGuiBase::DoTieTextBox ( const TranslatableString &  Prompt, WrappedType &  WrappedRef, const int  nChars  )

private

Definition at line 1433 of file ShuttleGui.cpp.

{
   HandleOptionality( Prompt );
   // The Add function does a UseUpId(), so don't do it here in that case.
   if( mShuttleMode == eIsCreating )
      return AddTextBox( Prompt, WrappedRef.ReadAsString(), nChars );
 
   UseUpId();
   wxTextCtrl * pTextBox=NULL;
 
   wxWindow * pWnd  = wxWindow::FindWindowById( miId, mpDlg);
   pTextBox = wxDynamicCast(pWnd, wxTextCtrl);
 
   switch( mShuttleMode )
   {
   // IF setting internal storage from the controls.
   case eIsGettingMetadata:
      break;
   case eIsGettingFromDialog:
      {
         wxASSERT( pTextBox );
         WrappedRef.WriteToAsString( pTextBox->GetValue() );
      }
      break;
   case eIsSettingToDialog:
      {
         wxASSERT( pTextBox );
         pTextBox->SetValue( WrappedRef.ReadAsString() );
      }
      break;
   default:
      wxASSERT( false );
      break;
   }
   return pTextBox;
}

References AddTextBox(), eIsCreating, eIsGettingFromDialog, eIsGettingMetadata, eIsSettingToDialog, HandleOptionality(), miId, mpDlg, mShuttleMode, WrappedType::ReadAsString(), UseUpId(), and WrappedType::WriteToAsString().

Referenced by TieTextBox().

Here is the call graph for this function:

Here is the caller graph for this function:

EndHorizontalLay()

void ShuttleGuiBase::EndHorizontalLay

(

)

Definition at line 1201 of file ShuttleGui.cpp.

{
   if( mShuttleMode != eIsCreating )
      return;
   PopSizer();
}

References eIsCreating, mShuttleMode, and PopSizer().

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

Here is the call graph for this function:

Here is the caller graph for this function:

EndInvisiblePanel()

void ShuttleGuiBase::EndInvisiblePanel

(

)

Definition at line 1179 of file ShuttleGui.cpp.

{
   EndPanel();
}

References EndPanel().

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

Here is the call graph for this function:

Here is the caller graph for this function:

EndMultiColumn()

void ShuttleGuiBase::EndMultiColumn

(

)

Definition at line 1262 of file ShuttleGui.cpp.

{
   if( mShuttleMode != eIsCreating )
      return;
   PopSizer();
}

References eIsCreating, mShuttleMode, and PopSizer().

Here is the call graph for this function:

EndNotebook()

void ShuttleGuiBase::EndNotebook

(

)

Definition at line 1064 of file ShuttleGui.cpp.

{
   //PopSizer();
   mpParent = mpParent->GetParent();
}

References mpParent.

EndNotebookPage()

void ShuttleGuiBase::EndNotebookPage

(

)

Definition at line 1115 of file ShuttleGui.cpp.

{
   if( mShuttleMode != eIsCreating )
      return;
   PopSizer();
   mpParent = mpParent->GetParent();
}

References eIsCreating, mpParent, mShuttleMode, and PopSizer().

Here is the call graph for this function:

EndPanel()

void ShuttleGuiBase::EndPanel

(

)

Definition at line 1042 of file ShuttleGui.cpp.

{
   if( mShuttleMode != eIsCreating )
      return;
   PopSizer();
   mpParent = mpParent->GetParent();
}

References eIsCreating, mpParent, mShuttleMode, and PopSizer().

Referenced by EndInvisiblePanel().

Here is the call graph for this function:

Here is the caller graph for this function:

EndRadioButtonGroup()

void ShuttleGuiBase::EndRadioButtonGroup

(

)

Call this after any TieRadioButton calls. It's generic too. We don't need type-specific ones.

Definition at line 1676 of file ShuttleGui.cpp.

{
   // too few buttons?
   wxASSERT( mRadioCount == mRadioSymbols.size() );
 
   if( mShuttleMode == eIsGettingFromDialog )
      DoDataShuttle( mRadioSettingName, *mRadioValue );
   mRadioValue.reset();// Clear it out...
   mRadioSettingName = wxT("");
   mRadioCount = -1; // So we detect a problem.
   mRadioSymbols = {};
}

References DoDataShuttle(), eIsGettingFromDialog, mRadioCount, mRadioSettingName, mRadioSymbols, mRadioValue, mShuttleMode, and wxT().

Here is the call graph for this function:

EndScroller()

void ShuttleGuiBase::EndScroller

(

)

Definition at line 995 of file ShuttleGui.cpp.

{
   if( mShuttleMode != eIsCreating )
      return;
   wxSize ScrollSize = mpSizer->GetMinSize();
   int yMin = ScrollSize.y+4;
   int xMin = ScrollSize.x+4;
   if( yMin > 400)
   {
      yMin = 400;
      xMin+=50;// extra space for vertical scrollbar.
   }
 
   mpParent->SetMinSize( wxSize(xMin, yMin) );
 
   PopSizer();
   mpParent = mpParent->GetParent();
}

References eIsCreating, mpParent, mpSizer, mShuttleMode, and PopSizer().

Here is the call graph for this function:

EndSimplebook()

void ShuttleGuiBase::EndSimplebook

(

)

Definition at line 1085 of file ShuttleGui.cpp.

{
   //PopSizer();
   mpParent = mpParent->GetParent();
}

References mpParent.

EndStatic()

void ShuttleGuiBase::EndStatic

(

)

Definition at line 947 of file ShuttleGui.cpp.

{
   if( mShuttleMode != eIsCreating )
      return;
   PopSizer();
   mpParent = mpParent->GetParent();
}

References eIsCreating, mpParent, mShuttleMode, and PopSizer().

Here is the call graph for this function:

EndThreeColumn()

void ShuttleGuiBase::EndThreeColumn ( )

inline

Definition at line 371 of file ShuttleGui.h.

{EndMultiColumn();};

EndTwoColumn()

void ShuttleGuiBase::EndTwoColumn ( )

inline

Definition at line 369 of file ShuttleGui.h.

{EndMultiColumn();};

EndVerticalLay()

void ShuttleGuiBase::EndVerticalLay

(

)

Definition at line 1227 of file ShuttleGui.cpp.

{
   if( mShuttleMode != eIsCreating )
      return;
   PopSizer();
}

References eIsCreating, mShuttleMode, and PopSizer().

Referenced by ShuttleGui::AddStandardButtons(), ErrorReportDialog::ErrorReportDialog(), audacity::cloud::audiocom::ShareAudioDialog::InitialStatePanel::PopulateInitialStatePanel(), and audacity::cloud::audiocom::ShareAudioDialog::ProgressPanel::PopulateProgressPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

EndWrapLay()

void ShuttleGuiBase::EndWrapLay

(

)

Definition at line 1245 of file ShuttleGui.cpp.

{
   if (mShuttleMode != eIsCreating)
      return;
 
   PopSizer();
}

References eIsCreating, mShuttleMode, and PopSizer().

Referenced by audacity::cloud::audiocom::ShareAudioDialog::ProgressPanel::PopulateProgressPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

GetBorder()

int ShuttleGuiBase::GetBorder ( ) const

noexcept

Definition at line 196 of file ShuttleGui.cpp.

{
   return miBorder;
}

References miBorder.

GetParent()

wxWindow * ShuttleGuiBase::GetParent ( )

inline

Definition at line 502 of file ShuttleGui.h.

   {
      // This assertion justifies the use of safenew in many places where GetParent()
      // is used to construct a window
      wxASSERT(mpParent != NULL);
      return mpParent;
   }

Referenced by AddBitmapButton(), AddButton(), AddCheckBox(), AddCheckBoxOnRight(), AddChoice(), AddCombo(), AddConstTextBox(), AddFixedText(), AddGrid(), AddIcon(), AddListBox(), AddListControl(), AddListControlReportMode(), AddNumericTextBox(), AddPrompt(), AddReadOnlyText(), AddSlider(), AddSpinControl(), AddSpinCtrl(), AddTextBox(), AddTextWindow(), AddTitle(), AddTree(), AddUnits(), AddVariableText(), DoAddRadioButton(), audacity::cloud::audiocom::ShareAudioDialog::InitialStatePanel::PopulateInitialStatePanel(), audacity::cloud::audiocom::ShareAudioDialog::ProgressPanel::PopulateProgressPanel(), StartInvisiblePanel(), StartNotebook(), StartNotebookPage(), StartPanel(), StartScroller(), StartSimplebook(), StartStatic(), and TieRadioButton().

Here is the caller graph for this function:

GetSizer()

wxSizer * ShuttleGuiBase::GetSizer ( )

inline

Definition at line 512 of file ShuttleGui.h.

{return mpSizer;}

GetStyle()

long ShuttleGuiBase::GetStyle ( long  Style )

protected

Definition at line 2284 of file ShuttleGui.cpp.

{
   if( mItem.miStyle )
      style = mItem.miStyle;
   mItem.miStyle = 0;
   return style;
}

References DialogDefinition::Item::miStyle, mItem, and anonymous_namespace{AudacityDontAskAgainMessageDialog.cpp}::style.

Referenced by AddBitmapButton(), AddButton(), AddCheckBox(), AddCheckBoxOnRight(), AddChoice(), AddCombo(), AddConstTextBox(), AddFixedText(), AddGrid(), AddIcon(), AddListBox(), AddListControl(), AddListControlReportMode(), AddNumericTextBox(), AddPrompt(), AddReadOnlyText(), AddSlider(), AddSpinCtrl(), AddTextBox(), AddTextWindow(), AddTitle(), AddTree(), AddUnits(), AddVariableText(), DoAddRadioButton(), StartNotebook(), StartPanel(), and StartSimplebook().

Here is the caller graph for this function:

HandleOptionality()

void ShuttleGuiBase::HandleOptionality

(

const TranslatableString &

Prompt

)

Definition at line 224 of file ShuttleGui.cpp.

{
   // If creating, will be handled by an AddPrompt.
   if( mShuttleMode == eIsCreating )
      return;
   //wxLogDebug( "Optionality: [%s] Id:%i (%i)", Prompt.c_str(), miId, miIdSetByUser ) ;
   if( mpbOptionalFlag ){
      bool * pVar = mpbOptionalFlag;
      mpbOptionalFlag = nullptr;
      TieCheckBox( Prompt, *pVar);
   }
}

References eIsCreating, mpbOptionalFlag, mShuttleMode, and TieCheckBox().

Referenced by AddCheckBox(), AddCheckBoxOnRight(), AddChoice(), AddCombo(), AddConstTextBox(), AddNumericTextBox(), AddReadOnlyText(), AddSlider(), AddSpinControl(), AddSpinCtrl(), AddTextBox(), DoTieCheckBox(), DoTieCheckBoxOnRight(), DoTieNumericTextBox(), DoTieSlider(), DoTieSpinControl(), DoTieSpinCtrl(), DoTieTextBox(), and TieChoice().

Here is the call graph for this function:

Here is the caller graph for this function:

Init()

void ShuttleGuiBase::Init	(	bool	vertical,
		wxSize	minSize
	)

Definition at line 143 of file ShuttleGui.cpp.

{
   mpShuttle = NULL;
   mpSizer = NULL;
   mpWind = NULL;
   mpSubSizer = NULL;
 
   mRadioSettingName = wxT("");
   mRadioCount = -1;
 
   miBorder = 5;
   miProp=0;
   miPropSetByUser=-1;
   miSizerProp=0;
   mSizerDepth=-1;
 
   ResetId();
 
   miNoMatchSelector = 0;
 
   if( mShuttleMode != eIsCreating )
      return;
 
   mpSizer = mpParent->GetSizer();
 
#if 0
   if( mpSizer == NULL )
   {
      wxWindow * pGrandParent = mpParent->GetParent();
      if( pGrandParent )
      {
         mpSizer = pGrandParent->GetSizer();
      }
   }
#endif
 
   if( !mpSizer )
   {
      mpParent->SetSizer(
         mpSizer = safenew wxBoxSizer(vertical ? wxVERTICAL : wxHORIZONTAL));
   }
   PushSizer();
   mpSizer->SetMinSize(minSize);
}

References eIsCreating, miBorder, miNoMatchSelector, miProp, miPropSetByUser, miSizerProp, mpParent, mpShuttle, mpSizer, mpSubSizer, mpWind, mRadioCount, mRadioSettingName, mShuttleMode, mSizerDepth, PushSizer(), ResetId(), safenew, and wxT().

Referenced by ShuttleGui::ShuttleGui(), and ShuttleGuiBase().

Here is the call graph for this function:

Here is the caller graph for this function:

PopSizer()

void ShuttleGuiBase::PopSizer ( )

protected

Definition at line 2270 of file ShuttleGui.cpp.

{
   mSizerDepth--;
   wxASSERT( mSizerDepth >=0 );
   mpSizer = pSizerStack[ mSizerDepth ];
}

References mpSizer, mSizerDepth, and pSizerStack.

Referenced by ShuttleGui::AddStandardButtons(), EndHorizontalLay(), EndMultiColumn(), EndNotebookPage(), EndPanel(), EndScroller(), EndStatic(), EndVerticalLay(), and EndWrapLay().

Here is the caller graph for this function:

Prop()

ShuttleGuiBase & ShuttleGuiBase::Prop

(

int

iProp

)

Definition at line 907 of file ShuttleGui.cpp.

{
   miPropSetByUser = iProp;
   return *this;
}

References miPropSetByUser.

Referenced by ShuttleGui::Prop().

Here is the caller graph for this function:

PushSizer()

void ShuttleGuiBase::PushSizer ( )

protected

Definition at line 2277 of file ShuttleGui.cpp.

{
   mSizerDepth++;
   wxASSERT( mSizerDepth < nMaxNestedSizers );
   pSizerStack[ mSizerDepth ] = mpSizer;
}

References mpSizer, mSizerDepth, nMaxNestedSizers, and pSizerStack.

Referenced by Init(), StartInvisiblePanel(), StartNotebookPage(), StartPanel(), StartScroller(), and UpdateSizersCore().

Here is the caller graph for this function:

ResetId()

void ShuttleGuiBase::ResetId

(

)

Definition at line 188 of file ShuttleGui.cpp.

{
   miIdSetByUser = -1;
   miId = -1;
   miIdNext = 3000;
}

References miId, miIdNext, and miIdSetByUser.

Referenced by Init().

Here is the caller graph for this function:

SetBorder()

void ShuttleGuiBase::SetBorder ( int  Border )

inline

Definition at line 495 of file ShuttleGui.h.

{miBorder = Border;};

Referenced by 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:

SetProportions()

void ShuttleGuiBase::SetProportions ( int  Default )

protected

Definition at line 2146 of file ShuttleGui.cpp.

{
   if( miPropSetByUser >=0 )
   {
      miProp = miPropSetByUser;
      miPropSetByUser =-1;
      return;
   }
   miProp = Default;
}

References Default, miProp, and miPropSetByUser.

Referenced by AddGrid(), AddListBox(), AddListControl(), AddListControlReportMode(), AddTextWindow(), AddTree(), AddWindow(), StartInvisiblePanel(), StartNotebook(), StartNotebookPage(), StartPanel(), StartScroller(), and StartSimplebook().

Here is the caller graph for this function:

SetSizerProportion()

void ShuttleGuiBase::SetSizerProportion ( int  iProp )

inline

Definition at line 497 of file ShuttleGui.h.

{miSizerProp = iProp;};

SetStretchyCol()

void ShuttleGuiBase::SetStretchyCol

(

int

i

)

Used to modify an already placed FlexGridSizer to make a column stretchy.

Definition at line 202 of file ShuttleGui.cpp.

{
   if( mShuttleMode != eIsCreating )
      return;
   wxFlexGridSizer *pSizer = wxDynamicCast(mpSizer, wxFlexGridSizer);
   wxASSERT( pSizer );
   pSizer->AddGrowableCol( i, 1 );
}

References eIsCreating, mpSizer, and mShuttleMode.

SetStretchyRow()

void ShuttleGuiBase::SetStretchyRow

(

int

i

)

Used to modify an already placed FlexGridSizer to make a row stretchy.

Definition at line 212 of file ShuttleGui.cpp.

{
   if( mShuttleMode != eIsCreating )
      return;
   wxFlexGridSizer *pSizer = wxDynamicCast(mpSizer, wxFlexGridSizer);
   wxASSERT( pSizer );
   pSizer->AddGrowableRow( i, 1 );
}

References eIsCreating, mpSizer, and mShuttleMode.

StartHorizontalLay()

void ShuttleGuiBase::StartHorizontalLay	(	int	PositionFlags = wxALIGN_CENTRE,
		int	iProp = 1
	)

Starts a Horizontal Layout.

• Use wxEXPAND and 0 to expand horizontally but not vertically.
• Use wxEXPAND and 1 to expand horizontally and vertically.
• Use wxCENTRE and 1 for no expansion.

  Parameters

  PositionFlag	Typically wxEXPAND or wxALIGN_CENTER.
  iProp	Proportionality for resizing.

Definition at line 1191 of file ShuttleGui.cpp.

{
   if( mShuttleMode != eIsCreating )
      return;
   miSizerProp=iProp;
   mpSubSizer = std::make_unique<wxBoxSizer>( wxHORIZONTAL );
   // PRL:  wxALL has no effect because UpdateSizersCore ignores border
   UpdateSizersCore( false, PositionFlags | wxALL );
}

References eIsCreating, miSizerProp, mpSubSizer, mShuttleMode, and UpdateSizersCore().

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

Here is the call graph for this function:

Here is the caller graph for this function:

StartInvisiblePanel()

wxPanel * ShuttleGuiBase::StartInvisiblePanel

(

int

border = 0

)

Definition at line 1156 of file ShuttleGui.cpp.

{
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxPanel);
   wxPanel * pPanel;
   mpWind = pPanel = safenew wxPanelWrapper(GetParent(), miId, wxDefaultPosition, wxDefaultSize,
      wxNO_BORDER);
 
   mpWind->SetBackgroundColour(
      wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE)
      );
   SetProportions( 1 );
   miBorder = border;
   UpdateSizers();  // adds window in to current sizer.
 
   // create a sizer within the window...
   mpParent = pPanel;
   pPanel->SetSizer(mpSizer = safenew wxBoxSizer(wxVERTICAL));
   PushSizer();
   return pPanel;
}

References eIsCreating, GetParent(), miBorder, miId, mpDlg, mpParent, mpSizer, mpWind, mShuttleMode, PushSizer(), safenew, SetProportions(), UpdateSizers(), and UseUpId().

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

Here is the call graph for this function:

Here is the caller graph for this function:

StartMultiColumn()

void ShuttleGuiBase::StartMultiColumn	(	int	nCols,
		int	PositionFlags = wxALIGN_LEFT
	)

Definition at line 1253 of file ShuttleGui.cpp.

{
   if( mShuttleMode != eIsCreating )
      return;
   mpSubSizer = std::make_unique<wxFlexGridSizer>( nCols );
   // PRL:  wxALL has no effect because UpdateSizersCore ignores border
   UpdateSizersCore( false, PositionFlags | wxALL );
}

References eIsCreating, mpSubSizer, mShuttleMode, and UpdateSizersCore().

Here is the call graph for this function:

StartNotebook()

wxNotebook * ShuttleGuiBase::StartNotebook

(

)

Definition at line 1050 of file ShuttleGui.cpp.

{
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxNotebook);
   wxNotebook * pNotebook;
   mpWind = pNotebook = safenew wxNotebook(GetParent(),
      miId, wxDefaultPosition, wxDefaultSize, GetStyle( 0 ));
   SetProportions( 1 );
   UpdateSizers();
   mpParent = pNotebook;
   return pNotebook;
}

References eIsCreating, GetParent(), GetStyle(), miId, mpDlg, mpParent, mpWind, mShuttleMode, safenew, SetProportions(), UpdateSizers(), and UseUpId().

Here is the call graph for this function:

StartNotebookPage()

wxNotebookPage * ShuttleGuiBase::StartNotebookPage

(

const TranslatableString &

Name

)

Definition at line 1092 of file ShuttleGui.cpp.

{
   if( mShuttleMode != eIsCreating )
      return NULL;
//      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wx);
   auto pNotebook = static_cast< wxBookCtrlBase* >( mpParent );
   wxNotebookPage * pPage = safenew wxPanelWrapper(GetParent());
   const auto translated = Name.Translation();
   pPage->SetName(translated);
 
   pNotebook->AddPage(
      pPage,
      translated);
 
   SetProportions( 1 );
   mpParent = pPage;
   pPage->SetSizer(mpSizer = safenew wxBoxSizer(wxVERTICAL));
   PushSizer();
   //   UpdateSizers();
   return pPage;
}

References eIsCreating, GetParent(), mpParent, mpSizer, mShuttleMode, PushSizer(), safenew, and SetProportions().

Here is the call graph for this function:

StartPanel()

wxPanel * ShuttleGuiBase::StartPanel

(

int

iStyle = 0

)

Definition at line 1014 of file ShuttleGui.cpp.

{
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxPanel);
   wxPanel * pPanel;
   mpWind = pPanel = safenew wxPanelWrapper( GetParent(), miId, wxDefaultPosition, wxDefaultSize,
      GetStyle( wxNO_BORDER ));
 
   if( iStyle != 0 )
   {
      mpWind->SetBackgroundColour(
         iStyle==1
         ? wxColour( 190,200,230) :
         wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW)
         );
   }
   SetProportions(0);
   miBorder=2;
   UpdateSizers();  // adds window in to current sizer.
 
   // create a sizer within the window...
   mpParent = pPanel;
   pPanel->SetSizer(mpSizer = safenew wxBoxSizer(wxVERTICAL));
   PushSizer();
   return pPanel;
}

References eIsCreating, GetParent(), GetStyle(), miBorder, miId, mpDlg, mpParent, mpSizer, mpWind, mShuttleMode, PushSizer(), safenew, SetProportions(), UpdateSizers(), and UseUpId().

Here is the call graph for this function:

StartRadioButtonGroup()

void ShuttleGuiBase::StartRadioButtonGroup

(

ChoiceSetting &

Setting

)

Call this before any TieRadioButton calls.

Definition at line 1659 of file ShuttleGui.cpp.

{
   mRadioSymbols = Setting.GetSymbols();
 
   // Configure the generic type mechanism to use OUR string.
   mRadioValueString = Setting.Default().Internal();
   mRadioValue.emplace( mRadioValueString );
 
   // Now actually start the radio button group.
   mRadioSettingName = Setting.Key();
   mRadioCount = 0;
   if( mShuttleMode == eIsCreating )
      DoDataShuttle( Setting.Key(), *mRadioValue );
}

References DoDataShuttle(), eIsCreating, mRadioCount, mRadioSettingName, mRadioSymbols, mRadioValue, mRadioValueString, and mShuttleMode.

Here is the call graph for this function:

StartScroller()

wxScrolledWindow * ShuttleGuiBase::StartScroller

(

int

iStyle = 0

)

This allows subsequent controls and static boxes to be in a scrolled panel. Very handy if you are running out of space on a dialog.

The iStyle parameter is used in some very hacky code that dynamically repopulates a dialog. It also controls the background colour. Look at the code for details.

Parameters

istyle

deprecated parameter, but has been used for hacking.

Definition at line 963 of file ShuttleGui.cpp.

{
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxScrolledWindow);
 
   wxScrolledWindow * pScroller;
   mpWind = pScroller = safenew wxScrolledWindow(GetParent(), miId, wxDefaultPosition, wxDefaultSize);
   pScroller->SetScrollRate( 20,20 );
 
   // This fools NVDA into not saying "Panel" when the dialog gets focus
   pScroller->SetName(wxT("\a"));
   pScroller->SetLabel(wxT("\a"));
 
   SetProportions( 1 );
   if( iStyle==2 )
   {
      UpdateSizersAtStart();
   }
   else
   {
     // mpWind->SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_MENUBAR));
      UpdateSizers();  // adds window in to current sizer.
   }
 
   // create a sizer within the window...
   mpParent = pScroller;
   pScroller->SetSizer(mpSizer = safenew wxBoxSizer(wxVERTICAL));
   PushSizer();
   return pScroller;
}

References eIsCreating, GetParent(), miId, mpDlg, mpParent, mpSizer, mpWind, mShuttleMode, PushSizer(), safenew, SetProportions(), UpdateSizers(), UpdateSizersAtStart(), UseUpId(), and wxT().

Here is the call graph for this function:

StartSimplebook()

wxSimplebook * ShuttleGuiBase::StartSimplebook

(

)

Definition at line 1071 of file ShuttleGui.cpp.

{
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxSimplebook);
   wxSimplebook * pNotebook;
   mpWind = pNotebook = safenew wxSimplebook(GetParent(),
      miId, wxDefaultPosition, wxDefaultSize, GetStyle( 0 ));
   SetProportions( 1 );
   UpdateSizers();
   mpParent = pNotebook;
   return pNotebook;
}

References eIsCreating, GetParent(), GetStyle(), miId, mpDlg, mpParent, mpWind, mShuttleMode, safenew, SetProportions(), UpdateSizers(), and UseUpId().

Here is the call graph for this function:

StartStatic()

wxStaticBox * ShuttleGuiBase::StartStatic	(	const TranslatableString &	Str,
		int	iProp = 0
	)

Starts a static box around a number of controls.

Parameters

Str	The text of the title for the box.
iProp	The resizing proportion value. Use iProp == 0 for a minimum sized static box. Use iProp == 1 for a box that grows if there is space to spare.

Definition at line 918 of file ShuttleGui.cpp.

{
   UseUpId();
   if( mShuttleMode != eIsCreating )
      return NULL;
   auto translated = Str.Translation();
   wxStaticBox * pBox = safenew wxStaticBoxWrapper(
      GetParent(), miId, translated );
   pBox->SetLabel( translated );
   if (Str.empty()) {
      // NVDA 2018.3 or later does not read the controls in a group box which has
      // an accessibility name which is empty. Bug 2169.
#if wxUSE_ACCESSIBILITY
      // so that name can be set on a standard control
      pBox->SetAccessible(safenew WindowAccessible(pBox));
#endif
      pBox->SetName(wxT("\a"));      // non-empty string which screen readers do not read
   }
   else
      pBox->SetName( wxStripMenuCodes( translated ) );
   mpSubSizer = std::make_unique<wxStaticBoxSizer>(
      pBox,
      wxVERTICAL );
   miSizerProp = iProp;
   UpdateSizers();
   mpParent = pBox;
   return pBox;
}

References eIsCreating, TranslatableString::empty(), GetParent(), miId, miSizerProp, mpParent, mpSubSizer, mShuttleMode, safenew, TranslatableString::Translation(), UpdateSizers(), UseUpId(), and wxT().

Here is the call graph for this function:

StartThreeColumn()

void ShuttleGuiBase::StartThreeColumn ( )

inline

Definition at line 370 of file ShuttleGui.h.

{StartMultiColumn(3);};

StartTwoColumn()

void ShuttleGuiBase::StartTwoColumn ( )

inline

Definition at line 368 of file ShuttleGui.h.

{StartMultiColumn(2);};

StartVerticalLay() [1/2]

void ShuttleGuiBase::StartVerticalLay

(

int

iProp = 1

)

Definition at line 1208 of file ShuttleGui.cpp.

{
   if( mShuttleMode != eIsCreating )
      return;
   miSizerProp=iProp;
   mpSubSizer = std::make_unique<wxBoxSizer>( wxVERTICAL );
   UpdateSizers();
}

References eIsCreating, miSizerProp, mpSubSizer, mShuttleMode, and UpdateSizers().

Referenced by ShuttleGui::AddStandardButtons(), ErrorReportDialog::ErrorReportDialog(), audacity::cloud::audiocom::ShareAudioDialog::InitialStatePanel::PopulateInitialStatePanel(), and audacity::cloud::audiocom::ShareAudioDialog::ProgressPanel::PopulateProgressPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

StartVerticalLay() [2/2]

void ShuttleGuiBase::StartVerticalLay	(	int	PositionFlags,
		int	iProp
	)

Definition at line 1217 of file ShuttleGui.cpp.

{
   if( mShuttleMode != eIsCreating )
      return;
   miSizerProp=iProp;
   mpSubSizer = std::make_unique<wxBoxSizer>( wxVERTICAL );
   // PRL:  wxALL has no effect because UpdateSizersCore ignores border
   UpdateSizersCore( false, PositionFlags | wxALL );
}

References eIsCreating, miSizerProp, mpSubSizer, mShuttleMode, and UpdateSizersCore().

Here is the call graph for this function:

StartWrapLay()

void ShuttleGuiBase::StartWrapLay	(	int	PositionFlags = wxEXPAND,
		int	iProp = 0
	)

Definition at line 1234 of file ShuttleGui.cpp.

{
   if (mShuttleMode != eIsCreating)
      return;
 
   miSizerProp = iProp;
   mpSubSizer = std::make_unique<wxWrapSizer>(wxHORIZONTAL, 0);
 
   UpdateSizersCore(false, PositionFlags | wxALL);
}

References eIsCreating, miSizerProp, mpSubSizer, mShuttleMode, and UpdateSizersCore().

Referenced by audacity::cloud::audiocom::ShareAudioDialog::ProgressPanel::PopulateProgressPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

TieCheckBox() [1/2]

wxCheckBox * ShuttleGuiBase::TieCheckBox	(	const TranslatableString &	Prompt,
		bool &	Var
	)

Definition at line 1693 of file ShuttleGui.cpp.

{
   WrappedType WrappedRef( Var );
   return DoTieCheckBox( Prompt, WrappedRef );
}

References DoTieCheckBox().

Referenced by AddPrompt(), HandleOptionality(), PitchAndSpeedDialog::PopulateOrExchange(), and anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieCheckBox().

Here is the call graph for this function:

Here is the caller graph for this function:

TieCheckBox() [2/2]

wxCheckBox * ShuttleGuiBase::TieCheckBox ( const TranslatableString &  Prompt, const BoolSetting &  Setting  )

virtual

Variant of the standard TieCheckBox which does the two step exchange between gui and stack variable and stack variable and shuttle.

Reimplemented in anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition.

Definition at line 1916 of file ShuttleGui.cpp.

{
   wxCheckBox * pCheck=NULL;
 
   auto Value = Setting.GetDefault();
   WrappedType WrappedRef( Value );
   if( DoStep(1) ) DoDataShuttle( Setting.GetPath(), WrappedRef );
   if( DoStep(2) ) pCheck = DoTieCheckBox( Prompt, WrappedRef );
   if( DoStep(3) ) DoDataShuttle( Setting.GetPath(), WrappedRef );
 
   return pCheck;
}

References DoDataShuttle(), DoStep(), DoTieCheckBox(), Setting< T >::GetDefault(), and SettingBase::GetPath().

Here is the call graph for this function:

TieCheckBoxOnRight() [1/2]

wxCheckBox * ShuttleGuiBase::TieCheckBoxOnRight	(	const TranslatableString &	Prompt,
		bool &	Var
	)

Definition at line 1700 of file ShuttleGui.cpp.

{
   // Only does anything different if it's creating.
   WrappedType WrappedRef( Var );
   if( mShuttleMode == eIsCreating )
      return AddCheckBoxOnRight( Prompt, WrappedRef.ReadAsString() == wxT("true") );
   return DoTieCheckBox( Prompt, WrappedRef );
}

References AddCheckBoxOnRight(), DoTieCheckBox(), eIsCreating, mShuttleMode, WrappedType::ReadAsString(), and wxT().

Referenced by anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieCheckBoxOnRight().

Here is the call graph for this function:

Here is the caller graph for this function:

TieCheckBoxOnRight() [2/2]

wxCheckBox * ShuttleGuiBase::TieCheckBoxOnRight ( const TranslatableString &  Prompt, const BoolSetting &  Setting  )

virtual

Variant of the standard TieCheckBox which does the two step exchange between gui and stack variable and stack variable and shuttle.

Reimplemented in anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition.

Definition at line 1933 of file ShuttleGui.cpp.

{
   wxCheckBox * pCheck=NULL;
 
   auto Value = Setting.GetDefault();
   WrappedType WrappedRef( Value );
   if( DoStep(1) ) DoDataShuttle( Setting.GetPath(), WrappedRef );
   if( DoStep(2) ) pCheck = DoTieCheckBoxOnRight( Prompt, WrappedRef );
   if( DoStep(3) ) DoDataShuttle( Setting.GetPath(), WrappedRef );
 
   return pCheck;
}

References DoDataShuttle(), DoStep(), DoTieCheckBoxOnRight(), Setting< T >::GetDefault(), and SettingBase::GetPath().

Here is the call graph for this function:

TieChoice() [1/3]

wxChoice * ShuttleGuiBase::TieChoice ( const TranslatableString &  Prompt, ChoiceSetting &  choiceSetting  )

virtual

Variant of the standard TieChoice which does the two step exchange between gui and stack variable and stack variable and shuttle.

Parameters

Prompt	The prompt shown beside the control.
Setting	Encapsulates setting name, internal and visible choice strings, and a designation of one of those as default.

Reimplemented in anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition.

Definition at line 2045 of file ShuttleGui.cpp.

{
   // Do this to force any needed migrations first
   choiceSetting.Read();
 
   const auto &symbols = choiceSetting.GetSymbols();
   const auto &SettingName = choiceSetting.Key();
   const auto &Default = choiceSetting.Default().Internal();
   const auto &Choices = symbols.GetMsgids();
   const auto &InternalChoices = symbols.GetInternals();
 
   wxChoice * pChoice=(wxChoice*)NULL;
 
   int TempIndex=0;
//   int TempIndex = TranslateToIndex( Default, InternalChoices );
   wxString TempStr = Default;
   WrappedType WrappedRef( TempStr );
   // Get from prefs does 1 and 2.
   // Put to prefs does 2 and 3.
   if( DoStep(1) ) DoDataShuttle( SettingName, WrappedRef ); // Get Index from Prefs.
   if( DoStep(1) ) TempIndex = TranslateToIndex( TempStr, InternalChoices ); // To an index
   if( DoStep(2) ) pChoice = TieChoice( Prompt, TempIndex, Choices );
   if( DoStep(3) ) TempStr = TranslateFromIndex( TempIndex, InternalChoices ); // To a string
   if( DoStep(3) ) choiceSetting.Write(TempStr); // Put into Prefs.
   return pChoice;
}

References ChoiceSetting::Default(), Default, DoDataShuttle(), DoStep(), ChoiceSetting::GetSymbols(), ComponentInterfaceSymbol::Internal(), ChoiceSetting::Key(), ChoiceSetting::Read(), TieChoice(), TranslateFromIndex(), TranslateToIndex(), and ChoiceSetting::Write().

Here is the call graph for this function:

TieChoice() [2/3]

wxChoice * ShuttleGuiBase::TieChoice	(	const TranslatableString &	Prompt,
		int &	Selected,
		const TranslatableStrings &	choices
	)

Definition at line 1553 of file ShuttleGui.cpp.

{
   HandleOptionality( Prompt );
 
   // The Add function does a UseUpId(), so don't do it here in that case.
   if( mShuttleMode != eIsCreating )
      UseUpId();
 
   wxChoice * pChoice=NULL;
   switch( mShuttleMode )
   {
   case eIsCreating:
      {
         pChoice = AddChoice( Prompt, choices, Selected );
         ShuttleGui::SetMinSize(pChoice, choices);
      }
      break;
   // IF setting internal storage from the controls.
   case eIsGettingMetadata:
      break;
   case eIsGettingFromDialog:
      {
         wxWindow * pWnd  = wxWindow::FindWindowById( miId, mpDlg);
         pChoice = wxDynamicCast(pWnd, wxChoice);
         wxASSERT( pChoice );
         Selected = pChoice->GetSelection();
      }
      break;
   case eIsSettingToDialog:
      {
         wxWindow * pWnd  = wxWindow::FindWindowById( miId, mpDlg);
         pChoice = wxDynamicCast(pWnd, wxChoice);
         wxASSERT( pChoice );
         pChoice->SetSelection( Selected );
      }
      break;
   default:
      wxASSERT( false );
      break;
   }
   return pChoice;
}

References AddChoice(), eIsCreating, eIsGettingFromDialog, eIsGettingMetadata, eIsSettingToDialog, HandleOptionality(), miId, mpDlg, mShuttleMode, ShuttleGui::SetMinSize(), and UseUpId().

Here is the call graph for this function:

TieChoice() [3/3]

wxChoice * ShuttleGuiBase::TieChoice	(	const TranslatableString &	Prompt,
		TranslatableString &	Selected,
		const TranslatableStrings &	choices
	)

Definition at line 1801 of file ShuttleGui.cpp.

{
   int Index = make_iterator_range( choices ).index( Selected );
   auto result = TieChoice( Prompt, Index, choices );
   if ( Index >= 0 && Index < choices.size() )
      Selected = choices[ Index ];
   else
      Selected = {};
   return result;
}

References make_iterator_range(), and TieChoice().

Referenced by anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieChoice(), TieChoice(), and TieNumberAsChoice().

Here is the call graph for this function:

Here is the caller graph for this function:

TieIntegerTextBox()

wxTextCtrl * ShuttleGuiBase::TieIntegerTextBox ( const TranslatableString &  Prompt, const IntSetting &  Setting, const int  nChars  )

virtual

Variant of the standard TieTextBox which does the two step exchange between gui and stack variable and stack variable and shuttle. This one does it for integer values...

Reimplemented in anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition.

Definition at line 2006 of file ShuttleGui.cpp.

{
   wxTextCtrl * pText=(wxTextCtrl*)NULL;
 
   auto Value = Setting.GetDefault();
   WrappedType WrappedRef( Value );
   if( DoStep(1) ) DoDataShuttle( Setting.GetPath(), WrappedRef );
   if( DoStep(2) ) pText = DoTieNumericTextBox( Prompt, WrappedRef, nChars );
   if( DoStep(3) ) DoDataShuttle( Setting.GetPath(), WrappedRef );
   return pText;
}

References DoDataShuttle(), DoStep(), DoTieNumericTextBox(), Setting< T >::GetDefault(), and SettingBase::GetPath().

Referenced by anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieIntegerTextBox().

Here is the call graph for this function:

Here is the caller graph for this function:

TieNumberAsChoice()

wxChoice * ShuttleGuiBase::TieNumberAsChoice ( const TranslatableString &  Prompt, IntSetting &  Setting, const TranslatableStrings &  Choices, const std::vector< int > *  pInternalChoices = nullptr, int  iNoMatchSelector = 0  )

virtual

Variant of the standard TieChoice which does the two step exchange between gui and stack variable and stack variable and shuttle. The Translated choices and default are integers, not Strings. Behaves identically to the previous, but is meant for use when the choices are non-exhaustive and there is a companion control for arbitrary entry.

Parameters

Prompt	The prompt shown beside the control.
SettingName	The setting name as stored in gPrefs
Default	The default integer value for this control
Choices	An array of choices that appear on screen.
pInternalChoices	The corresponding values (as an integer array) if null, then use 0, 1, 2, ...

Reimplemented in anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition.

Definition at line 2084 of file ShuttleGui.cpp.

{
   auto fn = [](int arg){ return wxString::Format( "%d", arg ); };
 
   wxArrayStringEx InternalChoices;
   if ( pInternalChoices )
      InternalChoices =
         transform_container<wxArrayStringEx>(*pInternalChoices, fn);
   else
      for ( int ii = 0; ii < (int)Choices.size(); ++ii )
         InternalChoices.push_back( fn( ii ) );
 
   const auto Default = Setting.GetDefault();
 
   miNoMatchSelector = iNoMatchSelector;
 
   long defaultIndex;
   if ( pInternalChoices )
      defaultIndex =  make_iterator_range( *pInternalChoices ).index( Default );
   else
      defaultIndex = Default;
   if ( defaultIndex < 0 || defaultIndex >= (int)Choices.size() )
      defaultIndex = -1;
 
   ChoiceSetting choiceSetting{
      Setting,
      {
         ByColumns,
         Choices,
         InternalChoices,
      },
      defaultIndex
   };
 
   return ShuttleGuiBase::TieChoice(Prompt, choiceSetting);
}

References ByColumns, Default, fn, Setting< T >::GetDefault(), make_iterator_range(), miNoMatchSelector, and TieChoice().

Referenced by anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieNumberAsChoice().

Here is the call graph for this function:

Here is the caller graph for this function:

TieNumericTextBox() [1/3]

wxTextCtrl * ShuttleGuiBase::TieNumericTextBox ( const TranslatableString &  Prompt, const DoubleSetting &  Setting, const int  nChars, bool  acceptEnter = false  )

virtual

Variant of the standard TieTextBox which does the two step exchange between gui and stack variable and stack variable and shuttle. This one does it for double values...

Reimplemented in anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition.

Definition at line 2024 of file ShuttleGui.cpp.

{
   wxTextCtrl * pText=(wxTextCtrl*)NULL;
 
   auto Value = Setting.GetDefault();
   WrappedType WrappedRef( Value );
   if( DoStep(1) ) DoDataShuttle( Setting.GetPath(), WrappedRef );
   if( DoStep(2) ) pText = DoTieNumericTextBox( Prompt, WrappedRef, nChars, acceptEnter );
   if( DoStep(3) ) DoDataShuttle( Setting.GetPath(), WrappedRef );
   return pText;
}

References DoDataShuttle(), DoStep(), DoTieNumericTextBox(), Setting< T >::GetDefault(), and SettingBase::GetPath().

Here is the call graph for this function:

TieNumericTextBox() [2/3]

wxTextCtrl * ShuttleGuiBase::TieNumericTextBox	(	const TranslatableString &	Prompt,
		double &	Value,
		const int	nChars = 0,
		bool	acceptEnter = false
	)

Definition at line 1753 of file ShuttleGui.cpp.

{
   WrappedType WrappedRef( Value );
   return DoTieNumericTextBox( Prompt, WrappedRef, nChars, acceptEnter );
}

References DoTieNumericTextBox().

Here is the call graph for this function:

TieNumericTextBox() [3/3]

wxTextCtrl * ShuttleGuiBase::TieNumericTextBox	(	const TranslatableString &	Prompt,
		int &	Value,
		const int	nChars = 0,
		bool	acceptEnter = false
	)

Definition at line 1745 of file ShuttleGui.cpp.

{
   WrappedType WrappedRef(Value);
   return DoTieNumericTextBox(Prompt, WrappedRef, nChars, acceptEnter);
}

References DoTieNumericTextBox().

Referenced by anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieNumericTextBox().

Here is the call graph for this function:

Here is the caller graph for this function:

TieRadioButton()

wxRadioButton * ShuttleGuiBase::TieRadioButton

(

)

This function must be within a StartRadioButtonGroup - EndRadioButtonGroup pair.

Definition at line 1600 of file ShuttleGui.cpp.

{
   wxASSERT( mRadioCount >= 0); // Did you remember to use StartRadioButtonGroup() ?
 
   EnumValueSymbol symbol;
   if (mRadioCount >= 0 && mRadioCount < (int)mRadioSymbols.size() )
      symbol = mRadioSymbols[ mRadioCount ];
 
   // In what follows, WrappedRef is used in read only mode, but we
   // don't have a 'read-only' version, so we copy to deal with the constness.
   auto Temp = symbol.Internal();
   wxASSERT( !Temp.empty() ); // More buttons than values?
 
   WrappedType WrappedRef( Temp );
 
   mRadioCount++;
 
   UseUpId();
   wxRadioButton * pRadioButton = NULL;
 
   switch( mShuttleMode )
   {
   case eIsCreating:
      {
         const auto &Prompt = symbol.Translation();
 
         mpWind = pRadioButton = safenew wxRadioButton(GetParent(), miId, Prompt,
            wxDefaultPosition, wxDefaultSize,
            (mRadioCount==1)?wxRB_GROUP:0);
 
         wxASSERT( WrappedRef.IsString() );
         wxASSERT( mRadioValue->IsString() );
         const bool value =
            (WrappedRef.ReadAsString() == mRadioValue->ReadAsString() );
         pRadioButton->SetValue( value );
 
         pRadioButton->SetName(wxStripMenuCodes(Prompt));
         UpdateSizers();
      }
      break;
   case eIsGettingMetadata:
      break;
   case eIsGettingFromDialog:
      {
         wxWindow * pWnd  = wxWindow::FindWindowById( miId, mpDlg);
         pRadioButton = wxDynamicCast(pWnd, wxRadioButton);
         wxASSERT( pRadioButton );
         if( pRadioButton->GetValue() )
            mRadioValue->WriteToAsString( WrappedRef.ReadAsString() );
      }
      break;
   default:
      wxASSERT( false );
      break;
   }
   return pRadioButton;
}

References eIsCreating, eIsGettingFromDialog, eIsGettingMetadata, GetParent(), ComponentInterfaceSymbol::Internal(), WrappedType::IsString(), miId, mpDlg, mpWind, mRadioCount, mRadioSymbols, mRadioValue, mShuttleMode, WrappedType::ReadAsString(), safenew, ComponentInterfaceSymbol::Translation(), UpdateSizers(), and UseUpId().

Here is the call graph for this function:

TieSlider() [1/4]

wxSlider * ShuttleGuiBase::TieSlider ( const TranslatableString &  Prompt, const IntSetting &  Setting, const int  max, const int  min = 0  )

virtual

Variant of the standard TieSlider which does the two step exchange between gui and stack variable and stack variable and shuttle.

Reimplemented in anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition.

Definition at line 1950 of file ShuttleGui.cpp.

{
   wxSlider * pSlider=NULL;
 
   auto Value = Setting.GetDefault();
   WrappedType WrappedRef( Value );
   if( DoStep(1) ) DoDataShuttle( Setting.GetPath(), WrappedRef );
   if( DoStep(2) ) pSlider = DoTieSlider( Prompt, WrappedRef, max, min );
   if( DoStep(3) ) DoDataShuttle( Setting.GetPath(), WrappedRef );
 
   return pSlider;
}

References DoDataShuttle(), DoStep(), DoTieSlider(), Setting< T >::GetDefault(), SettingBase::GetPath(), and min().

Here is the call graph for this function:

TieSlider() [2/4]

wxSlider * ShuttleGuiBase::TieSlider	(	const TranslatableString &	Prompt,
		double &	pos,
		const double	max,
		const double	min = 0.0
	)

Definition at line 1768 of file ShuttleGui.cpp.

{
   WrappedType WrappedRef( pos );
   return DoTieSlider( Prompt, WrappedRef, max, min );
}

References DoTieSlider(), and min().

Here is the call graph for this function:

TieSlider() [3/4]

wxSlider * ShuttleGuiBase::TieSlider	(	const TranslatableString &	Prompt,
		float &	pos,
		const float	fMin,
		const float	fMax
	)

Definition at line 1776 of file ShuttleGui.cpp.

{
   const float RoundFix=0.0000001f;
   int iVal=(pos-fMin+RoundFix)*100.0/(fMax-fMin);
   wxSlider * pWnd = TieSlider( Prompt, iVal, 100 );
   pos = iVal*(fMax-fMin)*0.01+fMin;
   return pWnd;
}

References TieSlider().

Here is the call graph for this function:

TieSlider() [4/4]

wxSlider * ShuttleGuiBase::TieSlider	(	const TranslatableString &	Prompt,
		int &	pos,
		const int	max,
		const int	min = 0
	)

Definition at line 1761 of file ShuttleGui.cpp.

{
   WrappedType WrappedRef( pos );
   return DoTieSlider( Prompt, WrappedRef, max, min );
}

References DoTieSlider(), and min().

Referenced by anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieSlider(), TieSlider(), and TieVSlider().

Here is the call graph for this function:

Here is the caller graph for this function:

TieSpinControl()

SpinControl * ShuttleGuiBase::TieSpinControl	(	const wxSize &	size,
		const TranslatableString &	Prompt,
		double &	Value,
		const double	max,
		const double	min = 0
	)

Definition at line 1716 of file ShuttleGui.cpp.

{
   WrappedType WrappedRef(Value);
   return DoTieSpinControl(size, Prompt, WrappedRef, max, min);
}

References DoTieSpinControl(), min(), and size.

Referenced by PitchAndSpeedDialog::PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

TieSpinCtrl() [1/2]

wxSpinCtrl * ShuttleGuiBase::TieSpinCtrl ( const TranslatableString &  Prompt, const IntSetting &  Setting, const int  max, const int  min  )

virtual

Variant of the standard TieSpinCtrl which does the two step exchange between gui and stack variable and stack variable and shuttle.

Reimplemented in anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition.

Definition at line 1969 of file ShuttleGui.cpp.

{
   wxSpinCtrl * pSpinCtrl=NULL;
 
   auto Value = Setting.GetDefault();
   WrappedType WrappedRef( Value );
   if( DoStep(1) ) DoDataShuttle( Setting.GetPath(), WrappedRef );
   if( DoStep(2) ) pSpinCtrl = DoTieSpinCtrl( Prompt, WrappedRef, max, min );
   if( DoStep(3) ) DoDataShuttle( Setting.GetPath(), WrappedRef );
 
   return pSpinCtrl;
}

References DoDataShuttle(), DoStep(), DoTieSpinCtrl(), Setting< T >::GetDefault(), SettingBase::GetPath(), and min().

Here is the call graph for this function:

TieSpinCtrl() [2/2]

wxSpinCtrl * ShuttleGuiBase::TieSpinCtrl	(	const TranslatableString &	Prompt,
		int &	Value,
		const int	max,
		const int	min = 0
	)

Definition at line 1709 of file ShuttleGui.cpp.

{
   WrappedType WrappedRef(Value);
   return DoTieSpinCtrl( Prompt, WrappedRef, max, min );
}

References DoTieSpinCtrl(), and min().

Referenced by PitchAndSpeedDialog::PopulateOrExchange(), and anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieSpinCtrl().

Here is the call graph for this function:

Here is the caller graph for this function:

TieTextBox() [1/4]

wxTextCtrl * ShuttleGuiBase::TieTextBox	(	const TranslatableString &	Caption,
		wxString &	Value,
		const int	nChars = 0
	)

Definition at line 1724 of file ShuttleGui.cpp.

{
   WrappedType WrappedRef(Selected);
   return DoTieTextBox( Prompt, WrappedRef, nChars );
}

References DoTieTextBox().

Referenced by anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieTextBox().

Here is the call graph for this function:

Here is the caller graph for this function:

TieTextBox() [2/4]

wxTextCtrl * ShuttleGuiBase::TieTextBox ( const TranslatableString &  Prompt, const StringSetting &  Setting, const int  nChars  )

virtual

Variant of the standard TieTextBox which does the two step exchange between gui and stack variable and stack variable and shuttle.

Reimplemented in anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition.

Definition at line 1988 of file ShuttleGui.cpp.

{
   wxTextCtrl * pText=(wxTextCtrl*)NULL;
 
   auto Value = Setting.GetDefault();
   WrappedType WrappedRef( Value );
   if( DoStep(1) ) DoDataShuttle( Setting.GetPath(), WrappedRef );
   if( DoStep(2) ) pText = DoTieTextBox( Prompt, WrappedRef, nChars );
   if( DoStep(3) ) DoDataShuttle( Setting.GetPath(), WrappedRef );
   return pText;
}

References DoDataShuttle(), DoStep(), DoTieTextBox(), Setting< T >::GetDefault(), and SettingBase::GetPath().

Here is the call graph for this function:

TieTextBox() [3/4]

wxTextCtrl * ShuttleGuiBase::TieTextBox	(	const TranslatableString &	Prompt,
		double &	Value,
		const int	nChars = 0
	)

Definition at line 1738 of file ShuttleGui.cpp.

{
   WrappedType WrappedRef( Value );
   return DoTieTextBox( Prompt, WrappedRef, nChars );
}

References DoTieTextBox().

Here is the call graph for this function:

TieTextBox() [4/4]

wxTextCtrl * ShuttleGuiBase::TieTextBox	(	const TranslatableString &	Prompt,
		int &	Selected,
		const int	nChars = 0
	)

Definition at line 1731 of file ShuttleGui.cpp.

{
   WrappedType WrappedRef( Selected );
   return DoTieTextBox( Prompt, WrappedRef, nChars );
}

References DoTieTextBox().

Here is the call graph for this function:

TieVSlider()

wxSlider * ShuttleGuiBase::TieVSlider	(	const TranslatableString &	Prompt,
		float &	pos,
		const float	fMin,
		const float	fMax
	)

Definition at line 1787 of file ShuttleGui.cpp.

{
   int iVal=(pos-fMin)*100.0/(fMax-fMin);
//   if( mShuttleMode == eIsCreating )
//   {
//      return AddVSlider( Prompt, iVal, 100 );
//   }
   wxSlider * pWnd = TieSlider( Prompt, iVal, 100 );
   pos = iVal*(fMax-fMin)*0.01+fMin;
   return pWnd;
}

References TieSlider().

Here is the call graph for this function:

TranslateFromIndex()

wxString ShuttleGuiBase::TranslateFromIndex	(	const int	nIn,
		const wxArrayStringEx &	Choices
	)

Index-to-String.

Definition at line 1833 of file ShuttleGui.cpp.

{
   int n = nIn;
   if( n== wxNOT_FOUND )
      n=miNoMatchSelector;
   miNoMatchSelector = 0;
   if( n < (int)Choices.size() )
   {
      return Choices[n];
   }
   return wxT("");
}

References miNoMatchSelector, and wxT().

Referenced by TieChoice().

Here is the call graph for this function:

Here is the caller graph for this function:

TranslateToIndex()

int ShuttleGuiBase::TranslateToIndex	(	const wxString &	Value,
		const wxArrayStringEx &	Choices
	)

String-to-Index.

Definition at line 1823 of file ShuttleGui.cpp.

{
   int n = make_iterator_range( Choices ).index( Value );
   if( n == wxNOT_FOUND  )
      n=miNoMatchSelector;
   miNoMatchSelector = 0;
   return n;
}

References make_iterator_range(), and miNoMatchSelector.

Referenced by TieChoice().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateSizers()

void ShuttleGuiBase::UpdateSizers ( )

protected

Definition at line 2258 of file ShuttleGui.cpp.

{  UpdateSizersCore( false, wxEXPAND | wxALL );}

References UpdateSizersCore().

Referenced by AddCheckBox(), AddCheckBoxOnRight(), AddChoice(), AddCombo(), AddConstTextBox(), AddFixedText(), AddGrid(), AddListBox(), AddListControl(), AddListControlReportMode(), AddNumericTextBox(), AddReadOnlyText(), AddSlider(), AddSpinControl(), AddSpinCtrl(), ShuttleGui::AddStandardButtons(), AddTextBox(), AddTextWindow(), AddTitle(), AddTree(), AddVariableText(), DoAddRadioButton(), StartInvisiblePanel(), StartNotebook(), StartPanel(), StartScroller(), StartSimplebook(), StartStatic(), StartVerticalLay(), and TieRadioButton().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateSizersAtStart()

void ShuttleGuiBase::UpdateSizersAtStart ( )

protected

Definition at line 2267 of file ShuttleGui.cpp.

{  UpdateSizersCore( true, wxEXPAND | wxALL );}

References UpdateSizersCore().

Referenced by StartScroller().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateSizersC()

void ShuttleGuiBase::UpdateSizersC ( )

protected

Definition at line 2262 of file ShuttleGui.cpp.

{  UpdateSizersCore( false, wxALIGN_CENTRE | wxALL );}

References UpdateSizersCore().

Referenced by AddFixedText(), AddIcon(), and AddVariableText().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateSizersCore()

void ShuttleGuiBase::UpdateSizersCore ( bool  bPrepend, int  Flags, bool  prompt = false  )

protected

Definition at line 2204 of file ShuttleGui.cpp.

{
   if( mpWind && mpParent )
   {
      int useFlags = Flags;
 
      if ( !prompt && mItem.mWindowPositionFlags )
         // override the given Flags
         useFlags = mItem.mWindowPositionFlags;
 
      if (!prompt)
         ApplyItem( 0, mItem, mpWind, mpDlg );
 
      if( mpSizer){
         if( bPrepend )
         {
            mpSizer->Prepend(mpWind, miProp, useFlags, miBorder);
         }
         else
         {
            mpSizer->Add(mpWind, miProp, useFlags, miBorder);
         }
      }
 
      if (!prompt) {
         ApplyItem( 1, mItem, mpWind, mpDlg );
         // Reset to defaults
         mItem = {};
      }
   }
 
   if( mpSubSizer && mpSizer )
   {
      // When adding sizers into sizers, don't add a border.
      // unless it's a static box sizer.
      wxSizer *const pSubSizer = mpSubSizer.get();
      if (wxDynamicCast(pSubSizer, wxStaticBoxSizer))
      {
         mpSizer->Add( mpSubSizer.release(), miSizerProp, Flags , miBorder);
      }
      else
      {
         mpSizer->Add( mpSubSizer.release(), miSizerProp, Flags ,0);//miBorder);
      }
      mpSizer = pSubSizer;
      PushSizer();
   }
 
   mpWind = NULL;
   miProp = 0;
   miSizerProp =0;
}

References ApplyItem(), miBorder, miProp, miSizerProp, mItem, mpDlg, mpParent, mpSizer, mpSubSizer, mpWind, DialogDefinition::Item::mWindowPositionFlags, and PushSizer().

Referenced by AddBitmapButton(), AddButton(), AddPrompt(), AddUnits(), AddVariableText(), AddWindow(), StartHorizontalLay(), StartMultiColumn(), StartVerticalLay(), StartWrapLay(), UpdateSizers(), UpdateSizersAtStart(), and UpdateSizersC().

Here is the call graph for this function:

Here is the caller graph for this function:

UseUpId()

void ShuttleGuiBase::UseUpId

(

)

The Ids increment as we add NEW controls. However, the user can force the id manually, for example if they need a specific Id for a button, and then let it resume normal numbering later. UseUpId() sets miId to the next Id, either using the user specicfied one, or resuming the sequence.

Definition at line 2135 of file ShuttleGui.cpp.

{
   if( miIdSetByUser > 0)
   {
      miId = miIdSetByUser;
      miIdSetByUser = -1;
      return;
   }
   miId = miIdNext++;
}

References miId, miIdNext, and miIdSetByUser.

Referenced by AddBitmapButton(), AddButton(), AddCheckBox(), AddCheckBoxOnRight(), AddChoice(), AddCombo(), AddConstTextBox(), AddFixedText(), AddGrid(), AddIcon(), AddListBox(), AddListControl(), AddListControlReportMode(), AddNumericTextBox(), AddReadOnlyText(), AddSlider(), AddSpinControl(), AddSpinCtrl(), AddTextBox(), AddTextWindow(), AddTree(), AddVariableText(), DoAddRadioButton(), DoTieCheckBox(), DoTieCheckBoxOnRight(), DoTieNumericTextBox(), DoTieSlider(), DoTieSpinControl(), DoTieSpinCtrl(), DoTieTextBox(), StartInvisiblePanel(), StartNotebook(), StartPanel(), StartScroller(), StartSimplebook(), StartStatic(), TieChoice(), and TieRadioButton().

Here is the caller graph for this function:

Member Data Documentation

miBorder

int ShuttleGuiBase::miBorder

protected

Definition at line 547 of file ShuttleGui.h.

Referenced by GetBorder(), Init(), StartInvisiblePanel(), StartPanel(), and UpdateSizersCore().

miId

int ShuttleGuiBase::miId

protected

Definition at line 551 of file ShuttleGui.h.

Referenced by AddBitmapButton(), AddButton(), AddCheckBox(), AddCheckBoxOnRight(), AddChoice(), AddCombo(), AddConstTextBox(), AddFixedText(), AddGrid(), AddIcon(), AddListBox(), AddListControl(), AddListControlReportMode(), AddNumericTextBox(), AddPrompt(), AddReadOnlyText(), AddSlider(), AddSpinControl(), AddSpinCtrl(), AddTextBox(), AddTextWindow(), AddTree(), AddVariableText(), DoAddRadioButton(), DoTieCheckBox(), DoTieCheckBoxOnRight(), DoTieNumericTextBox(), DoTieSlider(), DoTieSpinControl(), DoTieSpinCtrl(), DoTieTextBox(), ResetId(), StartInvisiblePanel(), StartNotebook(), StartPanel(), StartScroller(), StartSimplebook(), StartStatic(), TieChoice(), TieRadioButton(), and UseUpId().

miIdNext

int ShuttleGuiBase::miIdNext

protected

Definition at line 552 of file ShuttleGui.h.

Referenced by ResetId(), and UseUpId().

miIdSetByUser

int ShuttleGuiBase::miIdSetByUser

protected

Definition at line 553 of file ShuttleGui.h.

Referenced by ShuttleGui::Id(), ResetId(), and UseUpId().

miNoMatchSelector

int ShuttleGuiBase::miNoMatchSelector

protected

Controls source/destination of shuttled data. You can leave this NULL if you are shuttling to variables

Definition at line 541 of file ShuttleGui.h.

Referenced by Init(), TieNumberAsChoice(), TranslateFromIndex(), and TranslateToIndex().

miProp

int ShuttleGuiBase::miProp

protected

Definition at line 548 of file ShuttleGui.h.

Referenced by AddBitmapButton(), AddButton(), AddCheckBox(), AddCheckBoxOnRight(), AddChoice(), AddCombo(), AddConstTextBox(), AddFixedText(), AddNumericTextBox(), AddPrompt(), AddReadOnlyText(), AddSlider(), AddSpinControl(), AddSpinCtrl(), AddTextBox(), AddUnits(), AddVariableText(), Init(), SetProportions(), and UpdateSizersCore().

miPropSetByUser

int ShuttleGuiBase::miPropSetByUser

protected

Definition at line 555 of file ShuttleGui.h.

Referenced by Init(), Prop(), and SetProportions().

miSizerProp

int ShuttleGuiBase::miSizerProp

protected

Definition at line 545 of file ShuttleGui.h.

Referenced by ShuttleGui::AddStandardButtons(), Init(), StartHorizontalLay(), StartStatic(), StartVerticalLay(), StartWrapLay(), and UpdateSizersCore().

mItem

DialogDefinition::Item ShuttleGuiBase::mItem

protected

Definition at line 592 of file ShuttleGui.h.

Referenced by AddReadOnlyText(), AddSlider(), GetStyle(), and UpdateSizersCore().

mpbOptionalFlag

bool* ShuttleGuiBase::mpbOptionalFlag

protected

Definition at line 557 of file ShuttleGui.h.

Referenced by AddCheckBox(), AddPrompt(), HandleOptionality(), ShuttleGui::Optional(), and ShuttleGuiBase().

mpDlg

wxWindow* const ShuttleGuiBase::mpDlg

protected

Definition at line 536 of file ShuttleGui.h.

Referenced by AddBitmapButton(), AddButton(), AddCheckBox(), AddCheckBoxOnRight(), AddChoice(), AddCombo(), AddGrid(), AddListBox(), AddListControl(), AddListControlReportMode(), AddNumericTextBox(), AddPrompt(), AddReadOnlyText(), AddSlider(), AddSpinControl(), AddSpinCtrl(), AddTextBox(), AddTextWindow(), AddTree(), AddVariableText(), DoAddRadioButton(), DoTieCheckBox(), DoTieCheckBoxOnRight(), DoTieNumericTextBox(), DoTieSlider(), DoTieSpinControl(), DoTieSpinCtrl(), DoTieTextBox(), StartInvisiblePanel(), StartNotebook(), StartPanel(), StartScroller(), StartSimplebook(), TieChoice(), TieRadioButton(), and UpdateSizersCore().

mpParent

wxWindow* ShuttleGuiBase::mpParent

protected

Definition at line 561 of file ShuttleGui.h.

Referenced by ShuttleGui::AddStandardButtons(), EndNotebook(), EndNotebookPage(), EndPanel(), EndScroller(), EndSimplebook(), EndStatic(), Init(), ShuttleGuiBase(), StartInvisiblePanel(), StartNotebook(), StartNotebookPage(), StartPanel(), StartScroller(), StartSimplebook(), StartStatic(), and UpdateSizersCore().

mpShuttle

std::unique_ptr<ShuttlePrefs> ShuttleGuiBase::mpShuttle

protected

Definition at line 539 of file ShuttleGui.h.

Referenced by DoDataShuttle(), Init(), and ShuttleGui::ShuttleGui().

mpSizer

wxSizer* ShuttleGuiBase::mpSizer

protected

Definition at line 560 of file ShuttleGui.h.

Referenced by ShuttleGui::AddSpace(), EndScroller(), Init(), PopSizer(), PushSizer(), SetStretchyCol(), SetStretchyRow(), StartInvisiblePanel(), StartNotebookPage(), StartPanel(), StartScroller(), and UpdateSizersCore().

mpSubSizer

std::unique_ptr<wxSizer> ShuttleGuiBase::mpSubSizer

protected

Definition at line 559 of file ShuttleGui.h.

Referenced by ShuttleGui::AddStandardButtons(), Init(), StartHorizontalLay(), StartMultiColumn(), StartStatic(), StartVerticalLay(), StartWrapLay(), and UpdateSizersCore().

mpWind

wxWindow* ShuttleGuiBase::mpWind

protected

Definition at line 562 of file ShuttleGui.h.

Referenced by AddBitmapButton(), AddButton(), AddCheckBox(), AddCheckBoxOnRight(), AddChoice(), AddCombo(), AddConstTextBox(), AddFixedText(), AddGrid(), AddIcon(), AddListBox(), AddListControl(), AddListControlReportMode(), AddNumericTextBox(), AddPrompt(), AddReadOnlyText(), AddSlider(), AddSpinControl(), AddSpinCtrl(), AddTextBox(), AddTextWindow(), AddTitle(), AddTree(), AddUnits(), AddVariableText(), AddWindow(), DoAddRadioButton(), Init(), StartInvisiblePanel(), StartNotebook(), StartPanel(), StartScroller(), StartSimplebook(), TieRadioButton(), and UpdateSizersCore().

mRadioCount

int ShuttleGuiBase::mRadioCount

private

The wrapped value associated with the active radio button.

Definition at line 586 of file ShuttleGui.h.

Referenced by EndRadioButtonGroup(), Init(), StartRadioButtonGroup(), and TieRadioButton().

mRadioSettingName

wxString ShuttleGuiBase::mRadioSettingName

private

Definition at line 584 of file ShuttleGui.h.

Referenced by EndRadioButtonGroup(), Init(), and StartRadioButtonGroup().

mRadioSymbols

std::vector<EnumValueSymbol> ShuttleGuiBase::mRadioSymbols

private

Definition at line 583 of file ShuttleGui.h.

Referenced by EndRadioButtonGroup(), StartRadioButtonGroup(), and TieRadioButton().

mRadioValue

std::optional<WrappedType> ShuttleGuiBase::mRadioValue

private

The setting controlled by a group.

Definition at line 585 of file ShuttleGui.h.

Referenced by EndRadioButtonGroup(), StartRadioButtonGroup(), and TieRadioButton().

mRadioValueString

wxString ShuttleGuiBase::mRadioValueString

private

The index of this radio item. -1 for none.

Definition at line 587 of file ShuttleGui.h.

Referenced by StartRadioButtonGroup().

mShuttleMode

teShuttleMode ShuttleGuiBase::mShuttleMode

protected

Used in choices to determine which item to use on no match.

Definition at line 543 of file ShuttleGui.h.

Referenced by AddBitmapButton(), AddButton(), AddCheckBox(), AddCheckBoxOnRight(), AddChoice(), AddCombo(), AddConstTextBox(), AddFixedText(), AddGrid(), AddIcon(), AddListBox(), AddListControl(), AddListControlReportMode(), AddNumericTextBox(), AddPrompt(), AddReadOnlyText(), AddSlider(), ShuttleGui::AddSpace(), AddSpinControl(), AddSpinCtrl(), ShuttleGui::AddStandardButtons(), AddTextBox(), AddTextWindow(), AddTitle(), AddTree(), AddUnits(), AddVariableText(), AddWindow(), DoAddRadioButton(), DoStep(), DoTieCheckBox(), DoTieCheckBoxOnRight(), DoTieNumericTextBox(), DoTieSlider(), DoTieSpinControl(), DoTieSpinCtrl(), DoTieTextBox(), EndHorizontalLay(), EndMultiColumn(), EndNotebookPage(), EndPanel(), EndRadioButtonGroup(), EndScroller(), EndStatic(), EndVerticalLay(), EndWrapLay(), HandleOptionality(), Init(), SetStretchyCol(), SetStretchyRow(), ShuttleGui::ShuttleGui(), ShuttleGuiBase(), StartHorizontalLay(), StartInvisiblePanel(), StartMultiColumn(), StartNotebook(), StartNotebookPage(), StartPanel(), StartRadioButtonGroup(), StartScroller(), StartSimplebook(), StartStatic(), StartVerticalLay(), StartWrapLay(), TieCheckBoxOnRight(), TieChoice(), and TieRadioButton().

mSizerDepth

int ShuttleGuiBase::mSizerDepth

protected

Definition at line 546 of file ShuttleGui.h.

Referenced by Init(), PopSizer(), and PushSizer().

pSizerStack

wxSizer* ShuttleGuiBase::pSizerStack[nMaxNestedSizers]

protected

Definition at line 537 of file ShuttleGui.h.

Referenced by PopSizer(), and PushSizer().

---

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

• ShuttleGui.h
• ShuttleGui.cpp