Extending Qt Creator Manual | Utils Namespace

Extending Qt Creator Manual 4.6.2

# Utils Namespace

Header: | #include <Utils>

## Namespaces

namespace | FadingIndicator
namespace | Icons
namespace | Internal
namespace | Memory
namespace | Text
namespace | Ui

## Classes

class | AbstractMacroExpander
class | AnnotatedItemDelegate
class | AnsiEscapeCodeHandler
class | AppMainWindow
class | BaseTreeModel
class | BaseTreeView
class | BasicSettingsAccessor
class | BasicSmallString
class | BasicSmallStringLiteral
class | BasicSmallStringVector
class | Benchmarker
class | BuildableHelperLibrary
class | CategorySortFilterModel
class | ChangeSet
class | CheckableMessageBox
class | ClassNameValidatingLineEdit
class | CommentDefinition
class | CompletingLineEdit
class | CompletingTextEdit
class | ConsoleProcess
class | ConsoleProcessPrivate
class | CrumblePath
class | DebuggerMainWindow
class | DetailsButton
class | DetailsWidget
class | DropMimeData
class | DropSupport
class | ElfData
class | ElfMapper
class | ElfProgramHeader
class | ElfReader
class | ElfSectionHeader
class | ElidingLabel
class | Environment
class | EnvironmentDialog
class | EnvironmentItem
class | EnvironmentModel
class | ExecuteOnDestruction
class | FadingPanel
class | FadingWidget
class | FakeToolTip
class | FancyLineEdit
class | FancyMainWindow
class | FileCrumbLabel
class | FileInProjectFinder
class | FileIterator
class | FileListIterator
class | FileName
class | FileNameValidatingLineEdit
class | FileReader
class | FileSaver
class | FileSaverBase
class | FileSearchResult
class | FileSystemWatcher
class | FileUtils
class | FileWizardPage
class | FixedSizeClickLabel
class | FlowLayout
class | FormattedText
class | Guard
class | GuardLocker
class | HeaderViewStretcher
class | HighlightingItemDelegate
class | HistoryCompleter
class | HostOsInfo
class | HtmlDocExtractor
class | Icon
class | IconButton
class | ItemViewEvent
class | JsonMemoryPool
class | JsonNullValue
class | Link
class | ListView
class | ListWidget
class | MacroExpander
class | MimeType
class | NavigationTreeView
class | NetworkAccessManager
class | NewClassWidget
class | OsSpecificAspects
class | OutputFormatter
class | OutputProxy
class | OverrideCursor
class | ParameterAction
class | PathChooser
class | PathListEditor
class | PersistentSettingsReader
class | PersistentSettingsWriter
class | Perspective
class | Port
class | PortList
class | ProcessHandle
class | ProgressIndicator
class | ProgressIndicatorPainter
class | ProgressParser
class | ProjectIntroPage
class | ProxyAction
class | ProxyCredentialsDialog
class | QtColorButton
class | QtcProcess
class | RemoveFileDialog
class | SaveFile
class | SavedAction
class | SavedActionSet
class | ScopedSwap
class | SettingsAccessor
class | SettingsSelector
class | ShellCommand
class | ShellCommandPage
class | SizedArray
class | SmallStringView
class | StaticTreeItem
class | StatusLabel
class | StyleHelper
class | StyledBar
class | StyledSeparator
class | SubDirFileIterator
class | SynchronousProcess
class | SynchronousProcessResponse
class | TempFileSaver
class | TemplateEngine
class | TemporaryDirectory
class | TemporaryFile
class | TextFieldCheckBox
class | TextFieldComboBox
class | TextFileFormat
class | Theme
class | ThemePrivate
class | ToolTip
class | ToolbarDescription
class | TreeItem
class | TreeModel
class | TreeView
class | TreeViewComboBox
class | TreeViewComboBoxView
class | TreeWidget
class | TypedTreeItem
class | UnixUtils
class | VersionUpgrader
class | View
class | WindowsCrashDialogBlocker
class | Wizard
class | WizardPage
class | WizardProgress
class | WizardProgressItem
class | functionTakesArgument
class | functionTraits

## Types

