Ardour  9.0-pre0-350-gf17a656217
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
PlugUIBase Class Referenceabstract

#include <plugin_ui.h>

Inheritance diagram for PlugUIBase:
[legend]

Public Member Functions

 PlugUIBase (std::shared_ptr< ARDOUR::PlugInsertBase >)
 
virtual ~PlugUIBase ()
 
virtual gint get_preferred_height ()=0
 
virtual gint get_preferred_width ()=0
 
virtual bool resizable ()
 
virtual bool start_updating (GdkEventAny *)=0
 
virtual bool stop_updating (GdkEventAny *)=0
 
virtual bool is_external () const
 
virtual bool is_external_visible () const
 
virtual void activate ()
 
virtual void deactivate ()
 
void update_preset_list ()
 
void update_preset ()
 
void latency_button_clicked ()
 
void tailtime_button_clicked ()
 
virtual bool on_window_show (const std::string &)
 
virtual void on_window_hide ()
 
virtual void forward_key_event (GdkEventKey *)
 
virtual void grab_focus ()
 
virtual bool non_gtk_gui () const
 
- Public Member Functions inherited from PBD::ScopedConnectionList
 ScopedConnectionList ()
 
 ScopedConnectionList (const ScopedConnectionList &)=delete
 
ScopedConnectionList & operator= (const ScopedConnectionList &)=delete
 
virtual ~ScopedConnectionList ()
 
void add_connection (const UnscopedConnection &c)
 
void drop_connections ()
 

Public Attributes

sigc::signal< void, bool > KeyboardFocused
 

Protected Member Functions

void add_common_widgets (Gtk::HBox *, bool with_focus=true)
 
void set_latency_label ()
 
void set_tailtime_label ()
 
virtual void preset_selected (ARDOUR::Plugin::PresetRecord preset)
 
void add_plugin_setting ()
 
void save_plugin_setting ()
 
void delete_plugin_setting ()
 
void reset_plugin_parameters ()
 
void browse_presets ()
 
void manage_pins ()
 
bool focus_toggled (GdkEventButton *)
 
bool bypass_button_release (GdkEventButton *)
 
void toggle_description ()
 
void toggle_plugin_analysis ()
 
void toggle_cpuload_display ()
 
void processor_active_changed (std::weak_ptr< ARDOUR::Processor > p)
 
void plugin_going_away ()
 
void automation_state_changed ()
 
void preset_added_or_removed ()
 
void update_preset_modified ()
 
bool has_descriptive_presets () const
 

Protected Attributes

std::shared_ptr< ARDOUR::PlugInsertBase > _pib
 
std::shared_ptr< ARDOUR::PluginInsert > _pi
 
std::shared_ptr< ARDOUR::Plugin > plugin
 
ArdourWidgets::ArdourDropdown _preset_combo
 
Gtk::Label _preset_modified
 
ArdourWidgets::ArdourButton _add_button
 
ArdourWidgets::ArdourButton _save_button
 
ArdourWidgets::ArdourButton _delete_button
 
ArdourWidgets::ArdourButton _preset_browser_button
 
ArdourWidgets::ArdourButton _reset_button
 
ArdourWidgets::ArdourButton _bypass_button
 
ArdourWidgets::ArdourButton _pin_management_button
 
Gtk::EventBox _focus_button
 
Gtk::Expander description_expander
 
Gtk::Expander plugin_analysis_expander
 
Gtk::Expander cpuload_expander
 
ArdourWidgets::ArdourButton _latency_button
 
ArdourWidgets::ArdourButton _tailtime_button
 
ArdourWidgets::ArdourButton automation_manual_all_button
 
ArdourWidgets::ArdourButton automation_play_all_button
 
ArdourWidgets::ArdourButton automation_write_all_button
 
ArdourWidgets::ArdourButton automation_touch_all_button
 
ArdourWidgets::ArdourButton automation_latch_all_button
 
TimeCtlGUI * latency_gui
 
ArdourWindow * latency_dialog
 
TimeCtlGUI * tailtime_gui
 
ArdourWindow * tailtime_dialog
 
PluginEqGui * eqgui
 
PluginLoadStatsGui * stats_gui
 
PluginPresetsUI * preset_gui
 
ArdourWindow * preset_dialog
 
int _no_load_preset
 
PBD::ScopedConnection death_connection
 
PBD::ScopedConnection active_connection
 
PBD::ScopedConnection preset_added_connection
 
