source: trunk/doc/src/examples/treemodelcompleter.qdoc

Last change on this file was 846, checked in by Dmitry A. Kuminov, 15 years ago

trunk: Merged in qt 4.7.2 sources from branches/vendor/nokia/qt.

File size: 7.1 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4** All rights reserved.
5** Contact: Nokia Corporation ([email protected])
6**
7** This file is part of the documentation of the Qt Toolkit.
8**
9** $QT_BEGIN_LICENSE:FDL$
10** Commercial Usage
11** Licensees holding valid Qt Commercial licenses may use this file in
12** accordance with the Qt Commercial License Agreement provided with the
13** Software or, alternatively, in accordance with the terms contained in a
14** written agreement between you and Nokia.
15**
16** GNU Free Documentation License
17** Alternatively, this file may be used under the terms of the GNU Free
18** Documentation License version 1.3 as published by the Free Software
19** Foundation and appearing in the file included in the packaging of this
20** file.
21**
22** If you have questions regarding the use of this file, please contact
23** Nokia at [email protected].
24** $QT_END_LICENSE$
25**
26****************************************************************************/
27
28/*!
29 \example tools/treemodelcompleter
30 \title Tree Model Completer Example
31
32 The Tree Model Completer example shows how to provide completion
33 facilities for a hierarchical model, using a period as the separator
34 to access Child, GrandChild and GrandGrandChild level objects.
35
36 \image treemodelcompleter-example.png
37
38 Similar to the \l{Completer Example}, we provide QComboBox objects to
39 enable selection for completion mode and case sensitivity, as well as
40 a QCheckBox for wrap completions.
41
42 \section1 The Resource File
43
44 The contents of the TreeModelCompleter is read from \e treemodel.txt.
45 This file is embedded within the \e treemodelcompleter.qrc resource file,
46 which contains the following:
47
48 \quotefile examples/tools/treemodelcompleter/treemodelcompleter.qrc
49
50 \section1 TreeModelCompleter Class Definition
51
52 The \c TreeModelCompleter is a subclass of QCompleter with two
53 constructors - one with \a parent as an argument and another with
54 \a parent and \a model as arguments.
55
56 \snippet examples/tools/treemodelcompleter/treemodelcompleter.h 0
57
58 The class reimplements the protected functions
59 \l{QCompleter::splitPath()}{splitPath()} and
60 \l{QCompleter::pathFromIndex()}{pathFromIndex()} to suit a tree model.
61 For more information on customizing QCompleter to suit tree models, refer
62 to \l{QCompleter#Handling Tree Models}{Handling Tree Models}.
63
64 \c TreeModelCompleter also has a separator property which is declared