enum | ActivationMode { DoubleClickActivation, SingleClickActivation, PlatformDefaultActivation }
enum | ApplyMode { ImmediateApply, DeferedApply }
enum | DebugSymbolsType { UnknownSymbols, NoSymbols, LinkedSymbols, BuildIdSymbols, PlainSymbols, FastSymbols }
enum | ElfClass { Elf_ELFCLASS32, Elf_ELFCLASS64 }
enum | ElfEndian { Elf_ELFDATANONE, Elf_ELFDATA2LSB, Elf_ELFDATA2MSB, Elf_ELFDATANUM }
enum | ElfMachine { Elf_EM_386, Elf_EM_ARM, Elf_EM_X86_64 }
enum | ElfProgramHeaderType { Elf_PT_NULL, Elf_PT_LOAD, Elf_PT_DYNAMIC, Elf_PT_INTERP, ..., Elf_PT_NUM }
enum | ElfSectionHeaderType { Elf_SHT_NULL, Elf_SHT_PROGBITS, Elf_SHT_SYMTAB, Elf_SHT_STRTAB, ..., Elf_SHT_SYMTAB_SHNDX }
enum | ElfType { Elf_ET_NONE, Elf_ET_REL, Elf_ET_EXEC, Elf_ET_DYN, Elf_ET_CORE }
enum | FileDeletedPromptAnswer { FileDeletedClose, FileDeletedCloseAll, FileDeletedSaveAs, FileDeletedSave }
typedef | FileSearchResultList
enum | HighlightingItemRole { LineNumber, StartColumn, Length, Foreground, Background, User }
typedef | IconMaskAndColor
typedef | MacroExpanderProvider
typedef | MacroExpanderProviders
enum | MapReduceOption { Ordered, Unordered }
enum | MimeMatchMode { MatchDefault, MatchExtension, MatchContent }
enum | MimeStartupPhase { BeforeInitialize, PluginsLoading, PluginsInitializing, PluginsDelayedInitializing, UpAndRunning }
enum | OsType { OsTypeWindows, OsTypeLinux, OsTypeMac, OsTypeOtherUnix, OsTypeOther }
enum | OutputFormat { NormalMessageFormat, ErrorMessageFormat, LogMessageFormat, DebugFormat, ..., NumberOfFormats }
enum | ProgressIndicatorSize { Small, Medium, Large }
enum | ReloadPromptAnswer { ReloadCurrent, ReloadAll, ReloadSkipCurrent, ReloadNone, ReloadNoneAndDiff, CloseCurrent }
typedef | ScopedBoolSwap
enum | WinDLLVersionType { WinDLLFileVersion, WinDLLProductVersion }

## Functions

bool | anyOf(const T &container, F predicate)
T * | checkEventType(QEvent *ev)
void | fromSettings(const QString &postFix, const QString &category, const QSettings *s, SettingsClassT *obj)
QFuture<ReduceResult> | mapReduce(ForwardIterator begin, ForwardIterator end, InitFunction &&init, MapFunction &&map, ReduceFunction &&reduce, CleanUpFunction &&cleanup, MapReduceOption option = MapReduceOption::Unordered, QThreadPool *pool = nullptr, QThread::Priority priority = QThread::InheritPriority, int size = -1)
QList<T1> | qwConvertList(const QList<T2> &list)
void | toSettings(const QString &postFix, const QString &category, QSettings *s, const SettingsClassT *obj)
T | withNTFSPermissions(const std::function<T() > &task)
bool | operator!=(const Port &p1, const Port &p2)
bool | operator!=(const ProcessHandle &p1, const ProcessHandle &p2)
bool | operator<(const Port &p1, const Port &p2)
QTCREATOR_UTILS_EXPORT | operator<<(QDebug debug, const EnvironmentItem &i)
QDataStream & | operator<<(QDataStream &out, const BasicSmallString<Size> &string)
QDebug & | operator<<(QDebug &debug, const String &string)
std::ostream & | operator<<(std::ostream &out, const BasicSmallString<Size> &string)
std::ostream & | operator<<(std::ostream &out, SmallStringView string)
QDataStream & | operator<<(QDataStream &out, const BasicSmallStringVector<String> &stringVector)
QDebug | operator<<(QDebug debug, const BasicSmallStringVector<String> &stringVector)
std::ostream & | operator<<(std::ostream &out, const BasicSmallStringVector<String> &textVector)
QTCREATOR_UTILS_EXPORT | operator<<(QDebug str, const SynchronousProcessResponse &)
bool | operator<=(const Port &p1, const Port &p2)
bool | operator==(const Port &p1, const Port &p2)
bool | operator==(const ProcessHandle &p1, const ProcessHandle &p2)
bool | operator>(const Port &p1, const Port &p2)
bool | operator>=(const Port &p1, const Port &p2)
QDataStream & | operator>>(QDataStream &in, BasicSmallString<Size> &string)
QDataStream & | operator>>(QDataStream &in, BasicSmallStringVector<String> &stringVector)

