Qt Creator C++ Classes

Namespaces

Aggregation

Contains support for bundling related components, so that each component exposes the properties and behavior of the other components to the outside

Core

Contains all classes that make up the Core plugin which constitute the basic functionality of Qt Creator

Core::MessageManager

Used to post messages in the General Messages pane

Core::SettingsDatabase

Offers an alternative to the application-wide QSettings that is more suitable for storing large amounts of data

ExtensionSystem

Classes that belong to the core plugin system

Layouting

Contains classes and functions to conveniently create layouts in code

Utils

Contains a collection of utility classes and functions for use by all plugins

Utils::MathUtils

Contains functions for interpolation

Classes

Aggregation::Aggregate

Defines a collection of related components that can be viewed as a unit

Core::ActionBuilder

Convienience class to set up Core::Commands

Core::ActionContainer

Represents a menu or menu bar in Qt Creator

Core::ActionManager

Responsible for registration of menus and menu items and keyboard shortcuts

Core::BaseFileWizard

Implements a is a convenience class for creating files

Core::BaseFileWizardFactory

Implements a generic wizard for creating files

Core::BaseTextDocument

Very general base class for documents that work with text

Core::BaseTextFind

Implements a find filter for QPlainTextEdit and QTextEdit based widgets

Core::Command

Represents an action, such as a menu item, tool button, or shortcut

Core::Context

Implements a list of context IDs

Core::DesignMode

Implements the mode for the Design mode, which is for example used by Qt Quick Designer and Qt Widgets Designer

Core::DocumentManager

Manages a set of documents

Core::EditorManager

Manages the editors created for files according to their MIME type

Core::EditorManagerPlaceHolder

Used to integrate an editor area into a mode

Core::FileChangeBlocker

Blocks all change notifications to all IDocument objects that match the given filename

Core::FutureProgress

Used to adapt the appearance of progress indicators that were created through the ProgressManager class

Core::GeneratedFile

Represents a file generated by a wizard

Core::IContext

Associates a widget with a context list and context help

Core::ICore

Allows access to the different parts that make up the basic functionality of Qt Creator

Core::IDocument

Describes a document that can be saved and reloaded

Core::IEditor

Interface for editing an open document in Qt Creator

Core::IEditorFactory

Creates suitable editors for documents according to their MIME type

Core::IFeatureProvider

Defines an interface to manage features for wizards

Core::IFindFilter

The base class for find implementations that are invoked by selecting Edit > Find/Replace > Advanced Find

Core::IFindSupport

Functions for searching in a document or widget

Core::ILocatorFilter

Adds a locator filter

Core::IMode

Represents a mode in Qt Creator

Core::INavigationWidgetFactory

New instances of navigation widgets

Core::IOptionsPage

Interface for providing pages for the Options dialog (called Preferences on macOS)

Core::IOptionsPageWidget

Used to standardize the interaction between an IOptionsPage and its widget

Core::IOutputPane

Interface for providing Output panes

Core::IWizardFactory

The base class for all wizard factories

Core::LocatorFileCache

Encapsulates all the responsibilities needed for implementing a cache for file filters

Core::MiniSplitter

Simple helper-class to obtain macOS style 1-pixel wide splitters

Core::ModeManager

Manages the activation of modes and the actions in the mode selector's tool bar

Core::NonResizingSplitter

MiniSplitter that keeps its first widget's size fixed when it is resized

Core::ProcessProgress

Responsible for showing progress of the running process

Core::ProgressManager

Used to show a user interface for running tasks in Qt Creator

Core::SearchResult

Reports user interaction, such as the activation of a search result item

Core::SearchResultWindow

The implementation of a commonly shared Search Results output pane

Core::SessionManager

Manages sessions

Core::TaskProgress

Responsible for showing progress of the running task tree

Core::WizardDialogParameters

Holds parameters for the new file wizard dialog

ExtensionSystem::IPlugin

Abstract base class that must be implemented once for each plugin

ExtensionSystem::PluginArgumentDescription

PluginArgumentDescriptions class holds a list of descriptions of command line arguments that a plugin processes

ExtensionSystem::PluginDependency

Contains the name and required compatible version number of a plugin's dependency

ExtensionSystem::PluginDetailsView

Implements a widget that displays the contents of a PluginSpec

ExtensionSystem::PluginErrorView

Implements a widget that displays the state and error message of a PluginSpec

ExtensionSystem::PluginManager

Implements the core plugin system that manages the plugins, their life cycle, and their registered objects

ExtensionSystem::PluginSpec

Contains the information of the plugin's embedded meta data and information about the plugin's current state

ExtensionSystem::PluginView

Implements a widget that shows a list of all plugins and their state

Layouting::Layout

Layouting::LayoutItem

Layouting::Space

Represents some empty space in a layout

Layouting::Stretch

Represents some stretch in a layout

Layouting::Widget

Utils::Action

Intended for actions that act on a 'current', string-type parameter (typically a file name), for example 'Save file %1'

Utils::AnsiEscapeCodeHandler

Parses text and extracts ANSI escape codes from it

Utils::AspectContainer

Wraps one or more aspects while providing the interface of a single aspect

Utils::BaseAspect

Common base for classes implementing aspects

Utils::BoolAspect

A boolean aspect is a boolean property of some object, together with a description of its behavior for common operations like visualizing or persisting

Utils::CheckableMessageBox

Implements a message box suitable for questions with a Do not ask again or Do not show again checkbox

Utils::ClassNameValidatingLineEdit

Implements a line edit that validates a C++ class name and emits a signal to derive suggested file names from it

Utils::ColorAspect

A color aspect is a color property of some object, together with a description of its behavior for common operations like visualizing or persisting

