1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
**
****************************************************************************/
/*!
\page qtcreator-api.html
\title Qt Creator API Reference
The core of \QC is basically only a \l{ExtensionSystem}{plugin loader}. All
functionality is implemented in plugins. The basis of \QC is implemented in
the Core plugin. The plugin manager provides simple means for
plugin cooperation that allow plugins to provide hooks for other plugin's
extensions.
\section1 Libraries
\section2 Core Libraries
There are a few core libraries used by many parts of Qt Creator.
\table
\header
\li Library Name
\li Description
\row
\li \l{Aggregation}
\li Adds functionality for \e glueing QObjects of different types
together, so you can \e cast between them.
\row
\li \l{ExtensionSystem}
\li Implements the plugin loader framework. Provides a base class
for plugins and basic mechanisms for plugin interaction like an
object pool.
\omit
\row
\li \l{Utils}
\li General utility library.
\row
\li \l{QmlJS}
\li QML and JavaScript language support library.
\endtable
\section2 Additional libraries
\table
\header
\li Library Name
\li Description
\row
\li \l{qtcreatorcdbext}
\li Windows CDB debugger extension
\endomit
\endtable
\section1 Plugins
As already mentioned, \QC is basically only a plugin loader framework
which gets its IDE functionality through plugins. The most important plugin
is the Core plugin which provides all the basic functionality needed
later to integrate e.g. editors or mode windows.
\table
\header
\li Plugin Name
\li Description
\row
\li \l{Core}
\li The core plugin. Provides the main window and managers for
editors, actions, mode windows and files, just to mention the
most important ones.
This plugin also contains classes necessary to hook into the
\l{Core::ILocatorFilter}{Locator} as well as support for
searching text in arbitrary widgets.
\omit
\row
\li \l{ProjectExplorer}
\li The project explorer plugin. Provides base classes for project
handling.
\row
\li \l{Debugger}
\li Debugging functionality.
\row
\li \l{VcsBase}
\li Base classes for version control support.
\row
\li \l{TextEditor}
\li This is where everything starts if you want to create a text
editor. Besides the base editor itself, this plugin contains
APIs for supporting functionality like \l{Snippets}{snippets},
highlighting, \l{CodeAssist}{code assist}, indentation and
style, and others.
\endomit
\endtable
\section1 Reference
\list
\li \l {Qt Creator C++ Classes}
\li \l {Qt Creator Namespaces}
\li \l {Qt Creator Functions}
\endlist
*/
/*!
\module QtCreator
\title Qt Creator C++ Classes
This topic lists the documented Qt Creator C++ classes. For information
about the classes that have not been documented, please inspect the source
code.
*/
/*!
\page namespaces.html
\title Qt Creator Namespaces
This topic lists the documented Qt Creator namespaces. For information
about the namespaces that have not been documented, please inspect the
source code.
\generatelist namespaces
*/
/*!
\page mainclasses.html
\title Qt Creator Main Classes
This topic lists the most important Qt Creator C++ classes.
\generatelist mainclasses
*/
/*!
\page functions.html
\title Qt Creator Functions
This topic lists the documented Qt Creator functions. For information
about the functions that have not been documented, please inspect the
source code.
\generatelist functionindex
*/
|
