Audacity  2.2.2
Public Member Functions | List of all members
ShuttleGuiGetDefinition Class Reference

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

#include <ShuttleGui.h>

Inheritance diagram for ShuttleGuiGetDefinition:
ShuttleGui CommandMessageTargetDecorator ShuttleGuiBase CommandMessageTarget

Public Member Functions

 ShuttleGuiGetDefinition (wxWindow *pParent, CommandMessageTarget &target)
 
virtual ~ShuttleGuiGetDefinition ()
 
wxCheckBox * TieCheckBox (const wxString &Prompt, const wxString &SettingName, const bool bDefault) override
 
wxCheckBox * TieCheckBoxOnRight (const wxString &Prompt, const wxString &SettingName, const bool bDefault) override
 
wxChoice * TieChoice (const wxString &Prompt, const wxString &SettingName, const wxString &Default, const wxArrayString &Choices, const wxArrayString &InternalChoices) override
 
wxChoice * TieChoice (const wxString &Prompt, const wxString &SettingName, const int Default, const wxArrayString &Choices, const std::vector< int > &InternalChoices) override
 
wxChoice * TieNumberAsChoice (const wxString &Prompt, const wxString &SettingName, const int Default, const wxArrayString &Choices, const std::vector< int > &InternalChoices) override
 
wxTextCtrl * TieTextBox (const wxString &Prompt, const wxString &SettingName, const wxString &Default, const int nChars) override
 
wxTextCtrl * TieTextBox (const wxString &Prompt, const wxString &SettingName, const double &Default, const int nChars) override
 
wxTextCtrl * TieNumericTextBox (const wxString &Prompt, const wxString &SettingName, const wxString &Default, const int nChars) override
 
wxTextCtrl * TieNumericTextBox (const wxString &Prompt, const wxString &SettingName, const double &Default, const int nChars) override
 
wxSlider * TieSlider (const wxString &Prompt, const wxString &SettingName, const int iDefault, const int max, const int min=0) override
 
wxSpinCtrl * TieSpinCtrl (const wxString &Prompt, const wxString &SettingName, const int Value, const int max, const int min) override
 
- Public Member Functions inherited from ShuttleGui
 ShuttleGui (wxWindow *pParent, teShuttleMode ShuttleMode)
 
 ~ShuttleGui (void)
 
ShuttleGuiOptional (bool &bVar)
 
ShuttleGuiId (int id)
 
ShuttleGuiProp (int iProp)
 
GuiWaveTrack * AddGuiWaveTrack (const wxString &Name)
 
AttachableScrollBarAddAttachableScrollBar (long style=wxSB_HORIZONTAL)
 
void AddStandardButtons (long buttons=eOkButton|eCancelButton, wxButton *extra=NULL)
 
wxSizerItem * AddSpace (int width, int height)
 
wxSizerItem * AddSpace (int size)
 
teShuttleMode GetMode ()
 
- Public Member Functions inherited from ShuttleGuiBase
 ShuttleGuiBase (wxWindow *pParent, teShuttleMode ShuttleMode)
 
virtual ~ShuttleGuiBase ()
 
void Init ()
 
void ResetId ()
 
void HandleOptionality (const wxString &Prompt)
 
void AddPrompt (const wxString &Prompt)
 Right aligned text string. More...
 
void AddUnits (const wxString &Prompt)
 Left aligned text string. More...
 
void AddTitle (const wxString &Prompt)
 Centred text string. More...
 
wxWindow * AddWindow (wxWindow *pWindow, int Flags=wxALIGN_CENTRE|wxALL)
 
wxSlider * AddSlider (const wxString &Prompt, int pos, int Max, int Min=0)
 
wxSlider * AddVSlider (const wxString &Prompt, int pos, int Max)
 
wxSpinCtrl * AddSpinCtrl (const wxString &Prompt, int Value, int Max, int Min)
 
wxTreeCtrl * AddTree ()
 
wxRadioButton * AddRadioButton (const wxString &Prompt)
 
wxRadioButton * AddRadioButtonToGroup (const wxString &Prompt)
 
wxButton * AddButton (const wxString &Text, int PositionFlags=wxALIGN_CENTRE)
 
wxBitmapButton * AddBitmapButton (const wxBitmap &Bitmap, int PositionFlags=wxALIGN_CENTRE)
 