## Detailed Description

The Utils namespace contains a collection of utility classes and functions for use by all plugins.

## Namespaces

### namespace Utils::FadingIndicator

### namespace Utils::Icons

### namespace Utils::Internal

### namespace Utils::Memory

### namespace Utils::Text

### namespace Utils::Ui

## Classes

### class AbstractMacroExpander

### class AnnotatedItemDelegate

### class AnsiEscapeCodeHandler

The AnsiEscapeCodeHandler class parses text and extracts ANSI escape codes from it. More...

### class AppMainWindow

### class BaseTreeModel

### class BaseTreeView

### class BasicSettingsAccessor

### class BasicSmallString

### class BasicSmallStringLiteral

### class BasicSmallStringVector

### class Benchmarker

### class BuildableHelperLibrary

### class CategorySortFilterModel

### class ChangeSet

### class CheckableMessageBox

The CheckableMessageBox class implements a message box suitable for questions with a "Do not ask me again" checkbox. More...

### class ClassNameValidatingLineEdit

The ClassNameValidatingLineEdit class implements a line edit that validates a C++ class name and emits a signal to derive suggested file names from it. More...

### class CommentDefinition

### class CompletingLineEdit

### class CompletingTextEdit

The CompletingTextEdit class is a QTextEdit with auto-completion support. More...

### class ConsoleProcess

### class ConsoleProcessPrivate

### class CrumblePath

### class DebuggerMainWindow

### class DetailsButton

### class DetailsWidget

The DetailsWidget class implements a button to expand a Details area. More...

### class DropMimeData

### class DropSupport

### class ElfData

### class ElfMapper

### class ElfProgramHeader

### class ElfReader

### class ElfSectionHeader

### class ElidingLabel

The ElidingLabel class is a label suitable for displaying elided text. More...

### class Environment

### class EnvironmentDialog

### class EnvironmentItem

### class EnvironmentModel

### class ExecuteOnDestruction

### class FadingPanel

### class FadingWidget

### class FakeToolTip

The FakeToolTip class is a widget that pretends to be a tooltip. More...

### class FancyLineEdit

The FancyLineEdit class is an enhanced line edit with several opt-in features. More...

### class FancyMainWindow

The FancyMainWindow class is a MainWindow with dock widgets and additional "lock" functionality (locking the dock widgets in place) and "reset layout" functionality. More...

### class FileCrumbLabel

### class FileInProjectFinder

The FileInProjectFinder class is a helper class to find the original file in the project directory for a given file URL. More...

### class FileIterator

### class FileListIterator

### class FileName

The FileName class is a light-weight convenience class for filenames. More...

### class FileNameValidatingLineEdit

The FileNameValidatingLineEdit class is a control that lets the user choose a (base) file name, based on a QLineEdit. More...

### class FileReader

### class FileSaver

### class FileSaverBase

### class FileSearchResult

### class FileSystemWatcher

The FileSystemWatcher class is a file watcher that internally uses a centralized QFileSystemWatcher and enforces limits on Mac OS. More...

### class FileUtils

The FileUtils class contains file and directory related convenience functions. More...

### class FileWizardPage

The FileWizardPage class is a standard wizard page for a single file letting the user choose name and path. More...

### class FixedSizeClickLabel

The FixedSizeClickLabel class is a label with a size hint derived from a sample text that can be different to the text that is shown. More...

### class FlowLayout

### class FormattedText

### class Guard

The Guard class implements a recursive guard with locking mechanism. More...

### class GuardLocker

### class HeaderViewStretcher

The HeaderViewStretcher class fixes QHeaderView to resize all columns to contents, except one stretching column. More...