PBD::ScopedConnection preset_removed_connection
 
PBD::ScopedConnectionList control_connections
 

Private Attributes

Gtk::Image * _focus_out_image
 
Gtk::Image * _focus_in_image
 

Detailed Description

Definition at line 90 of file plugin_ui.h.

Constructor & Destructor Documentation

◆ PlugUIBase()

PlugUIBase::PlugUIBase ( std::shared_ptr< ARDOUR::PlugInsertBase >  )

◆ ~PlugUIBase()

virtual PlugUIBase::~PlugUIBase ( )
virtual

Member Function Documentation

◆ activate()

virtual void PlugUIBase::activate ( )
inlinevirtual

Reimplemented in AUPluginUI.

Definition at line 105 of file plugin_ui.h.

◆ add_common_widgets()

void PlugUIBase::add_common_widgets ( Gtk::HBox *  ,
bool  with_focus = true 
)
protected

◆ add_plugin_setting()

void PlugUIBase::add_plugin_setting ( )
protected

◆ automation_state_changed()

void PlugUIBase::automation_state_changed ( )
protected

◆ browse_presets()

void PlugUIBase::browse_presets ( )
protected

◆ bypass_button_release()

bool PlugUIBase::bypass_button_release ( GdkEventButton *  )
protected

◆ deactivate()

virtual void PlugUIBase::deactivate ( )
inlinevirtual

Reimplemented in AUPluginUI.

Definition at line 106 of file plugin_ui.h.

◆ delete_plugin_setting()

void PlugUIBase::delete_plugin_setting ( )
protected

◆ focus_toggled()

bool PlugUIBase::focus_toggled ( GdkEventButton *  )
protected

◆ forward_key_event()

virtual void PlugUIBase::forward_key_event ( GdkEventKey *  )
inlinevirtual

Reimplemented in WindowsVSTPluginUI, MacVSTPluginUI, LXVSTPluginUI, and AUPluginUI.

Definition at line 117 of file plugin_ui.h.

◆ get_preferred_height()

virtual gint PlugUIBase::get_preferred_height ( )
pure virtual

Implemented in VSTPluginUI, GenericPluginUI, LXVSTPluginUI, LV2PluginUI, and AUPluginUI.

◆ get_preferred_width()

virtual gint PlugUIBase::get_preferred_width ( )
pure virtual

Implemented in VSTPluginUI, GenericPluginUI, LV2PluginUI, and AUPluginUI.

◆ grab_focus()

virtual void PlugUIBase::grab_focus ( )
inlinevirtual

Reimplemented in LV2PluginUI, and AUPluginUI.

Definition at line 118 of file plugin_ui.h.

◆ has_descriptive_presets()

bool PlugUIBase::has_descriptive_presets ( ) const
protected

◆ is_external()

virtual bool PlugUIBase::is_external ( ) const
inlinevirtual

Reimplemented in LV2PluginUI.

Definition at line 102 of file plugin_ui.h.

◆ is_external_visible()

virtual bool PlugUIBase::is_external_visible ( ) const
inlinevirtual

Reimplemented in LV2PluginUI.

Definition at line 103 of file plugin_ui.h.

◆ latency_button_clicked()

void PlugUIBase::latency_button_clicked ( )

◆ manage_pins()

void PlugUIBase::manage_pins ( )
protected

◆ non_gtk_gui()

virtual bool PlugUIBase::non_gtk_gui ( ) const
inlinevirtual

Reimplemented in VSTPluginUI, LXVSTPluginUI, and AUPluginUI.

Definition at line 119 of file plugin_ui.h.

◆ on_window_hide()

virtual void PlugUIBase::on_window_hide ( )
inlinevirtual

Reimplemented in VSTPluginUI, LV2PluginUI, and AUPluginUI.

Definition at line 115 of file plugin_ui.h.

◆ on_window_show()

virtual bool PlugUIBase::on_window_show ( const std::string &  )
inlinevirtual

Reimplemented in VSTPluginUI, LV2PluginUI, and AUPluginUI.

Definition at line 114 of file plugin_ui.h.

◆ plugin_going_away()

void PlugUIBase::plugin_going_away ( )
protected

◆ preset_added_or_removed()

void PlugUIBase::preset_added_or_removed ( )
protected

◆ preset_selected()

virtual void PlugUIBase::preset_selected ( ARDOUR::Plugin::PresetRecord  preset)
protectedvirtual

