Audacity  2.3.1
Public Member Functions | List of all members
ShuttleGui Class Reference

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

#include <ShuttleGui.h>

Inheritance diagram for ShuttleGui:
ShuttleGuiBase ShuttleGuiGetDefinition

Public Member Functions

 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 wxCheckBox * TieCheckBox (const wxString &Prompt, const wxString &SettingName, const bool bDefault)
 
virtual wxCheckBox * TieCheckBoxOnRight (const wxString &Prompt, const wxString &SettingName, const bool bDefault)
 
virtual wxChoice * TieChoice (const wxString &Prompt, EnumSetting &enumSetting)
 
virtual wxChoice * TieChoice (const wxString &Prompt, const wxString &SettingName, const wxString &Default, const wxArrayString &Choices, const wxArrayString &InternalChoices)
 
virtual wxChoice * TieChoice (const wxString &Prompt, const wxString &SettingName, const int Default, const wxArrayString &Choices, const std::vector< int > &InternalChoices)
 
virtual wxChoice * TieNumberAsChoice (const wxString &Prompt, const wxString &SettingName, const int Default, const wxArrayString &Choices, const std::vector< int > &InternalChoices)
 
virtual wxTextCtrl * TieTextBox (const wxString &Prompt, const wxString &SettingName, const wxString &Default, const int nChars)
 
virtual wxTextCtrl * TieTextBox (const wxString &Prompt, const wxString &SettingName, const double &Default, const int nChars)
 
virtual wxTextCtrl * TieNumericTextBox (const wxString &Prompt, const wxString &SettingName, const wxString &Default, const int nChars)
 
virtual wxTextCtrl * TieNumericTextBox (const wxString &Prompt, const wxString &SettingName, const double &Default, const int nChars)
 
virtual wxSlider * TieSlider (const wxString &Prompt, const wxString &SettingName, const int iDefault, const int max, const int min=0)
 
virtual wxSpinCtrl * TieSpinCtrl (const wxString &Prompt, const wxString &SettingName, const int Value, const int max, const int min)
 
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 ()
 

Additional Inherited Members

- Static Public Member Functions inherited from ShuttleGuiBase
static void SetSizeHints (wxWindow *window, const wxArrayString &items)
 
- 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

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

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

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

Most of the ShuttleGui functions are actually defined in ShuttleGuiBase.

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

Definition at line 409 of file ShuttleGui.h.

Constructor & Destructor Documentation

ShuttleGui::ShuttleGui ( wxWindow *  pParent,
teShuttleMode  ShuttleMode 
)

Definition at line 2159 of file ShuttleGui.cpp.

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

2159  :
2160  ShuttleGuiBase( pParent, ShuttleMode )
2161 {
2162  if( ShuttleMode == eIsCreatingFromPrefs )
2163  {
2165  Init(); // Wasn't fully done in base constructor because it is only done when eIsCreating is set.
2166  }
2167  else if( ShuttleMode == eIsSavingToPrefs )
2168  {
2170  }
2171  else
2172  {
2173  return;
2174  }
2175 
2176  mpShuttle = std::make_unique<ShuttlePrefs>();
2177  // In this case the client is the GUI, so if creating we do want to
2178  // store in the client.
2179  mpShuttle->mbStoreInClient = (mShuttleMode == eIsCreating );
2180 };
std::unique_ptr< Shuttle > mpShuttle
Definition: ShuttleGui.h:328
ShuttleGuiBase(wxWindow *pParent, teShuttleMode ShuttleMode)
Definition: ShuttleGui.cpp:120
teShuttleMode mShuttleMode
Used in choices to determine which item to use on no match.
Definition: ShuttleGui.h:332
ShuttleGui::~ShuttleGui ( void  )

Definition at line 2182 of file ShuttleGui.cpp.

2183 {
2184 }

Member Function Documentation

AttachableScrollBar * ShuttleGui::AddAttachableScrollBar ( long  style = wxSB_HORIZONTAL)

Definition at line 2217 of file ShuttleGui.cpp.

References eIsCreating, ShuttleGuiBase::miId, ShuttleGuiBase::miProp, ShuttleGuiBase::mpParent, ShuttleGuiBase::mpWind, ShuttleGuiBase::mShuttleMode, safenew, ShuttleGuiBase::UpdateSizers(), and ShuttleGuiBase::UseUpId().

