Audacity 3.2.0
Public Member Functions | List of all members
anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition Class Reference

Shuttle that retrieves a JSON format definition of a command's parameters. More...

Inheritance diagram for anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition:
[legend]
Collaboration diagram for anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition:
[legend]

Public Member Functions

 ShuttleGuiGetDefinition (wxWindow *pParent, CommandMessageTarget &target)
 
virtual ~ShuttleGuiGetDefinition ()
 
wxCheckBox * TieCheckBox (const TranslatableString &Prompt, const BoolSetting &Setting) override
 
wxCheckBox * TieCheckBoxOnRight (const TranslatableString &Prompt, const BoolSetting &Setting) override
 
wxChoice * TieChoice (const TranslatableString &Prompt, ChoiceSetting &choiceSetting) override
 
wxChoice * TieNumberAsChoice (const TranslatableString &Prompt, IntSetting &Setting, const TranslatableStrings &Choices, const std::vector< int > *pInternalChoices, int iNoMatchSelector) override
 
wxTextCtrl * TieTextBox (const TranslatableString &Prompt, const StringSetting &Setting, const int nChars) override
 
wxTextCtrl * TieIntegerTextBox (const TranslatableString &Prompt, const IntSetting &Setting, const int nChars) override
 
wxTextCtrl * TieNumericTextBox (const TranslatableString &Prompt, const DoubleSetting &Setting, const int nChars, bool acceptEnter) override
 
wxSlider * TieSlider (const TranslatableString &Prompt, const IntSetting &Setting, const int max, const int min=0) override
 
wxSpinCtrl * TieSpinCtrl (const TranslatableString &Prompt, const IntSetting &Setting, const int max, const int min) override
 
- Public Member Functions inherited from ShuttleGui
 ShuttleGui (wxWindow *pParent, teShuttleMode ShuttleMode, bool vertical=true, wxSize minSize={ 250, 100 })
 
 ~ShuttleGui (void)
 
ShuttleGuiOptional (bool &bVar)
 
ShuttleGuiId (int id)
 
ShuttleGuiFocus (bool focused=true)
 
ShuttleGuiDisable (bool disabled=true)
 
ShuttleGuiToolTip (const TranslatableString &tip)
 
ShuttleGuiName (const TranslatableString &name)
 
ShuttleGuiNameSuffix (const TranslatableString &suffix)
 
template<typename Factory >
ShuttleGuiValidator (const Factory &f)
 
template<typename V , typename... Args>
ShuttleGuiValidator (Args &&...args)
 
template<typename Tag , typename Argument , typename Handler >
auto ConnectRoot (wxEventTypeTag< Tag > eventType, void(Handler::*func)(Argument &)) -> std::enable_if_t< std::is_base_of_v< Argument, Tag >, ShuttleGui & >
 
ShuttleGuiPosition (int flags)
 
ShuttleGuiSize (wxSize size)
 
ShuttleGuiProp (int iProp)
 
ShuttleGuiStyle (long iStyle)
 
ShuttleGuiMinSize ()
 
ShuttleGuiMinSize (wxSize sz)
 
void AddStandardButtons (long buttons=eOkButton|eCancelButton, wxWindow *extra=NULL)
 
wxSizerItem * AddSpace (int width, int height, int prop=0)
 
wxSizerItem * AddSpace (int size)
 
teShuttleMode GetMode ()
 
- Public Member Functions inherited from ShuttleGuiBase
 ShuttleGuiBase (wxWindow *pParent, teShuttleMode ShuttleMode, bool vertical, wxSize minSize)
 
virtual ~ShuttleGuiBase ()
 
void Init (bool vertical, wxSize minSize)
 
void ResetId ()
 
void HandleOptionality (const TranslatableString &Prompt)
 
wxStaticText * AddPrompt (const TranslatableString &Prompt, int wrapWidth=0)
 Right aligned text string. More...
 
void AddUnits (const TranslatableString &Prompt, int wrapWidth=0)
 Left aligned text string. More...
 
void AddTitle (const TranslatableString &Prompt, int wrapWidth=0)
 Centred text string. More...
 
