Add a buffer_path arg to InsetGraphicsMailer's params2string, string2params.

[lyx.git] / src / frontends / controllers / BCView.h

diff --git a/src/frontends/controllers/BCView.h b/src/frontends/controllers/BCView.h
index f4d66bb73b89dbb6b374245201ead9eaf0db0b4c..707192d27cc5cc8ebcfde464363897c74e7e74c3 100644 (file)
--- a/src/frontends/controllers/BCView.h
+++ b/src/frontends/controllers/BCView.h
@@ -14,13 +14,26 @@
 #ifndef BCVIEW_H
 #define BCVIEW_H
 
+
 #include "LString.h"
 #include <boost/shared_ptr.hpp>
 #include <list>
 
+
 class ButtonController;
 class ButtonPolicy;
 
+
+/** \c CheckedWidget is an abstract base class that can be stored
+ *  in the button controller's view and can be interrogated by it
+ *  when the activation state of the Ok, Apply buttons is refreshed.
+ *  Ideally, the user will be prevented from returning invalid data
+ *  to the LyX kernel.
+ *
+ *  Many widgets can be grouped together in the derived class if they
+ *  make a logical whole. E.g., an input and a choice widget that together
+ *  are used to set a LyXLength can be interrogated together.
+ */
 struct CheckedWidget {
        ///
        virtual ~CheckedWidget();
@@ -33,30 +46,40 @@ struct CheckedWidget {
 };
 
 
+/** \c BCView is the View to ButtonController's Controller. It
+ *  stores the individual GUI widgets and sets their activation state
+ *  upon receipt of instructions from the controller.
+ *
+ *  It is a base class. The true, GUI, instantiations derive from it.
+ */
 class BCView {
 public:
        BCView(ButtonController const &);
-       ///
        virtual ~BCView() {}
-       ///
-       virtual void refresh() = 0;
-       ///
-       virtual void refreshReadOnly() = 0;
-       ///
+
+       //@{
+       /// Refresh the status of the Ok, Apply, Restore, Cancel buttons.
+       virtual void refresh() const = 0;
+       /// Refresh the status of any widgets in the read_only list
+       virtual void refreshReadOnly() const = 0;
+       //@}
+
+       /// A shortcut to the BP of the BC.
        ButtonPolicy & bp() const;
-       ///
+
+       /** Add a widget to the list of all widgets whose validity should
+        *  be checked explicitly when the buttons are refreshed.
+        */
        void addCheckedWidget(CheckedWidget * ptr);
+
 protected:
-       ///
-       bool checkWidgets();
+       /// \return true if all CheckedWidgets are in a valid state.
+       bool checkWidgets() const;
 
 private:
-       ///
        typedef boost::shared_ptr<CheckedWidget> checked_widget_ptr;
        typedef std::list<checked_widget_ptr> checked_widget_list;
-       ///
        checked_widget_list checked_widgets;
-       ///
        ButtonController const & parent;
 };
 
@@ -71,33 +94,37 @@ public:
        GuiBC(ButtonController const & parent,
              string const & cancel, string const & close);
 
-       ///
+       //@{
+       /** Store pointers to these widgets. The pointers are _not_
+        *  owned by GuiBC.
+        */
        void setOK(Button * obj) { okay_ = obj; }
-       ///
        void setApply(Button * obj) { apply_ = obj; }
-       ///
        void setCancel(Button * obj) { cancel_ = obj; }
-       ///
        void setRestore(Button * obj) { restore_ = obj; }
-       ///
+       //@}
+
+       /** Add a pointer to the list of widgets whose activation
+        *  state is dependent upon the read-only status of the
+        *  underlying buffer.
+        */
        void addReadOnly(Widget * obj) { read_only_.push_back(obj); }
-       ///
-       void eraseReadOnly() { read_only_.clear(); }
 
        /// Refresh the status of the Ok, Apply, Restore, Cancel buttons.
-       void refresh();
+       virtual void refresh() const;
        /// Refresh the status of any widgets in the read_only list
-       void refreshReadOnly();
+       virtual void refreshReadOnly() const;
+
 private:
        /// Enable/Disable a widget
-       virtual void setWidgetEnabled(Widget * obj, bool enable) = 0;
+       virtual void setWidgetEnabled(Widget * obj, bool enable) const = 0;
        /// Enable/Disable a button
-       virtual void setButtonEnabled(Button * obj, bool enable) = 0;
+       virtual void setButtonEnabled(Button * obj, bool enable) const = 0;
        /// Set the Label on the button
-       virtual void setButtonLabel(Button * obj, string const & label) = 0;
+       virtual void setButtonLabel(Button * obj, string const & label) const = 0;
 
-       string cancel_label_;
-       string close_label_;
+       string const cancel_label_;
+       string const close_label_;
 
        Button * okay_;
        Button * apply_;