wxStaticText * AddVariableText (const wxString &Str, bool bCenter=false, int PositionFlags=0)
 
wxTextCtrl * AddTextBox (const wxString &Caption, const wxString &Value, const int nChars)
 
wxTextCtrl * AddNumericTextBox (const wxString &Caption, const wxString &Value, const int nChars)
 
wxTextCtrl * AddTextWindow (const wxString &Value)
 Multiline text box that grows. More...
 
wxListBox * AddListBox (const wxArrayString *pChoices, long style=0)
 
wxListCtrl * AddListControl ()
 
wxListCtrl * AddListControlReportMode ()
 
wxGrid * AddGrid ()
 
wxCheckBox * AddCheckBox (const wxString &Prompt, const wxString &Selected)
 
wxCheckBox * AddCheckBoxOnRight (const wxString &Prompt, const wxString &Selected)
 
wxComboBox * AddCombo (const wxString &Prompt, const wxString &Selected, const wxArrayString *pChoices, long style=0)
 
wxChoice * AddChoice (const wxString &Prompt, const wxString &Selected, const wxArrayString *pChoices)
 
wxMenuBar * AddMenuBar ()
 
wxMenu * AddMenu (const wxString &Title)
 
void AddIcon (wxBitmap *pBmp)
 
void AddIconButton (const wxString &Command, const wxString &Params, wxBitmap *pBmp)
 
void AddFixedText (const wxString &Str, bool bCenter=false)
 
void AddConstTextBox (const wxString &Caption, const wxString &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 ()
 
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 wxString &Str, int iProp=0)
 
void EndStatic ()
 
wxNotebook * StartNotebook ()
 
void EndNotebook ()
 
wxNotebookPageStartNotebookPage (const wxString &Name)
 
void StartNotebookPage (const wxString &Name, wxNotebookPage *pPage)
 
void EndNotebookPage ()
 
wxPanel * StartInvisiblePanel ()
 
void EndInvisiblePanel ()
 
void StartRadioButtonGroup (const wxString &SettingName)
 
void EndRadioButtonGroup ()
 
void StartRadioButtonGroup (const wxString &SettingName, const int iDefaultValue)
 
void StartRadioButtonGroup (const wxString &SettingName, const wxString &DefaultValue)
 
void DoDataShuttle (const wxString &Name, WrappedType &WrappedRef)
 
bool DoStep (int iStep)
 
int TranslateToIndex (const wxString &Value, const wxArrayString &Choices)
 String-to-Index. More...
 
wxString TranslateFromIndex (const int nIn, const wxArrayString &Choices)
 Index-to-String. More...
 
int TranslateToIndex (const int Value, const std::vector< int > &Choices)
 Int-to-Index (choices can be items like e.g 0x400120 ) More...
 
int TranslateFromIndex (const int nIn, const std::vector< int > &Choices)
 Index-to-int (choices can be items like e.g 0x400120 ) More...
 
wxTextCtrl * TieTextBox (const wxString &Prompt, WrappedType &WrappedRef, const int nChars)
 
wxTextCtrl * TieTextBox (const wxString &Caption, wxString &Value, const int nChars=0)
 
wxTextCtrl * TieTextBox (const wxString &Prompt, int &Selected, const int nChars=0)
 
wxTextCtrl * TieTextBox (const wxString &Prompt, double &Value, const int nChars=0)
 
wxTextCtrl * TieNumericTextBox (const wxString &Prompt, WrappedType &WrappedRef, const int nChars)
 
wxTextCtrl * TieNumericTextBox (const wxString &Caption, wxString &Value, const int nChars=0)
 
wxTextCtrl * TieNumericTextBox (const wxString &Prompt, int &Selected, const int nChars=0)
 
wxTextCtrl * TieNumericTextBox (const wxString &Prompt, double &Value, const int nChars=0)
 
wxCheckBox * TieCheckBox (const wxString &Prompt, WrappedType &WrappedRef)
 
wxCheckBox * TieCheckBox (const wxString &Prompt, const wxString &Selected)
 
wxCheckBox * TieCheckBox (const wxString &Prompt, bool &Var)
 
wxCheckBox * TieCheckBoxOnRight (const wxString &Prompt, WrappedType &WrappedRef)
 
wxCheckBox * TieCheckBoxOnRight (const wxString &Prompt, bool &Var)
 