wxWindow * AddWindow (wxWindow *pWindow, int PositionFlags=wxALIGN_CENTRE)
 
wxSlider * AddSlider (const TranslatableString &Prompt, int pos, int Max, int Min=0)
 
wxSlider * AddVSlider (const TranslatableString &Prompt, int pos, int Max)
 
wxSpinCtrl * AddSpinCtrl (const TranslatableString &Prompt, int Value, int Max, int Min)
 
SpinControlAddSpinControl (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)
 
ReadOnlyTextAddReadOnlyText (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 ()
 
wxNotebookPageStartNotebookPage (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)
 
SpinControlTieSpinControl (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 ()
 
ShuttleGuiBaseProp (int iProp)
 
void UseUpId ()
 
wxSizer * GetSizer ()
 
- Public Member Functions inherited from CommandMessageTargetDecorator
 CommandMessageTargetDecorator (CommandMessageTarget &target)
 
 ~CommandMessageTargetDecorator () override
 
void Update (const wxString &message) override
 
void StartArray () override
 
void EndArray () override
 
void StartStruct () override
 
void EndStruct () override
 
void AddItem (const wxString &value, const wxString &name={}) override
 
void AddBool (const bool value, const wxString &name={}) override
 
void AddItem (const double value, const wxString &name={}) override
 
void StartField (const wxString &name={}) override
 
void EndField () override
 
void Flush () override
 
- Public Member Functions inherited from CommandMessageTarget
 CommandMessageTarget ()
 
virtual ~CommandMessageTarget ()
 
virtual void Update (const wxString &message)=0
 
virtual void StartArray ()
 
virtual void EndArray ()
 
virtual void StartStruct ()
 
virtual void EndStruct ()
 
virtual void AddItem (const wxString &value, const wxString &name={})
 
virtual void AddBool (const bool value, const wxString &name={})
 
virtual void AddItem (const double value, const wxString &name={})
 
virtual void StartField (const wxString &name={})
 
virtual void EndField ()
 
virtual void Flush ()
 
wxString Escaped (const wxString &str)
 

Additional Inherited Members

- Static Public Member Functions inherited from ShuttleGui
static void SetMinSize (wxWindow *window, const TranslatableStrings &items)
 
static void SetMinSize (wxWindow *window, const wxArrayStringEx &items)
 
- Static Public Member Functions inherited from ShuttleGuiBase
static void ApplyItem (int step, const DialogDefinition::Item &item, wxWindow *pWind, wxWindow *pDlg)
 
- Public Attributes inherited from CommandMessageTargetDecorator
CommandMessageTargetmTarget
 
- Public Attributes inherited from CommandMessageTarget
std::vector< int > mCounts
 
- Protected Member Functions inherited from ShuttleGuiBase
void SetProportions (int Default)
 
void PushSizer ()
 
void PopSizer ()
 
void UpdateSizersCore (bool bPrepend, int Flags, bool prompt=false)
 
void UpdateSizers ()
 
void UpdateSizersC ()
 
void UpdateSizersAtStart ()
 
long GetStyle (long Style)
 
- Protected Attributes inherited from ShuttleGuiBase
wxWindow *const mpDlg
 
wxSizer * pSizerStack [nMaxNestedSizers]
 
std::unique_ptr< ShuttlePrefsmpShuttle
 
int miNoMatchSelector
 
teShuttleMode mShuttleMode
 Used in choices to determine which item to use on no match. More...
 
int miSizerProp
 
int mSizerDepth
 
int miBorder
 
int miProp
 
int miId
 
int miIdNext
 
int miIdSetByUser
 
int miPropSetByUser
 
bool * mpbOptionalFlag
 
std::unique_ptr< wxSizer > mpSubSizer
 
wxSizer * mpSizer
 
wxWindow * mpParent
 
wxWindow * mpWind
 
DialogDefinition::Item mItem
 

Detailed Description

Shuttle that retrieves a JSON format definition of a command's parameters.

Definition at line 221 of file GetInfoCommand.cpp.

Constructor & Destructor Documentation

◆ ShuttleGuiGetDefinition()

anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::ShuttleGuiGetDefinition ( wxWindow *  pParent,
CommandMessageTarget target 
)

Definition at line 266 of file GetInfoCommand.cpp.

268: ShuttleGui( pParent, eIsGettingMetadata ),
270{
271
272}
@ eIsGettingMetadata
Definition: ShuttleGui.h:40
CommandMessageTargetDecorator(CommandMessageTarget &target)
ShuttleGui(wxWindow *pParent, teShuttleMode ShuttleMode, bool vertical=true, wxSize minSize={ 250, 100 })

◆ ~ShuttleGuiGetDefinition()

anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::~ShuttleGuiGetDefinition ( void  )
virtual

Definition at line 273 of file GetInfoCommand.cpp.

274{
275}

Member Function Documentation

◆ TieCheckBox()

wxCheckBox * anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieCheckBox ( const TranslatableString Prompt,
const BoolSetting Setting 
)
overridevirtual

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

Reimplemented from ShuttleGuiBase.

Definition at line 277 of file GetInfoCommand.cpp.

280{
281 StartStruct();
282 AddItem( Setting.GetPath(), "id" );
283 AddItem( Prompt.Translation(), "prompt" );
284 AddItem( "bool", "type" );
285 AddBool( Setting.GetDefault(), "default" );
286 EndStruct();
287 return ShuttleGui::TieCheckBox( Prompt, Setting );
288}
void AddBool(const bool value, const wxString &name={}) override
void AddItem(const wxString &value, const wxString &name={}) override
const SettingPath & GetPath() const
Definition: Prefs.h:88
Definition: Prefs.h:178
const T & GetDefault() const
Definition: Prefs.h:199
wxCheckBox * TieCheckBox(const TranslatableString &Prompt, bool &Var)
wxString Translation() const

References CommandMessageTargetDecorator::AddBool(), CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), Setting< T >::GetDefault(), SettingBase::GetPath(), CommandMessageTargetDecorator::StartStruct(), ShuttleGuiBase::TieCheckBox(), and TranslatableString::Translation().

Here is the call graph for this function:

◆ TieCheckBoxOnRight()

wxCheckBox * anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieCheckBoxOnRight ( const TranslatableString Prompt,
const BoolSetting Setting 
)
overridevirtual

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

Reimplemented from ShuttleGuiBase.

Definition at line 290 of file GetInfoCommand.cpp.

293{
294 StartStruct();
295 AddItem( Setting.GetPath(), "id" );
296 AddItem( Prompt.Translation(), "prompt" );
297 AddItem( "bool", "type" );
298 AddBool( Setting.GetDefault(), "default" );
299 EndStruct();
300 return ShuttleGui::TieCheckBoxOnRight( Prompt, Setting );
301}
wxCheckBox * TieCheckBoxOnRight(const TranslatableString &Prompt, bool &Var)

References CommandMessageTargetDecorator::AddBool(), CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), Setting< T >::GetDefault(), SettingBase::GetPath(), CommandMessageTargetDecorator::StartStruct(), ShuttleGuiBase::TieCheckBoxOnRight(), and TranslatableString::Translation().

