various fixes

[features.git] / src / frontends / qt2 / README

diff --git a/src/frontends/qt2/README b/src/frontends/qt2/README
index 3ac34941172835d218b68a9346bbee7f744670b6..c6e300a8edcdaa1b5e4a8100a6f8374d283ea23a 100644 (file)
--- a/src/frontends/qt2/README
+++ b/src/frontends/qt2/README
@@ -10,7 +10,8 @@ form_->changed(). If you are using a more complicated thing anyway,
 then remember to call form_->changed() at the end (if it has changed !)
  
 Every non-trivial widget should have a tooltip. If you don't know
-what to write, write "FIXME", and it can fixed later.
+what to write, write "FIXME", and it can fixed later. Don't be afraid
+to use QWhatsThis too (e.g. the index dialog)
  
 If necessary, you should override Qt2Base::isValid() for determining the validity
 of the current dialog's contents.
@@ -18,9 +19,12 @@ of the current dialog's contents.
 OK/Apply/Restore/Close should be connected in the derived class's constructor
 to call form_->slotOK() etc. Refer to close/cancel as close in the source.
  
-Every overridden update() must call reset() to ensure the beginning state of the dialog
-is correct !
- 
+Override update_contents() to update the dialog, not update()
+
+Never call buttoncontroller functions directly from dialogs. In general, you
+should use Qt2Base::changed() in all circumstances. However, if you must call
+the buttoncontroller, make sure to respect Qt2Base::updating_
+
 Don't #undef emit - #include "QtLyXView.h" instead
  
 Naming conventions