2218 {
2219  UseUpId();
2220  if( mShuttleMode != eIsCreating )
2221  return (AttachableScrollBar*)NULL;
2222 // return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), AttachableScrollBar);
2223  AttachableScrollBar * pAttachableScrollBar;
2224  miProp=0;
2225  mpWind = pAttachableScrollBar = safenew AttachableScrollBar(
2226  mpParent,
2227  miId,
2228  wxDefaultPosition,
2229  wxDefaultSize,
2230  style
2231  );
2232  mpWind->SetMinSize(wxSize(10,20));
2233  UpdateSizers();
2234  return pAttachableScrollBar;
2235 }
An AttachableScrollBar is a scroll bar that can be attached to multiple items and so control their sc...
#define safenew
Definition: Audacity.h:230
wxWindow * mpParent
Definition: ShuttleGui.h:359
teShuttleMode mShuttleMode
Used in choices to determine which item to use on no match.
Definition: ShuttleGui.h:332
wxWindow * mpWind
Definition: ShuttleGui.h:360
GuiWaveTrack * ShuttleGui::AddGuiWaveTrack ( const wxString &  Name)

Definition at line 2199 of file ShuttleGui.cpp.

References eIsCreating, ShuttleGuiBase::miId, ShuttleGuiBase::miProp, ShuttleGuiBase::mpParent, ShuttleGuiBase::mpWind, ShuttleGuiBase::mShuttleMode, safenew, ShuttleGuiBase::UpdateSizers(), and ShuttleGuiBase::UseUpId().

2200 {
2201 #ifdef EXPERIMENTAL_TRACK_PANEL
2202  UseUpId();
2203  if( mShuttleMode != eIsCreating )
2204  return (GuiWaveTrack*)NULL;
2205 // return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), GuiWaveTrack);
2206  GuiWaveTrack * pGuiWaveTrack;
2207  miProp=1;
2208  mpWind = pGuiWaveTrack = safenew GuiWaveTrack(mpParent, miId, Name);
2209  mpWind->SetMinSize(wxSize(100,50));
2210  UpdateSizers();
2211  return pGuiWaveTrack;
2212 #else
2213  return NULL;
2214 #endif
2215 }
#define safenew
Definition: Audacity.h:230
wxWindow * mpParent
Definition: ShuttleGui.h:359
teShuttleMode mShuttleMode
Used in choices to determine which item to use on no match.
Definition: ShuttleGui.h:332
wxWindow * mpWind
Definition: ShuttleGui.h:360
wxSizerItem * ShuttleGui::AddSpace ( int  width,
int  height 
)

Definition at line 2374 of file ShuttleGui.cpp.

References eIsCreating, ShuttleGuiBase::miProp, ShuttleGuiBase::mpSizer, ShuttleGuiBase::mShuttleMode, and ShuttleGuiBase::SetProportions().

Referenced by NyquistEffect::BuildEffectWindow(), NyquistEffect::BuildPromptWindow(), FreqWindow::FreqWindow(), TrackActions::Handler::OnResample(), DirectoriesPrefs::PopulateOrExchange(), DemoCommand::PopulateOrExchange(), GetTrackInfoCommand::PopulateOrExchange(), SetLabelCommand::PopulateOrExchange(), DragCommand::PopulateOrExchange(), SetClipCommand::PopulateOrExchange(), SetEnvelopeCommand::PopulateOrExchange(), SetProjectCommand::PopulateOrExchange(), OpenProjectCommand::PopulateOrExchange(), TracksBehaviorsPrefs::PopulateOrExchange(), CompareAudioCommand::PopulateOrExchange(), HelpCommand::PopulateOrExchange(), ImportCommand::PopulateOrExchange(), MessageCommand::PopulateOrExchange(), SetTrackBase::PopulateOrExchange(), GetInfoCommand::PopulateOrExchange(), GetPreferenceCommand::PopulateOrExchange(), SelectTimeCommand::PopulateOrExchange(), KeyConfigPrefs::PopulateOrExchange(), ApplyMacroDialog::PopulateOrExchange(), TracksPrefs::PopulateOrExchange(), ExportCommand::PopulateOrExchange(), SaveProjectCommand::PopulateOrExchange(), EffectEcho::PopulateOrExchange(), SetPreferenceCommand::PopulateOrExchange(), EffectClickRemoval::PopulateOrExchange(), EffectAutoDuck::PopulateOrExchange(), EffectDtmf::PopulateOrExchange(), EffectAmplify::PopulateOrExchange(), EffectTimeScale::PopulateOrExchange(), EffectChangeSpeed::PopulateOrExchange(), SelectFrequenciesCommand::PopulateOrExchange(), EffectScienFilter::PopulateOrExchange(), VampEffect::PopulateOrExchange(), EffectReverb::PopulateOrExchange(), EffectTruncSilence::PopulateOrExchange(), EffectBassTreble::PopulateOrExchange(), EffectWahwah::PopulateOrExchange(), EffectPhaser::PopulateOrExchange(), SelectTracksCommand::PopulateOrExchange(), ScreenshotCommand::PopulateOrExchange(), MacrosWindow::PopulateOrExchange(), EffectDistortion::PopulateOrExchange(), EffectEqualization::PopulateOrExchange(), ExportFFmpegOptions::PopulateOrExchange(), and PluginRegistrationDialog::PopulateOrExchange().

