Audacity 3.2.0
Public Member Functions | Protected Attributes | List of all members
anonymous_namespace{EqualizationUI.cpp}::EqualizationUIEditor Class Reference
Inheritance diagram for anonymous_namespace{EqualizationUI.cpp}::EqualizationUIEditor:
[legend]
Collaboration diagram for anonymous_namespace{EqualizationUI.cpp}::EqualizationUIEditor:
[legend]

Public Member Functions

 EqualizationUIEditor (EqualizationUI &ui, EffectUIServices &services, EffectSettingsAccess &access, wxWindow *pParent=nullptr)
 
 ~EqualizationUIEditor () override
 Calls Disconnect. More...
 
bool ValidateUI () override
 Calls mServices.ValidateUI() More...
 
void Disconnect () override
 On the first call only, may disconnect from further event handling. More...
 
- Public Member Functions inherited from EffectEditor
 EffectEditor (const EffectUIServices &services, EffectSettingsAccess &access)
 
virtual ~EffectEditor ()
 
virtual bool ValidateUI ()=0
 Get settings data from the panel; may make error dialogs and return false. More...
 
virtual bool UpdateUI ()
 Update appearance of the panel for changes in settings. More...
 
virtual bool IsGraphicalUI ()
 
virtual void Disconnect ()
 On the first call only, may disconnect from further event handling. More...
 
virtual void OnClose ()
 
- Public Member Functions inherited from Observer::Publisher< EffectSettingChanged >
 Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
 Constructor supporting type-erased custom allocation/deletion. More...
 
 Publisher (Publisher &&)=default
 
Publisheroperator= (Publisher &&)=default
 
Subscription Subscribe (Callback callback)
 Connect a callback to the Publisher; later-connected are called earlier. More...
 
Subscription Subscribe (Object &obj, Return(Object::*callback)(Args...))
 Overload of Subscribe takes an object and pointer-to-member-function. More...
 

Protected Attributes

EqualizationUImEqualizationUI
 
wxWindow * mpParent {}
 
- Protected Attributes inherited from EffectEditor
const EffectUIServicesmUIServices
 
EffectSettingsAccessmAccess
 
bool mUIClosed { false }
 

Additional Inherited Members

- Public Types inherited from Observer::Publisher< EffectSettingChanged >
using message_type = EffectSettingChanged
 
using CallbackReturn = std::conditional_t< true, void, bool >
 
using Callback = std::function< CallbackReturn(const EffectSettingChanged &) >
 Type of functions that can be connected to the Publisher. More...
 
- Static Public Member Functions inherited from EffectEditor
static bool EnableApply (wxWindow *parent, bool enable=true)
 Enable or disable the Apply button of the dialog that contains parent. More...
 
static bool EnablePreview (wxWindow *parent, bool enable=true)
 
- Static Public Attributes inherited from EffectEditor
static constexpr int kPlayID = 20102
 
- Static Public Attributes inherited from Observer::Publisher< EffectSettingChanged >
static constexpr bool notifies_all
 
- Protected Member Functions inherited from EffectEditor
template<typename EventTag , typename Class , typename Event >
void BindTo (wxEvtHandler &src, const EventTag &eventType, void(Class::*pmf)(Event &))
 
- Protected Member Functions inherited from Observer::Publisher< EffectSettingChanged >
CallbackReturn Publish (const EffectSettingChanged &message)
 Send a message to connected callbacks. More...
 

Detailed Description

Definition at line 43 of file EqualizationUI.cpp.

Constructor & Destructor Documentation

◆ EqualizationUIEditor()

anonymous_namespace{EqualizationUI.cpp}::EqualizationUIEditor::EqualizationUIEditor ( EqualizationUI ui,
EffectUIServices services,
EffectSettingsAccess access,
wxWindow *  pParent = nullptr 
)
inline
Parameters
pParentif not null, caller will push an event handler onto this window; then this object is responsible to pop it

Definition at line 50 of file EqualizationUI.cpp.

53 : EffectEditor { services, access }
54 , mEqualizationUI { ui }
55 , mpParent { pParent }
56 {
57 if (mpParent)
58 mpParent->PushEventHandler(&ui);
59 }

◆ ~EqualizationUIEditor()

anonymous_namespace{EqualizationUI.cpp}::EqualizationUIEditor::~EqualizationUIEditor ( )
inlineoverride

Calls Disconnect.

Definition at line 61 of file EqualizationUI.cpp.

62 {
63 Disconnect();
64 }
void Disconnect() override
On the first call only, may disconnect from further event handling.

Member Function Documentation

◆ Disconnect()

void anonymous_namespace{EqualizationUI.cpp}::EqualizationUIEditor::Disconnect ( )
inlineoverridevirtual

On the first call only, may disconnect from further event handling.

Default implemantation does nothing

Reimplemented from EffectEditor.

Definition at line 78 of file EqualizationUI.cpp.

79 {
80 if (mpParent)
81 {
82 mpParent->PopEventHandler();
83 mpParent = nullptr;
84 }
85 }

◆ ValidateUI()

bool anonymous_namespace{EqualizationUI.cpp}::EqualizationUIEditor::ValidateUI ( )
inlineoverridevirtual

Calls mServices.ValidateUI()

Implements EffectEditor.

Definition at line 66 of file EqualizationUI.cpp.

67 {
68 bool result {};
71 {
73 return nullptr;
74 });
75 return result;
76 }
static Settings & settings()
Definition: TrackInfo.cpp:69
EffectSettingsAccess & mAccess
Definition: EffectEditor.h:92
void ModifySettings(Function &&function)
Do a correct read-modify-write of settings.
bool ValidateUI(EffectSettings &settings)
Externalized state of a plug-in.

References settings().

Here is the call graph for this function:

Member Data Documentation

◆ mEqualizationUI

EqualizationUI& anonymous_namespace{EqualizationUI.cpp}::EqualizationUIEditor::mEqualizationUI
protected

Definition at line 88 of file EqualizationUI.cpp.

◆ mpParent

wxWindow* anonymous_namespace{EqualizationUI.cpp}::EqualizationUIEditor::mpParent {}
protected

Definition at line 89 of file EqualizationUI.cpp.


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