src/frontends/qt2/README

   1 This file contains some do's and dont's for the Qt2 frontend.
   2
   3 General rules
   4 -------------
   5
   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 !)
  11
  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)
  15
  16 If necessary, you should override Qt2Base::isValid() for determining the validity
  17 of the current dialog's contents.
  18
  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.
  21
  22 Override update_contents() to update the dialog, not update()
  23
  24 Never call buttoncontroller functions directly from dialogs. In general, you
  25 should use Qt2Base::changed() in all circumstances. However, if you must call
  26 the buttoncontroller, make sure to respect Qt2Base::updating_
  27
  28 Don't #undef emit - #include "QtLyXView.h" instead
  29
  30 Naming conventions
  31 ------------------
  32
  33 QFoo.[Ch]              The file that interacts with the controller
  34 QFooDialog.[Ch]        The implementation of the dialog, derived from the generated files
  35 ui/QFooDialog.ui       The designer file
  36 ui/QFooDialogBase.[Ch] Generated files from QFooDialog.ui
  37
  38 slots should be named e.g. slotFooClicked(), slotFooSelected(), where foo is the name
  39 of the widget.
  40
  41 Widgets should be named like "fooXX", where XX is one of the following
  42 widget types :
  43
  44 CB - check box
  45 CO - combo box
  46 ED - line edit
  47 LA - label
  48 ML -
  49 PB - push button
  50 (FIXME: complete this)
  51
  52
  53 Dialog          Maintainer      MVC conversion
  54 ----------------------------------------------
  55 Character       Edwin
  56 Citation        Kalle           Done
  57 Document        Kalle           Waiting for MVC
  58 Index           Kalle           Done
  59 Paragraph       Edwin           Waiting for MVC
  60 Print           Edwin
  61 Ref             Kalle
  62 Search          Edwin
  63 Splash          Edwin
  64 Tabular                         Waiting for MVC
  65 TabularCreate   Edwin
  66 Toc             Kalle
  67 Url             Kalle