Core Namespace | Extending Qt Creator Manual

Extending Qt Creator Manual | Core Namespace

Extending Qt Creator Manual 4.12.0

# Core Namespace

The Core namespace contains all classes that make up the Core plugin which constitute the basic functionality of Qt Creator. More...

Header: | #include <Core>

## Namespaces

namespace | FileIconProvider

## Classes

class | ActionContainer
class | ActionManager
class | BaseFileFilter
class | BaseFileWizard
class | BaseFileWizardFactory
class | BaseTextDocument
class | BaseTextFind
class | Command
class | CommandButton
class | DocumentManager
class | EditorManager
class | FileChangeBlocker
class | FutureProgress
class | GeneratedFile
class | IContext
class | ICore
class | IDocument
class | IEditor
class | IEditorFactory
class | IExternalEditor
class | IFeatureProvider
class | IFindFilter
class | IFindSupport
class | ILocatorFilter
class | INavigationWidgetFactory
class | IOptionsPage
class | IOutputPane
class | IWizardFactory
class | Id
class | MiniSplitter
class | ModeManager
| NavigationView
class | NonResizingSplitter
class | ProgressManager
class | SearchResult
class | SearchResultWindow
class | SettingsDatabase
class | VariableChooser
class | WizardDialogParameters

## Types

enum | FindFlag { FindBackward, FindCaseSensitively, FindWholeWords, FindRegularExpression, FindPreserveCase }
flags | FindFlags

## Detailed Description

## Namespaces

### namespace Core::FileIconProvider

Provides icons based on file suffixes with the ability to overwrite system icons for specific subtypes. The underlying QFileIconProvider can be used for QFileSystemModel.

Note: Registering overlay icons currently completely replaces the system icon and is therefore not recommended on platforms that have their own overlay icon handling (macOS and Windows).

Plugins can register custom overlay icons via registerIconOverlayForSuffix(), and retrieve icons via the icon() function.

## Classes

### class ActionContainer

The ActionContainer class represents a menu or menu bar in Qt Creator. More...

### class ActionManager

The ActionManager class is responsible for registration of menus and menu items and keyboard shortcuts. More...

### class BaseFileFilter

The BaseFileFilter class is a base class for locator filter classes. More...

### class BaseFileWizard

The BaseFileWizard class implements a is a convenience class for creating files. More...

### class BaseFileWizardFactory

The BaseFileWizardFactory class implements a generic wizard for creating files. More...

### class BaseTextDocument

The BaseTextDocument class is a very general base class for documents that work with text. More...

### class BaseTextFind

The BaseTextFind class implements a find filter for QPlainTextEdit and QTextEdit based widgets. More...

### class Command

The Command class represents an action, such as a menu item, tool button, or shortcut. More...

### class CommandButton

The CommandButton class is a tool button associated with one of the registered Command objects. More...

### class DocumentManager

The DocumentManager class manages a set of documents. More...

### class EditorManager

The EditorManager class manages the editors created for files according to their MIME type. More...

### class FileChangeBlocker

The FileChangeBlocker class blocks all change notifications to all IDocument objects that match the given filename. More...

### class FutureProgress

The FutureProgress class is used to adapt the appearance of progress indicators that were created through the ProgressManager class. More...

### class GeneratedFile

The GeneratedFile class represents a file generated by a wizard. More...

### class IContext

The IContext class holds the context for performing an action. More...

### class ICore

The ICore class allows access to the different parts that make up the basic functionality of Qt Creator. More...

### class IDocument

The IDocument class describes a document that can be saved and reloaded. More...

### class IEditor

The IEditor class is an interface for providing suitable editors for documents according to their MIME type. More...

### class IEditorFactory

The IEditorFactory class creates suitable editors for documents according to their MIME type. More...

### class IExternalEditor

The IExternalEditor class enables registering an external editor in the Open With dialog. More...

### class IFeatureProvider

The IFeatureProvider class defines an interface to manage features for wizards. More...

### class IFindFilter

The IFindFilter class is the base class for find implementations that are invoked by selecting Edit > Find/Replace > Advanced Find. More...

### class IFindSupport

The IFindSupport class provides functions for searching in a document or widget. More...

### class ILocatorFilter

The ILocatorFilter class adds a locator filter. More...

### class INavigationWidgetFactory

The INavigationWidgetFactory class provides new instances of navigation widgets. More...

### class IOptionsPage

The IOptionsPage class is an interface for providing pages for the Options dialog (called Preferences on macOS). More...

### class IOutputPane

The IOutputPane class is an interface for providing Output panes. More...

### class IWizardFactory

The IWizardFactory class is the base class for all wizard factories. More...

### class Id

The Id class encapsulates an identifier that is unique within a specific running Qt Creator process. More...

### class MiniSplitter

The MiniSplitter class is a simple helper-class to obtain macOS style 1-pixel wide splitters. More...

### class ModeManager

The ModeManager class implements a mode manager. More...

### class NavigationView

The NavigationView class is a C struct for wrapping a widget and a list of tool buttons. Wrapping the widget that is shown in the content area of the navigation widget and a list of tool buttons that is shown in the header above it. More...

### class NonResizingSplitter

The NonResizingSplitter class is a MiniSplitter that keeps its first widget's size fixed when it is resized. More...

### class ProgressManager

The ProgressManager class is used to show a user interface for running tasks in Qt Creator. More...

### class SearchResult

The SearchResult class reports user interaction, such as the activation of a search result item. More...

### class SearchResultWindow

The SearchResultWindow class is the implementation of a commonly shared Search Results output pane. More...

### class SettingsDatabase

The SettingsDatabase class offers an alternative to the application-wide QSettings that is more suitable for storing large amounts of data. More...

### class VariableChooser

The VariableChooser class is used to add a tool window for selecting Qt Creator variables to line edits, text edits or plain text edits. More...

### class WizardDialogParameters

The WizardDialogParameters class holds parameters for the new file wizard dialog. More...

## Type Documentation

### enum Core::FindFlag
flags Core::FindFlags

This enum holds the find flags.

Constant | Value | Description
--- | --- | ---
`Core::FindBackward` | `0x01` | Searches backwards.
`Core::FindCaseSensitively` | `0x02` | Considers case when searching.
`Core::FindWholeWords` | `0x04` | Finds only whole words.
`Core::FindRegularExpression` | `0x08` | Uses a regular epression as a search term.
`Core::FindPreserveCase` | `0x10` | Preserves the case when replacing search terms.

The FindFlags type is a typedef for QFlags<FindFlag>. It stores an OR combination of FindFlag values.