wxChoice * TieChoice (const wxString &Prompt, WrappedType &WrappedRef, const wxArrayString *pChoices)
 
wxChoice * TieChoice (const wxString &Prompt, wxString &Selected, const wxArrayString *pChoices)
 
wxChoice * TieChoice (const wxString &Prompt, int &Selected, const wxArrayString *pChoices)
 
wxSlider * TieSlider (const wxString &Prompt, WrappedType &WrappedRef, const int max, const int min=0)
 
wxSlider * TieSlider (const wxString &Prompt, int &pos, const int max, const int min=0)
 
wxSlider * TieSlider (const wxString &Prompt, double &pos, const double max, const double min=0.0)
 
wxSlider * TieSlider (const wxString &Prompt, float &pos, const float fMin, const float fMax)
 
wxSlider * TieVSlider (const wxString &Prompt, float &pos, const float fMin, const float fMax)
 
wxRadioButton * TieRadioButton (const wxString &Prompt, WrappedType &WrappedRef)
 
wxRadioButton * TieRadioButton (const wxString &Prompt, const int iValue)
 This function must be within a StartRadioButtonGroup - EndRadioButtonGroup pair. More...
 
wxRadioButton * TieRadioButton (const wxString &Prompt, const wxString &Value)
 This function must be within a StartRadioButtonGroup - EndRadioButtonGroup pair. More...
 
wxSpinCtrl * TieSpinCtrl (const wxString &Prompt, WrappedType &WrappedRef, const int max, const int min=0)
 
wxSpinCtrl * TieSpinCtrl (const wxString &Prompt, int &Value, const int max, const int min=0)
 
virtual wxChoice * TieChoice (const wxString &Prompt, EnumSetting &enumSetting)
 
void EnableCtrl (bool bEnable)
 
void SetSizeHints (int minX, int minY)
 Used to modify an already placed Window. More...
 
void SetBorder (int Border)
 
void SetStyle (int Style)
 
void SetNoMatchSelector (int iSelector)
 
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 ()
 
wxString Escaped (const wxString &str)
 

Additional Inherited Members

- Static Public Member Functions inherited from ShuttleGuiBase
static void SetSizeHints (wxWindow *window, const wxArrayString &items)
 
- Public Attributes inherited from CommandMessageTargetDecorator
CommandMessageTargetmTarget
 
- Public Attributes inherited from CommandMessageTarget
wxArrayInt mCounts
 
- Protected Member Functions inherited from ShuttleGuiBase
void SetProportions (int Default)
 
void PushSizer ()
 
void PopSizer ()
 
void UpdateSizersCore (bool bPrepend, int Flags)
 
void UpdateSizers ()
 
void UpdateSizersC ()
 
void UpdateSizersAtStart ()
 
long Style (long Style)
 
- Protected Attributes inherited from ShuttleGuiBase
wxWindow * mpLastWind
 
wxWindow * mpDlg
 
wxSizer * pSizerStack [nMaxNestedSizers]
 
std::unique_ptr< ShuttlempShuttle
 
int miNoMatchSelector
 
teShuttleMode mShuttleMode
 Used in choices to determine which item to use on no match. More...
 
wxString mSettingName
 
int mRadioCount
 The setting controlled by a group. More...
 
WrappedType mRadioValue
 The index of this radio item. -1 for none. More...
 
wxString mRadioValueString
 The wrapped value associated with the active radio button. More...
 
int mRadioValueInt
 Unwrapped string value. More...
 
int miSizerProp
 Unwrapped integer value. More...
 
int mSizerDepth
 
int miBorder
 
long miStyle
 
int miProp
 
int miId
 
int miIdNext
 
int miIdSetByUser
 
int miPropSetByUser
 
bool * mpbOptionalFlag
 
std::unique_ptr< wxSizer > mpSubSizer
 
wxSizer * mpSizer
 
wxWindow * mpParent
 
wxWindow * mpWind
 
wxMenuBar * mpMenuBar
 
wxMenu * mpMenu
 

Detailed Description

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

Definition at line 432 of file ShuttleGui.h.

Constructor & Destructor Documentation

ShuttleGuiGetDefinition::ShuttleGuiGetDefinition ( wxWindow *  pParent,
CommandMessageTarget target 
)

Definition at line 2415 of file ShuttleGui.cpp.

