qtcreator-api.qdoc 6.45 KB
Newer Older
Leena Miettinen's avatar
Leena Miettinen committed
1 2
/****************************************************************************
**
Eike Ziller's avatar
Eike Ziller committed
3 4
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
Leena Miettinen's avatar
Leena Miettinen committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator
Leena Miettinen's avatar
Leena Miettinen committed
7 8 9 10 11 12 13 14 15 16 17 18
**
**
** GNU Free Documentation License
**
** 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.
**
**
****************************************************************************/

19
/*!
20
    \page qtcreator-api.html
21

22 23 24
    \title Qt Creator API Reference

    The core of Qt Creator is
con's avatar
con committed
25
    basically only a \l{ExtensionSystem}{plugin loader}.
26
    All functionality is implemented in plugins. The basis of Qt Creator is
con's avatar
con committed
27 28 29
    implemented in the \l{Core} {Core} Plugin. The plugin manager provides
    simple means for plugin cooperation that allow plugins to provide
    hooks for other plugin's extensions.
con's avatar
con committed
30

31 32 33
    \section1 Libraries

    \section2 Core Libraries
con's avatar
con committed
34 35 36 37 38

    There are a few core libraries used by many parts of Qt Creator.

    \table
    \header
Tobias Hunger's avatar
Tobias Hunger committed
39 40
    \li Library Name
    \li Description
con's avatar
con committed
41 42

    \row
Tobias Hunger's avatar
Tobias Hunger committed
43 44 45
    \li \l{Aggregation}
    \li Adds functionality for "glueing" QObjects of different
        types together, so you can "cast" between them.
con's avatar
con committed
46 47

    \row
Tobias Hunger's avatar
Tobias Hunger committed
48 49 50
    \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.
con's avatar
con committed
51

52
    \row
Tobias Hunger's avatar
Tobias Hunger committed
53 54
    \li \l{Utils}
    \li General utility library.
55

Christian Kamm's avatar
Christian Kamm committed
56
    \row
Tobias Hunger's avatar
Tobias Hunger committed
57 58
    \li \l{QmlJS}
    \li QML and JavaScript language support library.
Christian Kamm's avatar
Christian Kamm committed
59

con's avatar
con committed
60
    \endtable
61

62 63 64 65
    \section2 Additional libraries

    \table
    \header
Tobias Hunger's avatar
Tobias Hunger committed
66 67
    \li Library Name
    \li Description
68 69

    \row
Tobias Hunger's avatar
Tobias Hunger committed
70 71
    \li \l{qtcreatorcdbext}
    \li Windows CDB debugger extension
72

Leandro Melo's avatar
Leandro Melo committed
73

74 75
    \endtable

76 77 78 79 80 81 82 83 84
    \section1 Plugins

    As already mentioned, Qt Creator 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
Tobias Hunger's avatar
Tobias Hunger committed
85 86
    \li Plugin Name
    \li Description
87 88

    \row
Tobias Hunger's avatar
Tobias Hunger committed
89 90
    \li \l{Core}
    \li The core plugin. Provides the main window and managers for editors,
91 92
    actions, mode windows and files, just to mention the most important ones.

93
    \row
Tobias Hunger's avatar
Tobias Hunger committed
94 95
    \li \l{ProjectExplorer}
    \li The project explorer plugin. Provides base classes for project handling.
96

con's avatar
con committed
97
    \row
Tobias Hunger's avatar
Tobias Hunger committed
98 99
    \li \l{Find}
    \li Support for searching text in arbitrary widgets, and arbitrary other things.
con's avatar
con committed
100 101

    \row
Tobias Hunger's avatar
Tobias Hunger committed
102 103
    \li \l{Locator}
    \li Hooks for providing content for Locator.
con's avatar
con committed
104

105
    \row
Tobias Hunger's avatar
Tobias Hunger committed
106 107
    \li \l{Debugger}
    \li Debugging functionality.
108

109
    \row
Tobias Hunger's avatar
Tobias Hunger committed
110 111
    \li \l{VcsBase}
    \li Base classes for version control support.
112

Leandro Melo's avatar
Leandro Melo committed
113
    \row
Tobias Hunger's avatar
Tobias Hunger committed
114 115
    \li \l{TextEditor}
    \li This is where everything starts if you want to create a text editor. Besides
Leandro Melo's avatar
Leandro Melo committed
116
    the base editor itself, this plugin contains APIs for supporting functionality
Leandro Melo's avatar
Leandro Melo committed
117 118
    like \l{Snippets}{snippets}, highlighting, \l{CodeAssist}{code assist}, indentation
    and style, and others.
Leandro Melo's avatar
Leandro Melo committed
119

120 121 122 123 124
    \endtable
*/

/*!
    \page classes.html
con's avatar
con committed
125
    \title Qt Creator Classes
126 127

    \generatelist classes
con's avatar
con committed
128
*/
129

con's avatar
con committed
130 131 132
/*!
    \page namespaces.html
    \title Qt Creator Namespaces
133

con's avatar
con committed
134
    \generatelist namespaces
135 136 137
*/