2375 {
2376  if( mShuttleMode != eIsCreating )
2377  return NULL;
2378  SetProportions(0);
2379  return mpSizer->Add( width, height, miProp);
2380 }
wxSizer * mpSizer
Definition: ShuttleGui.h:358
teShuttleMode mShuttleMode
Used in choices to determine which item to use on no match.
Definition: ShuttleGui.h:332
void SetProportions(int Default)
wxSizerItem* ShuttleGui::AddSpace ( int  size)
inline

Definition at line 423 of file ShuttleGui.h.

References AddSpace().

Referenced by AddSpace().

423 { return AddSpace( size, size ); };
wxSizerItem * AddSpace(int width, int height)
void ShuttleGui::AddStandardButtons ( long  buttons = eOkButton | eCancelButton,
wxButton *  extra = NULL 
)

Definition at line 2359 of file ShuttleGui.cpp.

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

Referenced by ExportFFmpeg::AskResample(), ExportMP3::AskResample(), ContrastDialog::ContrastDialog(), Exporter::CreateUserPane(), EffectPresetsDialog::EffectPresetsDialog(), ErrorDialog::ErrorDialog(), FreqWindow::FreqWindow(), ImportRawDialog::ImportRawDialog(), AudacityCommandDialog::Init(), LongMessageDialog::Init(), EffectDialog::Init(), LangChoiceDialog::LangChoiceDialog(), HelpActions::Handler::OnAudioDeviceInfo(), TagsEditor::OnEdit(), HelpActions::Handler::OnMidiDeviceInfo(), MeterPanel::OnPreferences(), RateMenuTable::OnRateOther(), TrackActions::Handler::OnResample(), EffectUIHost::OnSaveAs(), LabelTrackMenuTable::OnSetFont(), SoundActivatedRecord::PopulateOrExchange(), TimeDialog::PopulateOrExchange(), ApplyMacroDialog::PopulateOrExchange(), MacroCommandDialog::PopulateOrExchange(), LabelDialog::PopulateOrExchange(), TimerRecordDialog::PopulateOrExchange(), ExportMultiple::PopulateOrExchange(), MacrosWindow::PopulateOrExchange(), QuickFixDialog::PopulateOrExchange(), TagsEditor::PopulateOrExchange(), LV2EffectSettingsDialog::PopulateOrExchange(), ExportFFmpegOptions::PopulateOrExchange(), FFmpegNotFoundDialog::PopulateOrExchange(), AudioUnitEffectOptionsDialog::PopulateOrExchange(), EditCurvesDialog::PopulateOrExchange(), LadspaEffectOptionsDialog::PopulateOrExchange(), PluginRegistrationDialog::PopulateOrExchange(), FindFFmpegDialog::PopulateOrExchange(), AudioUnitEffectExportDialog::PopulateOrExchange(), FindDialog::PopulateOrExchange(), AudioUnitEffectImportDialog::PopulateOrExchange(), VSTEffectOptionsDialog::PopulateOrExchange(), PrefsDialog::PrefsDialog(), DeviceToolBar::ShowComboDialog(), HelpSystem::ShowInfoDialog(), SliderDialog::SliderDialog(), and WarningDialog::WarningDialog().