### class HighlightingItemDelegate

### class HistoryCompleter

### class HostOsInfo

### class HtmlDocExtractor

### class Icon

### class IconButton

### class ItemViewEvent

### class JsonMemoryPool

### class JsonNullValue

### class Link

### class ListView

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

### class ListWidget

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

### class MacroExpander

The MacroExpander class 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. More...

### class MimeType

The MimeType class describes types of file or data, represented by a MIME type string. More...

### class NavigationTreeView

The NavigationTreeView class implements a general TreeView for any sidebar widget. More...

### class NetworkAccessManager

### class NewClassWidget

The NewClassWidget class is a utility widget for 'New Class' wizards. More...

### class OsSpecificAspects

### class OutputFormatter

### class OutputProxy

### class OverrideCursor

### class ParameterAction

The ParameterAction class is intended for actions that act on a 'current', string-type parameter (typically a file name), for example 'Save file %1'. More...

### class PathChooser

The PathChooser class is a control that lets the user choose a path, consisting of a QLineEdit and a "Browse" button. More...

### class PathListEditor

The PathListEditor class is a control that lets the user edit a list of (directory) paths using the platform separator (';',':'). More...

### class PersistentSettingsReader

The PersistentSettingsReader class reads a QVariantMap of arbitrary, nested data structures from an XML file. More...

### class PersistentSettingsWriter

The PersistentSettingsWriter class serializes a QVariantMap of arbitrary, nested data structures to an XML file. More...

### class Perspective

### class Port

The Port class implements a wrapper around a 16 bit port number to be used in conjunction with IP addresses. More...

### class PortList

### class ProcessHandle

The ProcessHandle class is a helper class to describe a process. More...

### class ProgressIndicator

The ProgressIndicator class shows an circular, endlessly animated progress indicator. More...

### class ProgressIndicatorPainter

The ProgressIndicatorPainter class is the painting backend for the ProgressIndicator class. More...

### class ProgressParser

### class ProjectIntroPage

The ProjectIntroPage class is the standard wizard page for a project, letting the user choose its name and path. More...

### class ProxyAction

### class ProxyCredentialsDialog

### class QtColorButton

### class QtcProcess

The QtcProcess class provides functionality for dealing with shell-quoted process arguments. More...

### class RemoveFileDialog

### class SaveFile

### class SavedAction

The SavedAction class is a helper class for actions with persistent state. More...

### class SavedActionSet

### class ScopedSwap

### class SettingsAccessor

### class SettingsSelector

### class ShellCommand

### class ShellCommandPage

The ShellCommandPage implements a page showing the progress of a `ShellCommand`. More...

### class SizedArray

### class SmallStringView

### class StaticTreeItem

### class StatusLabel

The StatusLabel class displays messages for a while with a timeout. More...

### class StyleHelper

### class StyledBar

### class StyledSeparator

### class SubDirFileIterator

### class SynchronousProcess

The SynchronousProcess class runs a synchronous process in its own event loop that blocks only user input events. Thus, it allows for the GUI to repaint and append output to log windows. More...

### class SynchronousProcessResponse

### class TempFileSaver

### class TemplateEngine

### class TemporaryDirectory

### class TemporaryFile

### class TextFieldCheckBox

The TextFieldCheckBox class is a aheckbox that plays with `QWizard::registerField`. More...

### class TextFieldComboBox

The TextFieldComboBox class is a non-editable combo box for text editing purposes that plays with `QWizard::registerField` (providing a settable 'text' property). More...

### class TextFileFormat

The TextFileFormat class describes the format of a text file and provides autodetection. More...

### class Theme

### class ThemePrivate

### class ToolTip

### class ToolbarDescription

### class TreeItem

### class TreeModel

The TreeModel class is a convienience base class for models to use in a QTreeView. More...

### class TreeView

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

### class TreeViewComboBox

### class TreeViewComboBoxView

### class TreeWidget

The TreeWidget adds setActivationMode to QTreeWidget to allow for single click/double click behavior on platforms where the default is different. Use with care. More...

### class TypedTreeItem

### class UnixUtils

### class VersionUpgrader

### class View

### class WindowsCrashDialogBlocker

### class Wizard

The Wizard class implements a wizard with a progress bar on the left. More...

