qtcreator-api.qdoc 6.02 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 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** No Commercial Usage
**
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** 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
** Nokia at qt-info@nokia.com.
**
****************************************************************************/

28 29 30 31
/*!
    \page index.html
    \title Qt Creator

32
    Qt Creator is Nokia's crossplatform IDE. The core of Qt Creator is
con's avatar
con committed
33
    basically only a \l{ExtensionSystem}{plugin loader}.
con's avatar
con committed
34 35 36 37
    All functionality is implemented in plugins, the basis of Qt Creator 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
38

con's avatar
con committed
39 40
    To get an overview of what parts of Qt Creator are extensible, have a look at the \l{Common Extension Tasks} page.
    Also read and follow the Qt Creator \l{Qt Creator Coding Rules}{coding style and best practice patterns}.
con's avatar
con committed
41

con's avatar
con committed
42 43 44 45 46 47 48 49 50 51
    \section1 Core Libraries

    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
52
    \o \l{Aggregation}
con's avatar
con committed
53 54 55 56
    \o Adds functionality for "glueing" QObjects of different
    types together, so you can "cast" between them.

    \row
con's avatar
con committed
57
    \o \l{ExtensionSystem}
con's avatar
con committed
58 59 60 61
    \o Implements the plugin loader framework. Provides a base class for plugins and
    basic mechanisms for plugin interaction like an object pool.

    \endtable
62 63 64 65 66 67 68 69 70 71 72 73 74 75

    \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
76
    \o \l{Core}
77 78 79
    \o The core plugin. Provides the main window and managers for editors,
    actions, mode windows and files, just to mention the most important ones.

con's avatar
con committed
80 81 82 83 84
    \row
    \o \l{Find}
    \o Support for searching text in arbitrary widgets, and arbitrary other things.

    \row
con's avatar
con committed
85
    \o \l{Locator}
con's avatar
con committed
86 87
    \o Hooks for providing content for Locator.

88 89 90 91
    \row
    \o \l{Debugger}
    \o Debugging functionality.

92 93 94 95 96
    \endtable
*/

/*!
    \page classes.html
con's avatar
con committed
97
    \title Qt Creator Classes
98 99

    \generatelist classes
con's avatar
con committed
100
*/
101

con's avatar
con committed
102 103 104
/*!
    \page namespaces.html
    \title Qt Creator Namespaces
105

con's avatar
con committed
106
    \generatelist namespaces
107 108 109
*/

/*!
con's avatar
con committed
110 111 112
    \page mainclasses.html
    \title Qt Creator Main Classes

113 114 115 116 117 118
    \generatelist mainclasses

*/

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

con's avatar
con committed
121
    \generatelist functionindex
122 123
*/

con's avatar
con committed
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
/*!
    \page common_extension_tasks.html
    \title Common Extension Tasks

    \table
    \header
    \o Task
    \o Details
    \o API

    \row
    \o Add a menu / menu entry.
    \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.
    \o Registerng shortcuts makes it possible for users to configure them in the common shortcut settings dialog.
    \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.
147
    \o \l{Core::IMode}
con's avatar
con committed
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

    \row
    \o Add a new editor type.
    \o Like an editor for xml files.
    \o \l{Core::IEditorFactory}, \l{Core::IEditor}, \l{Core::IFile}

    \row
    \o Add a "New" wizard.
    \o That is added to the list when users do File->New..., allows you to basically do whatever you want.
    \o \l{Core::IWizard}, \l{Core::StandardFileWizard}, \l{Core::BaseFileWizard}, \l{Core::BaseFileWizardParameters}

    \row
    \o Add support for a new version control system.
    \o Version control systems provided by QtCreator itself are Perforce, Git and Subversion.
    \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
    \o Add a preferences page to the preferences dialog.
    \o Add a new page to existing or new category in Tools->Options.
    \o \l{Core::IOptionsPage}

    \row
    \o Add a find filter for the find dialog.
    \o Implement any kind of search term based search.
177
    \o \l{Find::IFindFilter}, \l{Find::SearchResultWindow}
con's avatar
con committed
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196

    \row
    \o Add support for the find tool bar to a widget.
    \o The widget that has focus is asked if it supports text search, you can provide that for widgets under your control.
    \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
    \o Add a new filter to Locator.
    \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
197
    \o \l{Locator::ILocatorFilter}, \l{Locator::FilterEntry}, \l{Locator::BaseFileFilter}
con's avatar
con committed
198

199 200 201 202 203 204
    \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
205 206 207 208 209 210 211
    \row
    \o
    \o
    \o

    \endtable
*/