Here is the call graph for this function:

◆ TieChoice()

wxChoice * anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieChoice ( const TranslatableString Prompt,
ChoiceSetting choiceSetting 
)
overridevirtual

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

Parameters
PromptThe prompt shown beside the control.
SettingEncapsulates setting name, internal and visible choice strings, and a designation of one of those as default.

Reimplemented from ShuttleGuiBase.

Definition at line 303 of file GetInfoCommand.cpp.

305{
306 StartStruct();
307 AddItem( choiceSetting.Key(), "id" );
308 AddItem( Prompt.Translation(), "prompt" );
309 AddItem( "enum", "type" );
310 AddItem( choiceSetting.Default().Internal(), "default" );
311 StartField( "enum" );
312 StartArray();
313 for ( const auto &choice : choiceSetting.GetSymbols().GetInternals() )
314 AddItem( choice );
315 EndArray();
316 EndField();
317 EndStruct();
318 return ShuttleGui::TieChoice( Prompt, choiceSetting );
319}
const wxString & Key() const
Definition: Prefs.h:439
const EnumValueSymbols & GetSymbols() const
Definition: Prefs.h:441
const EnumValueSymbol & Default() const
Definition: Prefs.cpp:380
void StartField(const wxString &name={}) override
const wxString & Internal() const
const wxArrayStringEx & GetInternals() const
Definition: Prefs.cpp:371
wxChoice * TieChoice(const TranslatableString &Prompt, TranslatableString &Selected, const TranslatableStrings &choices)