### class WizardPage

QWizardPage with a couple of improvements More...

### class WizardProgress

### class WizardProgressItem

### class functionTakesArgument

### class functionTraits

## Type Documentation

### enum Utils::ActivationMode

### enum Utils::ApplyMode

### enum Utils::DebugSymbolsType

### enum Utils::ElfClass

### enum Utils::ElfEndian

### enum Utils::ElfMachine

### enum Utils::ElfProgramHeaderType

### enum Utils::ElfSectionHeaderType

### enum Utils::ElfType

### enum Utils::FileDeletedPromptAnswer

### typedef Utils::FileSearchResultList

### enum Utils::HighlightingItemRole

### typedef Utils::IconMaskAndColor

### typedef Utils::MacroExpanderProvider

### typedef Utils::MacroExpanderProviders

### enum Utils::MapReduceOption

### enum Utils::MimeMatchMode

### enum Utils::MimeStartupPhase

### enum Utils::OsType

### enum Utils::OutputFormat

### enum Utils::ProgressIndicatorSize

Size of a progress indicator.

Constant | Value | Description
--- | --- | ---
`Utils::Small` | `0` | Small icon size. Useful for tool bars, status bars, rows in tree views, and so on.
`Utils::Medium` | `1` | Larger progress indicator useful for covering whole medium sized widgets.
`Utils::Large` | `2` | Very large progress indicator that can be used to cover large parts of a UI.

See also Utils::ProgressIndicator and Utils::ProgressIndicatorPainter.

### enum Utils::ReloadPromptAnswer

### typedef Utils::ScopedBoolSwap

### enum Utils::WinDLLVersionType

## Function Documentation

### bool Utils::anyOf(const T &container, F predicate)

### T *Utils::checkEventType(QEvent *ev)

### void Utils::fromSettings(const QString &postFix, const QString &category, const QSettings *s, SettingsClassT *obj)

### QFuture<ReduceResult> Utils::mapReduce(ForwardIterator begin, ForwardIterator end, InitFunction &&init, MapFunction &&map, ReduceFunction &&reduce, CleanUpFunction &&cleanup, MapReduceOption option = MapReduceOption::Unordered, QThreadPool *pool = nullptr, QThread::Priority priority = QThread::InheritPriority, int size = -1)

### QList<T1> Utils::qwConvertList(const QList<T2> &list)

### void Utils::toSettings(const QString &postFix, const QString &category, QSettings *s, const SettingsClassT *obj)

### `[static]` T Utils::withNTFSPermissions(const std::function<T() > &task)

### bool Utils::operator!=(const Port &p1, const Port &p2)

### bool Utils::operator!=(const ProcessHandle &p1, const ProcessHandle &p2)

### bool Utils::operator<(const Port &p1, const Port &p2)

### QTCREATOR_UTILS_EXPORT Utils::operator<<(QDebug debug, const EnvironmentItem &i)

### QDataStream &Utils::operator<<(QDataStream &out, const BasicSmallString<Size> &string)

### QDebug &Utils::operator<<(QDebug &debug, const String &string)

### std::ostream &Utils::operator<<(std::ostream &out, const BasicSmallString<Size> &string)

### std::ostream &Utils::operator<<(std::ostream &out, SmallStringView string)

### QDataStream &Utils::operator<<(QDataStream &out, const BasicSmallStringVector<String> &stringVector)

### QDebug Utils::operator<<(QDebug debug, const BasicSmallStringVector<String> &stringVector)

### std::ostream &Utils::operator<<(std::ostream &out, const BasicSmallStringVector<String> &textVector)

### QTCREATOR_UTILS_EXPORT Utils::operator<<(QDebug str, const SynchronousProcessResponse &)

### bool Utils::operator<=(const Port &p1, const Port &p2)

### bool Utils::operator==(const Port &p1, const Port &p2)

### bool Utils::operator==(const ProcessHandle &p1, const ProcessHandle &p2)

### bool Utils::operator>(const Port &p1, const Port &p2)

### bool Utils::operator>=(const Port &p1, const Port &p2)

### QDataStream &Utils::operator>>(QDataStream &in, BasicSmallString<Size> &string)

### QDataStream &Utils::operator>>(QDataStream &in, BasicSmallStringVector<String> &stringVector)