some more random changes, added Timeout (make clean if LyX crashes !!)

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

diff --git a/src/frontends/qt2/README b/src/frontends/qt2/README
index 15716ea6670552ca36b1c0e5022931c0f4644b30..3ac34941172835d218b68a9346bbee7f744670b6 100644 (file)
--- a/src/frontends/qt2/README
+++ b/src/frontends/qt2/README
@@ -1,5 +1,26 @@
 This file contains some do's and dont's for the Qt2 frontend.
 
+General rules
+-------------
+
+Every editable field that affects the state of the dialog contents
+from LyX's point of view should connect its xxxChanged() signal to
+a the dialog's changed_adaptor() slot, which in turn should call
+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.
+ 
+If necessary, you should override Qt2Base::isValid() for determining the validity
+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 !
+ 
 Don't #undef emit - #include "QtLyXView.h" instead
  
 Naming conventions
@@ -17,8 +38,9 @@ Widgets should be named like "fooXX", where XX is one of the following
 widget types :
 
 CB - check box 
-CO -
-ED -
+CO - combo box
+ED - line edit
+LA - label
 ML -
 PB - push button
 (FIXME: complete this)
@@ -26,34 +48,16 @@ PB - push button
  
 Dialog         Maintainer      MVC conversion
 ----------------------------------------------
-Bibitem
-Bibtex
 Character      Edwin
-Citation       Kalle           In progress
-Command
-Connections
-Copyright      Kalle           Done
-Credits                Kalle           In progress
-Document       Kalle           In progress (Not yet prepared)
-Error
-External
-File           Edwin
-Graphics
-Include
-Index          Kalle
-Log
-Minipage
-Paragraph      Edwin           Not yet prepared
-Preamble
-Preferences
+Citation       Kalle           Done
+Document       Kalle           Waiting for MVC
+Index          Kalle           Done
+Paragraph      Edwin           Waiting for MVC
 Print          Edwin
 Ref            Kalle
 Search         Edwin
 Splash         Edwin
-Tabular                                Not yet prepared
+Tabular                                Waiting for MVC
 TabularCreate  Edwin
 Toc            Kalle
 Url            Kalle
-VCLog
-
-