Win32 API 日本語リファレンス
ホームUI.TextServices › TS_STATUS

TS_STATUS

構造体
サイズx64: 8 バイト / x86: 8 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
dwDynamicFlagsDWORD4+0+0

アプリが実行時に変更できるフラグのセットが格納されます。たとえば、ユーザーがドキュメントの状態をリセットするためのチェックボックスを、アプリが有効にすることができます。このメンバーには、0、または次の値のうち 1 つ以上を指定できます。

意味
TS_SD_LOADING ドキュメントは読み込み中です。
TS_SD_READONLY ドキュメントは読み取り専用です。
dwStaticFlagsDWORD4+4+4

実行時に変更できないフラグのセットが格納されます。このメンバーには、0、または次の値のうち 1 つ以上を指定できます。

意味
TS_SS_DISJOINTSEL ドキュメントは複数選択をサポートします。
TS_SS_REGIONS ドキュメントは複数の領域を含むことができます。
TS_SS_TRANSITORY ドキュメントは使用サイクルが短いことが想定されます。
TS_SS_NOHIDDENTEXT ドキュメントに隠しテキストが含まれることはありません。
TS_SS_TKBAUTOCORRECTENABLE Windows 8 以降: ドキュメントは、タッチキーボードが提供する自動修正をサポートします。
TS_SS_TKBPREDICTIONENABLE Windows 8 以降: ドキュメントは、タッチキーボードが提供するテキスト候補をサポートします。

公式ドキュメント

TS_STATUS 構造体には、ドキュメントの状態データが格納されます。

解説(Remarks)

TF_STATUS 構造体には、ドキュメントの状態データが格納されます。

TF_STATUSTS_STATUS のエイリアスです。

dwDynamicFlags には、アプリが実行時に変更できるフラグのセットが格納されます。たとえば、ユーザーがドキュメントの状態をリセットするためのチェックボックスを、アプリが有効にすることができます。このメンバーには、0、または次の値のうち 1 つ以上を指定できます。

意味
TF_SD_LOADING ドキュメントは読み込み中です。
TF_SD_READONLY ドキュメントは読み取り専用です。
TS_SD_INPUTPANEMANUALDISPLAYENABLE コントロールがタッチされても、システムはタッチキーボードの自動表示を試みません。代わりに、アプリが適切なタイミングで TryShow(CoreInputViewKind) を呼び出してキーボードを表示します (アプリは入力を監視して CoreInputViewKind を選択する必要があります)。
TS_SD_UIINTEGRATIONENABLE Windows 8.1 以降: ドキュメントを所有するテキストコントロールは、Input Method Editor (IME) の UI 統合をサポートしていることを示すためにこのフラグを設定します。指定された場合、IME はカーソル付近に候補ウィンドウを浮動表示するのではなく、テキストボックスの下に配置しようとします。
注: すべての IME がこのフラグに応答するわけではありません。IME の候補一覧は、基本的なテキスト入力が行えるだけの十分なサイズで画面上に配置されます。場合によっては、IME が妥当な最小サイズを強制することがあります。また IME は、より良いユーザー体験を提供するために、候補ウィンドウやキーボード入力の動作を調整することもあります。たとえば、水平方向の候補一覧を使用したり、候補一覧のナビゲーションなどのシナリオのために上矢印キーや下矢印キーなどの一部のキーをアプリへ送信できるようにしたりします。
TF_SD_TKBAUTOCORRECTENABLE Windows 8.1 以降: ドキュメントは、タッチキーボードが提供する自動修正をサポートします。このサポートは、コントロールの有効期間中に変化する可能性があります。
TF_SD_TKBPREDICTIONENABLE Windows 8.1 以降: ドキュメントは、タッチキーボードが提供するテキスト候補をサポートします。このサポートは、コントロールの有効期間中に変化する可能性があります。

dwStaticFlags には、実行時に変更できないフラグのセットが格納されます。このメンバーには、0、または次の値のうち 1 つ以上を指定できます。

意味
TF_SS_DISJOINTSEL ドキュメントは複数選択をサポートします。
TF_SS_REGIONS ドキュメントは複数の領域を含むことができます。
TF_SS_TRANSITORY ドキュメントは使用サイクルが短いことが想定されます。
TF_SS_TKBAUTOCORRECTENABLE Windows 8 以降: ドキュメントは、タッチキーボードが提供する自動修正をサポートします。
TF_SS_TKBPREDICTIONENABLE Windows 8 以降: ドキュメントは、タッチキーボードが提供するテキスト候補をサポートします。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での定義

#include <windows.h>

// TS_STATUS  (x64 8 / x86 8 バイト)
typedef struct TS_STATUS {
    DWORD dwDynamicFlags;
    DWORD dwStaticFlags;
} TS_STATUS;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct TS_STATUS
{
    public uint dwDynamicFlags;
    public uint dwStaticFlags;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure TS_STATUS
    Public dwDynamicFlags As UInteger
    Public dwStaticFlags As UInteger
End Structure
import ctypes
from ctypes import wintypes

class TS_STATUS(ctypes.Structure):
    _fields_ = [
        ("dwDynamicFlags", wintypes.DWORD),
        ("dwStaticFlags", wintypes.DWORD),
    ]
#[repr(C)]
pub struct TS_STATUS {
    pub dwDynamicFlags: u32,
    pub dwStaticFlags: u32,
}
import "golang.org/x/sys/windows"

type TS_STATUS struct {
	dwDynamicFlags uint32
	dwStaticFlags uint32
}
type
  TS_STATUS = record
    dwDynamicFlags: DWORD;
    dwStaticFlags: DWORD;
  end;
const TS_STATUS = extern struct {
    dwDynamicFlags: u32,
    dwStaticFlags: u32,
};
type
  TS_STATUS {.bycopy.} = object
    dwDynamicFlags: uint32
    dwStaticFlags: uint32
struct TS_STATUS
{
    uint dwDynamicFlags;
    uint dwStaticFlags;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; TS_STATUS サイズ: 8 バイト(x64)
dim st, 2    ; 4byte整数×2(構造体サイズ 8 / 4 切り上げ)
; dwDynamicFlags : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwStaticFlags : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global TS_STATUS
    #field int dwDynamicFlags
    #field int dwStaticFlags
#endstruct

stdim st, TS_STATUS        ; NSTRUCT 変数を確保
st->dwDynamicFlags = 100
mes "dwDynamicFlags=" + st->dwDynamicFlags