3 * \file ControlButtons.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Angus Leeming
9 * Full author contact details are available in file CREDITS
11 * ControlButtons serves only to control the activation of the Ok, Apply, Cancel
12 * and Restore buttons on the View dialog.
14 * More generally, the class is part of a hierarchy of controller classes
15 * that together connect the GUI-dependent dialog to any appropriate
16 * signals and dispatches any changes to the kernel.
18 * These controllers have no knowledge of the actual instantiation of the
19 * GUI-dependent View and ButtonController, which should therefore
20 * be created elsewhere.
22 * Once created, the Controller will take care of their initialisation,
23 * management and, ultimately, destruction.
26 #ifndef CONTROLBUTTONS_H
27 #define CONTROLBUTTONS_H
33 #include <boost/utility.hpp>
36 class ButtonControllerBase;
38 /** Abstract base class for Controllers with a ButtonController.
40 class ControlButtons : boost::noncopyable {
45 virtual ~ControlButtons() {}
47 /** These functions are called by the view when the appropriate buttons
59 /// Returns the user-specified iconification policy.
60 bool IconifyWithMain() const;
63 ButtonControllerBase & bc();
66 void setView(ViewBase &);
68 void setButtonController(ButtonControllerBase &);
73 /** When Applying it's useful to know whether the dialog is about
74 to close or not (no point refreshing the display for example). */
75 bool isClosing() const { return is_closing_; }
77 /// Get changed parameters and Dispatch them to the kernel.
78 virtual void apply() = 0;
79 /// Disconnect signals and hide View.
80 virtual void hide() = 0;
81 /// Update dialog before showing it.
82 virtual void update() = 0;
84 /** This flag can be set by one of the miriad the controller methods
85 to ensure that the dialog is shut down. */
90 /// We own neither of these pointers.
91 ButtonControllerBase * bc_ptr_;
96 #endif // CONTROLBUTTONS_H