2417 : ShuttleGui( pParent, eIsGettingMetadata ),
2419 {
2420 
2421 }
ShuttleGui(wxWindow *pParent, teShuttleMode ShuttleMode)
CommandMessageTargetDecorator(CommandMessageTarget &target)
ShuttleGuiGetDefinition::~ShuttleGuiGetDefinition ( void  )
virtual

Definition at line 2422 of file ShuttleGui.cpp.

2423 {
2424 }

Member Function Documentation

wxCheckBox * ShuttleGuiGetDefinition::TieCheckBox ( const wxString &  Prompt,
const wxString &  SettingName,
const bool  bDefault 
)
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 2426 of file ShuttleGui.cpp.

References CommandMessageTargetDecorator::AddBool(), CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), CommandMessageTargetDecorator::StartStruct(), and ShuttleGuiBase::TieCheckBox().

2430 {
2431  StartStruct();
2432  AddItem( SettingName, "id" );
2433  AddItem( Prompt, "prompt" );
2434  AddItem( "bool", "type" );
2435  AddBool( bDefault, "default" );
2436  EndStruct();
2437  return ShuttleGui::TieCheckBox( Prompt, SettingName, bDefault );
2438 }
void AddBool(const bool value, const wxString &name="") override
void AddItem(const wxString &value, const wxString &name="") override
wxCheckBox * TieCheckBox(const wxString &Prompt, WrappedType &WrappedRef)
wxCheckBox * ShuttleGuiGetDefinition::TieCheckBoxOnRight ( const wxString &  Prompt,
const wxString &  SettingName,
const bool  bDefault 
)
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 2439 of file ShuttleGui.cpp.

References CommandMessageTargetDecorator::AddBool(), CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), CommandMessageTargetDecorator::StartStruct(), and ShuttleGuiBase::TieCheckBoxOnRight().

2443 {
2444  StartStruct();
2445  AddItem( SettingName, "id" );
2446  AddItem( Prompt, "prompt" );
2447  AddItem( "bool", "type" );
2448  AddBool( bDefault, "default" );
2449  EndStruct();
2450  return ShuttleGui::TieCheckBoxOnRight( Prompt, SettingName, bDefault );
2451 }
wxCheckBox * TieCheckBoxOnRight(const wxString &Prompt, WrappedType &WrappedRef)
void AddBool(const bool value, const wxString &name="") override
void AddItem(const wxString &value, const wxString &name="") override
wxChoice * ShuttleGuiGetDefinition::TieChoice ( const wxString &  Prompt,
const wxString &  SettingName,
const wxString &  Default,
const wxArrayString &  Choices,
const wxArrayString &  InternalChoices 
)
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.
SettingNameThe setting name as stored in gPrefs
DefaultThe default value for this control (translated)
ChoicesAn array of choices that appear on screen.
InternalChoicesThe corresponding values (as a string array)

Reimplemented from ShuttleGuiBase.

Definition at line 2452 of file ShuttleGui.cpp.

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndArray(), CommandMessageTargetDecorator::EndField(), CommandMessageTargetDecorator::EndStruct(), CommandMessageTargetDecorator::StartArray(), CommandMessageTargetDecorator::StartField(), CommandMessageTargetDecorator::StartStruct(), and ShuttleGuiBase::TieChoice().

2458 {
2459  StartStruct();
2460  AddItem( SettingName, "id" );
2461  AddItem( Prompt, "prompt" );
2462  AddItem( "enum", "type" );
2463  AddItem( Default, "default" );
2464  StartField( "enum" );
2465  StartArray();
2466  for( size_t i=0;i<Choices.Count(); i++ )
2467  AddItem( InternalChoices[i] );
2468  EndArray();
2469  EndField();
2470  EndStruct();
2471  return ShuttleGui::TieChoice( Prompt, SettingName, Default, Choices, InternalChoices );
2472 }
wxChoice * TieChoice(const wxString &Prompt, WrappedType &WrappedRef, const wxArrayString *pChoices)
void StartField(const wxString &name="") override
void AddItem(const wxString &value, const wxString &name="") override
wxChoice * ShuttleGuiGetDefinition::TieChoice ( const wxString &  Prompt,
const wxString &  SettingName,
const int  Default,
const wxArrayString &  Choices,
const std::vector< int > &  InternalChoices 
)
overridevirtual

