Класс QKeySequence

Класс QKeySequence инкапсулирует последовательность нажатий клавиш, используемых для ярлыков. Подробнее...

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

Типы public

Функции public

Статические public члены

Связанные нечлены

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

В наиболее распространённом виде последовательность нажатий клавиш описывает комбинацию клавиш, которые необходимо использовать вместе для выполнения некоторого действия. Последовательности нажатий клавиш используются с объектами QAction для указания сочетаний клавиш, которые могут быть использованы для запуска действий.

Последовательности нажатий клавиш можно создавать для использования в качестве сочетаний клавиш тремя различными способами:

• Для стандартных сочетаний клавиш можно использовать стандартную клавишу, чтобы запросить платформозависимую последовательность нажатий клавиш, связанную с каждым ярлыком.
• Для пользовательских сочетаний клавиш можно использовать удобочитаемые строки, такие как "Ctrl+X", которые могут быть переведены в соответствующие сочетания клавиш для пользователей разных языков. Переводы выполняются в контексте "QShortcut".
• Для жёстко закодированных сочетаний клавиш можно указать целочисленные коды клавиш, комбинируя значения, определённые перечислениями Qt::Key и Qt::Modifier. Каждый код клавиши состоит из одного значения Qt::Key и нуля или более модификаторов, таких как Qt::SHIFT, Qt::CTRL, Qt::ALT и Qt::META.

Например, Ctrl P может быть последовательностью, используемой в качестве ярлыка для печати документа, и может быть указана любым из следующих способов:

QKeySequence(QKeySequence::Print);
QKeySequence(tr("Ctrl+P"));
QKeySequence(tr("Ctrl+p"));
QKeySequence(Qt::CTRL + Qt::Key_P);

Обратите внимание, что для букв регистр, используемый в строке спецификации, не имеет значения. В приведенных выше примерах пользователю не нужно удерживать клавишу Shift, чтобы активировать ярлык, указанный с помощью "Ctrl+P". Однако для других клавиш использование Shift в качестве неопределённого дополнительного модификатора может привести к путанице для пользователей приложения, у которых раскладки клавиатуры отличаются от тех, которые используются разработчиками. Дополнительные сведения см. в разделе Вопросы раскладки клавиатуры ниже.

Желательно использовать стандартные сочетания клавиш, когда это возможно. При создании последовательностей нажатий клавиш для нестандартных сочетаний клавиш следует предпочесть удобочитаемые строки жёстко закодированным целочисленным значениям.

Объекты QKeySequence можно привести к типу QString, чтобы получить удобочитаемую переведённую версию последовательности. Аналогично, функция toString() генерирует удобочитаемые строки для использования в меню. В macOS используются соответствующие символы для описания сочетаний клавиш, использующих специальные клавиши на клавиатуре Macintosh.

Альтернативный способ указания жёстко закодированных кодов клавиш — использование кода Юникода символа; например, 'A' даёт такую же последовательность нажатий клавиш, как и Qt::Key_A.

Примечание: В macOS ссылки на "Ctrl", Qt::CTRL, Qt::Key_Control и Qt::ControlModifier соответствуют клавишам Command на клавиатуре Macintosh, а ссылки на "Meta", Qt::META, Qt::Key_Meta и Qt::MetaModifier соответствуют клавишам Control. Разработчики в macOS могут использовать одни и те же описания ярлыков на всех платформах, и их приложения будут автоматически работать так, как ожидается, в macOS.

Стандартные ярлыки

QKeySequence определяет множество стандартных сочетаний клавиш, чтобы уменьшить усилия, необходимые при настройке действий в типичном приложении. Таблица ниже показывает некоторые распространенные сочетания клавиш, которые часто используются для этих стандартных сочетаний клавиш приложениями на четырёх широко используемых платформах. Обратите внимание, что на macOS значение Ctrl соответствует клавишам Command на клавиатуре Macintosh, а значение Meta соответствует клавишам Control.

Обратите внимание, что, поскольку последовательности клавиш, используемые для стандартных сочетаний клавиш, различаются между платформами, вам все равно необходимо протестировать свои сочетания клавиш на каждой платформе, чтобы убедиться, что вы не случайно назначили одну и ту же последовательность клавиш для многих действий.

Проблемы с раскладкой клавиатуры

Многие спецификации последовательностей клавиш выбираются разработчиками на основе раскладки определенных типов клавиатуры, а не выбора клавиш, представляющих первую букву имени действия, например, Ctrl S («Ctrl+S») или Ctrl C («Ctrl+C»). Кроме того, поскольку некоторые символы могут быть введены только с помощью клавиш модификаторов на определенных раскладках клавиатуры, последовательности клавиш, предназначенные для использования с одной раскладкой клавиатуры, могут отображаться на другой клавише, вообще не отображаться или потребовать использования дополнительной клавиши модификатора при использовании другой раскладки клавиатуры.

