followup to the previous tempo-dragging commit: use argument to Drag::aborted() to...
[ardour.git] / gtk2_ardour / plugin_ui.h
index 20282c4cfaacf35f4336ae030b5e638e8ebbe8c4..92af891803b8649a4bd22c3af2aa4e11f8026b8a 100644 (file)
 #include <gtkmm/socket.h>
 
 #include "ardour/types.h"
+#include "ardour/plugin.h"
 
 #include "automation_controller.h"
+#include "ardour_button.h"
 
 namespace ARDOUR {
        class PluginInsert;
        class Plugin;
-       class VSTPlugin;
+       class WindowsVSTPlugin;
        class LXVSTPlugin;
        class IOProcessor;
        class AUPlugin;
+       class Processor;
 }
 
 namespace PBD {
@@ -71,7 +74,7 @@ namespace Gtkmm2ext {
 }
 
 class LatencyGUI;
-class ArdourDialog;
+class ArdourWindow;
 class PluginEqGui;
 
 class PlugUIBase : public virtual sigc::trackable, public PBD::ScopedConnectionList
@@ -104,23 +107,35 @@ class PlugUIBase : public virtual sigc::trackable, public PBD::ScopedConnectionL
   protected:
        boost::shared_ptr<ARDOUR::PluginInsert> insert;
        boost::shared_ptr<ARDOUR::Plugin> plugin;
-       Gtk::HBox _preset_box;
+
+       /* UI elements that can subclasses can add to their widgets */
+
+       /** a ComboBoxText which lists presets and manages their selection */
        Gtk::ComboBoxText _preset_combo;
+       /** a label which has a * in if the current settings are different from the preset being shown */
        Gtk::Label _preset_modified;
+       /** a button to add a preset */
        Gtk::Button add_button;
+       /** a button to save the current settings as a new user preset */
        Gtk::Button save_button;
+       /** a button to delete the current preset (if it is a user one) */
        Gtk::Button delete_button;
-       Gtk::ToggleButton bypass_button;
+       /** a button to bypass the plugin */
+       ArdourButton bypass_button;
+       /** a button to acquire keyboard focus */
        Gtk::EventBox focus_button;
-
+       /** an expander containing the plugin analysis graph */
+       Gtk::Expander plugin_analysis_expander;
+       /** a label indicating the plugin latency */
        Gtk::Label latency_label;
+       /** a button which, when clicked, opens the latency GUI */
        Gtk::Button latency_button;
+       
        void set_latency_label ();
 
        LatencyGUI* latency_gui;
-       ArdourDialog* latency_dialog;
+       ArdourWindow* latency_dialog;
 
-       Gtk::Expander plugin_analysis_expander;
        PluginEqGui* eqgui;
        Gtk::Requisition pre_eq_size;
 
@@ -133,7 +148,7 @@ class PlugUIBase : public virtual sigc::trackable, public PBD::ScopedConnectionL
        void save_plugin_setting ();
        void delete_plugin_setting ();
        bool focus_toggled(GdkEventButton*);
-       void bypass_toggled();
+       bool bypass_button_release(GdkEventButton*);
        void toggle_plugin_analysis ();
        void processor_active_changed (boost::weak_ptr<ARDOUR::Processor> p);
        void plugin_going_away ();
@@ -248,8 +263,6 @@ class GenericPluginUI : public PlugUIBase, public Gtk::VBox
        void control_port_toggled (ControlUI* cui);
        void control_combo_changed (ControlUI* cui);
 
-       void processor_active_changed (boost::weak_ptr<ARDOUR::Processor>);
-
        void astate_clicked (ControlUI*, uint32_t parameter);
        void automation_state_changed (ControlUI*);
        void set_automation_state (ARDOUR::AutoState state, ControlUI* cui);
@@ -298,7 +311,7 @@ class PluginUIWindow : public Gtk::Window
        void app_activated (bool);
        void plugin_going_away ();
 
-       bool create_vst_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
+       bool create_windows_vst_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
        bool create_lxvst_editor(boost::shared_ptr<ARDOUR::PluginInsert>);
        bool create_audiounit_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
        bool create_lv2_editor (boost::shared_ptr<ARDOUR::PluginInsert>);