3 * \file ButtonController.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
12 #ifndef BUTTONCONTROLLER_H
13 #define BUTTONCONTROLLER_H
15 #include "ButtonPolicy.h"
24 /** General purpose button controller for up to four buttons.
25 Controls the activation of the OK, Apply and Cancel buttons.
26 Actually supports 4 buttons in all and it's up to the user to decide on
27 the activation policy and which buttons correspond to which output of the
32 /** \c ButtonController controls the activation of the OK, Apply and
35 * It actually supports 4 buttons in all and it's up to the user to decide on
36 * the activation policy and which buttons correspond to which output of the
40 class ButtonController
47 /** Methods to set and get the ButtonPolicy.
48 * \param ptr is owned by the ButtonController.
50 void setPolicy(ButtonPolicy::Policy policy);
51 ButtonPolicy const & policy() const;
52 ButtonPolicy & policy();
56 void input(ButtonPolicy::SMInput);
59 /// Tell the BC that a particular button has been pressed.
66 /// Tell the BC that the dialog is being hidden
69 /**Refresh the activation state of the Ok, Apply, Close and
74 /** Refresh the activation state of all the widgets under the control
75 * of the BC to reflect the read-only status of the underlying buffer.
77 void refreshReadOnly() const;
79 /** Passthrough function -- returns its input value
80 * Tell the BC about the read-only status of the underlying buffer.
82 bool setReadOnly(bool);
84 /** \param validity Tell the BC that the data is, or is not, valid.
85 * Sets the activation state of the buttons immediately.
94 /** Store pointers to these widgets.
96 void setOK(QPushButton * obj);
97 void setApply(QPushButton * obj);
98 void setCancel(QPushButton * obj);
99 void setRestore(QPushButton * obj);
102 /** Add a pointer to the list of widgets whose activation
103 * state is dependent upon the read-only status of the
106 void addReadOnly(QWidget * obj);
108 /** Add a widget to the list of all widgets whose validity should
109 * be checked explicitly when the buttons are refreshed.
111 void addCheckedLineEdit(QLineEdit * input, QWidget * label = 0);
115 ButtonController(ButtonController const &);
116 void operator=(ButtonController const &);
123 } // namespace frontend
126 #endif // BUTTONCONTROLLER_H