lyx_mirror/src/frontends/qt4
Richard Heck 8c69aca339 Add constness in several places.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@40338 a592a061-630c-0410-9148-cb99ea01b6c8
2011-12-02 22:41:33 +00:00
..
ui Initial work for view source improvements. 2011-10-29 21:00:23 +00:00
Action.cpp * FuncStatus: unify naming of functions. 2010-04-16 10:51:20 +00:00
Action.h
BulletsModule.cpp Update status when bullet size is changed. 2011-06-04 12:50:39 +00:00
BulletsModule.h
ButtonController.cpp
ButtonController.h
ButtonPolicy.cpp Revert r35760, as suggested by Vincent. 2010-10-21 19:33:29 +00:00
ButtonPolicy.h fix compiler warnings in pedantic mode: remove trailing comma after last enum member 2010-12-17 19:56:51 +00:00
CMakeLists.txt cmake: move CMakeLists.txt into source dir (multiple steps) 2011-05-10 17:44:41 +00:00
ColorCache.cpp Set url color from system theme. 2010-09-09 13:04:02 +00:00
ColorCache.h Finish implementation of "use system colors" checkbox. 2010-08-09 12:15:02 +00:00
CustomizedWidgets.cpp
CustomizedWidgets.h
Dialog.cpp Added method for easy reach of main document buffer. 2011-05-27 21:53:23 +00:00
Dialog.h Added method for easy reach of main document buffer. 2011-05-27 21:53:23 +00:00
DialogView.h DialogView: make GuiView the parent widget to partly solve bug #6710. 2010-10-21 13:40:49 +00:00
DockView.h close floating dock widgets (not currently docked) with escape keypress event 2011-09-29 18:52:36 +00:00
EmptyTable.cpp
EmptyTable.h
FancyLineEdit.cpp Another unused variable. 2011-09-23 17:52:11 +00:00
FancyLineEdit.h Compile fix for Qt 4.5 and earlier. The other build systems should update 2011-06-08 19:45:52 +00:00
FileDialog.cpp Take Vincent's advice: using a pointer for selectedFilter 2011-10-15 13:32:14 +00:00
FileDialog.h Take Vincent's advice: using a pointer for selectedFilter 2011-10-15 13:32:14 +00:00
FindAndReplace.cpp Fix a crash in adv F&R when the a manual could not be loaded 2011-10-27 09:31:17 +00:00
FindAndReplace.h GuiWorkArea: Move private stuff to GuiWorkArea_Private.h. 2011-10-16 22:48:26 +00:00
FloatPlacement.cpp More include frenzy. 2010-10-31 01:04:03 +00:00
FloatPlacement.h InsetParamsWidget(): fix method constness. 2010-02-18 07:56:38 +00:00
GuiAbout.cpp Proper camel case for FileName.absFilename 2010-04-21 01:19:09 +00:00
GuiAbout.h
GuiAlert.cpp Qt performs its own formatting to assure a maximum line length of the 2011-03-02 00:26:34 +00:00
GuiApplication.cpp Fix bug #4213: Change tracking support for tex2lyx. 2011-11-06 17:03:59 +00:00
GuiApplication.h #7149 fix a crash on file-open with having some view but no current one 2011-01-18 15:22:10 +00:00
GuiBibitem.cpp Remove the name parameter from string2params and params2string. We can always derive the name with insetName(params.code()). 2010-10-29 00:25:28 +00:00
GuiBibitem.h Migrate GuiBibitem to InsetParamsWidget. 2010-02-23 21:24:24 +00:00
GuiBibtex.cpp Fix bug #7540. Patch based upon one added to bug report by Max Funk. 2011-06-01 13:18:08 +00:00
GuiBibtex.h
GuiBox.cpp remove unused include of FuncRequest 2010-08-24 03:07:09 +00:00
GuiBox.h * GuiBoc.{cpp,h}: 2010-06-26 07:57:54 +00:00
GuiBranch.cpp Migrate Branch dialog to InsetParamsWidget 2010-02-19 20:57:25 +00:00
GuiBranch.h Migrate Branch dialog to InsetParamsWidget 2010-02-19 20:57:25 +00:00
GuiBranches.cpp Don't allow newline characters in document settings. 2011-09-24 16:39:23 +00:00
GuiBranches.h Fix unnecessary dependencies on GuiDocument.h. 2010-07-12 21:42:25 +00:00
GuiChanges.cpp Fix bug #4213: Change tracking support for tex2lyx. 2011-11-06 17:03:59 +00:00
GuiChanges.h
GuiCharacter.cpp
GuiCharacter.h
GuiCitation.cpp We use the main document's buffer() instead of the current buffer(), so as to catch the citations 2011-05-27 21:54:23 +00:00
GuiCitation.h We use the main document's buffer() instead of the current buffer(), so as to catch the citations 2011-05-27 21:54:23 +00:00
GuiClipboard.cpp Fix bug #6538 (Figure: relative path changed to absolute on copy/paste) 2010-12-11 23:04:24 +00:00
GuiClipboard.h Fix bug #6538 (Figure: relative path changed to absolute on copy/paste) 2010-12-11 23:04:24 +00:00
GuiCommandBuffer.cpp Revert "Don't allow newline characters in the command buffer." 2011-10-19 22:52:34 +00:00
GuiCommandBuffer.h
GuiCommandEdit.cpp
GuiCommandEdit.h
GuiCompare.cpp Fix bug #7540. Patch based upon one added to bug report by Max Funk. 2011-06-01 13:18:08 +00:00
GuiCompare.h Some cosmetics (from my local cosmetics branch). 2010-10-18 14:20:03 +00:00
GuiCompareHistory.cpp Ui glitches 2010-09-07 11:58:42 +00:00
GuiCompareHistory.h These things need to be updated for each dialog opening 2010-09-07 11:29:05 +00:00
GuiCompleter.cpp Add constness in several places. 2011-12-02 22:41:33 +00:00
GuiCompleter.h Add constness in several places. 2011-12-02 22:41:33 +00:00
GuiDelimiter.cpp * GuiDelimiter.cpp: disable cut and paste inside the listviews (bug 6942). 2010-10-15 07:12:49 +00:00
GuiDelimiter.h
GuiDialog.cpp remove unused include of FuncRequest 2010-08-24 03:07:09 +00:00
GuiDialog.h Typos in the comment. 2011-02-13 09:59:14 +00:00
GuiDocument.cpp Cosmetics. 2011-10-27 11:49:15 +00:00
GuiDocument.h Fix bug #7500: There is presently no way in the GUI to update local 2011-05-08 00:54:17 +00:00
GuiErrorList.cpp Generalize check to generic non-editable insets. 2011-04-05 15:40:00 +00:00
GuiErrorList.h Fix bug #6462: Out-of-bounds index in GuiErrorList::goTo when new buffer is active. 2010-03-12 15:06:13 +00:00
GuiERT.cpp remove unused include of FuncRequest 2010-08-24 03:07:09 +00:00
GuiERT.h InsetParamsWidget(): fix method constness. 2010-02-18 07:56:38 +00:00
GuiExternal.cpp Fix the guiName of external insets. 2011-09-13 21:50:07 +00:00
GuiExternal.h
GuiFontExample.cpp
GuiFontExample.h
GuiFontLoader.cpp Add some extra information about bug #3684. 2010-12-29 05:50:50 +00:00
GuiFontLoader.h
GuiFontMetrics.cpp Fix bug #7187: Font painting problems with emulated scaling. 2010-12-29 05:35:03 +00:00
GuiFontMetrics.h
GuiGraphics.cpp Fix bug #7540. Patch based upon one added to bug report by Max Funk. 2011-06-01 13:18:08 +00:00
GuiGraphics.h
GuiGraphicsUi.h
GuiHSpace.cpp Simplify code a bit. 2011-11-23 16:49:34 +00:00
GuiHSpace.h InsetSpace support for 2011-08-29 14:07:30 +00:00
GuiHyperlink.cpp Fix assert in all InsetParamsWidget's for unicode characters (bug #7017) 2010-11-07 17:38:39 +00:00
GuiHyperlink.h Migrate GuiHyperlink to InsetParamsDialog. 2010-10-27 17:02:42 +00:00
GuiIdListModel.cpp Fix a couple of compilation issues with gcc 4.6. See bug #7285. 2011-02-07 22:47:02 +00:00
GuiIdListModel.h
GuiImage.cpp Proper camel case for FileName.absFilename 2010-04-21 01:19:09 +00:00
GuiImage.h
GuiInclude.cpp Fix the file filters for InsetInclude. 2011-09-13 20:43:06 +00:00
GuiInclude.h fix compiler warnings in pedantic mode: remove trailing comma after last enum member 2010-12-17 19:56:51 +00:00
GuiIndex.cpp
GuiIndex.h
GuiIndices.cpp Don't allow newline characters in document settings. 2011-09-24 16:39:23 +00:00
GuiIndices.h Rename QLineEdit widgets to have a LE suffix (consistent within GuiDocument). 2011-09-24 16:39:20 +00:00
GuiInfo.cpp More include frenzy. 2010-10-31 01:04:03 +00:00
GuiInfo.h InsetParamsWidget(): fix method constness. 2010-02-18 07:56:38 +00:00
GuiKeySymbol.cpp fix wrong preprocessor 2011-02-23 21:06:15 +00:00
GuiKeySymbol.h
GuiLabel.cpp Fix assert in all InsetParamsWidget's for unicode characters (bug #7017) 2010-11-07 17:38:39 +00:00
GuiLabel.h Revert r35933. There are insets not based upon InsetCommand, such as 2010-10-31 18:56:32 +00:00
GuiLine.cpp fix typo: double semicolon at line end of code 2010-12-21 15:28:55 +00:00
GuiLine.h GuiLine: honor Abdel as author 2010-09-17 01:32:23 +00:00
GuiListings.cpp
GuiListings.h
GuiLog.cpp * GuiLog.cpp: refine warning detection: 2010-08-02 16:38:41 +00:00
GuiLog.h
GuiMathMatrix.cpp This should be fixed. 2010-11-13 23:01:30 +00:00
GuiMathMatrix.h GuiMathMatrix: 2010-09-24 03:44:34 +00:00
GuiNomenclature.cpp Implement GuiNomenclature::initialiseParams(), thus restoring the 2011-09-11 14:14:04 +00:00
GuiNomenclature.h Implement GuiNomenclature::initialiseParams(), thus restoring the 2011-09-11 14:14:04 +00:00
GuiNote.cpp
GuiNote.h
GuiPainter.cpp #7266 drawing of dotted lines with QPen and line width of 0.5 does not work well - restore line width 0 for thin line 2011-03-08 15:35:24 +00:00
GuiPainter.h use one place to adjust width of thin lines 2010-09-07 05:14:57 +00:00
GuiParagraph.cpp
GuiParagraph.h
GuiPhantom.cpp
GuiPhantom.h
GuiPrefs.cpp Remove unused functions. 2011-10-27 12:54:14 +00:00
GuiPrefs.h Remove unused functions. 2011-10-27 12:54:14 +00:00
GuiPrint.cpp Fix bug #7540. Patch based upon one added to bug report by Max Funk. 2011-06-01 13:18:08 +00:00
GuiPrint.h
GuiPrintindex.cpp Remove the name parameter from string2params and params2string. We can always derive the name with insetName(params.code()). 2010-10-29 00:25:28 +00:00
GuiPrintindex.h
GuiPrintNomencl.cpp GuiPrintNomencl.cpp: fix bug #7853 2011-10-24 23:35:01 +00:00
GuiPrintNomencl.h Revert r35933. There are insets not based upon InsetCommand, such as 2010-10-31 18:56:32 +00:00
GuiProgress.cpp use more common millisecond notation 2011-02-15 15:25:16 +00:00
GuiProgress.h start the timer in the correct thread 2011-01-15 22:39:46 +00:00
GuiProgressView.cpp fix bug #6748: queue LyXErrMessages so any other stuff is done 2010-06-03 21:24:20 +00:00
GuiProgressView.h Coding style, thanks Abdel. 2010-05-17 08:15:04 +00:00
GuiRef.cpp Remove the name parameter from string2params and params2string. We can always derive the name with insetName(params.code()). 2010-10-29 00:25:28 +00:00
GuiRef.h
GuiSearch.cpp
GuiSearch.h
GuiSelection.cpp
GuiSelection.h
GuiSelectionManager.cpp Revert wrong previous commit. 2011-03-19 10:34:59 +00:00
GuiSelectionManager.h Take Andre's advice and implement the focus tracking using the event 2010-03-24 14:34:44 +00:00
GuiSendto.cpp Fix the outstanding part of #7764, which involves sorting the file lists 2011-10-30 20:02:14 +00:00
GuiSendto.h
GuiSetBorder.cpp
GuiSetBorder.h
GuiShowFile.cpp support: 2010-04-21 01:19:28 +00:00
GuiShowFile.h
GuiSpellchecker.cpp avoid compiler warning regarding operator precedence 2011-10-07 07:59:50 +00:00
GuiSpellchecker.h Fixes the following issues: 2011-04-08 13:26:45 +00:00
GuiSymbols.cpp
GuiSymbols.h
GuiTabular.cpp Cosmetic improvements to tabular dialog. 2011-06-20 21:08:51 +00:00
GuiTabular.h Fix #7021: the problem was that activating the border combo was triggering dialogToParams() and thus disallowed because of the empty value. 2010-12-04 10:55:03 +00:00
GuiTabularCreate.cpp
GuiTabularCreate.h
GuiTexinfo.cpp support: 2010-04-21 01:19:28 +00:00
GuiTexinfo.h
GuiThesaurus.cpp make thesaurus usable for readonly documents 2011-01-15 12:09:23 +00:00
GuiThesaurus.h make thesaurus usable for readonly documents 2011-01-15 12:09:23 +00:00
GuiToc.cpp Fix bug #3871: Shortcut to switch from TOC to text pane. 2010-04-26 10:03:09 +00:00
GuiToc.h
GuiToolbar.cpp Typo 2011-05-05 09:19:34 +00:00
GuiToolbar.h Remove unused member variable GuiToolbar::name_. 2011-01-03 12:39:56 +00:00
GuiView.cpp Clarify by renaming some arguments. 2011-11-16 00:38:06 +00:00
GuiView.h Fix the messaging after an autosave 2011-10-30 21:34:12 +00:00
GuiViewSource.cpp Initial work for view source improvements. 2011-10-29 21:00:23 +00:00
GuiViewSource.h Initial work for view source improvements. 2011-10-29 21:00:23 +00:00
GuiVSpace.cpp remove unused include of FuncRequest 2010-08-24 03:07:09 +00:00
GuiVSpace.h InsetParamsWidget(): fix method constness. 2010-02-18 07:56:38 +00:00
GuiWorkArea_Private.h Change the type of the context menu name to string 2011-10-29 14:48:55 +00:00
GuiWorkArea.cpp Change the type of the context menu name to string 2011-10-29 14:48:55 +00:00
GuiWorkArea.h First step towards a little bit more independence of GuiWorkArea (WRT GuiView). Ideally, GuiWorkArea should not at all about GuiView. GuiWorkArea now uses a new signal busy() to inform its container (GuiView) about its status. 2011-10-23 20:21:01 +00:00
GuiWrap.cpp
GuiWrap.h
IconPalette.cpp correct icon size in math panels 2010-09-24 12:59:43 +00:00
IconPalette.h
InGuiThread.cpp check also if there is a QApplication instance 2010-11-01 21:32:59 +00:00
InGuiThread.h Be compatible with Qt 4.2 and 4.3 (Q_EMIT). 2010-11-03 00:38:35 +00:00
InsertTableWidget.cpp
InsertTableWidget.h
InsetParamsDialog.cpp InsetParamsDialog: update the dialog settings on context change (on user request). 2011-01-31 14:48:16 +00:00
InsetParamsDialog.h InsetParamsDialog: update the dialog settings on context change (on user request). 2011-01-31 14:48:16 +00:00
InsetParamsWidget.cpp set eol-style 2010-11-18 19:50:29 +00:00
InsetParamsWidget.h set eol-style 2010-11-18 19:50:29 +00:00
LaTeXHighlighter.cpp
LaTeXHighlighter.h
LayoutBox.cpp Fixing ASSERT on re-opening of Advanced F&R with cursor on a text style non-existing in the currently opened document. 2011-10-18 22:04:42 +00:00
LayoutBox.h Cleanup private part of Layout Box on destructor (probably not really an 2011-10-15 13:34:14 +00:00
LengthCombo.cpp
LengthCombo.h
LyXFileDialog.cpp
LyXFileDialog.h
Makefile.am compilation fix; a couple of warnings 2011-10-17 08:57:28 +00:00
Menus.cpp Fix the outstanding part of #7764, which involves sorting the file lists 2011-10-30 20:02:14 +00:00
Menus.h Fix memory leak: submenus were never deleted because QMenu::clear() only deletes the QActions 2011-07-14 11:10:13 +00:00
PanelStack.cpp Fix the tab ordering of PanelStack and PrefsUi. 2011-09-24 16:39:26 +00:00
PanelStack.h Add a search box to the Document Settings and Preferences dialog. 2011-06-05 17:54:27 +00:00
pch.h
qt_helpers.cpp Better label for index list. 2011-09-15 21:48:45 +00:00
qt_helpers.h Fix bug #7540. Patch based upon one added to bug report by Max Funk. 2011-06-01 13:18:08 +00:00
qt_i18n.h
README
TocModel.cpp Fix bug #7709. Seems we need to reset the source model here. 2011-11-23 16:52:46 +00:00
TocModel.h Make sure the Table of Contents is always on top in the model combobox of the TocWidget. 2010-04-26 01:36:24 +00:00
TocWidget.cpp Fix bug #7708. When we reload the outliner, we have to make sure the Buffer is up to date. So we have to do a complete updateBuffer() here. 2011-08-08 18:29:52 +00:00
TocWidget.h Attempt to workaround movement and editation slowness. 2010-12-19 22:27:21 +00:00
Toolbars.cpp Fix another instance of "visibility >= MATH". This was forgotten in r37068. 2011-01-03 12:14:44 +00:00
Toolbars.h Remove GuiToolbar::allowauto_ and define this property in the Toolbars.h::Visibility enum. 2011-01-03 11:42:01 +00:00
Validator.cpp Move the NoNewLineValidator to Validator.cpp where it fits better. 2011-09-24 16:39:17 +00:00
Validator.h Move the NoNewLineValidator to Validator.cpp where it fits better. 2011-09-24 16:39:17 +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.