qtcreator-api.qdoc 6.22 KB
Newer Older
Leena Miettinen's avatar
Leena Miettinen committed
1 2 3 4
/****************************************************************************
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
Leena Miettinen's avatar
Leena Miettinen committed
6
**
hjk's avatar
hjk committed
7
** Contact: Nokia Corporation (info@qt.nokia.com)
Leena Miettinen's avatar
Leena Miettinen committed
8 9 10 11 12 13 14 15 16 17
**
**
** 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.
**
** If you have questions regarding the use of this file, please contact
Tobias Hunger's avatar
Tobias Hunger committed
18
** Nokia at info@qt.nokia.com.
Leena Miettinen's avatar
Leena Miettinen committed
19 20 21
**
****************************************************************************/

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

26 27 28
    \title Qt Creator API Reference

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

35 36 37
    \section1 Libraries

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

    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
47
    \o \l{Aggregation}
con's avatar
con committed
48 49 50 51
    \o Adds functionality for "glueing" QObjects of different
    types together, so you can "cast" between them.

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

56 57 58 59
    \row
    \o \l{Utils}
    \o General utility library.

con's avatar
con committed
60
    \endtable
61

62 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

    \endtable

75 76 77 78 79 80 81 82 83 84 85 86 87
    \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
88
    \o \l{Core}
89 90 91
    \o The core plugin. Provides the main window and managers for editors,
    actions, mode windows and files, just to mention the most important ones.

92 93 94 95 96
    \row
    \o \l{ProjectExplorer}
    \o The project explorer plugin. Provides base classes for
    project handling.

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

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

105 106 107 108
    \row
    \o \l{Debugger}
    \o Debugging functionality.

109 110 111 112
    \row
    \o \l{VCSBase}
    \o Base classes for version control support.

113 114 115 116 117
    \endtable
*/

/*!
    \page classes.html
con's avatar
con committed
118
    \title Qt Creator Classes
119 120

    \generatelist classes
con's avatar
con committed
121
*/
122

con's avatar
con committed
123 124 125
/*!
    \page namespaces.html
    \title Qt Creator Namespaces
126

con's avatar
con committed
127
    \generatelist namespaces
128 129 130
*/

/*!
con's avatar
con committed
131 132 133
    \page mainclasses.html
    \title Qt Creator Main Classes

134 135 136 137 138 139
    \generatelist mainclasses

*/

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

con's avatar
con committed
142
    \generatelist functionindex
143 144
*/

con's avatar
con committed
145 146 147 148
/*!
    \page common_extension_tasks.html
    \title Common Extension Tasks

149 150 151
    This section summarizes the API functions that you can use to add UI
    components to Qt Creator.

con's avatar
con committed
152 153 154 155 156 157 158
    \table
    \header
    \o Task
    \o Details
    \o API

    \row
159
    \o Add a menu or menu item.
con's avatar
con committed
160 161 162 163 164
    \o You can extend existing menus or create new ones.
    \o \l{Core::ActionManager}, \l{Core::Command}, \l{Core::ICore::actionManager()}

    \row
    \o Add a configurable keyboard shortcut.
165 166
    \o Registering shortcuts makes it possible for users to configure them in
       the common shortcut settings dialog.
con's avatar
con committed
167 168 169 170 171
    \o \l{Core::ActionManager}, \l{Core::Command}, \l{Core::ICore::actionManager()}

    \row
    \o Add a mode.
    \o Modes correspond to complete screens of controls, specialized for a task.
172
    \o \l{Core::IMode}
con's avatar
con committed
173 174 175

    \row
    \o Add a new editor type.
176
    \o Such as an editor for XML files.
con's avatar
con committed
177 178 179
    \o \l{Core::IEditorFactory}, \l{Core::IEditor}, \l{Core::IFile}

    \row
180 181 182 183 184
    \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
185 186 187

    \row
    \o Add support for a new version control system.
188 189
    \o Version control systems integrated in QtCreator are Bazaar, CVS, Git,
       Mecurial, Perforce, and Subversion.
con's avatar
con committed
190 191 192 193 194 195 196 197
    \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
198 199
    \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
200 201 202
    \o \l{Core::IOptionsPage}

    \row
203
    \o Add a find filter to the \gui Find dialog.
con's avatar
con committed
204
    \o Implement any kind of search term based search.
205
    \o \l{Find::IFindFilter}, \l{Find::SearchResultWindow}
con's avatar
con committed
206 207 208

    \row
    \o Add support for the find tool bar to a widget.
209 210
    \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
211 212 213 214 215 216 217 218 219 220 221 222 223
    \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
224
    \o Add a new filter to the locator.
con's avatar
con committed
225
    \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
226
    \o \l{Locator::ILocatorFilter}, \l{Locator::FilterEntry}, \l{Locator::BaseFileFilter}
con's avatar
con committed
227

228 229 230 231 232 233
    \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
234 235 236 237 238 239 240
    \row
    \o
    \o
    \o

    \endtable
*/