QVirtualKeyboardTrace Class
Traceはタッチ入力データのデータモデルです。詳細...
Header: | #include <QVirtualKeyboardTrace> |
CMake: | find_package(Qt6 REQUIRED COMPONENTS VirtualKeyboard) target_link_libraries(mytarget PRIVATE Qt6::VirtualKeyboard) |
qmake: | QT += virtualkeyboard |
Since: | QtQuick.VirtualKeyboard 2.0 |
In QML: | Trace |
Inherits: | QObject |
プロパティ
パブリック関数
int | addPoint(const QPointF &point) |
QVariantList | channelData(const QString &channel, int pos = 0, int count = -1) const |
QStringList | channels() const |
bool | isCanceled() const |
bool | isFinal() const |
int | length() const |
qreal | opacity() const |
QVariantList | points(int pos = 0, int count = -1) const |
void | setCanceled(bool canceled) |
void | setChannelData(const QString &channel, int index, const QVariant &data) |
void | setChannels(const QStringList &channels) |
void | setFinal(bool final) |
void | setOpacity(qreal opacity) |
void | setTraceId(int id) |
(since QtQuick.VirtualKeyboard.Styles 6.1) void | startHideTimer(int delayMs) |
int | traceId() const |
シグナル
void | canceledChanged(bool isCanceled) |
void | channelsChanged() |
void | finalChanged(bool isFinal) |
void | lengthChanged(int length) |
void | opacityChanged(qreal opacity) |
void | traceIdChanged(int traceId) |
詳細説明
トレースは、1つのストロークに関連する座標データおよびその他のオプションデータのデータモデルを提供します。
トレースオブジェクトの典型的な使用例は次のとおりです:
- TraceInputArea または他の入力デバイスが () メソッドを呼び出してトレースイベントを開始します。InputEngine.traceBegin
- 現在の入力メソッドがイベントを受け入れると、トレースオブジェクトが作成され、必要なデータチャネルが設定されます。
- TraceInputArea トレース・オブジェクトのデータを収集する。
- TraceInputArea InputEngine.traceEnd() メソッドを呼び出してトレースを終了し、トレースオブジェクトを入力メソッドに渡す。
- input メソッドはデータを処理し、不要になったらオブジェクトを破棄する。
座標データはpoints() 関数を使用して取得される。
座標ベースのデータに加えて、各データ・ポイントに任意のデータ・チャンネルを付加することも可能です。
データ・チャネルは、点を追加する前に定義しておく必要があります。TraceInputArea がサポートするデータ・チャネルを以下に示す:
"t"
各データポイントの時間を収集する。時間は 1970/01/01 からのミリ秒数:
例えば、各ポイントの時間を収集するようにオブジェクトを構成します:
QVirtualKeyboardTrace *trace = new QVirtualKeyboardTrace(this); trace->setChannels(QStringList() << "t");
収集されたデータは、channelData() 関数を使用してアクセスできます:
QVariantList timeData = trace->channelData("t");
QVirtualKeyboardTrace オブジェクトはその作成者(通常の場合は入力メソッド)によって所有されます。つまり、オブジェクトはInputMethod.traceBegin() (QML) メソッドで構築されます。
この定義により、トレースオブジェクトはInputMethod.traceEnd() (QML) メソッド内でいつでも破棄することができます。
プロパティ Documentation
canceled : bool
は、QVirtualKeyboardTrace がキャンセルされるかどうかを定義します。
canceled
プロパティが true に設定されたトレースからは、入力データを処理してはいけません。
アクセス関数
bool | isCanceled() const |
void | setCanceled(bool canceled) |
Notifier シグナル:
void | canceledChanged(bool isCanceled) |
channels : QStringList
QQTrace 内のデータチャンネルのリスト。
このプロパティは、データを追加する前に初期化する必要があります。
アクセス関数:
QStringList | channels() const |
void | setChannels(const QStringList &channels) |
ノーティファイア・シグナル:
void | channelsChanged() |
final : bool
QVirtualKeyboardTrace がそれ以上のデータを受け入れることができるかどうかを定義します。値がtrue
の場合、それ以上のデータは受け付けられません。
アクセス関数:
bool | isFinal() const |
void | setFinal(bool final) |
このプロパティは、 のポイント数を保持する:
void | finalChanged(bool isFinal) |
[read-only]
length : const int
このプロパティは、QVirtualKeyboardTrace のポイント数を保持する。
アクセス関数:
int | length() const |
ノーティファイアシグナル:
void | lengthChanged(int length) |
opacity : qreal
このプロパティは、QVirtualKeyboardTrace の不透明度を定義する。
値が小さいほど、より透明なトレースになります。0.0
は完全に透明で、1.0
は完全に不透明です。
このプロパティは、新しいトレースが追加されたときに、古いトレースをより透明にするのに便利です。
アクセス関数:
qreal | opacity() const |
void | setOpacity(qreal opacity) |
Notifier シグナル:
void | opacityChanged(qreal opacity) |
traceId : int
このQVirtualKeyboardTrace のユニークID。
アクセス関数:
int | traceId() const |
void | setTraceId(int id) |
ノーティファイアシグナル:
void | traceIdChanged(int traceId) |
メンバー関数ドキュメント
[invokable]
int QVirtualKeyboardTrace::addPoint(const QPointF &point)
QVirtualKeyboardTrace にpoint を追加する。
このメソッドは、追加された点のインデックスを返し、点を追加できない(つまり、final が真)場合は -1 を返します。
注意 :返されたインデックスは、setChannelData ()メソッドを使用して、追加データを点に関連付けるために必要です。
注意 :この関数はメタオブジェクトシステムやQMLから呼び出すことができます。Q_INVOKABLE を参照してください。
[invokable]
QVariantList QVirtualKeyboardTrace::channelData(const QString &channel, int pos = 0, int count = -1) const
指定されたchannel からデータを返します。他のパラメータが与えられていない場合、このメソッドはすべてのデータを返します。
pos パラメータが与えられると、メソッドはその位置から始まるデータを返します。count パラメータは、返される項目の数を制限します。
注意: この関数はメタオブジェクトシステムやQMLから呼び出すことができます。Q_INVOKABLE を参照してください。
setChannelData()も参照してください 。
[invokable]
QVariantList QVirtualKeyboardTrace::points(int pos = 0, int count = -1) const
点のリストを返します。パラメータが与えられていない場合、このメソッドはすべてのデータを返します。
pos パラメータが与えられると、メソッドはその位置から始まる点を返します。count パラメータは、返される点の数を制限します。
返されるリストには、QPointF 型が含まれます。
注意: この関数はメタオブジェクトシステムやQMLから呼び出すことができます。Q_INVOKABLE を参照してください。
[invokable]
void QVirtualKeyboardTrace::setChannelData(const QString &channel, int index, const QVariant &data)
与えられたデータchannel のindex の点のdata を設定します。
各データポイントに対してこのメソッドを呼び出さない場合、チャンネルデータは空の値でパディングされます。ただし、任意のインデックスでデータを追加することはできません。つまり、点データと同期して追加する必要があります。
注意: この関数はメタオブジェクトシステムやQMLから呼び出すことができます。Q_INVOKABLE を参照してください。
channelData()も参照してください 。
[invokable, since QtQuick.VirtualKeyboard.Styles 6.1]
void QVirtualKeyboardTrace::startHideTimer(int delayMs)
delayMs の後、不透明度をゼロにするタイマーを開始します。delayMs 内で再度呼び出されると、タイマーは再スタートします。
この関数を使用すると、トレースが処理されたことを示すために、トレースオブジェクトを破棄する前に、入力メソッドはスクリーンからトレースを隠すことができます。
注意: この関数は、メタオブジェクトシステムや QML から呼び出すことができます。Q_INVOKABLE を参照してください。
この関数は、QtQuick.VirtualKeyboard.Styles 6.1 で導入されました。
このドキュメントは、QtQuick.VirtualKeyboard.Styles 6.1で導入されました。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。