Audacity 3.2.0
|
Shuttle that retrieves a JSON format definition of a command's parameters. More...
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) | |
ShuttleGui & | Optional (bool &bVar) |
ShuttleGui & | Id (int id) |
ShuttleGui & | Focus (bool focused=true) |
ShuttleGui & | Disable (bool disabled=true) |
ShuttleGui & | ToolTip (const TranslatableString &tip) |
ShuttleGui & | Name (const TranslatableString &name) |
ShuttleGui & | NameSuffix (const TranslatableString &suffix) |
template<typename Factory > | |
ShuttleGui & | Validator (const Factory &f) |
template<typename V , typename... Args> | |
ShuttleGui & | Validator (Args &&...args) |
template<typename Tag , typename Argument , typename Handler > | |
auto | ConnectRoot (wxEventTypeTag< Tag > eventType, void(Handler::*func)(Argument &)) -> std::enable_if_t< std::is_base_of_v< Argument, Tag >, ShuttleGui & > |
ShuttleGui & | Position (int flags) |
ShuttleGui & | Size (wxSize size) |
ShuttleGui & | Prop (int iProp) |
ShuttleGui & | Style (long iStyle) |
ShuttleGui & | MinSize () |
ShuttleGui & | MinSize (wxSize sz) |
void | AddStandardButtons (long buttons=eOkButton|eCancelButton, wxWindow *extra=NULL) |
wxSizerItem * | AddSpace (int width, int height, int prop=0) |
wxSizerItem * | AddSpace (int size) |
teShuttleMode | GetMode () |
Public Member Functions inherited from ShuttleGuiBase | |
ShuttleGuiBase (wxWindow *pParent, teShuttleMode ShuttleMode, bool vertical, wxSize minSize) | |
virtual | ~ShuttleGuiBase () |
void | Init (bool vertical, wxSize minSize) |
void | ResetId () |
void | HandleOptionality (const TranslatableString &Prompt) |
wxStaticText * | AddPrompt (const TranslatableString &Prompt, int wrapWidth=0) |
Right aligned text string. More... | |
void | AddUnits (const TranslatableString &Prompt, int wrapWidth=0) |
Left aligned text string. More... | |
void | AddTitle (const TranslatableString &Prompt, int wrapWidth=0) |
Centred text string. More... | |
wxWindow * | AddWindow (wxWindow *pWindow, int PositionFlags=wxALIGN_CENTRE) |
wxSlider * | AddSlider (const TranslatableString &Prompt, int pos, int Max, int Min=0) |
wxSlider * | AddVSlider (const TranslatableString &Prompt, int pos, int Max) |
wxSpinCtrl * | AddSpinCtrl (const TranslatableString &Prompt, int Value, int Max, int Min) |
SpinControl * | AddSpinControl (const wxSize &size, const TranslatableString &Prompt, double Value, double Max, double Min) |
wxTreeCtrl * | AddTree () |
wxRadioButton * | AddRadioButton (const TranslatableString &Prompt, int selector=0, int initValue=0) |
wxRadioButton * | AddRadioButtonToGroup (const TranslatableString &Prompt, int selector=1, int initValue=0) |
wxButton * | AddButton (const TranslatableString &Text, int PositionFlags=wxALIGN_CENTRE, bool setDefault=false) |
wxBitmapButton * | AddBitmapButton (const wxBitmap &Bitmap, int PositionFlags=wxALIGN_CENTRE, bool setDefault=false) |
wxStaticText * | AddVariableText (const TranslatableString &Str, bool bCenter=false, int PositionFlags=0, int wrapWidth=0) |
ReadOnlyText * | AddReadOnlyText (const TranslatableString &Caption, const wxString &Value) |
wxTextCtrl * | AddTextBox (const TranslatableString &Caption, const wxString &Value, const int nChars) |
wxTextCtrl * | AddNumericTextBox (const TranslatableString &Caption, const wxString &Value, const int nChars, bool acceptEnter=false) |
wxTextCtrl * | AddTextWindow (const wxString &Value) |
Multiline text box that grows. More... | |
wxListBox * | AddListBox (const wxArrayStringEx &choices) |
wxListCtrl * | AddListControl (std::initializer_list< const ListControlColumn > columns={}, long listControlStyles=0) |
wxListCtrl * | AddListControlReportMode (std::initializer_list< const ListControlColumn > columns={}, long listControlStyles=0) |
wxGrid * | AddGrid () |
wxCheckBox * | AddCheckBox (const TranslatableString &Prompt, bool Selected) |
wxCheckBox * | AddCheckBoxOnRight (const TranslatableString &Prompt, bool Selected) |
wxCheckBox * | AddCheckBox (const TranslatableString &Prompt, const wxChar *)=delete |
wxCheckBox * | AddCheckBox (const TranslatableString &Prompt, const char *)=delete |
wxCheckBox * | AddCheckBoxOnRight (const TranslatableString &Prompt, const wxChar *)=delete |
wxCheckBox * | AddCheckBoxOnRight (const TranslatableString &Prompt, const char *)=delete |
wxComboBox * | AddCombo (const TranslatableString &Prompt, const wxString &Selected, const wxArrayStringEx &choices) |
wxChoice * | AddChoice (const TranslatableString &Prompt, const TranslatableStrings &choices, int Selected=-1) |
wxChoice * | AddChoice (const TranslatableString &Prompt, const TranslatableStrings &choices, const TranslatableString &selected) |
void | AddIcon (wxBitmap *pBmp) |
void | AddFixedText (const TranslatableString &Str, bool bCenter=false, int wrapWidth=0) |
void | AddConstTextBox (const TranslatableString &Caption, const TranslatableString &Value) |
Single line text box of fixed size. More... | |
void | StartHorizontalLay (int PositionFlags=wxALIGN_CENTRE, int iProp=1) |
void | EndHorizontalLay () |
void | StartVerticalLay (int iProp=1) |
void | StartVerticalLay (int PositionFlags, int iProp) |
void | EndVerticalLay () |
void | StartWrapLay (int PositionFlags=wxEXPAND, int iProp=0) |
void | EndWrapLay () |
wxScrolledWindow * | StartScroller (int iStyle=0) |
void | EndScroller () |
wxPanel * | StartPanel (int iStyle=0) |
void | EndPanel () |
void | StartMultiColumn (int nCols, int PositionFlags=wxALIGN_LEFT) |
void | EndMultiColumn () |
void | StartTwoColumn () |
void | EndTwoColumn () |
void | StartThreeColumn () |
void | EndThreeColumn () |
wxStaticBox * | StartStatic (const TranslatableString &Str, int iProp=0) |
void | EndStatic () |
wxNotebook * | StartNotebook () |
void | EndNotebook () |
wxSimplebook * | StartSimplebook () |
void | EndSimplebook () |
wxNotebookPage * | StartNotebookPage (const TranslatableString &Name) |
void | EndNotebookPage () |
wxPanel * | StartInvisiblePanel (int border=0) |
void | EndInvisiblePanel () |
void | StartRadioButtonGroup (ChoiceSetting &Setting) |
Call this before any TieRadioButton calls. More... | |
void | EndRadioButtonGroup () |
bool | DoStep (int iStep) |
int | TranslateToIndex (const wxString &Value, const wxArrayStringEx &Choices) |
String-to-Index. More... | |
wxString | TranslateFromIndex (const int nIn, const wxArrayStringEx &Choices) |
Index-to-String. More... | |
wxTextCtrl * | TieTextBox (const TranslatableString &Caption, wxString &Value, const int nChars=0) |
wxTextCtrl * | TieTextBox (const TranslatableString &Prompt, int &Selected, const int nChars=0) |
wxTextCtrl * | TieTextBox (const TranslatableString &Prompt, double &Value, const int nChars=0) |
wxTextCtrl * | TieNumericTextBox (const TranslatableString &Prompt, int &Value, const int nChars=0, bool acceptEnter=false) |
wxTextCtrl * | TieNumericTextBox (const TranslatableString &Prompt, double &Value, const int nChars=0, bool acceptEnter=false) |
wxCheckBox * | TieCheckBox (const TranslatableString &Prompt, bool &Var) |
wxCheckBox * | TieCheckBoxOnRight (const TranslatableString &Prompt, bool &Var) |
wxChoice * | TieChoice (const TranslatableString &Prompt, TranslatableString &Selected, const TranslatableStrings &choices) |
wxChoice * | TieChoice (const TranslatableString &Prompt, int &Selected, const TranslatableStrings &choices) |
wxSlider * | TieSlider (const TranslatableString &Prompt, int &pos, const int max, const int min=0) |
wxSlider * | TieSlider (const TranslatableString &Prompt, double &pos, const double max, const double min=0.0) |
wxSlider * | TieSlider (const TranslatableString &Prompt, float &pos, const float fMin, const float fMax) |
wxSlider * | TieVSlider (const TranslatableString &Prompt, float &pos, const float fMin, const float fMax) |
wxRadioButton * | TieRadioButton () |
This function must be within a StartRadioButtonGroup - EndRadioButtonGroup pair. More... | |
wxSpinCtrl * | TieSpinCtrl (const TranslatableString &Prompt, int &Value, const int max, const int min=0) |
SpinControl * | TieSpinControl (const wxSize &size, const TranslatableString &Prompt, double &Value, const double max, const double min=0) |
virtual wxCheckBox * | TieCheckBox (const TranslatableString &Prompt, const BoolSetting &Setting) |
virtual wxCheckBox * | TieCheckBoxOnRight (const TranslatableString &Prompt, const BoolSetting &Setting) |
virtual wxChoice * | TieChoice (const TranslatableString &Prompt, ChoiceSetting &choiceSetting) |
virtual wxChoice * | TieNumberAsChoice (const TranslatableString &Prompt, IntSetting &Setting, const TranslatableStrings &Choices, const std::vector< int > *pInternalChoices=nullptr, int iNoMatchSelector=0) |
virtual wxTextCtrl * | TieTextBox (const TranslatableString &Prompt, const StringSetting &Setting, const int nChars) |
virtual wxTextCtrl * | TieIntegerTextBox (const TranslatableString &Prompt, const IntSetting &Setting, const int nChars) |
virtual wxTextCtrl * | TieNumericTextBox (const TranslatableString &Prompt, const DoubleSetting &Setting, const int nChars, bool acceptEnter=false) |
virtual wxSlider * | TieSlider (const TranslatableString &Prompt, const IntSetting &Setting, const int max, const int min=0) |
virtual wxSpinCtrl * | TieSpinCtrl (const TranslatableString &Prompt, const IntSetting &Setting, const int max, const int min) |
void | SetBorder (int Border) |
int | GetBorder () const noexcept |
void | SetSizerProportion (int iProp) |
void | SetStretchyCol (int i) |
Used to modify an already placed FlexGridSizer to make a column stretchy. More... | |
void | SetStretchyRow (int i) |
Used to modify an already placed FlexGridSizer to make a row stretchy. More... | |
wxWindow * | GetParent () |
ShuttleGuiBase & | Prop (int iProp) |
void | UseUpId () |
wxSizer * | GetSizer () |
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) |
Protected Member Functions inherited from ShuttleGuiBase | |
void | SetProportions (int Default) |
void | PushSizer () |
void | PopSizer () |
void | UpdateSizersCore (bool bPrepend, int Flags, bool prompt=false) |
void | UpdateSizers () |
void | UpdateSizersC () |
void | UpdateSizersAtStart () |
long | GetStyle (long Style) |
Protected Attributes inherited from ShuttleGuiBase | |
wxWindow *const | mpDlg |
wxSizer * | pSizerStack [nMaxNestedSizers] |
std::unique_ptr< ShuttlePrefs > | mpShuttle |
int | miNoMatchSelector |
teShuttleMode | mShuttleMode |
Used in choices to determine which item to use on no match. More... | |
int | miSizerProp |
int | mSizerDepth |
int | miBorder |
int | miProp |
int | miId |
int | miIdNext |
int | miIdSetByUser |
int | miPropSetByUser |
bool * | mpbOptionalFlag |
std::unique_ptr< wxSizer > | mpSubSizer |
wxSizer * | mpSizer |
wxWindow * | mpParent |
wxWindow * | mpWind |
DialogDefinition::Item | mItem |
Shuttle that retrieves a JSON format definition of a command's parameters.
Definition at line 221 of file GetInfoCommand.cpp.
anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::ShuttleGuiGetDefinition | ( | wxWindow * | pParent, |
CommandMessageTarget & | target | ||
) |
Definition at line 266 of file GetInfoCommand.cpp.
|
virtual |
Definition at line 273 of file GetInfoCommand.cpp.
|
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.
References CommandMessageTargetDecorator::AddBool(), CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), Setting< T >::GetDefault(), SettingBase::GetPath(), CommandMessageTargetDecorator::StartStruct(), ShuttleGuiBase::TieCheckBox(), and TranslatableString::Translation().
|
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.
References CommandMessageTargetDecorator::AddBool(), CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), Setting< T >::GetDefault(), SettingBase::GetPath(), CommandMessageTargetDecorator::StartStruct(), ShuttleGuiBase::TieCheckBoxOnRight(), and TranslatableString::Translation().
|
overridevirtual |
Variant of the standard TieChoice which does the two step exchange between gui and stack variable and stack variable and shuttle.
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 from ShuttleGuiBase.
Definition at line 303 of file GetInfoCommand.cpp.
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().
|
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.
References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), Setting< T >::GetDefault(), SettingBase::GetPath(), CommandMessageTargetDecorator::StartStruct(), ShuttleGuiBase::TieIntegerTextBox(), and TranslatableString::Translation().
|
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.
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 from ShuttleGuiBase.
Definition at line 321 of file GetInfoCommand.cpp.
References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), Setting< T >::GetDefault(), SettingBase::GetPath(), CommandMessageTargetDecorator::StartStruct(), ShuttleGuiBase::TieNumberAsChoice(), and TranslatableString::Translation().
|
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.
References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), Setting< T >::GetDefault(), SettingBase::GetPath(), CommandMessageTargetDecorator::StartStruct(), ShuttleGuiBase::TieNumericTextBox(), and TranslatableString::Translation().
|
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.
References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), Setting< T >::GetDefault(), SettingBase::GetPath(), min(), CommandMessageTargetDecorator::StartStruct(), ShuttleGuiBase::TieSlider(), and TranslatableString::Translation().
|
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.
References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), Setting< T >::GetDefault(), SettingBase::GetPath(), min(), CommandMessageTargetDecorator::StartStruct(), ShuttleGuiBase::TieSpinCtrl(), and TranslatableString::Translation().
|
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.
References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), Setting< T >::GetDefault(), SettingBase::GetPath(), CommandMessageTargetDecorator::StartStruct(), ShuttleGuiBase::TieTextBox(), and TranslatableString::Translation().