aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/coreplugin/editormanager/ieditor.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/plugins/coreplugin/editormanager/ieditor.cpp')
-rw-r--r--src/plugins/coreplugin/editormanager/ieditor.cpp19
1 files changed, 11 insertions, 8 deletions
diff --git a/src/plugins/coreplugin/editormanager/ieditor.cpp b/src/plugins/coreplugin/editormanager/ieditor.cpp
index 45ed5897df..d490e1ba1a 100644
--- a/src/plugins/coreplugin/editormanager/ieditor.cpp
+++ b/src/plugins/coreplugin/editormanager/ieditor.cpp
@@ -35,7 +35,7 @@
different file types.
Classes that implement this interface are for example the editors for
- C++ files, ui-files and resource files.
+ C++ files, UI files and resource files.
Whenever a user wants to edit or create a file, the EditorManager scans all
EditorFactoryInterfaces for suitable editors. The selected EditorFactory
@@ -43,14 +43,17 @@
Guidelines for implementing:
\list
- \li displayName() is used as a user visible description of the document (usually filename w/o path).
- \li kind() must be the same value as the kind() of the corresponding EditorFactory.
- \li The changed() signal should be emitted when the modified state of the document changes
- (so /bold{not} every time the document changes, but /bold{only once}).
+ \li \c displayName() is used as a user visible description of the document
+ (usually filename w/o path).
+ \li \c kind() must be the same value as the \c kind() of the corresponding
+ EditorFactory.
+ \li The \c changed() signal should be emitted when the modified state of the
+ document changes (so \e not every time the document changes, but
+ \e {only once}).
\li If duplication is supported, you need to ensure that all duplicates
- return the same file().
- \li QString preferredMode() const is the mode the editor manager should activate.
- Some editors use a special mode (such as Design mode).
+ return the same \c file().
+ \li QString \c preferredMode() const is the mode the editor manager should
+ activate. Some editors use a special mode (such as \gui Design mode).
\endlist
\sa Core::EditorFactoryInterface Core::IContext