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, but this must be done in the derived class's
15 constructor, and use _("..."). Non-trivial means that things like "OK"
16 /must not/ have a tooltip.
18 If necessary, you should override Qt2Base::isValid() for determining the validity
19 of the current dialog's contents.
21 OK/Apply/Restore/Close should be connected in the derived class's constructor
22 to call form_->slotOK() etc. Refer to close/cancel as close in the source.
24 Override update_contents() to update the dialog, not update(), and build_dialog(),
25 not build(). Only these functions may change dialog widgets that may emit changed()
26 during initialisation, to prevent the button controller from changing its state.
28 Never call buttoncontroller functions directly from dialogs. In general, you
29 should use Qt2Base::changed() in all circumstances. However, if you must call
30 the buttoncontroller, make sure to respect Qt2Base::updating_
32 Don't #undef emit - #include "QtLyXView.h" instead
37 QFoo.[Ch] The file that interacts with the controller
38 QFooDialog.[Ch] The implementation of the dialog, derived from the generated files
39 ui/QFooDialog.ui The designer file
40 ui/QFooDialogBase.[Ch] Generated files from QFooDialog.ui
42 slots should be named e.g. slotFooClicked(), slotFooSelected(), where foo is the name
45 Widgets should be named like "fooXX", where XX is one of the following
54 (FIXME: complete this)
57 Dialog Maintainer MVC conversion
58 ----------------------------------------------
64 Document Kalle Waiting for MVC
73 Paragraph Edwin Waiting to be updated
78 Spellchecker John Done
80 Tabular Waiting for MVC
81 TabularCreate Edwin Done
83 Toc Kalle Waiting to be updated
91 The connect statement in Qt is a macro and its arguments does not follow
92 the C++ standard as it should. Using the construct "Type const &" as
93 argument will lead to runtime-errors, use "const Type &" instead.
99 connect(list, SIGNAL(selected(const QString &)),
100 this, SLOT(complete_selected(const QString &)));
104 connect(list, SIGNAL(selected(QString const &)),
105 this, SLOT(complete_selected(QString const &)));