References CommandMessageTargetDecorator::AddItem(), ChoiceSetting::Default(), CommandMessageTargetDecorator::EndArray(), CommandMessageTargetDecorator::EndField(), CommandMessageTargetDecorator::EndStruct(), EnumValueSymbols::GetInternals(), ChoiceSetting::GetSymbols(), ComponentInterfaceSymbol::Internal(), ChoiceSetting::Key(), CommandMessageTargetDecorator::StartArray(), CommandMessageTargetDecorator::StartField(), CommandMessageTargetDecorator::StartStruct(), ShuttleGuiBase::TieChoice(), and TranslatableString::Translation().

Here is the call graph for this function:

◆ TieIntegerTextBox()

wxTextCtrl * anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieIntegerTextBox ( const TranslatableString Prompt,
const IntSetting Setting,
const int  nChars 
)
overridevirtual

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 from ShuttleGuiBase.

Definition at line 354 of file GetInfoCommand.cpp.

358{
359 StartStruct();
360 AddItem( Setting.GetPath(), "id" );
361 AddItem( Prompt.Translation(), "prompt" );
362 AddItem( "number", "type" );
363 AddItem( Setting.GetDefault(), "default" );
364 EndStruct();
365 return ShuttleGui::TieIntegerTextBox( Prompt, Setting, nChars );
366}
virtual wxTextCtrl * TieIntegerTextBox(const TranslatableString &Prompt, const IntSetting &Setting, const int nChars)

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), Setting< T >::GetDefault(), SettingBase::GetPath(), CommandMessageTargetDecorator::StartStruct(), ShuttleGuiBase::TieIntegerTextBox(), and TranslatableString::Translation().

Here is the call graph for this function:

◆ TieNumberAsChoice()

wxChoice * anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieNumberAsChoice ( const TranslatableString Prompt,
IntSetting Setting,
const TranslatableStrings Choices,
const std::vector< int > *  pInternalChoices,
int  iNoMatchSelector 
)
overridevirtual

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
PromptThe prompt shown beside the control.
SettingNameThe setting name as stored in gPrefs
DefaultThe default integer value for this control
ChoicesAn array of choices that appear on screen.
pInternalChoicesThe corresponding values (as an integer array) if null, then use 0, 1, 2, ...

Reimplemented from ShuttleGuiBase.

Definition at line 321 of file GetInfoCommand.cpp.

326{
327 // Come here for controls that present non-exhaustive choices among some
328 // numbers, with an associated control that allows arbitrary entry of an
329 // "Other..."
330 StartStruct();
331 AddItem( Setting.GetPath(), "id" );
332 AddItem( Prompt.Translation(), "prompt" );
333 AddItem( "number", "type" ); // not "enum" !
334 AddItem( Setting.GetDefault(), "default" );
335 EndStruct();
337 Prompt, Setting, Choices, pInternalChoices, iNoMatchSelector );
338}
virtual wxChoice * TieNumberAsChoice(const TranslatableString &Prompt, IntSetting &Setting, const TranslatableStrings &Choices, const std::vector< int > *pInternalChoices=nullptr, int iNoMatchSelector=0)

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), Setting< T >::GetDefault(), SettingBase::GetPath(), CommandMessageTargetDecorator::StartStruct(), ShuttleGuiBase::TieNumberAsChoice(), and TranslatableString::Translation().

Here is the call graph for this function:

◆ TieNumericTextBox()

