Класс QFlags

Класс QFlags предоставляет безопасный способ хранения побитовых объединений значений перечисления. Подробнее...

• Список всех членов, включая унаследованные

Типы

Открытые функции

Макросы

Подробное описание

Класс QFlags предоставляет безопасный способ хранения побитовых объединений значений перечисления.

Класс QFlags<Enum> — это шаблонный класс, где Enum — тип перечисления. QFlags используется в Qt для хранения комбинаций значений перечисления.

Традиционный подход C++ для хранения побитовых объединений значений перечисления — использование int или uint переменной. Неудобство этого подхода в том, что тип проверки вообще отсутствует; любое значение перечисления может быть побитовым ИЛИ с любым другим значением перечисления и передано в функцию, принимающую int или uint.

Qt использует QFlags для обеспечения безопасности типов. Например, тип Qt::Alignment — это просто typedef для QFlags<Qt::AlignmentFlag>. QLabel::setAlignment() принимает параметр Qt::Alignment, что означает, что любая комбинация значений Qt::AlignmentFlag или 0 является допустимой:

label->setAlignment(Qt::AlignLeft | Qt::AlignTop);

Если вы попытаетесь передать значение из другого перечисления или просто целое число, отличное от 0, компилятор сообщит об ошибке. Если вам нужно преобразовать целые значения в флаги без типизированного способа, вы можете использовать явный конструктор QFlags как оператор преобразования.

Если вы хотите использовать QFlags для собственных типов перечисления, используйте Q_DECLARE_FLAGS() и Q_DECLARE_OPERATORS_FOR_FLAGS().

Пример:

class MyClass
{
public:
    enum Option {
        NoOptions = 0x0,
        ShowTabs = 0x1,
        ShowAll = 0x2,
        SqueezeBlank = 0x4
    };
    Q_DECLARE_FLAGS(Options, Option)
    ...
};

Q_DECLARE_OPERATORS_FOR_FLAGS(MyClass::Options)

Затем вы можете использовать тип MyClass::Options для хранения комбинаций значений MyClass::Option.

Флаги и система метаобъектов

Макрос Q_DECLARE_FLAGS() не делает флаги доступными системе метаобъектов, поэтому их нельзя использовать в Qt Script или редактировать в Qt Designer. Чтобы сделать флаги доступными для этих целей, необходимо использовать макрос Q_FLAG().

Q_FLAG(Options)

Конвенция именования

Разумная конвенция именования для типов перечисления и связанных типов QFlags заключается в использовании единственного имени для типа перечисления (например, Option) и множественного имени для типа QFlags (например, Options). Если для типа QFlags требуется единственное имя (например, Alignment), вы можете использовать Flag в качестве суффикса для типа перечисления (например, AlignmentFlag).

См. также QFlag.

Документация по типам членов

typedef QFlags::Int

Тип-синоним для целочисленного типа, используемого для хранения, а также неявного преобразования. Либо int , либо unsigned int, в зависимости от того, является ли базовый тип перечисления знаковым или беззнаковым.

Этот typedef был введен в Qt 5.0.

typedef QFlags::enum_type

Тип-синоним для шаблона типа Enum.

Документация по функциям членов

QFlags::QFlags(const QFlags &other)

Создает копию other.

QFlags::QFlags(Enum flag)

Создает объект QFlags, хранящий заданный флаг flag.

QFlags::QFlags(Zero zero = Q_NULLPTR)

Создает объект QFlags без установленных флагов. zero должно быть литеральным значением 0.

QFlags::QFlags(QFlag value)

Создает объект QFlags, инициализированный заданным целым значением value.

Тип QFlag — вспомогательный тип. Используя его вместо int, мы гарантируем, что произвольные значения перечисления не могут быть преобразованы в QFlags, в то время как нетипизированные значения перечисления (т.е. значения int ) могут.

QFlags::QFlags(std::initializer_list<Enum> flags)

Создает объект QFlags, инициализированный всеми flags, объединенными с помощью оператора побитового ИЛИ.

Эта функция была введена в Qt 5.4.

См. также operator|=() и operator|().

QFlags &QFlags::setFlag(Enum flag, bool on = true)

Устанавливает указанный флаг flag, если on — true, или сбрасывает его, если on — false. Возвращает ссылку на этот объект.

Эта функция была введена в Qt 5.7.

bool QFlags::testFlag(Enum flag) const

Возвращает true если флаг flag установлен, в противном случае false.

Эта функция была добавлена в Qt 4.2.

QFlags::operator Int() const

Возвращает значение, хранящееся в объекте QFlags, в виде целого числа.

См. также Int.

bool QFlags::operator!() const

Возвращает true если ни один флаг не установлен (т.е., если значение, хранящееся в объекте QFlags, равно 0); в противном случае возвращает false.

QFlags QFlags::operator&(int mask) const

Возвращает объект QFlags, содержащий результат побитовой операции AND над этим объектом и mask.

См. также operator&=(), operator|(), operator^() и operator~().

QFlags QFlags::operator&(uint mask) const

Это перегруженная функция.

QFlags QFlags::operator&(Enum mask) const

Это перегруженная функция.

QFlags &QFlags::operator&=(int mask)

Выполняет побитовую операцию AND с mask и сохраняет результат в этом объекте QFlags. Возвращает ссылку на этот объект.

См. также operator&(), operator|=() и operator^=().

QFlags &QFlags::operator&=(uint mask)

Это перегруженная функция.

QFlags &QFlags::operator&=(Enum mask)

Это перегруженная функция.

QFlags &QFlags::operator=(const QFlags &other)

Присваивает other этому объекту и возвращает ссылку на этот объект.

QFlags QFlags::operator^(QFlags other) const

Возвращает объект QFlags, содержащий результат побитовой операции XOR над этим объектом и other.

См. также operator^=(), operator&(), operator|() и operator~().

QFlags QFlags::operator^(Enum other) const

Это перегруженная функция.

QFlags &QFlags::operator^=(QFlags other)

Выполняет побитовую операцию XOR с other и сохраняет результат в этом объекте QFlags. Возвращает ссылку на этот объект.

См. также operator^(), operator&=() и operator|=().

QFlags &QFlags::operator^=(Enum other)

Это перегруженная функция.

QFlags QFlags::operator|(QFlags other) const

Возвращает объект QFlags, содержащий результат побитовой операции OR над этим объектом и other.

См. также operator|=(), operator^(), operator&() и operator~().

QFlags QFlags::operator|(Enum other) const

Это перегруженная функция.

QFlags &QFlags::operator|=(QFlags other)

Выполняет побитовую операцию OR с other и сохраняет результат в этом объекте QFlags. Возвращает ссылку на этот объект.

См. также operator|(), operator&=() и operator^=().

QFlags &QFlags::operator|=(Enum other)

Это перегруженная функция.

QFlags QFlags::operator~() const

Возвращает объект QFlags, содержащий побитовое отрицание этого объекта.

См. также operator&(), operator|() и operator^().

typedef QFlags<Enum> Flags;