Utils Namespace
The Utils namespace contains a collection of utility classes and functions for use by all plugins. More...
Header: | #include <Utils> |
Namespaces
Classes
class | AnsiEscapeCodeHandler |
class | CheckableMessageBox |
class | CompletingTextEdit |
class | DetailsWidget |
class | FancyMainWindow |
class | FileNameValidatingLineEdit |
class | FileWizardPage |
class | FixedSizeClickLabel |
class | NavigationTreeView |
class | NetworkAccessManager |
class | OptionPushButton |
class | ParameterAction |
class | PathListEditor |
class | PersistentSettingsReader |
class | PersistentSettingsWriter |
class | ProcessHandle |
class | ProjectIntroPage |
class | QrcCache |
class | QrcParser |
class | StatusLabel |
class | TextFieldCheckBox |
class | TreeModel |
Types
flags | LanguageExtensions |
enum class | ProgressIndicatorSize { Small, Medium, Large } |
Functions
Utils::Q_DECL_IMPORT | createItem(Layouting::LayoutItem *item, const int &aspect) |
QAction * | execMenuAtWidget(QMenu *menu, QWidget *widget) |
Utils::Q_DECL_IMPORT | qtcEnvironmentVariableIntValue(const class QString &key, bool *ok = nullptr) |
Utils::Q_DECL_IMPORT | qtcEnvironmentVariableIsEmpty(const class QString &key) |
Utils::Q_DECL_IMPORT | qtcEnvironmentVariableIsSet(const class QString &key) |
Detailed Description
Namespaces
namespace Utils::Internal
Stores the internal value of this BaseAspect into the QVariantMap 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 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 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 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 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 QVariantMap of arbitrary, nested data structures to an XML file. More...
class ProcessHandle
The ProcessHandle class is a helper class to describe a process. 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 TreeModel
The TreeModel class is a convienience base class for models to use in a QTreeView. More...
Type Documentation
enum class Utils::ProgressIndicatorSize
Size of a progress indicator.
Constant | Value | Description |
---|---|---|
Utils::ProgressIndicatorSize::Small | 0 | Small icon size. Useful for tool bars, status bars, rows in tree views, and so on. |
Utils::ProgressIndicatorSize::Medium | 1 | Larger progress indicator useful for covering whole medium sized widgets. |
Utils::ProgressIndicatorSize::Large | 2 | Very large progress indicator that can be used to cover large parts of a UI. |
See also Utils::ProgressIndicator and Utils::ProgressIndicatorPainter.
Function Documentation
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().
Utils::Q_DECL_IMPORT 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.
Utils::Q_DECL_IMPORT 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.
Utils::Q_DECL_IMPORT 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.