Utils::CommandLine

Represents a command line of a QProcess or similar utility

Utils::CompletingTextEdit

QTextEdit with auto-completion support

Utils::DetailsWidget

Implements a button to expand a Details area

Utils::DoubleAspect

An double aspect is a numerical property of some object, together with a description of its behavior for common operations like visualizing or persisting

Utils::ElidingLabel

Label suitable for displaying elided text

Utils::Environment

Sets Qt Creator's system environment

Utils::FakeToolTip

Widget that pretends to be a tooltip

Utils::FancyLineEdit

Enhanced line edit with several opt-in features

Utils::FancyMainWindow

MainWindow with dock widgets and additional "lock" functionality (locking the dock widgets in place) and "reset layout" functionality

Utils::FileInProjectFinder

Helper class to find the original file in the project directory for a given file URL

Utils::FileNameValidatingLineEdit

Control that lets the user choose a (base) file name, based on a QLineEdit

Utils::FilePath

Abstraction for handles to objects in a (possibly remote) file system, similar to a URL or, in the local case, a path to a file or directory

Utils::FilePathAspect

A file path aspect is shallow wrapper around a Utils::StringAspect that represents a file in the file system

Utils::FilePathListAspect

A filepath list aspect represents a property of some object that is a list of filepathList

Utils::FileSystemWatcher

File watcher that internally uses a centralized QFileSystemWatcher and enforces limits on Mac OS

Utils::FileUtils

Contains file and directory related convenience functions

Utils::FileWizardPage

Standard wizard page for a single file letting the user choose name and path

Utils::FutureSynchronizer

Enhanced version of QFutureSynchronizer

Utils::Guard

Implements a recursive guard with locking mechanism

Utils::HeaderViewStretcher

Fixes QHeaderView to resize all columns to contents, except one stretching column

Utils::Id

Encapsulates an identifier that is unique within a specific running Qt Creator process

Utils::IntegerAspect

An integer aspect is a integral property of some object, together with a description of its behavior for common operations like visualizing or persisting

Utils::ListView

Adds setActivationMode to QListView to allow for single click/double click behavior on platforms where the default is different. Use with care

Utils::ListWidget

Adds setActivationMode to QListWidget to allow for single click/double click behavior on platforms where the default is different. Use with care

Utils::MacroExpander

Manages Qt Creator wide variables, that a user can enter into many string settings. The variables are replaced by an actual value when the string is used, similar to how environment variables are expanded by a shell

Utils::MultiSelectionAspect

A multi-selection aspect represents one or more choices out of several

Utils::NavigationTreeView

Implements a general TreeView for any sidebar widget

Utils::NetworkAccessManager

Network access manager for use with Qt Creator

Utils::OptionPushButton

Implements a QPushButton for which the menu is only opened if the user presses the menu indicator

Utils::PathChooser

Control that lets the user choose a path. The control consist of a QLineEdit and a "Browse" button, and is optionally able to perform variable substitution

Utils::PathListEditor

Control that lets the user edit a list of (directory) paths using the platform separator (';',':')

Utils::PersistentSettingsReader

Reads a QVariantMap of arbitrary, nested data structures from an XML file

Utils::PersistentSettingsWriter

Serializes a Store of arbitrary, nested data structures to an XML file

Utils::Port

Implements a wrapper around a 16 bit port number to be used in conjunction with IP addresses

Utils::Process

Functionality for with processes

Utils::ProcessArgs

Handles shell-quoted process arguments

Utils::ProcessHandle

Helper class to describe a process

Utils::ProjectIntroPage

The standard wizard page for a project, letting the user choose its name and path

Utils::QrcCache

Caches the contents of parsed QRC files

Utils::QrcParser

Parses one or more QRC files and keeps their content cached

Utils::QtcSettings

Extension of the QSettings class the uses Utils::Key instead of QString for keys

Utils::SelectionAspect

A selection aspect represents a specific choice out of several

Utils::StatusLabel

Displays messages for a while with a timeout

Utils::StringAspect

A string aspect is a string-like property of some object, together with a description of its behavior for common operations like visualizing or persisting

Utils::StringListAspect

A string list aspect represents a property of some object that is a list of strings

Utils::TextDisplay

A text display is a phony aspect with the sole purpose of providing some text display using an Utils::InfoLabel in places where otherwise more expensive Utils::StringAspect items would be used

Utils::TextFieldCheckBox

Aheckbox that plays with QWizard::registerField

Utils::TextFieldComboBox

Non-editable combo box for text editing purposes that plays with QWizard::registerField (providing a settable 'text' property)

Utils::TextFileFormat

Describes the format of a text file and provides autodetection

Utils::ToggleAspect

A toggle aspect is a boolean property of some object, together with a description of its behavior for common operations like visualizing or persisting. It also contains independent tooltips, icons and text for the action() according to the on / off state of the aspect

Utils::TreeModel

Convienience base class for models to use in a QTreeView

Utils::TreeView

Adds setActivationMode to QTreeView to allow for single click/double click behavior on platforms where the default is different. Use with care

Utils::TriStateAspect

A tristate aspect is a property of some object that can have three values: enabled, disabled, and unspecified

Utils::TypedAspect

Helper class for implementing a simple aspect

Utils::VariableChooser

Used to add a tool window for selecting Qt Creator variables to line edits, text edits or plain text edits

Utils::Wizard

Implements a wizard with a progress bar on the left

Utils::WizardPage

QWizardPage with a couple of improvements

This topic lists the documented Qt Creator C++ classes. For information about the classes that have not been documented, please inspect the source code.

Copyright © The Qt Company Ltd. and other contributors. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.