]> git.lyx.org Git - lyx.git/blobdiff - src/frontends/qt4/GuiDialog.h
Typos in the comment.
[lyx.git] / src / frontends / qt4 / GuiDialog.h
index b43448a5f28fc238fec1a226143940ac9443a60e..1e95fc5e371ae79e21cc2d70ac7e4119ccad1309 100644 (file)
 #include "ButtonController.h"
 
 #include <QDialog>
-#include <QObject>
+
 
 namespace lyx {
 namespace frontend {
 
-/** \c Dialog collects the different parts of a Model-Controller-View
- *  split of a generic dialog together.
- */
+/// Base class for historical LyX dialogs.
+/** 
+  * \warning New dialogs should use the leaner classes \c DialogView or
+  * \c DockView depending on the intent. Eventually, old dialogs should be
+  * converted to \c DialogView too.
+  */
 class GuiDialog : public QDialog, public Dialog
 {
        Q_OBJECT
@@ -32,38 +35,35 @@ public:
        /// \param lv is the access point for the dialog to the LyX kernel.
        /// \param name is the identifier given to the dialog by its parent
        /// container.
-       GuiDialog(LyXView & lv, std::string const & name);
-       //GuiDialog(GuiDialog &, docstring const &);
+       /// \param title is the window title used for decoration.
+       GuiDialog(GuiView & lv, QString const & name, QString const & title);
+
+       virtual QWidget * asQWidget() { return this; }
+       virtual QWidget const * asQWidget() const { return this; }
 
 public Q_SLOTS:
-       // dialog closed from WM
-       void slotWMHide();
+       /** \name Buttons
+        *  These methods are publicly accessible because they are invoked
+        *  by the View when the user presses... guess what ;-)
+        */
        // Restore button clicked
        void slotRestore();
        // OK button clicked
        void slotOK();
        // Apply button clicked
        void slotApply();
-       // Close button clicked
+       // AutoApply checkbox clicked
+       void slotAutoApply();
+       // Close button clicked or closed from WindowManager
        void slotClose();
+       ///
+       void closeEvent(QCloseEvent * e);
 
 public:
-       /** \name Buttons
-        *  These methods are publicly accessible because they are invoked
-        *  by the View when the user presses... guess what ;-)
-        */
-       //@{
-       void ApplyButton();
-       void OKButton();
-       void CancelButton();
-       void RestoreButton();
-       //@}
-
        /** Check whether we may apply our data.
         *
         *  The buttons are disabled if not and (re-)enabled if yes.
         */
-       void checkStatus();
        void setButtonsValid(bool valid);
 
        /** \name Dialog Components
@@ -74,43 +74,42 @@ public:
        ButtonController & bc() { return bc_; }
        //@}
 
-       void preShow();
-       void postShow();
-       void preUpdate();
-       void postUpdate();
-
-       void setViewTitle(docstring const & title);
-
-       ///
-       bool readOnly() const;
-
        /// the dialog has changed contents
        virtual void changed();
 
+       virtual void enableView(bool enable);
+
        /// default: do nothing
        virtual void applyView() {}
        /// default: do nothing
-       virtual void update_contents() {}
+       virtual void updateContents() {}
 
-protected:
-       /// Hide the dialog.
-       virtual void hideView();
-       /// Create the dialog if necessary, update it and display it.
-       virtual void showView();
-       ///
-       virtual bool isVisibleView() const;
+public:
        /// is the dialog currently valid ?
-       virtual bool isValid();
+       virtual bool isValid() { return true; }
 
-private:
-       /// update the dialog
+public:
+
+       /** When applying, it's useful to know whether the dialog is about
+        *  to close or not (no point refreshing the display for example).
+        */
+       bool isClosing() const { return is_closing_; }
+       
+       ///
+       bool needBufferOpen() const { return isBufferDependent(); }
+
+       /// Update the display of the dialog whilst it is still visible.
        virtual void updateView();
 
+private:
        ButtonController bc_;
        /// are we updating ?
        bool updating_;
+
+       bool is_closing_;
 };
 
+
 } // namespace frontend
 } // namespace lyx