Audacity 3.2.0
Public Member Functions | Static 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:
[legend]
Collaboration diagram for ShuttleGui:
[legend]

Public Member Functions

 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)
 
void 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)
 
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)
 
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 ()
 
void EndInvisiblePanel ()
 
void StartRadioButtonGroup (const 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)
 
wxTextCtrl * TieNumericTextBox (const TranslatableString &Prompt, double &Value, const int nChars=0)
 
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)
 
virtual wxCheckBox * TieCheckBox (const TranslatableString &Prompt, const BoolSetting &Setting)
 
virtual wxCheckBox * TieCheckBoxOnRight (const TranslatableString &Prompt, const BoolSetting &Setting)
 
virtual wxChoice * TieChoice (const TranslatableString &Prompt, const ChoiceSetting &choiceSetting)
 
virtual wxChoice * TieNumberAsChoice (const TranslatableString &Prompt, const 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)
 
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 ()
 

Static Public Member Functions

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)
 

Additional Inherited Members

- 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< ShuttlempShuttle
 
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

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 630 of file ShuttleGui.h.

Constructor & Destructor Documentation

◆ ShuttleGui()

ShuttleGui::ShuttleGui ( wxWindow *  pParent,
teShuttleMode  ShuttleMode,
bool  vertical = true,
wxSize  minSize = { 250, 100 } 
)

Definition at line 2246 of file ShuttleGui.cpp.

2248 : ShuttleGuiBase( pParent, ShuttleMode, vertical, minSize )
2249{
2250 if( ShuttleMode == eIsCreatingFromPrefs )
2251 {
2253 Init( vertical, minSize ); // Wasn't fully done in base constructor because it is only done when eIsCreating is set.
2254 }
2255 else if( ShuttleMode == eIsSavingToPrefs )
2256 {
2258 }
2259 else
2260 {
2261 return;
2262 }
2263
2264 mpShuttle = std::make_unique<ShuttlePrefs>();
2265 // In this case the client is the GUI, so if creating we do want to
2266 // store in the client.
2267 mpShuttle->mbStoreInClient = (mShuttleMode == eIsCreating );
2268};
@ eIsCreating
Definition: ShuttleGui.h:39
@ eIsCreatingFromPrefs
Definition: ShuttleGui.h:48
@ eIsSavingToPrefs
Definition: ShuttleGui.h:49
@ eIsGettingFromDialog
Definition: ShuttleGui.h:40
ShuttleGuiBase(wxWindow *pParent, teShuttleMode ShuttleMode, bool vertical, wxSize minSize)
Definition: ShuttleGui.cpp:129
void Init(bool vertical, wxSize minSize)
Definition: ShuttleGui.cpp:144
std::unique_ptr< Shuttle > mpShuttle
Definition: ShuttleGui.h:533
teShuttleMode mShuttleMode
Used in choices to determine which item to use on no match.
Definition: ShuttleGui.h:537

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

Here is the call graph for this function:

◆ ~ShuttleGui()

ShuttleGui::~ShuttleGui ( void  )

Definition at line 2270 of file ShuttleGui.cpp.

2271{
2272}

Member Function Documentation

◆ AddSpace() [1/2]

wxSizerItem * ShuttleGui::AddSpace ( int  size)
inline

Definition at line 743 of file ShuttleGui.h.

743{ return AddSpace( size, size ); };
wxSizerItem * AddSpace(int width, int height, int prop=0)

References AddSpace(), and size.

Referenced by AddSpace().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ AddSpace() [2/2]

wxSizerItem * ShuttleGui::AddSpace ( int  width,
int  height,
int  prop = 0 
)

Definition at line 2460 of file ShuttleGui.cpp.

2461{
2462 if( mShuttleMode != eIsCreating )
2463 return NULL;
2464
2465// SetProportions(0);
2466 // return mpSizer->Add( width, height, miProp);
2467
2468 return mpSizer->Add( width, height, prop );
2469}
wxSizer * mpSizer
Definition: ShuttleGui.h:554

References eIsCreating, ShuttleGuiBase::mpSizer, and ShuttleGuiBase::mShuttleMode.

Referenced by ErrorReportDialog::ErrorReportDialog().

Here is the caller graph for this function:

◆ AddStandardButtons()

