lyx_mirror/src/frontends/qt4
André Pönitz e1453ef687 lexer cosmetics
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@24134 a592a061-630c-0410-9148-cb99ea01b6c8
2008-04-05 21:24:57 +00:00
..
ui * src/frontends/qt4/GuiPrefs.cpp: 2008-04-05 10:46:48 +00:00
Action.cpp * remove the need of an active GuiView 2008-03-14 16:33:16 +00:00
Action.h * remove the need of an active GuiView 2008-03-14 16:33:16 +00:00
BulletsModule.cpp
BulletsModule.h
ButtonController.cpp
ButtonController.h
ButtonPolicy.cpp Silent a console warning, fixes http://bugzilla.lyx.org/show_bug.cgi?id=4667 2008-03-29 23:12:24 +00:00
ButtonPolicy.h
ColorCache.cpp
ColorCache.h
CustomizedWidgets.cpp
CustomizedWidgets.h
Dialog.cpp more of that 2008-03-06 00:07:19 +00:00
Dialog.h s/kb_action/FuncCode/g 2008-03-15 01:20:36 +00:00
DialogView.h do what the FIXME suggested 2008-03-05 20:11:47 +00:00
DockView.h do what the FIXME suggested 2008-03-05 20:11:47 +00:00
EmptyTable.cpp
EmptyTable.h
FileDialog.cpp s/kb_action/FuncCode/g 2008-03-15 01:20:36 +00:00
FileDialog.h s/kb_action/FuncCode/g 2008-03-15 01:20:36 +00:00
FloatPlacement.cpp
FloatPlacement.h
GuiAbout.cpp * Some work was done in 2007 and 2008 which should deserve a copyright, no? 2008-03-14 23:32:34 +00:00
GuiAbout.h
GuiAlert.cpp
GuiApplication.cpp remove InsetWrapMailer class 2008-03-27 00:07:54 +00:00
GuiApplication.h simpliofy {Gui}FontLoader architecture a bit 2008-03-20 00:00:53 +00:00
GuiBibitem.cpp
GuiBibitem.h
GuiBibtex.cpp Return the right params[embed] from GuiBibtex.cpp, for safety reasons 2008-03-29 23:28:49 +00:00
GuiBibtex.h less string conversions as long as we stay in the frontend 2008-03-08 07:59:47 +00:00
GuiBox.cpp * src/frontends/qt4/GuiBox.cpp: 2008-04-04 13:33:52 +00:00
GuiBox.h remove InsetBoxMailer. 2008-03-27 07:26:37 +00:00
GuiBranch.cpp remove remaining MailInsets. 2008-03-27 22:26:24 +00:00
GuiBranch.h
GuiBranches.cpp
GuiBranches.h
GuiChanges.cpp
GuiChanges.h
GuiCharacter.cpp less string conversions as long as we stay in the frontend 2008-03-08 07:59:47 +00:00
GuiCharacter.h s/kb_action/FuncCode/g 2008-03-15 01:20:36 +00:00
GuiCitation.cpp remove remaining MailInsets. 2008-03-27 22:26:24 +00:00
GuiCitation.h cosmetics/#include cleanup 2008-03-15 00:22:54 +00:00
GuiClipboard.cpp Change strings. 2008-03-17 02:49:47 +00:00
GuiClipboard.h
GuiCommandBuffer.cpp
GuiCommandBuffer.h
GuiCommandEdit.cpp
GuiCommandEdit.h
GuiCompleter.cpp cosmetics/#include cleanup 2008-03-15 00:22:54 +00:00
GuiCompleter.h
GuiDelimiter.cpp simpliofy {Gui}FontLoader architecture a bit 2008-03-20 00:00:53 +00:00
GuiDelimiter.h
GuiDialog.cpp remove remaining MailInsets. 2008-03-27 22:26:24 +00:00
GuiDialog.h do what the FIXME suggested 2008-03-05 20:11:47 +00:00
GuiDocument.cpp Add support for document-local layout information. GUI is to follow. 2008-03-24 12:31:07 +00:00
GuiDocument.h Allow selection of a local layout file from the document->settings dialog. 2008-03-10 21:31:22 +00:00
GuiErrorList.cpp
GuiErrorList.h
GuiERT.cpp this feels more natural... 2008-03-27 23:37:59 +00:00
GuiERT.h
GuiExternal.cpp EmbeddedFile::enable() should take a reference instead of a pointer. 2008-03-29 23:32:52 +00:00
GuiExternal.h more of that 2008-03-06 00:07:19 +00:00
GuiFloat.cpp remove remaining MailInsets. 2008-03-27 22:26:24 +00:00
GuiFloat.h
GuiFontExample.cpp
GuiFontExample.h
GuiFontLoader.cpp cosmetics 2008-03-21 16:16:43 +00:00
GuiFontLoader.h cleanup/compile fix 2008-03-20 00:19:10 +00:00
GuiFontMetrics.cpp
GuiFontMetrics.h
GuiGraphics.cpp EmbeddedFile::enable() should take a reference instead of a pointer. 2008-03-29 23:32:52 +00:00
GuiGraphics.h * src/frontends/qt4/GuiGraphics.{cpp,h}: 2008-03-24 09:32:34 +00:00
GuiGraphicsUi.h
GuiHSpace.cpp * some UI clarification on \enspace vs. \enskip 2008-04-01 14:53:29 +00:00
GuiHSpace.h ** add support for protected horizontal fill. FILE FORMAT CHANGE. ** 2008-03-18 12:11:28 +00:00
GuiHyperlink.cpp
GuiHyperlink.h
GuiIdListModel.cpp * clean-up layout document class settings 2008-03-26 18:57:42 +00:00
GuiIdListModel.h
GuiImage.cpp
GuiImage.h
GuiInclude.cpp EmbeddedFile::enable() should take a reference instead of a pointer. 2008-03-29 23:32:52 +00:00
GuiInclude.h more of that 2008-03-06 00:07:19 +00:00
GuiKeySymbol.cpp merge qlkey.h into the only .cpp file #including it 2008-03-05 20:31:49 +00:00
GuiKeySymbol.h
GuiLabel.cpp
GuiLabel.h
GuiListings.cpp remove remaining MailInsets. 2008-03-27 22:26:24 +00:00
GuiListings.h
GuiLog.cpp next try... 2008-04-02 23:06:22 +00:00
GuiLog.h
GuiMath.cpp s/kb_action/FuncCode/g 2008-03-15 01:20:36 +00:00
GuiMath.h s/kb_action/FuncCode/g 2008-03-15 01:20:36 +00:00
GuiMathMatrix.cpp
GuiMathMatrix.h
GuiNomencl.cpp
GuiNomencl.h
GuiNote.cpp remove remaining MailInsets. 2008-03-27 22:26:24 +00:00
GuiNote.h
GuiPainter.cpp cleanup/compile fix 2008-03-20 00:19:10 +00:00
GuiPainter.h
GuiParagraph.cpp cosmetics/#include cleanup 2008-03-15 00:22:54 +00:00
GuiParagraph.h s/kb_action/FuncCode/g 2008-03-15 01:20:36 +00:00
GuiPrefs.cpp * src/frontends/qt4/GuiPrefs.cpp: 2008-04-05 10:46:48 +00:00
GuiPrefs.h * src/frontends/qt4/GuiPrefs.{cpp,h}: 2008-03-19 13:11:14 +00:00
GuiPrint.cpp less string conversions as long as we stay in the frontend 2008-03-08 07:59:47 +00:00
GuiPrint.h s/kb_action/FuncCode/g 2008-03-15 01:20:36 +00:00
GuiRef.cpp
GuiRef.h
GuiSearch.cpp Fix bug http://bugzilla.lyx.org/show_bug.cgi?id=4194 . 2008-03-12 16:17:25 +00:00
GuiSearch.h
GuiSelection.cpp
GuiSelection.h
GuiSelectionManager.cpp
GuiSelectionManager.h
GuiSendto.cpp
GuiSendto.h s/kb_action/FuncCode/g 2008-03-15 01:20:36 +00:00
GuiSetBorder.cpp
GuiSetBorder.h
GuiShowFile.cpp a few more docstring<->QString conversions 2008-03-05 23:10:53 +00:00
GuiShowFile.h
GuiSpellchecker.cpp * getSpeller create a new speller, so call it create* 2008-03-16 17:06:26 +00:00
GuiSpellchecker.h
GuiSymbols.cpp cosmetics 2008-03-23 13:59:51 +00:00
GuiSymbols.h improved position caching 2008-03-21 20:47:29 +00:00
GuiTabular.cpp remove remaining MailInsets. 2008-03-27 22:26:24 +00:00
GuiTabular.h Free line setting in tabulars. FILE FORMAT CHANGE. 2008-03-18 18:08:32 +00:00
GuiTabularCreate.cpp
GuiTabularCreate.h s/kb_action/FuncCode/g 2008-03-15 01:20:36 +00:00
GuiTexinfo.cpp ...and clean up headers 2008-03-08 21:55:03 +00:00
GuiTexinfo.h less string conversions as long as we stay in the frontend 2008-03-08 07:59:47 +00:00
GuiThesaurus.cpp
GuiThesaurus.h
GuiToc.cpp cosmetics 2008-03-26 22:25:43 +00:00
GuiToc.h frontend cosmetics 2008-03-06 19:39:52 +00:00
GuiToolbar.cpp Minor cleanup. 2008-03-24 18:56:12 +00:00
GuiToolbar.h * copy icon size to new GuiView from the last GuiView 2008-03-14 16:39:34 +00:00
GuiToolbars.cpp cosmetics/#include cleanup 2008-03-15 00:22:54 +00:00
GuiToolbars.h
GuiView.cpp Fullscreen: correct restoring of window state. 2008-03-30 22:27:17 +00:00
GuiView.h * on Mac close GuiView when the last tab was closed 2008-03-14 23:24:59 +00:00
GuiViewSource.cpp
GuiViewSource.h
GuiVSpace.cpp remove InsetVSpaceMailer class 2008-03-27 00:21:35 +00:00
GuiVSpace.h
GuiWorkArea.cpp cosmetics 2008-03-21 09:30:19 +00:00
GuiWorkArea.h * drag'n'drop for tabs 2008-03-15 02:13:01 +00:00
GuiWrap.cpp remove InsetWrapMailer class 2008-03-27 00:07:54 +00:00
GuiWrap.h
IconPalette.cpp
IconPalette.h
InsertTableWidget.cpp
InsertTableWidget.h
LaTeXHighlighter.cpp
LaTeXHighlighter.h
LengthCombo.cpp
LengthCombo.h
LyXFileDialog.cpp a few more docstring<->QString conversions 2008-03-05 23:10:53 +00:00
LyXFileDialog.h a few more docstring<->QString conversions 2008-03-05 23:10:53 +00:00
Makefile.am Next make dist shot. 2008-03-21 17:31:14 +00:00
Menus.cpp lexer cosmetics 2008-04-05 21:24:57 +00:00
Menus.h * make sure the Mac special menu item are only created once per QMenuBar. 2008-03-15 02:58:05 +00:00
PanelStack.cpp * src/frontends/qt4/PanelStack.{cpp, h}: 2008-03-19 18:15:16 +00:00
PanelStack.h * src/frontends/qt4/PanelStack.{cpp, h}: 2008-03-19 18:15:16 +00:00
pch.h
qt_helpers.cpp more fixes (correct filename, and repair view file) 2008-03-08 09:54:48 +00:00
qt_helpers.h less string conversions as long as we stay in the frontend 2008-03-08 07:59:47 +00:00
README
TocModel.cpp cosmetics 2008-03-26 22:25:43 +00:00
TocModel.h cosmetics 2008-03-26 22:25:43 +00:00
TocWidget.cpp frontend cosmetics 2008-03-06 19:39:52 +00:00
TocWidget.h Comments from Andre'. 2008-03-04 21:45:54 +00:00
Validator.cpp
Validator.h

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.