lyx_mirror/src/frontends/qt4
Richard Heck 85bad159fe Some comments and cosmetics.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@21151 a592a061-630c-0410-9148-cb99ea01b6c8
2007-10-23 15:58:10 +00:00
..
ui * src/frontends/qt4/ui/ParagraphUi.ui: 2007-10-23 08:10:55 +00:00
Action.cpp mainly reduce include dependencies 2007-10-15 22:43:55 +00:00
Action.h mainly reduce include dependencies 2007-10-15 22:43:55 +00:00
alert_pimpl.cpp shuffle stuff around; minor coding style issues 2007-09-15 15:42:22 +00:00
BulletsModule.cpp use "real" resources 2007-10-17 18:28:45 +00:00
BulletsModule.h Why would boost::array<Bullet, 4> be better than Bullet[4]? 2007-09-15 23:04:28 +00:00
ButtonController.cpp ButtonController.cpp: fix a bug introduced in r20018: don't enable all widgets in the dialog, see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg128222.html 2007-09-27 21:03:26 +00:00
ButtonController.h extract code that sets color of widget from ButtonController and move to qt_helpers 2007-09-15 13:06:48 +00:00
ColorCache.cpp
ColorCache.h
Dialogs.cpp Remove the embedding dialog 2007-10-21 17:56:22 +00:00
DialogView.h cosmetics 2007-10-09 22:13:51 +00:00
DockView.h finally merge Dialog and Controller 2007-10-09 21:21:01 +00:00
EmptyTable.cpp
EmptyTable.h
FileDialog.cpp shuffle stuff around; minor coding style issues 2007-09-15 15:42:22 +00:00
FloatPlacement.cpp
FloatPlacement.h
GuiAbout.cpp move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiAbout.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiApplication.cpp * DialogView: Initial Window geometry session support. 2007-09-27 14:05:05 +00:00
GuiApplication.h consmetics 2007-09-15 22:56:09 +00:00
GuiBibitem.cpp some refactoring 2007-10-07 14:44:41 +00:00
GuiBibitem.h move stuff around. probably not the final destination... 2007-10-07 21:14:24 +00:00
GuiBibtex.cpp one more 2007-10-07 18:40:01 +00:00
GuiBibtex.h one more 2007-10-07 18:40:01 +00:00
GuiBox.cpp move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiBox.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiBranch.cpp move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiBranch.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiBranches.cpp next one 2007-10-06 22:43:21 +00:00
GuiBranches.h the fun begins.... 2007-09-05 20:33:29 +00:00
GuiChanges.cpp move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiChanges.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiCharacter.cpp finally merge Dialog and Controller 2007-10-09 21:21:01 +00:00
GuiCharacter.h finally merge Dialog and Controller 2007-10-09 21:21:01 +00:00
GuiCitation.cpp some refactoring 2007-10-07 14:59:01 +00:00
GuiCitation.h one more 2007-10-07 18:40:01 +00:00
GuiClipboard.cpp GuiClipboard.cpp: add missing ";" 2007-10-01 00:11:21 +00:00
GuiClipboard.h Fix slowness issue with Clipboard. Cache the Clipboard status when the data is changed. 2007-09-30 20:28:15 +00:00
GuiCommandBuffer.cpp use "real" resources 2007-10-17 18:28:45 +00:00
GuiCommandBuffer.h one more 2007-10-07 18:40:01 +00:00
GuiCommandEdit.cpp move our stuff off the Q* namespace 2007-08-31 05:53:55 +00:00
GuiCommandEdit.h the fun begins.... 2007-09-05 20:33:29 +00:00
GuiDelimiter.cpp move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiDelimiter.h math stuff 2007-10-07 20:34:09 +00:00
GuiDialog.cpp InsetCommandParams() now takes an InsetCode rather than a string. 2007-10-19 17:22:55 +00:00
GuiDialog.h finally merge Dialog and Controller 2007-10-09 21:21:01 +00:00
GuiDocument.cpp * BufferView::update(): renamed to processUpdateFlags() to clarify the intent. Also get rid of the default argument which added to the confusion as to what was the purpose of update(). Now also emit Buffer::changed() signal internally instead of assuming that the caller will act upon the returned boolean. 2007-10-10 08:52:55 +00:00
GuiDocument.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiErrorList.cpp mainly cosmetics 2007-10-20 10:03:45 +00:00
GuiErrorList.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiERT.cpp move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiERT.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiExternal.cpp finally merge Dialog and Controller 2007-10-09 21:21:01 +00:00
GuiExternal.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiFloat.cpp move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiFloat.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiFontExample.cpp move our stuff off the Q* namespace 2007-08-31 05:53:55 +00:00
GuiFontExample.h the fun begins.... 2007-09-05 20:33:29 +00:00
GuiFontLoader.cpp consmetics 2007-09-15 22:56:09 +00:00
GuiFontLoader.h consmetics 2007-09-15 22:56:09 +00:00
GuiFontMetrics.cpp Add a FIXME and a hint for implementation of surrogate pair metric problem. 2007-10-08 08:55:21 +00:00
GuiFontMetrics.h the fun begins.... 2007-09-05 20:33:29 +00:00
GuiGraphics.cpp isome more FileName shuffling 2007-10-18 23:03:51 +00:00
GuiGraphics.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiGraphicsUi.h move our stuff off the Q* namespace 2007-08-31 05:53:55 +00:00
GuiHyperlink.cpp The huge URL patch: 2007-10-13 19:06:09 +00:00
GuiHyperlink.h The huge URL patch: 2007-10-13 19:06:09 +00:00
GuiImage.cpp cosmetics 2007-10-17 18:47:47 +00:00
GuiImage.h the fun begins.... 2007-09-05 20:33:29 +00:00
GuiImplementation.cpp move our stuff off the Q* namespace 2007-08-31 05:53:55 +00:00
GuiImplementation.h Merge QController into individual dialogs. Also various cleanup 2007-08-31 22:16:11 +00:00
GuiInclude.cpp InsetInclude becomes an InsetCommand. 2007-10-23 15:02:15 +00:00
GuiInclude.h Some comments and cosmetics. 2007-10-23 15:58:10 +00:00
GuiIndex.cpp some refactoring 2007-10-07 14:59:01 +00:00
GuiIndex.h some refactoring 2007-10-07 14:59:01 +00:00
GuiKeySymbol.cpp cosmetics 2007-10-02 21:51:54 +00:00
GuiKeySymbol.h cosmetics 2007-10-02 21:51:54 +00:00
GuiListings.cpp Add Erlang support for listings (bug 4263) 2007-10-13 20:56:28 +00:00
GuiListings.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiLog.cpp add missing include 2007-10-11 19:35:49 +00:00
GuiLog.h add "copy to clipboard" button to log dialog 2007-10-11 18:15:30 +00:00
GuiMath.cpp move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiMath.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiMathMatrix.cpp move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiMathMatrix.h math stuff 2007-10-07 20:34:09 +00:00
GuiMenubar.cpp * make it compile 2007-10-21 17:15:02 +00:00
GuiMenubar.h fix compilation on mac 2007-10-02 07:51:25 +00:00
GuiNomencl.cpp next ones 2007-10-07 14:41:49 +00:00
GuiNomencl.h next ones 2007-10-07 14:41:49 +00:00
GuiNote.cpp move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiNote.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiPainter.cpp consmetics 2007-09-15 22:56:09 +00:00
GuiPainter.h Merge QController into individual dialogs. Also various cleanup 2007-08-31 22:16:11 +00:00
GuiParagraph.cpp * src/frontends/qt4/ui/ParagraphUi.ui: 2007-10-23 08:10:55 +00:00
GuiParagraph.h * src/frontends/qt4/ui/ParagraphUi.ui: 2007-10-23 08:10:55 +00:00
GuiPopupMenu.cpp mainly reduce include dependencies 2007-10-15 22:43:55 +00:00
GuiPopupMenu.h rename a few view functions from foo() to fooView() 2007-09-03 20:28:26 +00:00
GuiPrefs.cpp Licensing info. 2007-10-23 05:07:45 +00:00
GuiPrefs.h PrefShortcuts: ShortcutEdit, adapted from Edwin's patch 2007-10-23 03:48:02 +00:00
GuiPrint.cpp mainly cosmetics 2007-10-20 10:03:45 +00:00
GuiPrint.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiRef.cpp Some comments and cosmetics. 2007-10-23 15:58:10 +00:00
GuiRef.h Some comments and cosmetics. 2007-10-23 15:58:10 +00:00
GuiSearch.cpp finally merge Dialog and Controller 2007-10-09 21:21:01 +00:00
GuiSearch.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiSelection.cpp Potentially fix slowness issue with Selection. Cache the Selection status when the data is changed. 2007-10-01 08:18:14 +00:00
GuiSelection.h Potentially fix slowness issue with Selection. Cache the Selection status when the data is changed. 2007-10-01 08:18:14 +00:00
GuiSelectionManager.cpp Repair behavior of citation dialog after all the recent changes in src/frontends/. Previously, there had been a virtual initialiseParams() method in QCitation which overrode the corresponding method in ControlCitation. But now there is no "local" controller, and so intialiseParams() overrode nothing and so never got called. 2007-09-15 01:53:26 +00:00
GuiSelectionManager.h Repair behavior of citation dialog after all the recent changes in src/frontends/. Previously, there had been a virtual initialiseParams() method in QCitation which overrode the corresponding method in ControlCitation. But now there is no "local" controller, and so intialiseParams() overrode nothing and so never got called. 2007-09-15 01:53:26 +00:00
GuiSendto.cpp move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiSendto.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiSetBorder.cpp move our stuff off the Q* namespace 2007-08-31 05:53:55 +00:00
GuiSetBorder.h the fun begins.... 2007-09-05 20:33:29 +00:00
GuiShowFile.cpp cosmetics 2007-10-20 17:35:27 +00:00
GuiShowFile.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiSpellchecker.cpp * BufferView::update(): renamed to processUpdateFlags() to clarify the intent. Also get rid of the default argument which added to the confusion as to what was the purpose of update(). Now also emit Buffer::changed() signal internally instead of assuming that the caller will act upon the returned boolean. 2007-10-10 08:52:55 +00:00
GuiSpellchecker.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiTabular.cpp Move Inset::Code to InsetCode.h 2007-10-13 09:04:52 +00:00
GuiTabular.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiTabularCreate.cpp move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiTabularCreate.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiTexinfo.cpp cosmetics 2007-10-20 17:35:27 +00:00
GuiTexinfo.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiThesaurus.cpp move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiThesaurus.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiToc.cpp mainly cosmetics 2007-10-20 10:03:45 +00:00
GuiToc.h Fix memory leak. 2007-10-09 09:29:27 +00:00
GuiToolbar.cpp CmdDef.cpp/h: A class that manages command definitions. The definitions are 2007-10-20 23:27:03 +00:00
GuiToolbar.h mainly reduce include dependencies 2007-10-15 22:43:55 +00:00
GuiToolbars.cpp mainly reduce include dependencies 2007-10-15 22:43:55 +00:00
GuiToolbars.h mainly reduce include dependencies 2007-10-15 22:43:55 +00:00
GuiView.cpp mainly cosmetics 2007-10-20 10:03:45 +00:00
GuiView.h Move TabWidget related code to TabWorkArea class in GuiWorkArea.{cpp,h} 2007-10-06 15:48:58 +00:00
GuiViewSource.cpp * GuiViewSource: port back to DockView. 2007-10-09 09:43:56 +00:00
GuiViewSource.h * GuiViewSource: port back to DockView. 2007-10-09 09:43:56 +00:00
GuiVSpace.cpp finally merge Dialog and Controller 2007-10-09 21:21:01 +00:00
GuiVSpace.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiWorkArea.cpp mainly cosmetics 2007-10-20 10:03:45 +00:00
GuiWorkArea.h Reduce use of dynamic_cast. 2007-10-16 06:50:09 +00:00
GuiWrap.cpp move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
GuiWrap.h move Controller inheritance further up the tree 2007-10-09 19:34:27 +00:00
IconPalette.cpp listen to andré 2007-10-01 17:40:42 +00:00
IconPalette.h cosmetics 2007-09-28 22:26:28 +00:00
InsertTableWidget.cpp
InsertTableWidget.h
LaTeXHighlighter.cpp set eol-style. 2007-10-09 06:39:53 +00:00
LaTeXHighlighter.h move LaTeXHighlighte 2007-10-06 19:03:41 +00:00
LengthCombo.cpp
LengthCombo.h
LyXFileDialog.cpp remove Dialog::title_, direct setting the title works as well. 2007-09-10 19:02:11 +00:00
LyXFileDialog.h
Makefile.am * qt4/Makefile.am: make sure that Resource-related files are deleted by make clean 2007-10-22 13:58:13 +00:00
PanelStack.cpp
PanelStack.h
pch.h the delegate patch 2007-10-02 18:27:20 +00:00
qlkey.h shuffle stuff around; minor coding style issues 2007-09-15 15:42:22 +00:00
qt_helpers.cpp shuffle stuff around; minor coding style issues 2007-09-15 15:42:22 +00:00
qt_helpers.h shuffle stuff around; minor coding style issues 2007-09-15 15:42:22 +00:00
README the fun begins.... 2007-09-05 20:33:29 +00:00
TocModel.cpp Remove warnings reported with gcc 4.3: 2007-09-16 10:36:57 +00:00
TocModel.h
TocWidget.cpp use "real" resources 2007-10-17 18:28:45 +00:00
TocWidget.h next one 2007-10-06 20:54:31 +00:00
Validator.cpp one more 2007-10-07 08:55:20 +00:00
Validator.h shuffle some frontend stuff around. merge controller(base) and "Kernel". Make frontend::Dialog pure virtual 2007-09-10 22:32:59 +00:00

