diff options
authorNico Vertriest <>2013-03-05 12:37:37 +0100
committerThe Qt Project <>2013-03-05 17:55:14 +0100
commitf2162d04d23acd27ee641a07286f30f5581fe6bf (patch)
parent8b10e8c198baa53f892c65d2e41c56df751ff7b8 (diff)
Doc: fixed snippet issues with customcompleter.qdoc
Edited customcompleter.qdoc (paths snippets + ingroup statement) Moved customcompleter.qdoc to widgets/tools/customcompleter/doc/src Moved png files to doc/qtwidgets/images Task-number: QTBUG-29101 Change-Id: Iab66f178b92321257c4eb0e4e9704bb1e3043ef6 Reviewed-by: Jerome Pasion <> Reviewed-by: Laszlo Papp <>
-rw-r--r--examples/widgets/tools/customcompleter/doc/src/customcompleter.qdoc (renamed from examples/tools/doc/src/customcompleter.qdoc)40
-rw-r--r--src/widgets/doc/images/customcompleter-example.png (renamed from doc/src/images/customcompleter-example.png)bin11636 -> 11636 bytes
-rw-r--r--src/widgets/doc/images/customcompleter-insertcompletion.png (renamed from doc/src/images/customcompleter-insertcompletion.png)bin1371 -> 1371 bytes
3 files changed, 21 insertions, 19 deletions
diff --git a/examples/tools/doc/src/customcompleter.qdoc b/examples/widgets/tools/customcompleter/doc/src/customcompleter.qdoc
index f9ad3a43e9..a6c425d4c8 100644
--- a/examples/tools/doc/src/customcompleter.qdoc
+++ b/examples/widgets/tools/customcompleter/doc/src/customcompleter.qdoc
@@ -1,6 +1,6 @@
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact:
** This file is part of the documentation of the Qt Toolkit.
@@ -26,9 +26,11 @@
- \example customcompleter
+ \example tools/customcompleter
\title Custom Completer Example
+ \ingroup examples-widgets-tools
\brief The Custom Completer example shows how to provide string-completion
facilities for an input widget based on data provided by a model. The
completer pops up suggestions for possible words based on the first three
@@ -43,7 +45,7 @@
that has a list of words to help QCompleter complete words. This file
contains the following:
- \quotefile customcompleter/customcompleter.qrc
+ \quotefile tools/customcompleter/customcompleter.qrc
\section1 TextEdit Class Definition
@@ -54,7 +56,7 @@
contains a private function \c textUnderCursor() and a private instance
of QCompleter, \c c.
- \snippet customcompleter/textedit.h 0
+ \snippet tools/customcompleter/textedit.h 0
\section1 TextEdit Class Implementation
@@ -63,11 +65,11 @@
the \c TextEdit object, using the
\l{QTextEdit::setPlainText()}{setPlainText()} function.
- \snippet customcompleter/textedit.cpp 0
+ \snippet tools/customcompleter/textedit.cpp 0
In addition, \c TextEdit also includes a default destructor:
- \snippet customcompleter/textedit.cpp 1
+ \snippet tools/customcompleter/textedit.cpp 1
The \c setCompleter() function accepts a \a completer and sets it up.
We use \c{if (c)} to check if \c c has been initialized. If it has been
@@ -75,7 +77,7 @@
the signal from the slot. This is to ensure that no previous completer
object is still connected to the slot.
- \snippet customcompleter/textedit.cpp 2
+ \snippet tools/customcompleter/textedit.cpp 2
We then instantiate \c c with \a completer and set it as \c{TextEdit}'s
widget. The completion mode and case sensitivity are also set and then
@@ -84,7 +86,7 @@
The \c completer() function is a getter function that returns \c c.
- \snippet customcompleter/textedit.cpp 3
+ \snippet tools/customcompleter/textedit.cpp 3
The completer pops up the options available, based on the contents of
\e wordlist.txt, but the text cursor is responsible for filling in the
@@ -99,7 +101,7 @@
completer's widget is \c TextEdit before using \c tc to insert the extra
characters to complete the word.
- \snippet customcompleter/textedit.cpp 4
+ \snippet tools/customcompleter/textedit.cpp 4
The figure below illustrates this process:
@@ -116,13 +118,13 @@
The \c textUnderCursor() function uses a QTextCursor, \c tc, to select a
word under the cursor and return it.
- \snippet customcompleter/textedit.cpp 5
+ \snippet tools/customcompleter/textedit.cpp 5
The \c TextEdit class reimplements \l{QWidget::focusInEvent()}
{focusInEvent()} function, which is an event handler used to receive
keyboard focus events for the widget.
- \snippet customcompleter/textedit.cpp 6
+ \snippet tools/customcompleter/textedit.cpp 6
The \l{QAbstractScrollArea::keyPressEvent()}{keyPressEvent()} is
reimplemented to ignore key events like Qt::Key_Enter, Qt::Key_Return,
@@ -131,12 +133,12 @@
If there is an active completer, we cannot process the shortcut, Ctrl+E.
- \snippet customcompleter/textedit.cpp 7
+ \snippet tools/customcompleter/textedit.cpp 7
We also handle other modifiers and shortcuts for which we do not want the
completer to respond to.
- \snippet customcompleter/textedit.cpp 8
+ \snippet tools/customcompleter/textedit.cpp 8
Finally, we pop up the completer.
@@ -147,7 +149,7 @@
\c createMenu() and \c modelFromFile() as well as private instances of
QCompleter and \c TextEdit.
- \snippet customcompleter/mainwindow.h 0
+ \snippet tools/customcompleter/mainwindow.h 0
\section1 MainWindow Class Implementation
@@ -157,31 +159,31 @@
to populate the \c completer. The \c{MainWindow}'s central widget is set
to \c TextEdit and its size is set to 500 x 300.
- \snippet customcompleter/mainwindow.cpp 0
+ \snippet tools/customcompleter/mainwindow.cpp 0
The \c createMenu() function creates the necessary QAction objects needed
for the "File" and "Help" menu and their \l{QAction::triggered()}
{triggered()} signals are connected to the \c quit(), \c about(), and
\c aboutQt() slots respectively.
- \snippet customcompleter/mainwindow.cpp 1
+ \snippet tools/customcompleter/mainwindow.cpp 1
The \c modelFromFile() function accepts a \a fileName and attempts to
extract the contents of this file into a QStringListModel. We display the
Qt::WaitCursor when we are populating the QStringList, \c words, and
restore the mouse cursor when we are done.
- \snippet customcompleter/mainwindow.cpp 2
+ \snippet tools/customcompleter/mainwindow.cpp 2
The \c about() function provides a brief description about the Custom
Completer example.
- \snippet customcompleter/mainwindow.cpp 3
+ \snippet tools/customcompleter/mainwindow.cpp 3
\section1 \c main() Function
The \c main() function instantiates \c MainWindow and invokes the
\l{QWidget::show()}{show()} function.
- \snippet customcompleter/main.cpp 0
+ \snippet tools/customcompleter/main.cpp 0
diff --git a/doc/src/images/customcompleter-example.png b/src/widgets/doc/images/customcompleter-example.png
index a525208118..a525208118 100644
--- a/doc/src/images/customcompleter-example.png
+++ b/src/widgets/doc/images/customcompleter-example.png
Binary files differ
diff --git a/doc/src/images/customcompleter-insertcompletion.png b/src/widgets/doc/images/customcompleter-insertcompletion.png
index 0bb2c25c39..0bb2c25c39 100644
--- a/doc/src/images/customcompleter-insertcompletion.png
+++ b/src/widgets/doc/images/customcompleter-insertcompletion.png
Binary files differ