1 This file contains some do's and dont's for the Qt2 frontend.
6 Every editable field that affects the state of the dialog contents
7 from LyX's point of view should connect its xxxChanged() signal to
8 a the dialog's changed_adaptor() slot, which in turn should call
9 form_->changed(). If you are using a more complicated thing anyway,
10 then remember to call form_->changed() at the end (if it has changed !)
12 Every non-trivial widget should have a tooltip. If you don't know
13 what to write, write "FIXME", and it can fixed later. Don't be afraid
14 to use QWhatsThis too (e.g. the index dialog)
16 If necessary, you should override Qt2Base::isValid() for determining the validity
17 of the current dialog's contents.
19 OK/Apply/Restore/Close should be connected in the derived class's constructor
20 to call form_->slotOK() etc. Refer to close/cancel as close in the source.
22 Override update_contents() to update the dialog, not update(), and build_dialog(),
23 not build(). Only these functions may change dialog widgets that may emit changed()
24 during initialisation, to prevent the button controller from changing its state.
26 Never call buttoncontroller functions directly from dialogs. In general, you
27 should use Qt2Base::changed() in all circumstances. However, if you must call
28 the buttoncontroller, make sure to respect Qt2Base::updating_
30 Don't #undef emit - #include "QtLyXView.h" instead
35 QFoo.[Ch] The file that interacts with the controller
36 QFooDialog.[Ch] The implementation of the dialog, derived from the generated files
37 ui/QFooDialog.ui The designer file
38 ui/QFooDialogBase.[Ch] Generated files from QFooDialog.ui
40 slots should be named e.g. slotFooClicked(), slotFooSelected(), where foo is the name
43 Widgets should be named like "fooXX", where XX is one of the following
52 (FIXME: complete this)
55 Dialog Maintainer MVC conversion
56 ----------------------------------------------
61 Document Kalle Waiting for MVC
64 Paragraph Edwin Waiting for MVC
69 Tabular Waiting for MVC