Variant of the standard TieChoice which does the two step exchange between gui and stack variable and stack variable and shuttle. Difference to previous one is that the Translated choices and default are integers, not Strings.

Parameters
PromptThe prompt shown beside the control.
SettingNameThe setting name as stored in gPrefs
DefaultThe default value for this control (translated)
ChoicesAn array of choices that appear on screen.
InternalChoicesThe corresponding values (as an integer array)

Reimplemented from ShuttleGuiBase.

Definition at line 2473 of file ShuttleGui.cpp.

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndArray(), CommandMessageTargetDecorator::EndField(), CommandMessageTargetDecorator::EndStruct(), CommandMessageTargetDecorator::StartArray(), CommandMessageTargetDecorator::StartField(), CommandMessageTargetDecorator::StartStruct(), and ShuttleGuiBase::TieChoice().

2479 {
2480  // Should no longer come here!
2481  // Choice controls in Preferences that really are exhaustive choices among
2482  // non-numerical options must now encode the internal choices as strings,
2483  // not numbers.
2484  wxASSERT(false);
2485 
2486  // But if we do get here anyway, proceed sub-optimally as before.
2487  StartStruct();
2488  AddItem( SettingName, "id" );
2489  AddItem( Prompt, "prompt" );
2490  AddItem( "enum", "type" );
2491  AddItem( Default, "default" );
2492  StartField( "enum" );
2493  StartArray();
2494  for( size_t i=0;i<Choices.Count(); i++ )
2495  AddItem( Choices[i] );
2496  EndArray();
2497  EndField();
2498  EndStruct();
2499  return ShuttleGui::TieChoice( Prompt, SettingName, Default, Choices, InternalChoices );
2500 }
wxChoice * TieChoice(const wxString &Prompt, WrappedType &WrappedRef, const wxArrayString *pChoices)
void StartField(const wxString &name="") override
void AddItem(const wxString &value, const wxString &name="") override
wxChoice * ShuttleGuiGetDefinition::TieNumberAsChoice ( const wxString &  Prompt,
const wxString &  SettingName,
const int  Default,
const wxArrayString &  Choices,
const std::vector< int > &  InternalChoices 
)
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 abitrary entry.

Parameters
PromptThe prompt shown beside the control.
SettingNameThe setting name as stored in gPrefs
DefaultThe default value for this control (translated)
ChoicesAn array of choices that appear on screen.
InternalChoicesThe corresponding values (as an integer array)

Reimplemented from ShuttleGuiBase.

Definition at line 2501 of file ShuttleGui.cpp.

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), CommandMessageTargetDecorator::StartStruct(), and ShuttleGuiBase::TieNumberAsChoice().

2507 {
2508  // Come here for controls that present non-exhaustive choices among some
2509  // numbers, with an associated control that allows arbitrary entry of an
2510  // "Other..."
2511  StartStruct();
2512  AddItem( SettingName, "id" );
2513  AddItem( Prompt, "prompt" );
2514  AddItem( "number", "type" ); // not "enum" !
2515  AddItem( Default, "default" );
2516  EndStruct();
2518  Prompt, SettingName, Default, Choices, InternalChoices );
2519 }
void AddItem(const wxString &value, const wxString &name="") override
virtual wxChoice * TieNumberAsChoice(const wxString &Prompt, const wxString &SettingName, const int Default, const wxArrayString &Choices, const std::vector< int > &InternalChoices)
wxTextCtrl * ShuttleGuiGetDefinition::TieNumericTextBox ( const wxString &  Prompt,
const wxString &  SettingName,
const wxString &  Default,
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 2548 of file ShuttleGui.cpp.

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), CommandMessageTargetDecorator::StartStruct(), and ShuttleGuiBase::TieNumericTextBox().

2553 {
2554  StartStruct();
2555  AddItem( SettingName, "id" );
2556  AddItem( Prompt, "prompt" );
2557  AddItem( "number", "type" );
2558  AddItem( Default, "default" );
2559  EndStruct();
2560  return ShuttleGui::TieNumericTextBox( Prompt, SettingName, Default, nChars );
2561 }
wxTextCtrl * TieNumericTextBox(const wxString &Prompt, WrappedType &WrappedRef, const int nChars)
void AddItem(const wxString &value, const wxString &name="") override
wxTextCtrl * ShuttleGuiGetDefinition::TieNumericTextBox ( const wxString &  Prompt,
const wxString &  SettingName,
const double &  Default,
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 double values...

Reimplemented from ShuttleGuiBase.

Definition at line 2562 of file ShuttleGui.cpp.

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), CommandMessageTargetDecorator::StartStruct(), and ShuttleGuiBase::TieNumericTextBox().