void ShuttleGui::AddStandardButtons ( long  buttons = eOkButton | eCancelButton,
wxWindow *  extra = NULL 
)

Definition at line 2445 of file ShuttleGui.cpp.

2446{
2447 if( mShuttleMode != eIsCreating )
2448 return;
2449
2450 StartVerticalLay( false );
2451
2452 miSizerProp = false;
2453 mpSubSizer = CreateStdButtonSizer( mpParent, buttons, extra );
2454 UpdateSizers();
2455 PopSizer();
2456
2458}
std::unique_ptr< wxSizer > CreateStdButtonSizer(wxWindow *parent, long buttons, wxWindow *extra)
void EndVerticalLay()
void StartVerticalLay(int iProp=1)
wxWindow * mpParent
Definition: ShuttleGui.h:555
std::unique_ptr< wxSizer > mpSubSizer
Definition: ShuttleGui.h:553

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

Here is the call graph for this function:

◆ ConnectRoot()

template<typename Tag , typename Argument , typename Handler >
auto ShuttleGui::ConnectRoot ( wxEventTypeTag< Tag >  eventType,
void(Handler::*)(Argument &)  func 
) -> std::enable_if_t< std::is_base_of_v<Argument, Tag>, ShuttleGui& >
inline

Definition at line 699 of file ShuttleGui.h.

706 {
707 std::move( mItem ).ConnectRoot( eventType, func );
708 return *this;
709 }
DialogDefinition::Item mItem
Definition: ShuttleGui.h:582

References ConnectRoot().

Referenced by ConnectRoot().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Disable()

ShuttleGui & ShuttleGui::Disable ( bool  disabled = true)
inline

Definition at line 650 of file ShuttleGui.h.

651 {
652 std::move( mItem ).Disable( disabled );
653 return *this;
654 }

References Disable().

Referenced by Disable().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Focus()

ShuttleGui & ShuttleGui::Focus ( bool  focused = true)
inline

Definition at line 644 of file ShuttleGui.h.

645 {
646 std::move( mItem ).Focus( focused );
647 return *this;
648 }

References Focus().

Referenced by Focus().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetMode()

teShuttleMode ShuttleGui::GetMode ( )
inline

Definition at line 751 of file ShuttleGui.h.

751{ return mShuttleMode; };

◆ Id()

ShuttleGui & ShuttleGui::Id ( int  id)

Definition at line 2275 of file ShuttleGui.cpp.

2276{
2277 miIdSetByUser = id;
2278 return *this;
2279}
int id

References id, and ShuttleGuiBase::miIdSetByUser.

◆ MinSize() [1/2]

ShuttleGui & ShuttleGui::MinSize ( )
inline

Definition at line 732 of file ShuttleGui.h.

733 { std::move( mItem ).MinSize(); return *this; }

References MinSize().

Referenced by ErrorReportDialog::ErrorReportDialog(), and MinSize().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ MinSize() [2/2]

ShuttleGui & ShuttleGui::MinSize ( wxSize  sz)
inline

Definition at line 734 of file ShuttleGui.h.

735 { std::move( mItem ).MinSize( sz ); return *this; }

References MinSize().

Here is the call graph for this function:

◆ Name()

ShuttleGui & ShuttleGui::Name ( const TranslatableString name)
inline

Definition at line 663 of file ShuttleGui.h.

664 {
665 std::move( mItem ).Name( name );
666 return *this;
667 }
const TranslatableString name
Definition: Distortion.cpp:82

References name, and Name().

Referenced by ErrorReportDialog::ErrorReportDialog(), and Name().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ NameSuffix()

ShuttleGui & ShuttleGui::NameSuffix ( const TranslatableString suffix)
inline

Definition at line 671 of file ShuttleGui.h.

672 {
673 std::move( mItem ).NameSuffix( suffix );
674 return *this;
675 }

References NameSuffix().

Referenced by NameSuffix().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Optional()

ShuttleGui & ShuttleGui::Optional ( bool &  bVar)

Definition at line 2281 of file ShuttleGui.cpp.

2281 {
2282 mpbOptionalFlag = &bVar;
2283 return *this;
2284};
bool * mpbOptionalFlag
Definition: ShuttleGui.h:551

References ShuttleGuiBase::mpbOptionalFlag.

◆ Position()

