Utils Namespace

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

Header: #include <Utils>

Namespaces

namespace Internal
namespace MathUtils

Classes

Types

enum FindFlag { FindBackward, FindCaseSensitively, FindWholeWords, FindRegularExpression, FindPreserveCase }
flags LanguageExtensions
enum class ProgressIndicatorSize { Small, Medium, Large }

Functions

void addToolTipsToMenu(QMenu *menu)
Utils::Q_DECL_IMPORT createItem(Layouting::LayoutItem *item, const int &aspect)
QAction *execMenuAtWidget(QMenu *menu, QWidget *widget)
class QString qtcEnvironmentVariable(const class QString &key)
class QString qtcEnvironmentVariable(const class QString &key, const class QString &defaultValue)
int qtcEnvironmentVariableIntValue(const class QString &key, bool *ok = nullptr)
bool qtcEnvironmentVariableIsEmpty(const class QString &key)
bool qtcEnvironmentVariableIsSet(const class QString &key)

Detailed Description

Namespaces

namespace Utils::Internal

Stores the internal value of this BaseAspect into the Store map.

namespace Utils::MathUtils

Classes

class AnsiEscapeCodeHandler

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

class CheckableMessageBox

The CheckableMessageBox class implements a message box suitable for questions with a Do not ask again or Do not show 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 CompletingTextEdit

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

class DetailsWidget

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

class Environment

The Environment class sets Qt Creator's system environment. 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 FileNameValidatingLineEdit

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

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 FutureSynchronizer

The FutureSynchronizer is an enhanced version of QFutureSynchronizer. More...

class Guard

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

class HeaderViewStretcher

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

class NavigationTreeView

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

class NetworkAccessManager

The NetworkAccessManager class provides a network access manager for use with Qt Creator. More...

class OptionPushButton

The OptionPushButton class implements a QPushButton for which the menu is only opened if the user presses the menu indicator. More...

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 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 Store of arbitrary, nested data structures to an XML file. More...

class Port

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

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 ProjectIntroPage

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

class QrcCache

The QrcCache class caches the contents of parsed QRC files. More...

class QrcParser

The QrcParser class parses one or more QRC files and keeps their content cached. More...

class StatusLabel

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

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 TreeModel

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

class WizardPage

QWizardPage with a couple of improvements. More...

Type Documentation

enum Utils::FindFlag

This enum holds the find flags.

ConstantValueDescription
Utils::FindBackward0x01Searches backwards.
Utils::FindCaseSensitively0x02Considers case when searching.
Utils::FindWholeWords0x04Finds only whole words.
Utils::FindRegularExpression0x08Uses a regular epression as a search term.
Utils::FindPreserveCase0x10Preserves the case when replacing search terms.

enum class Utils::ProgressIndicatorSize

Size of a progress indicator.

ConstantValueDescription
Utils::ProgressIndicatorSize::Small0Small icon size. Useful for tool bars, status bars, rows in tree views, and so on.
Utils::ProgressIndicatorSize::Medium1Larger progress indicator useful for covering whole medium sized widgets.
Utils::ProgressIndicatorSize::Large2Very large progress indicator that can be used to cover large parts of a UI.

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

Function Documentation

void Utils::addToolTipsToMenu(QMenu *menu)

Adds tool tips to the menu that show the actions tool tip when hovering over an entry.

Utils::Q_DECL_IMPORT Utils::createItem(Layouting::LayoutItem *item, const int &aspect)

Adds the visual representation of this aspect to the layout with the specified parent using a layout builder.

QAction *Utils::execMenuAtWidget(QMenu *menu, QWidget *widget)

Opens menu at the specified widget position. This function computes the position where to show the menu, and opens it with QMenu::exec().

class QString Utils::qtcEnvironmentVariable(const class QString &key)

Returns the value of key in Qt Creator's modified system environment.

See also Utils::Environment::systemEnvironment and qEnvironmentVariable.

class QString Utils::qtcEnvironmentVariable(const class QString &key, const class QString &defaultValue)

Returns the value of key in Qt Creator's modified system environment if it is set, or otherwise defaultValue.

See also Utils::Environment::systemEnvironment and qEnvironmentVariable.

int Utils::qtcEnvironmentVariableIntValue(const class QString &key, bool *ok = nullptr)

Returns the value of key in Qt Creator's modified system environment, converted to an int. If ok is not null, sets *ok to true or false depending on the success of the conversion

See also Utils::Environment::systemEnvironment and qEnvironmentVariableIntValue.

bool Utils::qtcEnvironmentVariableIsEmpty(const class QString &key)

Returns if the environment variable key is not set or empty in Qt Creator's modified system environment.

See also Utils::Environment::systemEnvironment and qEnvironmentVariableIsEmpty.

bool Utils::qtcEnvironmentVariableIsSet(const class QString &key)

Returns if the environment variable key is set Qt Creator's modified system environment.

See also Utils::Environment::systemEnvironment and qEnvironmentVariableIsSet.