qtcreator-api.qdoc 6.43 KB
Newer Older
Leena Miettinen's avatar
Leena Miettinen committed
1 2 3 4
/****************************************************************************
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
Leena Miettinen's avatar
Leena Miettinen committed
6
**
Eike Ziller's avatar
Eike Ziller committed
7
** Contact: http://www.qt-project.org/
Leena Miettinen's avatar
Leena Miettinen committed
8 9 10 11 12 13 14 15 16 17 18 19
**
**
** 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.
**
**
****************************************************************************/

20
/*!
21 22
    \contentspage{index.html}{Extending Qt Creator Manual}
    \page qtcreator-api.html
23

24 25 26
    \title Qt Creator API Reference

    The core of Qt Creator is
con's avatar
con committed
27
    basically only a \l{ExtensionSystem}{plugin loader}.
28
    All functionality is implemented in plugins. The basis of Qt Creator is
con's avatar
con committed
29 30 31
    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
32

33 34 35
    \section1 Libraries

    \section2 Core Libraries
con's avatar
con committed
36 37 38 39 40 41 42 43 44

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

    \table
    \header
    \o Library Name
    \o Description

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

    \row
con's avatar
con committed
50
    \o \l{ExtensionSystem}
con's avatar
con committed
51 52 53
    \o Implements the plugin loader framework. Provides a base class for plugins and
    basic mechanisms for plugin interaction like an object pool.

54 55 56 57
    \row
    \o \l{Utils}
    \o General utility library.

Christian Kamm's avatar
Christian Kamm committed
58 59 60 61
    \row
    \o \l{QmlJS}
    \o QML and JavaScript language support library.

con's avatar
con committed
62
    \endtable
63

64 65 66 67 68 69 70 71 72 73 74
    \section2 Additional libraries

    \table
    \header
    \o Library Name
    \o Description

    \row
    \o \l{qtcreatorcdbext}
    \o Windows CDB debugger extension

Leandro Melo's avatar
Leandro Melo committed
75

76 77
    \endtable

78 79 80 81 82 83 84 85 86 87 88 89 90
    \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
    \o Plugin Name
    \o Description

    \row
con's avatar
con committed
91
    \o \l{Core}
92 93 94
    \o The core plugin. Provides the main window and managers for editors,
    actions, mode windows and files, just to mention the most important ones.

95 96 97 98 99
    \row
    \o \l{ProjectExplorer}
    \o The project explorer plugin. Provides base classes for
    project handling.

con's avatar
con committed
100 101 102 103 104
    \row
    \o \l{Find}
    \o Support for searching text in arbitrary widgets, and arbitrary other things.

    \row
con's avatar
con committed
105
    \o \l{Locator}
con's avatar
con committed
106 107
    \o Hooks for providing content for Locator.

108 109 110 111
    \row
    \o \l{Debugger}
    \o Debugging functionality.

112
    \row
hjk's avatar
hjk committed
113
    \o \l{VcsBase}
114 115
    \o Base classes for version control support.

Leandro Melo's avatar
Leandro Melo committed
116 117 118 119
    \row
    \o \l{TextEditor}
    \o 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
Leandro Melo's avatar
Leandro Melo committed
120 121
    like \l{Snippets}{snippets}, highlighting, \l{CodeAssist}{code assist}, indentation
    and style, and others.
Leandro Melo's avatar
Leandro Melo committed
122

123 124 125 126 127
    \endtable
*/

/*!
    \page classes.html
con's avatar
con committed
128
    \title Qt Creator Classes
129 130

    \generatelist classes
con's avatar
con committed
131
*/
132

con's avatar
con committed
133 134 135
/*!
    \page namespaces.html
    \title Qt Creator Namespaces
136

con's avatar
con committed
137
    \generatelist namespaces
138 139 140
*/

/*!
con's avatar
con committed
141 142 143
    \page mainclasses.html
    \title Qt Creator Main Classes

144 145 146 147 148 149
    \generatelist mainclasses

*/

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

con's avatar
con committed
152
    \generatelist functionindex
153 154
*/

con's avatar
con committed
155 156 157 158
/*!
    \page common_extension_tasks.html
    \title Common Extension Tasks

159 160 161
    This section summarizes the API functions that you can use to add UI
    components to Qt Creator.

con's avatar
con committed
162 163 164 165 166 167 168
    \table
    \header
    \o Task
    \o Details
    \o API

    \row
169
    \o Add a menu or menu item.
con's avatar
con committed
170
    \o You can extend existing menus or create new ones.
Eike Ziller's avatar
Eike Ziller committed
171
    \o \l{Core::ActionManager}, \l{Core::Command}
con's avatar
con committed
172 173 174

    \row
    \o Add a configurable keyboard shortcut.
175 176
    \o Registering shortcuts makes it possible for users to configure them in
       the common shortcut settings dialog.
Eike Ziller's avatar
Eike Ziller committed
177
    \o \l{Core::ActionManager}, \l{Core::Command}
con's avatar
con committed
178 179 180 181

    \row
    \o Add a mode.
    \o Modes correspond to complete screens of controls, specialized for a task.
182
    \o \l{Core::IMode}
con's avatar
con committed
183 184 185

    \row
    \o Add a new editor type.
186
    \o Such as an editor for XML files.
187
    \o \l{Core::IEditorFactory}, \l{Core::IEditor}, \l{Core::IDocument}
con's avatar
con committed
188 189

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

    \row
    \o Add support for a new version control system.
198 199
    \o Version control systems integrated in QtCreator are Bazaar, CVS, Git,
       Mecurial, Perforce, and Subversion.
con's avatar
con committed
200 201 202 203 204 205 206 207
    \o \l{Core::IVersionControl}

    \row
    \o Add a view to the navigation sidebar.
    \o The one which shows the project tree, filesystem, open documents or bookmarks.
    \o \l{Core::INavigationWidgetFactory}

    \row
208 209
    \o Add an options page to the \gui Options dialog.
    \o Add a new page to existing or new category in Tools > Options.
con's avatar
con committed
210 211 212
    \o \l{Core::IOptionsPage}

    \row
213
    \o Add a find filter to the \gui Find dialog.
con's avatar
con committed
214
    \o Implement any kind of search term based search.
215
    \o \l{Find::IFindFilter}, \l{Find::SearchResultWindow}
con's avatar
con committed
216 217 218

    \row
    \o Add support for the find tool bar to a widget.
219 220
    \o The widget that has focus is asked whether it supports text search. You can
       add support for widgets under your control.
con's avatar
con committed
221 222 223 224 225 226 227 228 229 230 231 232 233
    \o \l{Find::IFindSupport}, \l{Find::BaseTextFind}

    \row
    \o Add a completely new project type.
    \o
    \o

    \row
    \o Add a new type of build step.
    \o
    \o

    \row
234
    \o Add a new filter to the locator.
con's avatar
con committed
235
    \o 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.
con's avatar
con committed
236
    \o \l{Locator::ILocatorFilter}, \l{Locator::FilterEntry}, \l{Locator::BaseFileFilter}
con's avatar
con committed
237

238 239 240 241 242 243
    \row
    \o Show a progress indicator for a concurrently running task.
    \o 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).
    \o \l{Core::ProgressManager}, \l{Core::FutureProgress}

con's avatar
con committed
244 245 246 247 248 249 250
    \row
    \o
    \o
    \o

    \endtable
*/