qtcreator-api.qdoc 4.94 KB
Newer Older
1 2 3 4
/*!
    \page index.html
    \title Qt Creator

5
    Qt Creator is Nokia's crossplatform IDE. The core of Qt Creator is
con's avatar
con committed
6
    basically only a \l{ExtensionSystem}{plugin loader}.
con's avatar
con committed
7 8 9 10
    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
11

con's avatar
con committed
12 13
    To get an overview of what parts of QtCreator are extensible, have a look at the \l{Common Extension Tasks} page.

con's avatar
con committed
14 15 16 17 18 19 20 21 22 23
    \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
24
    \o \l{Aggregation}
con's avatar
con committed
25 26 27 28
    \o Adds functionality for "glueing" QObjects of different
    types together, so you can "cast" between them.

    \row
con's avatar
con committed
29
    \o \l{ExtensionSystem}
con's avatar
con committed
30 31 32 33
    \o Implements the plugin loader framework. Provides a base class for plugins and
    basic mechanisms for plugin interaction like an object pool.

    \endtable
34 35 36 37 38 39 40 41 42 43 44 45 46 47

    \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
48
    \o \l{Core}
49 50 51
    \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
52 53 54 55 56
    \row
    \o \l{Find}
    \o Support for searching text in arbitrary widgets, and arbitrary other things.

    \row
con's avatar
con committed
57
    \o \l{Locator}
con's avatar
con committed
58 59
    \o Hooks for providing content for Locator.

60 61 62 63 64
    \endtable
*/

/*!
    \page classes.html
con's avatar
con committed
65
    \title Qt Creator Classes
66 67

    \generatelist classes
con's avatar
con committed
68
*/
69

con's avatar
con committed
70 71 72
/*!
    \page namespaces.html
    \title Qt Creator Namespaces
73

con's avatar
con committed
74
    \generatelist namespaces
75 76 77
*/

/*!
con's avatar
con committed
78 79 80
    \page mainclasses.html
    \title Qt Creator Main Classes

81 82 83 84 85 86
    \generatelist mainclasses

*/

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

con's avatar
con committed
89
    \generatelist functionindex
90 91
*/

con's avatar
con committed
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 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
/*!
    \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.
    \o \l{Core::IMode}, \l{Core::BaseMode}

    \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.
145
    \o \l{Find::IFindFilter}, \l{Find::SearchResultWindow}
con's avatar
con committed
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164

    \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
165
    \o \l{Locator::ILocatorFilter}, \l{Locator::FilterEntry}, \l{Locator::BaseFileFilter}
con's avatar
con committed
166

167 168 169 170 171 172
    \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
173 174 175 176 177 178 179
    \row
    \o
    \o
    \o

    \endtable
*/