/*!
con's avatar
con committed
138 139 140
    \page mainclasses.html
    \title Qt Creator Main Classes

141 142 143 144 145 146
    \generatelist mainclasses

*/

/*!
    \page functions.html
con's avatar
con committed
147
    \title Qt Creator Functions
148

con's avatar
con committed
149
    \generatelist functionindex
150 151
*/

con's avatar
con committed
152 153 154 155
/*!
    \page common_extension_tasks.html
    \title Common Extension Tasks

156 157 158
    This section summarizes the API functions that you can use to add UI
    components to Qt Creator.

con's avatar
con committed
159 160
    \table
    \header
Tobias Hunger's avatar
Tobias Hunger committed
161 162 163
    \li Task
    \li Details
    \li API
con's avatar
con committed
164 165

    \row
Tobias Hunger's avatar
Tobias Hunger committed
166 167 168
    \li Add a menu or menu item.
    \li You can extend existing menus or create new ones.
    \li \l{Core::ActionManager}, \l{Core::Command}
con's avatar
con committed
169 170

    \row
Tobias Hunger's avatar
Tobias Hunger committed
171 172 173 174
    \li Add a configurable keyboard shortcut.
    \li Registering shortcuts makes it possible for users to configure them in
        the common shortcut settings dialog.
    \li \l{Core::ActionManager}, \l{Core::Command}
con's avatar
con committed
175 176

    \row
Tobias Hunger's avatar
Tobias Hunger committed
177 178 179
    \li Add a mode.
    \li Modes correspond to complete screens of controls, specialized for a task.
    \li \l{Core::IMode}
con's avatar
con committed
180 181

    \row
Tobias Hunger's avatar
Tobias Hunger committed
182 183 184
    \li Add a new editor type.
    \li Such as an editor for XML files.
    \li \l{Core::IEditorFactory}, \l{Core::IEditor}, \l{Core::IDocument}
con's avatar
con committed
185 186

    \row
Tobias Hunger's avatar
Tobias Hunger committed
187 188 189 190 191
    \li Add a new wizard.
    \li You can extend the wizards in File > New File or Project with your own
        file and project templates.
    \li \l{Core::IWizard}, \l{Core::StandardFileWizard},
        \l{Core::BaseFileWizard}, \l{Core::BaseFileWizardParameters}
con's avatar
con committed
192 193

    \row
Tobias Hunger's avatar
Tobias Hunger committed
194 195 196 197
    \li Add support for a new version control system.
    \li Version control systems integrated in QtCreator are Bazaar, CVS, Git,
        Mecurial, Perforce, and Subversion.
    \li \l{Core::IVersionControl}
con's avatar
con committed
198 199

    \row
Tobias Hunger's avatar
Tobias Hunger committed
200 201 202
    \li Add a view to the navigation sidebar.
    \li The one which shows the project tree, filesystem, open documents or bookmarks.
    \li \l{Core::INavigationWidgetFactory}
con's avatar
con committed
203 204

    \row
205
    \li Add an options page to the \uicontrol Options dialog.
Tobias Hunger's avatar
Tobias Hunger committed
206 207
    \li Add a new page to existing or new category in Tools > Options.
    \li \l{Core::IOptionsPage}
con's avatar
con committed
208 209

    \row
210
    \li Add a find filter to the \uicontrol Find dialog.
Tobias Hunger's avatar
Tobias Hunger committed
211
    \li Implement any kind of search term based search.
212
    \li \l{Find::IFindFilter}, \l{Core::SearchResultWindow}
con's avatar
con committed
213 214

    \row
Tobias Hunger's avatar
Tobias Hunger committed
215 216 217
    \li Add support for the find tool bar to a widget.
    \li The widget that has focus is asked whether it supports text search. You can
        add support for widgets under your control.
218
    \li \l{Core::IFindSupport}, \l{Find::BaseTextFind}
con's avatar
con committed
219 220

    \row
Tobias Hunger's avatar
Tobias Hunger committed
221 222 223
    \li Add a completely new project type.
    \li
    \li
con's avatar
con committed
224 225

    \row
Tobias Hunger's avatar
Tobias Hunger committed
226 227 228
    \li Add a new type of build step.
    \li
    \li
con's avatar
con committed
229 230

    \row
Tobias Hunger's avatar
Tobias Hunger committed
231 232 233
    \li Add a new filter to the locator.
    \li For a text typed in by the user you provide a list of things to show in the popup.
        When the user selects an entry you are requested to do whatever you want.
234
    \li \l{Core::ILocatorFilter}, \l{Core::LocatorFilterEntry}, \l{Locator::BaseFileFilter}
con's avatar
con committed
235

236
    \row
Tobias Hunger's avatar
Tobias Hunger committed
237 238 239 240
    \li Show a progress indicator for a concurrently running task.
    \li You can show a progress indicator for your tasks in the left hand tool bar,
        and also in the application icon (on platforms that support it).
    \li \l{Core::ProgressManager}, \l{Core::FutureProgress}
241

con's avatar
con committed
242
    \row
Tobias Hunger's avatar
Tobias Hunger committed
243 244 245
    \li
    \li
    \li
con's avatar
con committed
246 247 248

    \endtable
*/