EffectDialog Class Reference

#include <EffectUI.h>

Inheritance diagram for EffectDialog:

Collaboration diagram for EffectDialog:

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

Private Attributes
int	mType
int	mAdditionalButtons

Detailed Description

Definition at line 182 of file EffectUI.h.

Constructor & Destructor Documentation

EffectDialog()

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

Definition at line 1351 of file EffectUI.cpp.

: wxDialogWrapper(parent, wxID_ANY, title, wxDefaultPosition, wxDefaultSize, flags)
{
   mType = type;
   mAdditionalButtons = additionalButtons;
}

Member Function Documentation

Init()

void EffectDialog::Init

(

)

Definition at line 1362 of file EffectUI.cpp.

{
   long buttons = eOkButton;
   if ((mType != EffectTypeAnalyze) && (mType != EffectTypeTool))
   {
      buttons |= eCancelButton;
      if (mType == EffectTypeProcess)
      {
         buttons |= ePreviewButton;
      }
   }
 
   ShuttleGui S(this, eIsCreating);
 
   S.SetBorder(5);
   S.StartVerticalLay(true);
   {
      PopulateOrExchange(S);
      S.AddStandardButtons(buttons|mAdditionalButtons);
   }
   S.EndVerticalLay();
 
   Layout();
   Fit();
   SetMinSize(GetSize());
   Center();
}

References eCancelButton, EffectTypeAnalyze, EffectTypeProcess, EffectTypeTool, eIsCreating, eOkButton, ePreviewButton, mAdditionalButtons, mType, PopulateOrExchange(), and S.

Here is the call graph for this function:

OnOk()

void EffectDialog::OnOk ( wxCommandEvent &  evt )

virtual

Definition at line 1424 of file EffectUI.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 Effects 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(wxID_OK);
   }
 
   return;
}

References TransferDataFromWindow(), and Validate().

Here is the call graph for this function:

OnPreview()

void EffectDialog::OnPreview ( wxCommandEvent &  evt )

virtual

Reimplemented in EffectNoiseReduction::Dialog.

Definition at line 1419 of file EffectUI.cpp.

{
   return;
}

PopulateOrExchange()

void EffectDialog::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.

Reimplemented in EffectNoiseReduction::Dialog.

Definition at line 1393 of file EffectUI.cpp.

{
   return;
}

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

Here is the caller graph for this function:

TransferDataFromWindow()

bool EffectDialog::TransferDataFromWindow ( )

override

Definition at line 1406 of file EffectUI.cpp.

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

References eIsGettingFromDialog, PopulateOrExchange(), and S.

Referenced by OnOk(), and EffectNoiseReduction::Dialog::TransferDataFromWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

TransferDataToWindow()

bool EffectDialog::TransferDataToWindow ( )

override

Definition at line 1398 of file EffectUI.cpp.

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

References eIsSettingToDialog, PopulateOrExchange(), and S.

Referenced by EffectNoiseReduction::Dialog::TransferDataToWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

Validate()

bool EffectDialog::Validate ( )

override

Definition at line 1414 of file EffectUI.cpp.

{
   return true;
}

Referenced by OnOk().

Here is the caller graph for this function:

wxDECLARE_NO_COPY_CLASS()

EffectDialog::wxDECLARE_NO_COPY_CLASS ( EffectDialog  )

private

Member Data Documentation

mAdditionalButtons

int EffectDialog::mAdditionalButtons

private

Definition at line 205 of file EffectUI.h.

Referenced by Init().

mType

int EffectDialog::mType

private

Definition at line 204 of file EffectUI.h.

Referenced by Init().

---

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

• EffectUI.h
• EffectUI.cpp