Reimplemented in VSTPluginUI.

◆ processor_active_changed()

void PlugUIBase::processor_active_changed ( std::weak_ptr< ARDOUR::Processor >  p)
protected

◆ reset_plugin_parameters()

void PlugUIBase::reset_plugin_parameters ( )
protected

◆ resizable()

virtual bool PlugUIBase::resizable ( )
inlinevirtual

Reimplemented in LV2PluginUI.

Definition at line 98 of file plugin_ui.h.

◆ save_plugin_setting()

void PlugUIBase::save_plugin_setting ( )
protected

◆ set_latency_label()

void PlugUIBase::set_latency_label ( )
protected

◆ set_tailtime_label()

void PlugUIBase::set_tailtime_label ( )
protected

◆ start_updating()

virtual bool PlugUIBase::start_updating ( GdkEventAny *  )
pure virtual

Implemented in WindowsVSTPluginUI, GenericPluginUI, MacVSTPluginUI, LXVSTPluginUI, LV2PluginUI, and AUPluginUI.

◆ stop_updating()

virtual bool PlugUIBase::stop_updating ( GdkEventAny *  )
pure virtual

Implemented in WindowsVSTPluginUI, GenericPluginUI, MacVSTPluginUI, LXVSTPluginUI, LV2PluginUI, and AUPluginUI.

◆ tailtime_button_clicked()

void PlugUIBase::tailtime_button_clicked ( )

◆ toggle_cpuload_display()

void PlugUIBase::toggle_cpuload_display ( )
protected

◆ toggle_description()

void PlugUIBase::toggle_description ( )
protected

◆ toggle_plugin_analysis()

void PlugUIBase::toggle_plugin_analysis ( )
protected

◆ update_preset()

void PlugUIBase::update_preset ( )

◆ update_preset_list()

void PlugUIBase::update_preset_list ( )

◆ update_preset_modified()

void PlugUIBase::update_preset_modified ( )
protected

Member Data Documentation

◆ _add_button

ArdourWidgets::ArdourButton PlugUIBase::_add_button
protected

a button to add a preset

Definition at line 137 of file plugin_ui.h.

◆ _bypass_button

ArdourWidgets::ArdourButton PlugUIBase::_bypass_button
protected

a button to bypass the plugin

Definition at line 147 of file plugin_ui.h.

◆ _delete_button

ArdourWidgets::ArdourButton PlugUIBase::_delete_button
protected

a button to delete the current preset (if it is a user one)

Definition at line 141 of file plugin_ui.h.

◆ _focus_button

Gtk::EventBox PlugUIBase::_focus_button
protected

a button to acquire keyboard focus

Definition at line 151 of file plugin_ui.h.

◆ _focus_in_image

Gtk::Image* PlugUIBase::_focus_in_image
private

Definition at line 216 of file plugin_ui.h.

◆ _focus_out_image

Gtk::Image* PlugUIBase::_focus_out_image
private

Definition at line 215 of file plugin_ui.h.

◆ _latency_button

ArdourWidgets::ArdourButton PlugUIBase::_latency_button
protected

a button which, when clicked, opens the latency GUI

Definition at line 159 of file plugin_ui.h.

◆ _no_load_preset

int PlugUIBase::_no_load_preset
protected

Definition at line 186 of file plugin_ui.h.

◆ _pi

std::shared_ptr<ARDOUR::PluginInsert> PlugUIBase::_pi
protected

Definition at line 125 of file plugin_ui.h.

◆ _pib

std::shared_ptr<ARDOUR::PlugInsertBase> PlugUIBase::_pib
protected

Definition at line 124 of file plugin_ui.h.

◆ _pin_management_button

ArdourWidgets::ArdourButton PlugUIBase::_pin_management_button
protected

and self-explaining button :)

Definition at line 149 of file plugin_ui.h.

◆ _preset_browser_button

ArdourWidgets::ArdourButton PlugUIBase::_preset_browser_button
protected

a button to show a preset browser

Definition at line 143 of file plugin_ui.h.

◆ _preset_combo

ArdourWidgets::ArdourDropdown PlugUIBase::_preset_combo
protected

a ComboBoxText which lists presets and manages their selection

Definition at line 133 of file plugin_ui.h.

◆ _preset_modified

Gtk::Label PlugUIBase::_preset_modified
protected

a label which has a * in if the current settings are different from the preset being shown

Definition at line 135 of file plugin_ui.h.