2567 {
2568  StartStruct();
2569  AddItem( SettingName, "id" );
2570  AddItem( Prompt, "prompt" );
2571  AddItem( "number", "type" );
2572  AddItem( Default, "default" );
2573  EndStruct();
2574  return ShuttleGui::TieNumericTextBox( Prompt, SettingName, Default, nChars );
2575 }
wxTextCtrl * TieNumericTextBox(const wxString &Prompt, WrappedType &WrappedRef, const int nChars)
void AddItem(const wxString &value, const wxString &name="") override
wxSlider * ShuttleGuiGetDefinition::TieSlider ( const wxString &  Prompt,
const wxString &  SettingName,
const int  iDefault,
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 2576 of file ShuttleGui.cpp.

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), CommandMessageTargetDecorator::StartStruct(), and ShuttleGuiBase::TieSlider().

2582 {
2583  StartStruct();
2584  AddItem( SettingName, "id" );
2585  AddItem( Prompt, "prompt" );
2586  AddItem( "number", "type" );
2587  AddItem( iDefault, "default" );
2588  EndStruct();
2589  return ShuttleGui::TieSlider( Prompt, SettingName, iDefault, max, min );
2590 }
wxSlider * TieSlider(const wxString &Prompt, WrappedType &WrappedRef, const int max, const int min=0)
int min(int a, int b)
void AddItem(const wxString &value, const wxString &name="") override
wxSpinCtrl * ShuttleGuiGetDefinition::TieSpinCtrl ( const wxString &  Prompt,
const wxString &  SettingName,
const int  Value,
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 2591 of file ShuttleGui.cpp.

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), CommandMessageTargetDecorator::StartStruct(), and ShuttleGuiBase::TieSpinCtrl().

2597 {
2598  StartStruct();
2599  AddItem( SettingName, "id" );
2600  AddItem( Prompt, "prompt" );
2601  AddItem( "number", "type" );
2602  AddItem( Value, "default" );
2603  EndStruct();
2604  return ShuttleGui::TieSpinCtrl( Prompt, SettingName, Value, max, min );
2605 }
wxSpinCtrl * TieSpinCtrl(const wxString &Prompt, WrappedType &WrappedRef, const int max, const int min=0)
int min(int a, int b)
void AddItem(const wxString &value, const wxString &name="") override
wxTextCtrl * ShuttleGuiGetDefinition::TieTextBox ( const wxString &  Prompt,
const wxString &  SettingName,
const wxString &  Default,
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 2520 of file ShuttleGui.cpp.

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), CommandMessageTargetDecorator::StartStruct(), and ShuttleGuiBase::TieTextBox().

2525 {
2526  StartStruct();
2527  AddItem( SettingName, "id" );
2528  AddItem( Prompt, "prompt" );
2529  AddItem( "string", "type" );
2530  AddItem( Default, "default" );
2531  EndStruct();
2532  return ShuttleGui::TieTextBox( Prompt, SettingName, Default, nChars );
2533 }
void AddItem(const wxString &value, const wxString &name="") override
wxTextCtrl * TieTextBox(const wxString &Prompt, WrappedType &WrappedRef, const int nChars)
wxTextCtrl * ShuttleGuiGetDefinition::TieTextBox ( const wxString &  Prompt,
const wxString &  SettingName,
const double &  Default,
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 double values...

Reimplemented from ShuttleGuiBase.

Definition at line 2534 of file ShuttleGui.cpp.

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), CommandMessageTargetDecorator::StartStruct(), and ShuttleGuiBase::TieTextBox().

2539 {
2540  StartStruct();
2541  AddItem( SettingName, "id" );
2542  AddItem( Prompt, "prompt" );
2543  AddItem( "string", "type" );
2544  AddItem( Default, "default" );
2545  EndStruct();
2546  return ShuttleGui::TieTextBox( Prompt, SettingName, Default, nChars );
2547 }
void AddItem(const wxString &value, const wxString &name="") override
wxTextCtrl * TieTextBox(const wxString &Prompt, WrappedType &WrappedRef, const int nChars)

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