forked from qt-creator/qt-creator
c04a4a1ae0
- Mark undocumented but existing functions with \c (instead of \l or \sa)
- Remove reference to functions I could no longer find
- Fix other broken links
- Fix reference to an image whose file format changed to WEBP
- Use {} instead of "" to mark alt text for images
- Add missing \a commands
- Add class name to a function name so that it can be found
Change-Id: I10655bb0356c7417ab0e14a3ce620930f4ee8349
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
108 lines
3.9 KiB
Plaintext
108 lines
3.9 KiB
Plaintext
// Copyright (C) 2020 The Qt Company Ltd.
|
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
|
|
|
/*!
|
|
\page common_extension_tasks.html
|
|
\title Common Extension Tasks
|
|
|
|
This section summarizes the API functions that you can use to add UI
|
|
components to \QC.
|
|
|
|
\table
|
|
\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 \uicontrol File >
|
|
\uicontrol {New File} and \uicontrol {New Project} with your own file
|
|
and project templates. We recommend that you create
|
|
JSON-based wizards instead of implementing new
|
|
wizards in C++ code.
|
|
\li \l{https://doc.qt.io/qtcreator/creator-project-wizards.html}
|
|
{Adding New Custom Wizards}
|
|
|
|
\l{Core::IWizardFactory}, \l{Core::BaseFileWizardFactory},
|
|
\l{Core::BaseFileWizard}, \l{Core::WizardDialogParameters}
|
|
\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 \c{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 a page to the \uicontrol Preferences dialog.
|
|
\li Add a new page to existing or new category in
|
|
\uicontrol Edit > \uicontrol Preferences.
|
|
\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{Core::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{Core::BaseTextFind}
|
|
|
|
\omit
|
|
\row
|
|
\li Add a completely new project type.
|
|
\li
|
|
\li
|
|
|
|
\row
|
|
\li Add a new type of build step.
|
|
\li
|
|
\li
|
|
\endomit
|
|
|
|
\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}
|
|
|
|
\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}
|
|
|
|
\endtable
|
|
*/
|