Например, сочетания клавиш Ctrl плюс и Ctrl минус часто используются в качестве сочетаний клавиш для операций масштабирования в графических приложениях, и они могут быть указаны соответственно как «Ctrl++» и «Ctrl+-». Однако способ указания и интерпретации этих сочетаний клавиш зависит от раскладки клавиатуры. Пользователи норвежских клавиатур заметят, что клавиши + и - не находятся рядом на клавиатуре, но все равно смогут активировать оба сочетания клавиш без необходимости нажатия клавиши Shift. Однако пользователям британских клавиатур потребуется удерживать клавишу Shift для ввода символа +, что делает сочетание клавиш фактически таким же, как «Ctrl+Shift+=".

Хотя некоторые разработчики могут прибегнуть к полному указанию всех модификаторов, используемых на их клавиатуре для активации сочетания клавиш, это также приведет к неожиданному поведению для пользователей с различными раскладками клавиатуры.

Например, разработчик, использующий британскую клавиатуру, может решить указать «Ctrl+Shift+» в качестве последовательности клавиш, чтобы создать сочетание клавиш, которое случайно ведет себя так же, как Ctrl плюс. Однако клавиша = должна быть доступна с помощью клавиши Shift на норвежской клавиатуре, что делает необходимое сочетание клавиш фактически Ctrl Shift Shift = (невозможное сочетание клавиш).

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

Несмотря на это, мы можем решить эту проблему, гарантируя, что используются удобочитаемые строки, что позволит осуществить перевод последовательностей клавиш для пользователей разных языков. Этот подход будет успешным для пользователей, чьи клавиатуры имеют наиболее типичную для их языка раскладку.

Сочетания клавиш в стиле GNU Emacs

Сочетания клавиш, аналогичные используемым в GNU Emacs, позволяющие использовать до четырех кодов клавиш, можно создавать, используя конструктор с несколькими аргументами или передавая удобочитаемую строку с запятыми последовательностей клавиш.

Например, последовательность клавиш Ctrl X, за которой следует Ctrl C, можно указать одним из следующих способов:

QKeySequence(tr("Ctrl+X, Ctrl+C"));
QKeySequence(Qt::CTRL + Qt::Key_X, Qt::CTRL + Qt::Key_C);

Предупреждение: экземпляр QApplication должен быть создан до создания QKeySequence; в противном случае ваше приложение может зависнуть.

См. также QShortcut.

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

перечисление QKeySequence::SequenceFormat

перечисление QKeySequence::SequenceMatch

перечисление QKeySequence::StandardKey

Это перечисление представляет стандартные сочетания клавиш. Они могут использоваться для назначения платформозависимых сочетаний клавиш действию QAction.

Обратите внимание, что сочетания клавиш зависят от платформы. Текущие привязанные сочетания клавиш можно запросить с помощью keyBindings().

Этот перечисление был введён или изменён в Qt 4.2.

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

QKeySequence::QKeySequence(QKeySequence::StandardKey key)

Создаёт объект QKeySequence для данного key. Результат будет зависеть от текущей платформы.

Полученный объект будет основан на первом элементе в списке привязок клавиш для key.

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

QKeySequence::QKeySequence(const QKeySequence &keysequence)

Конструктор копирования. Создаёт копию keysequence.

QKeySequence::QKeySequence(int k1, int k2 = 0, int k3 = 0, int k4 = 0)

Создаёт последовательность клавиш с максимум 4 клавишами k1, k2, k3 и k4.

Коды клавиш перечислены в Qt::Key и могут быть объединены с модификаторами (см. Qt::Modifier), такими как Qt::SHIFT, Qt::CTRL, Qt::ALT или Qt::META.

QKeySequence::QKeySequence(const QString &key, QKeySequence::SequenceFormat format = NativeText)

Создаёт последовательность клавиш из строки key, на основе format.

Например, "Ctrl+O" даёт CTRL+'O'. Строки "Ctrl", "Shift", "Alt" и "Meta" распознаются, а также их переведённые эквиваленты в контексте "QShortcut" (используя QObject::tr()).

Можно ввести до четырёх кодов клавиш, разделяя их запятыми, например, "Alt+X,Ctrl+S,Q".

Этот конструктор обычно используется с tr(), чтобы сочетания клавиш можно было заменить в переводах:

QMenu *file = new QMenu(this);
file->addAction(tr("&Open..."), this, SLOT(open()),
                  QKeySequence(tr("Ctrl+O", "File|Open")));

Обратите внимание на комментарий переводчика "Файл|Открыть". Он совершенно не обязателен, но предоставляет контекст для переводчика.

QKeySequence::QKeySequence()

Создаёт пустую последовательность клавиш.

QKeySequence &QKeySequence::operator=(QKeySequence &&other)

Перемещающее присваивание other этому экземпляру QKeySequence.

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

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

Оператор присваивания. Присваивает последовательность клавиш other этому объекту.

