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.
  14
  15 If necessary, you should override Qt2Base::isValid() for determining the validity
  16 of the current dialog's contents.
  17
  18 OK/Apply/Restore/Close should be connected in the derived class's constructor
  19 to call form_->slotOK() etc. Refer to close/cancel as close in the source.
  20
  21 Every overridden update() must call reset() to ensure the beginning state of the dialog
  22 is correct !
  23
  24 Don't #undef emit - #include "QtLyXView.h" instead
  25
  26 Naming conventions
  27 ------------------
  28
  29 QFoo.[Ch]              The file that interacts with the controller
  30 QFooDialog.[Ch]        The implementation of the dialog, derived from the generated files
  31 ui/QFooDialog.ui       The designer file
  32 ui/QFooDialogBase.[Ch] Generated files from QFooDialog.ui
  33
  34 slots should be named e.g. slotFooClicked(), slotFooSelected(), where foo is the name
  35 of the widget.
  36
  37 Widgets should be named like "fooXX", where XX is one of the following
  38 widget types :
  39
  40 CB - check box
  41 CO - combo box
  42 ED - line edit
  43 LA - label
  44 ML -
  45 PB - push button
  46 (FIXME: complete this)
  47
  48
  49 Dialog          Maintainer      MVC conversion
  50 ----------------------------------------------
  51 Character       Edwin
  52 Citation        Kalle           Done
  53 Document        Kalle           Waiting for MVC
  54 Index           Kalle           Done
  55 Paragraph       Edwin           Waiting for MVC
  56 Print           Edwin
  57 Ref             Kalle
  58 Search          Edwin
  59 Splash          Edwin
  60 Tabular                         Waiting for MVC
  61 TabularCreate   Edwin
  62 Toc             Kalle
  63 Url             Kalle