AudacityCommandDialog Class Reference

Default dialog used for commands. Is populated using ShuttleGui. More...

#include <AudacityCommand.h>

Inheritance diagram for AudacityCommandDialog:

Collaboration diagram for AudacityCommandDialog:

Public Member Functions
	AudacityCommandDialog (wxWindow *parent, const TranslatableString &title, AudacityCommand *pCommand, int type=0, int flags=wxDEFAULT_DIALOG_STYLE, int additionalButtons=0)
bool	Init ()
bool	TransferDataToWindow () override
bool	TransferDataFromWindow () override
bool	Validate () override
virtual void	PopulateOrExchange (ShuttleGui &S)
virtual void	OnOk (wxCommandEvent &evt)
virtual void	OnCancel (wxCommandEvent &evt)
virtual void	OnHelp (wxCommandEvent &evt)
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
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Member Functions
	wxDECLARE_NO_COPY_CLASS (AudacityCommandDialog)

Private Attributes
int	mType
int	mAdditionalButtons
AudacityCommand *	mpCommand

Detailed Description

Default dialog used for commands. Is populated using ShuttleGui.

Definition at line 141 of file AudacityCommand.h.

Constructor & Destructor Documentation

AudacityCommandDialog()

AudacityCommandDialog::AudacityCommandDialog	(	wxWindow *	parent,
		const TranslatableString &	title,
		AudacityCommand *	pCommand,
		int	type = 0,
		int	flags = wxDEFAULT_DIALOG_STYLE,
		int	additionalButtons = 0
	)

Definition at line 240 of file AudacityCommand.cpp.

: wxDialogWrapper(parent, wxID_ANY, title, wxDefaultPosition, wxDefaultSize, flags)
{
   mType = type;
   wxASSERT( pCommand );
   mpCommand = pCommand;
   mAdditionalButtons = additionalButtons |eCancelButton;
   if( !pCommand->ManualPage().empty() )
      mAdditionalButtons |= eHelpButton;
}

References eCancelButton, and eHelpButton.

Member Function Documentation

Init()

bool AudacityCommandDialog::Init

(

)

Definition at line 256 of file AudacityCommand.cpp.

{
   ShuttleGui S(this, eIsCreating);
 
   S.SetBorder(5);
   S.StartVerticalLay(true);
   {
      PopulateOrExchange(S);
 
      long buttons = eOkButton;
      S.AddStandardButtons(buttons|mAdditionalButtons);
   }
   S.EndVerticalLay();
 
   Layout();
   Fit();
   SetMinSize(GetSize());
   Center();
   return true;
}

References eIsCreating, eOkButton, mAdditionalButtons, PopulateOrExchange(), and S.

Here is the call graph for this function:

OnCancel()

void AudacityCommandDialog::OnCancel ( wxCommandEvent &  evt )

virtual

Definition at line 319 of file AudacityCommand.cpp.

{
   EndModal(false);
}

OnHelp()

void AudacityCommandDialog::OnHelp ( wxCommandEvent &  evt )

virtual

Definition at line 324 of file AudacityCommand.cpp.

{
   if( mpCommand )
   {
      // otherwise use ShowHelp
      HelpSystem::ShowHelp(FindWindow(wxID_HELP), mpCommand->ManualPage(), true);
   }
}

References AudacityCommand::ManualPage(), mpCommand, and HelpSystem::ShowHelp().

Here is the call graph for this function:

OnOk()

void AudacityCommandDialog::OnOk ( wxCommandEvent &  evt )

virtual

Definition at line 305 of file AudacityCommand.cpp.

{
   // On wxGTK (wx2.8.12), the default action is still executed even if
   // the button is disabled.  This appears to affect all wxDialogs, not
   // just our AudacityCommands dialogs.  So, this is a only temporary workaround
   // for legacy effects that disable the OK button.  Hopefully this has
   // been corrected in wx3.
   if (FindWindow(wxID_OK)->IsEnabled() && Validate() && TransferDataFromWindow())
   {
      EndModal(true);
   }
}

References TransferDataFromWindow(), and Validate().

Here is the call graph for this function:

PopulateOrExchange()

void AudacityCommandDialog::PopulateOrExchange ( ShuttleGui &  S )

virtual

This is a virtual function which will be overridden to provide the actual parameters that we want for each kind of dialog.

Definition at line 280 of file AudacityCommand.cpp.

{
   wxASSERT( mpCommand );
   mpCommand->PopulateOrExchange( S );
}

References mpCommand, AudacityCommand::PopulateOrExchange(), and S.

Referenced by Init(), TransferDataFromWindow(), and TransferDataToWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

TransferDataFromWindow()

bool AudacityCommandDialog::TransferDataFromWindow ( )

override

Definition at line 293 of file AudacityCommand.cpp.

{
   ShuttleGui S(this, eIsGettingFromDialog);
   PopulateOrExchange(S);
   return true;
}

References eIsGettingFromDialog, PopulateOrExchange(), and S.

Referenced by OnOk().

Here is the call graph for this function:

Here is the caller graph for this function:

TransferDataToWindow()

bool AudacityCommandDialog::TransferDataToWindow ( )

override

Definition at line 286 of file AudacityCommand.cpp.

{
   ShuttleGui S(this, eIsSettingToDialog);
   PopulateOrExchange(S);
   return true;
}

References eIsSettingToDialog, PopulateOrExchange(), and S.

Here is the call graph for this function:

Validate()

bool AudacityCommandDialog::Validate ( )

override

Definition at line 300 of file AudacityCommand.cpp.

{
   return true;
}

Referenced by OnOk().

Here is the caller graph for this function:

wxDECLARE_NO_COPY_CLASS()

AudacityCommandDialog::wxDECLARE_NO_COPY_CLASS ( AudacityCommandDialog  )

private

Member Data Documentation

mAdditionalButtons

int AudacityCommandDialog::mAdditionalButtons

private

Definition at line 165 of file AudacityCommand.h.

Referenced by Init().

mpCommand

AudacityCommand* AudacityCommandDialog::mpCommand

private

Definition at line 166 of file AudacityCommand.h.

Referenced by OnHelp(), and PopulateOrExchange().

mType

int AudacityCommandDialog::mType

private

Definition at line 164 of file AudacityCommand.h.

---

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

• AudacityCommand.h
• AudacityCommand.cpp