wxTextCtrl * anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieNumericTextBox ( const TranslatableString Prompt,
const DoubleSetting Setting,
const int  nChars,
bool  acceptEnter 
)
overridevirtual

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 from ShuttleGuiBase.

Definition at line 368 of file GetInfoCommand.cpp.

372{
373 StartStruct();
374 AddItem( Setting.GetPath(), "id" );
375 AddItem( Prompt.Translation(), "prompt" );
376 AddItem( "number", "type" );
377 AddItem( Setting.GetDefault(), "default" );
378 EndStruct();
379 return ShuttleGui::TieNumericTextBox( Prompt, Setting, nChars, acceptEnter );
380}
wxTextCtrl * TieNumericTextBox(const TranslatableString &Prompt, int &Value, const int nChars=0, bool acceptEnter=false)

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), Setting< T >::GetDefault(), SettingBase::GetPath(), CommandMessageTargetDecorator::StartStruct(), ShuttleGuiBase::TieNumericTextBox(), and TranslatableString::Translation().

Here is the call graph for this function:

◆ TieSlider()

wxSlider * anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieSlider ( const TranslatableString Prompt,
const IntSetting Setting,
const int  max,
const int  min = 0 
)
overridevirtual

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

Reimplemented from ShuttleGuiBase.

Definition at line 382 of file GetInfoCommand.cpp.

387{
388 StartStruct();
389 AddItem( Setting.GetPath(), "id" );
390 AddItem( Prompt.Translation(), "prompt" );
391 AddItem( "number", "type" );
392 AddItem( Setting.GetDefault(), "default" );
393 EndStruct();
394 return ShuttleGui::TieSlider( Prompt, Setting, max, min );
395}
int min(int a, int b)
wxSlider * TieSlider(const TranslatableString &Prompt, int &pos, const int max, const int min=0)

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), Setting< T >::GetDefault(), SettingBase::GetPath(), min(), CommandMessageTargetDecorator::StartStruct(), ShuttleGuiBase::TieSlider(), and TranslatableString::Translation().

Here is the call graph for this function:

◆ TieSpinCtrl()

wxSpinCtrl * anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieSpinCtrl ( const TranslatableString Prompt,
const IntSetting Setting,
const int  max,
const int  min 
)
overridevirtual

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

Reimplemented from ShuttleGuiBase.

Definition at line 397 of file GetInfoCommand.cpp.

402{
403 StartStruct();
404 AddItem( Setting.GetPath(), "id" );
405 AddItem( Prompt.Translation(), "prompt" );
406 AddItem( "number", "type" );
407 AddItem( Setting.GetDefault(), "default" );
408 EndStruct();
409 return ShuttleGui::TieSpinCtrl( Prompt, Setting, max, min );
410}
wxSpinCtrl * TieSpinCtrl(const TranslatableString &Prompt, int &Value, const int max, const int min=0)

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), Setting< T >::GetDefault(), SettingBase::GetPath(), min(), CommandMessageTargetDecorator::StartStruct(), ShuttleGuiBase::TieSpinCtrl(), and TranslatableString::Translation().

Here is the call graph for this function:

◆ TieTextBox()

wxTextCtrl * anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieTextBox ( const TranslatableString Prompt,
const StringSetting Setting,
const int  nChars 
)
overridevirtual

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

Reimplemented from ShuttleGuiBase.

Definition at line 340 of file GetInfoCommand.cpp.

344{
345 StartStruct();
346 AddItem( Setting.GetPath(), "id" );
347 AddItem( Prompt.Translation(), "prompt" );
348 AddItem( "string", "type" );
349 AddItem( Setting.GetDefault(), "default" );
350 EndStruct();
351 return ShuttleGui::TieTextBox( Prompt, Setting, nChars );
352}
wxTextCtrl * TieTextBox(const TranslatableString &Caption, wxString &Value, const int nChars=0)

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), Setting< T >::GetDefault(), SettingBase::GetPath(), CommandMessageTargetDecorator::StartStruct(), ShuttleGuiBase::TieTextBox(), and TranslatableString::Translation().

Here is the call graph for this function:

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