forked from qt-creator/qt-creator
3f912c01fb
qmake files were still referenced. Do not focus on building Qt Creator, we ship a development package nowadays which is preferred. Change-Id: If209f48c0fcf4f8fbe87ecaddae826ad3a63c209 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
65 lines
2.2 KiB
Plaintext
65 lines
2.2 KiB
Plaintext
// Copyright (C) 2020 The Qt Company Ltd.
|
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
|
|
|
/*!
|
|
\page creating-plugins.html
|
|
\title Creating Plugins
|
|
|
|
At its very core, \QC consists of a plugin loader that loads and runs a set
|
|
of plugins, which then actually provide the functionality that you know from
|
|
\QC the IDE. So, even the main application window and menus are all provided
|
|
by plugins. Plugins can use different means to provide other plugins access
|
|
to their functionality and to allow them to extend certain aspects of the
|
|
application.
|
|
|
|
For example the \c Core plugin, which is the very basic plugin that must be
|
|
present for \QC to run at all, provides the main window itself, and API
|
|
for adding menu items, modes, editor types, navigation panels and many other
|
|
things.
|
|
|
|
The \c TextEditor plugin provides a framework and base implementation for
|
|
different text editors with highlighting, completion and folding, that is
|
|
then used by other plugins to add more specialized text editor types to \QC,
|
|
like for editing C/C++ or \c {.pro} files.
|
|
|
|
After reading this guide you will know what a basic plugin consists of,
|
|
how to write a plugin specification file, what the lifecycle of a plugin is,
|
|
what the general principles for extending existing plugins' functionality
|
|
and providing interfaces for other plugins are, and will be able to write
|
|
your first plugin.
|
|
|
|
\section1 Basics
|
|
|
|
\list
|
|
\li \l{Getting Qt and Qt Creator}
|
|
\li \l{Creating Your First Plugin}
|
|
\li \l{Plugin Meta Data}
|
|
\li \l{Plugin Life Cycle}
|
|
\li \l{Distributing Plugins}
|
|
\endlist
|
|
|
|
\section1 Topics
|
|
|
|
\list
|
|
\li \l{Adding Tests}
|
|
\endlist
|
|
|
|
\section1 Design Principles
|
|
|
|
\list
|
|
\li \l{The Plugin Manager, the Object Pool, and Registered Objects}
|
|
\li \l{The Action Manager and Commands}
|
|
\omit
|
|
\li \l{Aggregations}
|
|
\li \l{Extending and Providing Interfaces}
|
|
\endlist
|
|
|
|
\section1 Creating 3rd-Party Plugins
|
|
|
|
\list
|
|
\li \l{A Note on Binary Compatibility}
|
|
\li \l{Creating User-Installable Plugins}
|
|
\endomit
|
|
\endlist
|
|
*/
|