QKeySequence::~QKeySequence()

Уничтожает последовательность клавиш.

int QKeySequence::count() const

Возвращает количество клавиш в последовательности клавиш. Максимальное значение — 4.

[static] QKeySequence QKeySequence::fromString(const QString &str, QKeySequence::SequenceFormat format = PortableText)

Возвращает QKeySequence из строки str на основе format.

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

См. также toString().

bool QKeySequence::isEmpty() const

Возвращает true, если последовательность клавиш пустая; в противном случае возвращает false.

[static] QList<QKeySequence> QKeySequence::keyBindings(QKeySequence::StandardKey key)

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

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

[static] QList<QKeySequence> QKeySequence::listFromString(const QString &str, QKeySequence::SequenceFormat format = PortableText)

Возвращает список QKeySequence из строки str, основанный на format.

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

См. также fromString() и listToString().

[static] QString QKeySequence::listToString(const QList<QKeySequence> &list, QKeySequence::SequenceFormat format = PortableText)

Возвращает строковое представление list на основе format.

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

См. также toString() и listFromString().

QKeySequence::SequenceMatch QKeySequence::matches(const QKeySequence &seq) const

Сопоставляет последовательность с seq. Возвращает ExactMatch, если успешно; PartialMatch, если seq частично совпадает, и NoMatch, если у последовательностей нет ничего общего. Возвращает NoMatch, если seq короче.

[static] QKeySequence QKeySequence::mnemonic(const QString &text)

Возвращает сочетание клавиш для мнемоники в text или пустую последовательность клавиш, если мнемоники не найдены.

Например, mnemonic("E&xit") возвращает Qt::ALT+Qt::Key_X, mnemonic("&Quit") возвращает ALT+Key_Q, а mnemonic("Quit") возвращает пустой QKeySequence.

Мы предоставляем список общих мнемоник на английском языке. На момент написания этой документации Microsoft и Open Group, по-видимому, не опубликовали эквивалентных рекомендаций для других языков.

void QKeySequence::swap(QKeySequence &other)

Меняет местами последовательность клавиш other с текущей последовательностью клавиш. Эта операция очень быстрая и никогда не терпит неудачу.

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

QString QKeySequence::toString(QKeySequence::SequenceFormat format = PortableText) const

Возвращает строковое представление последовательности клавиш на основе format.

Например, значение Qt::CTRL+Qt::Key_O приводит к "Ctrl+O". Если последовательность клавиш содержит несколько кодов клавиш, каждый из них разделяется запятыми в возвращаемой строке, например, "Alt+X, Ctrl+Y, Z". Строки "Ctrl", "Shift" и т. д. переводятся с помощью QObject::tr() в контексте "QShortcut".

Если последовательность клавиш не содержит клавиш, возвращается пустая строка.

В macOS возвращаемая строка напоминает последовательность, отображаемую в строке меню, если format — QKeySequence::NativeText; в противном случае строка использует "портативный" формат, подходящий для записи в файл.

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

См. также fromString().

QVariant QKeySequence::operator QVariant() const

Возвращает последовательность клавиш как QVariant.

bool QKeySequence::operator!=(const QKeySequence &other) const

Возвращает true, если эта последовательность клавиш не равна последовательности клавиш other; в противном случае возвращает false.

bool QKeySequence::operator<(const QKeySequence &other) const

Обеспечивает произвольное сравнение этой последовательности клавиш и последовательности клавиш other. Гарантируется только то, что оператор возвращает true, если обе последовательности клавиш равны, и что (ks1 < ks2) == !( ks2 < ks1), если последовательности клавиш не равны.

Эта функция полезна в некоторых случаях, например, если вы хотите использовать объекты QKeySequence в качестве ключей в QMap.

См. также operator==(), operator!=(), operator>(), operator<=() и operator>=().

bool QKeySequence::operator<=(const QKeySequence &other) const

Возвращает true , если эта последовательность ключей меньше или равна последовательности ключей other; в противном случае возвращает false.

См. также operator==(), operator!=(), operator<(), operator>() и operator>=().

bool QKeySequence::operator==(const QKeySequence &other) const

Возвращает true , если эта последовательность ключей равна последовательности ключей other; в противном случае возвращает false.

bool QKeySequence::operator>(const QKeySequence &other) const

Возвращает true , если эта последовательность ключей больше, чем последовательность ключей other; в противном случае возвращает false.

См. также operator==(), operator!=(), operator<(), operator<=() и operator>=().

bool QKeySequence::operator>=(const QKeySequence &other) const

Возвращает true , если эта последовательность ключей больше или равна последовательности ключей other; в противном случае возвращает false.

См. также operator==(), operator!=(), operator<(), operator>() и operator<=().

int QKeySequence::operator[](uint index) const

Возвращает ссылку на элемент в позиции index в последовательности ключей. Это можно использовать только для чтения элемента.