qtcreator-api.qdoc 7.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
    \title Qt Creator API Reference

24 25 26 27 28
    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 \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
29

30 31 32
    \section1 Libraries

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

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

    \table
37 38 39
        \header
            \li Library Name
            \li Description
con's avatar
con committed
40

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

46 47 48 49 50
        \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.
con's avatar
con committed
51

52 53 54
        \row
            \li \l{Utils}
            \li General utility library.
55

56 57 58
        \row
            \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
    \section2 Additional libraries

    \table
65 66 67
        \header
            \li Library Name
            \li Description
68

69 70 71
        \row
            \li \l{qtcreatorcdbext}
            \li Windows CDB debugger extension
72 73
    \endtable

74 75
    \section1 Plugins

76
    As already mentioned, \QC is basically only a plugin loader framework
77
    which gets its IDE functionality through plugins. The most important plugin
78
    is the \c Core plugin which provides all the basic functionality needed
79 80 81
    later to integrate e.g. editors or mode windows.

    \table
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
        \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.

        \row
            \li \l{ProjectExplorer}
            \li The project explorer plugin. Provides base classes for project
                handling.

        \row
            \li \l{Find}
            \li Support for searching text in arbitrary widgets, and arbitrary
                other things.

        \row
            \li \l{Locator}
            \li Hooks for providing content for Locator.

        \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.
121 122 123 124 125
    \endtable
*/

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

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

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

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

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

142 143 144 145 146 147
    \generatelist mainclasses

*/

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

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

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

157
    This section summarizes the API functions that you can use to add UI
158
    components to \QC.
159

con's avatar
con committed
160
    \table
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
        \header
            \li Task
            \li Details
            \li API

        \row
            \li Add a menu or menu item.
            \li You can extend existing menus or create new ones.
            \li \l{Core::ActionManager}, \l{Core::Command}

        \row
            \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}

        \row
            \li Add a mode.
            \li Modes correspond to complete screens of controls, specialized
                for a task.
            \li \l{Core::IMode}

        \row
            \li Add a new editor type.
            \li Such as an editor for XML files.
            \li \l{Core::IEditorFactory}, \l{Core::IEditor}, \l{Core::IDocument}

        \row
            \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}

        \row
            \li Add support for a new version control system.
            \li Version control systems integrated in \QC are Bazaar, CVS, Git,
                Mecurial, Perforce, and Subversion.
            \li \l{Core::IVersionControl}

        \row
            \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}

        \row
            \li Add an options page to the \uicontrol Options dialog.
            \li Add a new page to existing or new category in
                \uicontrol Tools > \uicontrol Options.
            \li \l{Core::IOptionsPage}

        \row
            \li Add a find filter to the \uicontrol Find dialog.
            \li Implement any kind of search term based search.
            \li \l{Find::IFindFilter}, \l{Core::SearchResultWindow}

        \row
            \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.
            \li \l{Core::IFindSupport}, \l{Find::BaseTextFind}

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

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

        \row
            \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.
            \li \l{Core::ILocatorFilter}, \l{Core::LocatorFilterEntry},
                \l{Locator::BaseFileFilter}

        \row
            \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}

        \row
            \li
            \li
            \li
con's avatar
con committed
253 254 255

    \endtable
*/