◆ _reset_button

ArdourWidgets::ArdourButton PlugUIBase::_reset_button
protected

a button to delete the reset the plugin params

Definition at line 145 of file plugin_ui.h.

◆ _save_button

ArdourWidgets::ArdourButton PlugUIBase::_save_button
protected

a button to save the current settings as a new user preset

Definition at line 139 of file plugin_ui.h.

◆ _tailtime_button

ArdourWidgets::ArdourButton PlugUIBase::_tailtime_button
protected

a button which, when clicked, opens the tailtime GUI

Definition at line 161 of file plugin_ui.h.

◆ active_connection

PBD::ScopedConnection PlugUIBase::active_connection
protected

Definition at line 209 of file plugin_ui.h.

◆ automation_latch_all_button

ArdourWidgets::ArdourButton PlugUIBase::automation_latch_all_button
protected

a button which sets all controls' automation setting to Latch

Definition at line 171 of file plugin_ui.h.

◆ automation_manual_all_button

ArdourWidgets::ArdourButton PlugUIBase::automation_manual_all_button
protected

a button which sets all controls' automation setting to Manual

Definition at line 163 of file plugin_ui.h.

◆ automation_play_all_button

ArdourWidgets::ArdourButton PlugUIBase::automation_play_all_button
protected

a button which sets all controls' automation setting to Play

Definition at line 165 of file plugin_ui.h.

◆ automation_touch_all_button

ArdourWidgets::ArdourButton PlugUIBase::automation_touch_all_button
protected

a button which sets all controls' automation setting to Touch

Definition at line 169 of file plugin_ui.h.

◆ automation_write_all_button

ArdourWidgets::ArdourButton PlugUIBase::automation_write_all_button
protected

a button which sets all controls' automation setting to Write

Definition at line 167 of file plugin_ui.h.

◆ control_connections

PBD::ScopedConnectionList PlugUIBase::control_connections
protected

Definition at line 212 of file plugin_ui.h.

◆ cpuload_expander

Gtk::Expander PlugUIBase::cpuload_expander
protected

an expander containing the plugin cpu profile

Definition at line 157 of file plugin_ui.h.

◆ death_connection

PBD::ScopedConnection PlugUIBase::death_connection
protected

Definition at line 208 of file plugin_ui.h.

◆ description_expander

Gtk::Expander PlugUIBase::description_expander
protected

an expander containing the plugin description

Definition at line 153 of file plugin_ui.h.

◆ eqgui

PluginEqGui* PlugUIBase::eqgui
protected

Definition at line 181 of file plugin_ui.h.

◆ KeyboardFocused

sigc::signal<void,bool> PlugUIBase::KeyboardFocused

Definition at line 121 of file plugin_ui.h.

◆ latency_dialog

ArdourWindow* PlugUIBase::latency_dialog
protected

Definition at line 175 of file plugin_ui.h.

◆ latency_gui

TimeCtlGUI* PlugUIBase::latency_gui
protected

Definition at line 174 of file plugin_ui.h.

◆ plugin

std::shared_ptr<ARDOUR::Plugin> PlugUIBase::plugin
protected

Definition at line 126 of file plugin_ui.h.

◆ plugin_analysis_expander

Gtk::Expander PlugUIBase::plugin_analysis_expander
protected

an expander containing the plugin analysis graph

Definition at line 155 of file plugin_ui.h.

◆ preset_added_connection

PBD::ScopedConnection PlugUIBase::preset_added_connection
protected

Definition at line 210 of file plugin_ui.h.

◆ preset_dialog

ArdourWindow* PlugUIBase::preset_dialog
protected

Definition at line 184 of file plugin_ui.h.

◆ preset_gui

PluginPresetsUI* PlugUIBase::preset_gui
protected

Definition at line 183 of file plugin_ui.h.

◆ preset_removed_connection

PBD::ScopedConnection PlugUIBase::preset_removed_connection
protected

Definition at line 211 of file plugin_ui.h.

◆ stats_gui

PluginLoadStatsGui* PlugUIBase::stats_gui
protected

Definition at line 182 of file plugin_ui.h.

◆ tailtime_dialog

ArdourWindow* PlugUIBase::tailtime_dialog
protected

Definition at line 179 of file plugin_ui.h.

◆ tailtime_gui

TimeCtlGUI* PlugUIBase::tailtime_gui
protected

Definition at line 178 of file plugin_ui.h.

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