2360 {
2361  if( mShuttleMode != eIsCreating )
2362  return;
2363 
2364  StartVerticalLay( false );
2365 
2366  miSizerProp = false;
2367  mpSubSizer = CreateStdButtonSizer( mpParent, buttons, extra );
2368  UpdateSizers();
2369  PopSizer();
2370 
2371  EndVerticalLay();
2372 }
std::unique_ptr< wxSizer > CreateStdButtonSizer(wxWindow *parent, long buttons, wxWindow *extra)
int miSizerProp
Unwrapped integer value.
Definition: ShuttleGui.h:342
void EndVerticalLay()
wxWindow * mpParent
Definition: ShuttleGui.h:359
teShuttleMode mShuttleMode
Used in choices to determine which item to use on no match.
Definition: ShuttleGui.h:332
std::unique_ptr< wxSizer > mpSubSizer
Definition: ShuttleGui.h:357
void StartVerticalLay(int iProp=1)
teShuttleMode ShuttleGui::GetMode ( )
inline

Definition at line 425 of file ShuttleGui.h.

References ShuttleGuiBase::mShuttleMode.

Referenced by ContrastDialog::ContrastDialog(), and SpectrumPrefs::PopulateOrExchange().

425 { return mShuttleMode; };
teShuttleMode mShuttleMode
Used in choices to determine which item to use on no match.
Definition: ShuttleGui.h:332
ShuttleGui & ShuttleGui::Id ( int  id)

Definition at line 2187 of file ShuttleGui.cpp.

References ShuttleGuiBase::miIdSetByUser.

Referenced by QuickFixDialog::AddStuck(), NyquistEffect::BuildEffectWindow(), NyquistEffect::BuildPromptWindow(), ContrastDialog::ContrastDialog(), EffectPresetsDialog::EffectPresetsDialog(), ExportCL::Export(), FreqWindow::FreqWindow(), HistoryWindow::HistoryWindow(), ImportRawDialog::ImportRawDialog(), BenchmarkDialog::MakeBenchmarkDialog(), ApplyMacroDialog::OnApplyToFiles(), HelpActions::Handler::OnAudioDeviceInfo(), HelpActions::Handler::OnMidiDeviceInfo(), SplashDialog::Populate(), DirectoriesPrefs::PopulateOrExchange(), RecordingPrefs::PopulateOrExchange(), WaveformPrefs::PopulateOrExchange(), LibraryPrefs::PopulateOrExchange(), DevicePrefs::PopulateOrExchange(), ThemePrefs::PopulateOrExchange(), QualityPrefs::PopulateOrExchange(), MidiIOPrefs::PopulateOrExchange(), KeyConfigPrefs::PopulateOrExchange(), SpectrumPrefs::PopulateOrExchange(), ApplyMacroDialog::PopulateOrExchange(), ExportCLOptions::PopulateOrExchange(), MacroCommandDialog::PopulateOrExchange(), ExtImportPrefs::PopulateOrExchange(), EffectClickRemoval::PopulateOrExchange(), EffectCompressor::PopulateOrExchange(), EffectDtmf::PopulateOrExchange(), EffectChangeSpeed::PopulateOrExchange(), LabelDialog::PopulateOrExchange(), EffectTimeScale::PopulateOrExchange(), EffectAmplify::PopulateOrExchange(), ScreenFrame::PopulateOrExchange(), EffectScienFilter::PopulateOrExchange(), VampEffect::PopulateOrExchange(), EffectReverb::PopulateOrExchange(), EffectBassTreble::PopulateOrExchange(), TimerRecordDialog::PopulateOrExchange(), EffectWahwah::PopulateOrExchange(), EffectPhaser::PopulateOrExchange(), ExportMultiple::PopulateOrExchange(), MacrosWindow::PopulateOrExchange(), EffectDistortion::PopulateOrExchange(), ExportPCMOptions::PopulateOrExchange(), EffectEqualization::PopulateOrExchange(), TagsEditor::PopulateOrExchange(), ExportFFmpegCustomOptions::PopulateOrExchange(), ExportFFmpegOptions::PopulateOrExchange(), DependencyDialog::PopulateOrExchange(), ExportMP3Options::PopulateOrExchange(), EditCurvesDialog::PopulateOrExchange(), EffectNoiseReduction::Dialog::PopulateOrExchange(), PluginRegistrationDialog::PopulateOrExchange(), FindFFmpegDialog::PopulateOrExchange(), FindDialog::PopulateOrExchange(), and HelpSystem::ShowHtmlText().

2188 {
2189  miIdSetByUser = id;
2190  return *this;
2191 }
ShuttleGui & ShuttleGui::Optional ( bool &  bVar)
ShuttleGui& ShuttleGui::Prop ( int  iProp)
inline

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