This file contains some do's and dont's for the Qt4 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
changed(). If you are using a more complicated thing anyway,
then remember to call 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. Don't be afraid
to use QWhatsThis too, but this must be done in the derived class's
constructor, and use _("..."). Non-trivial means that things like "OK"
/must not/ have a tooltip.

moc needs a fully qualified "std::string" for .connect() statements
to work. Be very, very careful.

Remember to check tab order on a dialog (third icon, with blue bars in
designer).

Remember to check sensible resizing behaviour on a dialog. This is
usually done by adding a top-level layout to the dialog in Designer.

Remember to use Edit->Check Accelerators

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 slotOK() etc. Refer to close/cancel as close in the
source.

Override update_contents() to update the dialog, not update().  Only
these functions may change dialog widgets that may emit changed() during
initialisation, to prevent the button controller from changing its
state.

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_

Naming conventions
------------------

QFoo.{cpp,h}     The file that interacts with the controller _and_
the implementation of the dialog, derived from the generated files
ui/FooDialog.ui  The designer file
ui_FooDialog.h   Generated files from FooDialog.ui

slots should be named e.g. slotFooClicked(), slotFooSelected(), where
foo is the name of the widget.

Widgets should be named like "fooXX", where XX is one of the following
widget types :

CB - check box
CO - combo box
ED - line edit
GB - group box
LA - label
LC - LengthCombo
LV - QListView
ML - QTextBrowser
PB - push button
RB - radio button
SB - spin box
SL - slider
TE - text edit
TW - tree widget (FIXME: also TV in some files)


Qt, Unicode, and LyX
--------------------

LyX uses a different encoding (UCS4) than Qt (UTF16), therefore there are a
number of conversion functions in qt_helpers.{cpp,h}. Read the doxygen
documentation for details when to use which function.

Additionally, you should follow these simple rules :

o Use qt_() not _() in code
o Use the conversion functions of qt_helpers.h, NOT .latin1() / .c_str() etc.