ShuttleGui & ShuttleGui::Position ( int  flags)
inline

Definition at line 711 of file ShuttleGui.h.

712 {
713 std::move( mItem ).Position( flags );
714 return *this;
715 }

References Position().

Referenced by Position().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Prop()

ShuttleGui & ShuttleGui::Prop ( int  iProp)
inline

Definition at line 724 of file ShuttleGui.h.

724{ ShuttleGuiBase::Prop(iProp); return *this;}; // Has to be here too, to return a ShuttleGui and not a ShuttleGuiBase.
ShuttleGuiBase & Prop(int iProp)
Definition: ShuttleGui.cpp:883

References ShuttleGuiBase::Prop().

Here is the call graph for this function:

◆ SetMinSize() [1/2]

void ShuttleGui::SetMinSize ( wxWindow *  window,
const TranslatableStrings items 
)
static

Definition at line 2471 of file ShuttleGui.cpp.

2472{
2473 SetMinSize( window,
2474 transform_container<wxArrayStringEx>(
2475 items, std::mem_fn( &TranslatableString::StrippedTranslation ) ) );
2476}
static void SetMinSize(wxWindow *window, const TranslatableStrings &items)
wxString StrippedTranslation() const

References SetMinSize(), and TranslatableString::StrippedTranslation().

Referenced by DevicePrefs::OnDevice(), DevicePrefs::OnHost(), SetMinSize(), and ShuttleGuiBase::TieChoice().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetMinSize() [2/2]

void ShuttleGui::SetMinSize ( wxWindow *  window,
const wxArrayStringEx items 
)
static

Definition at line 2478 of file ShuttleGui.cpp.

2479{
2480 int maxw = 0;
2481
2482 for( size_t i = 0; i < items.size(); i++ )
2483 {
2484 int x;
2485 int y;
2486
2487 window->GetTextExtent(items[i], &x, &y );
2488 if( x > maxw )
2489 {
2490 maxw = x;
2491 }
2492 }
2493
2494 // Would be nice to know the sizes of the button and borders, but this is
2495 // the best we can do for now.
2496#if defined(__WXMAC__)
2497 maxw += 50;
2498#elif defined(__WXMSW__)
2499 maxw += 50;
2500#elif defined(__WXGTK__)
2501 maxw += 50;
2502#else
2503 maxw += 50;
2504#endif
2505
2506 window->SetMinSize( { maxw, -1 } );
2507}

◆ Size()

ShuttleGui & ShuttleGui::Size ( wxSize  size)
inline

Definition at line 717 of file ShuttleGui.h.

718 {
719 std::move( mItem ).Size( size );
720 return *this;
721 }

References size, and Size().

Referenced by Size().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Style()

ShuttleGui & ShuttleGui::Style ( long  iStyle)
inline

Definition at line 726 of file ShuttleGui.h.

727 {
728 std::move( mItem ).Style( iStyle );
729 return *this;
730 }

References Style().

Referenced by ErrorReportDialog::ErrorReportDialog(), and Style().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ToolTip()

ShuttleGui & ShuttleGui::ToolTip ( const TranslatableString tip)
inline

Definition at line 656 of file ShuttleGui.h.

657 {
658 std::move( mItem ).ToolTip( tip );
659 return *this;
660 }

References ToolTip().

Referenced by ToolTip().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Validator() [1/2]

template<typename V , typename... Args>
ShuttleGui & ShuttleGui::Validator ( Args &&...  args)
inline

Definition at line 687 of file ShuttleGui.h.

688 {
689 if ( GetMode() == eIsCreating )
690 std::move( mItem ).Validator<V>( std::forward<Args>(args)... );
691 return *this;
692 }
teShuttleMode GetMode()
Definition: ShuttleGui.h:751

References eIsCreating, and Validator().

Here is the call graph for this function:

◆ Validator() [2/2]

template<typename Factory >
ShuttleGui & ShuttleGui::Validator ( const Factory &  f)
inline

Definition at line 678 of file ShuttleGui.h.

679 {
680 if ( GetMode() == eIsCreating )
681 std::move( mItem ).Validator( f );
682 return *this;
683 }

References eIsCreating, and Validator().

Referenced by Validator().

Here is the call graph for this function:
Here is the caller graph for this function:

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