Audacity  3.0.3
Public Member Functions | Private Member Functions | List of all members
NyquistOutputDialog Class Referencefinal

Dialog used with NyquistEffect. More...

#include <Nyquist.h>

Inheritance diagram for NyquistOutputDialog:
[legend]
Collaboration diagram for NyquistOutputDialog:
[legend]

Public Member Functions

 NyquistOutputDialog (wxWindow *parent, wxWindowID id, const TranslatableString &title, const TranslatableString &prompt, const TranslatableString &message)
 
- Public Member Functions inherited from wxDialogWrapper
 wxDialogWrapper ()
 
 wxDialogWrapper (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
 
bool Create (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
 
void SetTitle (const TranslatableString &title)
 
void SetLabel (const TranslatableString &title)
 
void SetName (const TranslatableString &title)
 
void SetName ()
 
- Public Member Functions inherited from wxTabTraversalWrapper< wxDialog >
 wxTabTraversalWrapper (Args &&... args)
 
 wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
 
 wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
 
wxTabTraversalWrapperoperator= (const wxTabTraversalWrapper &)=delete
 
wxTabTraversalWrapperoperator= (wxTabTraversalWrapper &&)=delete
 

Private Member Functions

void OnOk (wxCommandEvent &event)
 

Detailed Description

Dialog used with NyquistEffect.

Definition at line 294 of file Nyquist.h.

Constructor & Destructor Documentation

◆ NyquistOutputDialog()

NyquistOutputDialog::NyquistOutputDialog ( wxWindow *  parent,
wxWindowID  id,
const TranslatableString title,
const TranslatableString prompt,
const TranslatableString message 
)

Definition at line 3321 of file Nyquist.cpp.

3325 : wxDialogWrapper{ parent, id, title, wxDefaultPosition, wxDefaultSize, wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER }
3326 {
3327  SetName();
3328 
3329  ShuttleGui S{ this, eIsCreating };
3330  {
3331  S.SetBorder(10);
3332 
3333  S.AddVariableText( prompt, false, wxALIGN_LEFT | wxLEFT | wxTOP | wxRIGHT );
3334 
3335  // TODO: use ShowInfoDialog() instead.
3336  // Beware this dialog MUST work with screen readers.
3337  S.Prop( 1 )
3338  .Position(wxEXPAND | wxALL)
3339  .MinSize( { 480, 250 } )
3340  .Style(wxTE_MULTILINE | wxTE_READONLY | wxTE_RICH)
3341  .AddTextWindow( message.Translation() );
3342 
3343  S.SetBorder( 5 );
3344 
3345  S.StartHorizontalLay(wxALIGN_CENTRE | wxLEFT | wxBOTTOM | wxRIGHT, 0 );
3346  {
3347  /* i18n-hint: In most languages OK is to be translated as OK. It appears on a button.*/
3348  S.Id(wxID_OK).AddButton( XXO("OK"), wxALIGN_CENTRE, true );
3349  }
3350  S.EndHorizontalLay();
3351 
3352  }
3353 
3354  SetAutoLayout(true);
3355  GetSizer()->Fit(this);
3356  GetSizer()->SetSizeHints(this);
3357 }

References id, and title.

Member Function Documentation

◆ OnOk()

void NyquistOutputDialog::OnOk ( wxCommandEvent &  event)
private

Definition at line 3363 of file Nyquist.cpp.

3364 {
3365  EndModal(wxID_OK);
3366 }

The documentation for this class was generated from the following files:
eIsCreating
@ eIsCreating
Definition: ShuttleGui.h:38
XXO
#define XXO(s)
Definition: Internat.h:44
id
int id
Definition: WaveTrackControls.cpp:577
wxDialogWrapper
Definition: wxPanelWrapper.h:81
title
static const auto title
Definition: NoUpdatesAvailableDialog.cpp:22
TranslatableString::Translation
wxString Translation() const
Definition: TranslatableString.h:79
wxDialogWrapper::SetName
void SetName()
Definition: wxPanelWrapper.cpp:81
ShuttleGui
Derived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI.
Definition: ShuttleGui.h:631