include/msctf.idl

   1 /*
   2  * Copyright 2008 Aric Stewart, CodeWeavers
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 #ifndef DO_NO_IMPORTS
  20 import "oaidl.idl";
  21 import "comcat.idl";
  22 import "textstor.idl";
  23 import "ctfutb.idl";
  24 #endif
  25 cpp_quote("#include <winuser.h>")
  26
  27 cpp_quote("#define TF_E_STACKFULL MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, 0x0501)")
  28 cpp_quote("#define TF_E_DISCONNECTED    MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, 0x0504)")
  29 cpp_quote("#define TF_E_ALREADY_EXISTS  MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, 0x0506)")
  30 cpp_quote("#define TF_E_NOLOCK          MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, 0x0201)")
  31
  32 cpp_quote("HRESULT WINAPI TF_CreateThreadMgr(ITfThreadMgr **pptim);")
  33 cpp_quote("HRESULT WINAPI TF_GetThreadMgr(ITfThreadMgr **pptim);")
  34 cpp_quote("HRESULT WINAPI TF_CreateInputProcessorProfiles(ITfInputProcessorProfiles **ppipr);")
  35 cpp_quote("HRESULT WINAPI TF_CreateLangBarMgr(ITfLangBarMgr **pppbm);")
  36 cpp_quote("HRESULT WINAPI TF_CreateLangBarItemMgr(ITfLangBarItemMgr **pplbim);")
  37 cpp_quote("HRESULT WINAPI TF_InvalidAssemblyListCacheIfExist(void);")
  38
  39 cpp_quote("EXTERN_C const GUID GUID_PROP_TEXTOWNER;")
  40 cpp_quote("DEFINE_GUID(GUID_PROP_ATTRIBUTE,0x34b45670,0x7526,0x11d2,0xa1,0x47,0x00,0x10,0x5a,0x27,0x99,0xb5);")
  41 cpp_quote("EXTERN_C const GUID GUID_PROP_LANGID;")
  42 cpp_quote("EXTERN_C const GUID GUID_PROP_READING;")
  43 cpp_quote("EXTERN_C const GUID GUID_PROP_COMPOSING;")
  44
  45 cpp_quote("EXTERN_C const CLSID CLSID_TF_ThreadMgr;")
  46 cpp_quote("EXTERN_C const CLSID CLSID_TF_InputProcessorProfiles;")
  47 cpp_quote("EXTERN_C const CLSID CLSID_TF_LangBarMgr;")
  48 cpp_quote("EXTERN_C const CLSID CLSID_TF_CategoryMgr;")
  49 cpp_quote("EXTERN_C const CLSID CLSID_TF_DisplayAttributeMgr;")
  50
  51 /* GUIDs for Compartments */
  52 cpp_quote("EXTERN_C const GUID GUID_COMPARTMENT_KEYBOARD_DISABLED;")
  53 cpp_quote("EXTERN_C const GUID GUID_COMPARTMENT_KEYBOARD_OPENCLOSE;")
  54 cpp_quote("EXTERN_C const GUID GUID_COMPARTMENT_HANDWRITING_OPENCLOSE;")
  55 cpp_quote("EXTERN_C const GUID GUID_COMPARTMENT_SPEECH_DISABLED;")
  56 cpp_quote("EXTERN_C const GUID GUID_COMPARTMENT_SPEECH_OPENCLOSE;")
  57 cpp_quote("EXTERN_C const GUID GUID_COMPARTMENT_SPEECH_GLOBALSTATE;")
  58 cpp_quote("EXTERN_C const GUID GUID_COMPARTMENT_PERSISTMENUENABLED;")
  59 cpp_quote("EXTERN_C const GUID GUID_COMPARTMENT_EMPTYCONTEXT;")
  60 cpp_quote("EXTERN_C const GUID GUID_COMPARTMENT_TIPUISTATUS;")
  61
  62 /* GUIDs for Categories */
  63 cpp_quote("EXTERN_C const GUID GUID_TFCAT_TIP_KEYBOARD;")
  64 cpp_quote("EXTERN_C const GUID GUID_TFCAT_TIP_SPEECH;")
  65 cpp_quote("EXTERN_C const GUID GUID_TFCAT_TIP_HANDWRITING;")
  66 cpp_quote("EXTERN_C const GUID GUID_TFCAT_DISPLAYATTRIBUTEPROVIDER;")
  67
  68 typedef [uuid(7213778c-7bb0-4270-b050-6189ee594e97)]  DWORD TfEditCookie;
  69 typedef [uuid(de403c21-89fd-4f85-8b87-64584d063fbc)] DWORD TfClientId;
  70 typedef [uuid(88a9c478-f3ec-4763-8345-cd9250443f8d)] DWORD TfGuidAtom;
  71
  72 cpp_quote("#define TF_MOD_ALT                   0x0001")
  73 cpp_quote("#define TF_MOD_CONTROL               0x0002")
  74 cpp_quote("#define TF_MOD_SHIFT                 0x0004")
  75 cpp_quote("#define TF_MOD_RALT                  0x0008")
  76 cpp_quote("#define TF_MOD_RCONTROL              0x0010")
  77 cpp_quote("#define TF_MOD_RSHIFT                0x0020")
  78 cpp_quote("#define TF_MOD_LALT                  0x0040")
  79 cpp_quote("#define TF_MOD_LCONTROL              0x0080")
  80 cpp_quote("#define TF_MOD_LSHIFT                0x0100")
  81 cpp_quote("#define TF_MOD_ON_KEYUP              0x0200")
  82 cpp_quote("#define TF_MOD_IGNORE_ALL_MODIFIER   0x0400")
  83
  84 cpp_quote("#define TF_PROFILETYPE_INPUTPROCESSOR  0x0001")
  85 cpp_quote("#define TF_PROFILETYPE_KEYBOARDLAYOUT  0x0002")
  86
  87 cpp_quote("#define TF_IPSINK_FLAG_ACTIVE 0x0001")
  88
  89 interface ITfDocumentMgr;
  90 interface ITfContext;
  91 interface IEnumTfDocumentMgrs;
  92 interface IEnumTfContexts;
  93 interface ITfFunctionProvider;
  94 interface IEnumTfFunctionProviders;
  95 interface ITfCompartmentMgr;
  96 interface ITfEditSession;
  97 interface ITfRange;
  98 interface ITfContextView;
  99 interface IEnumTfContextViews;
 100 interface ITfProperty;
 101 interface ITfReadOnlyProperty;
 102 interface IEnumTfProperties;
 103 interface ITfRangeBackup;
 104 interface IEnumTfLanguageProfiles;
 105 interface ITfEditRecord;
 106 interface ITfCompositionView;
 107 interface ITfKeyEventSink;
 108
 109 cpp_quote("#if 0")
 110 typedef [uuid(4f5d560f-5ab5-4dde-8c4d-404592857ab0)] UINT_PTR HKL;
 111 cpp_quote("#endif")
 112
 113 typedef [uuid(e26d9e1d-691e-4f29-90d7-338dcf1f8cef)] struct TF_PERSISTENT_PROPERTY_HEADER_ACP
 114 {
 115     GUID guidType;
 116     LONG ichStart;
 117     LONG cch;
 118     ULONG cb;
 119     DWORD dwPrivate;
 120     CLSID clsidTIP;
 121 } TF_PERSISTENT_PROPERTY_HEADER_ACP;
 122
 123 typedef [uuid(e1b5808d-1e46-4c19-84dc-68c5f5978cc8)] struct TF_LANGUAGEPROFILE
 124 {
 125     CLSID clsid;
 126     LANGID langid;
 127     GUID catid;
 128     BOOL fActive;
 129     GUID guidProfile;
 130 } TF_LANGUAGEPROFILE;
 131
 132 typedef [uuid(77c12f95-b783-450d-879f-1cd2362c6521)] struct TF_PRESERVEDKEY
 133 {
 134     UINT uVKey;
 135     UINT uModifiers;
 136 } TF_PRESERVEDKEY;
 137
 138 typedef [uuid(5a886226-ae9a-489b-b991-2b1e25ee59a9)]  enum { TF_ANCHOR_START = 0, TF_ANCHOR_END = 1 } TfAnchor;
 139
 140 [
 141     object,
 142     uuid(aa80e801-2021-11d2-93e0-0060b067b86e),
 143     pointer_default(unique)
 144 ]
 145 interface ITfThreadMgr: IUnknown
 146 {
 147     HRESULT Activate(
 148         [out] TfClientId *ptid);
 149
 150     HRESULT Deactivate();
 151
 152     HRESULT CreateDocumentMgr(
 153         [out] ITfDocumentMgr **ppdim);
 154
 155     HRESULT EnumDocumentMgrs(
 156         [out] IEnumTfDocumentMgrs **ppEnum);
 157
 158     HRESULT GetFocus(
 159         [out] ITfDocumentMgr **ppdimFocus);
 160
 161     HRESULT SetFocus(
 162         [in] ITfDocumentMgr *pdimFocus);
 163
 164     HRESULT AssociateFocus(
 165         [in] HWND hwnd,
 166         [in, unique] ITfDocumentMgr *pdimNew,
 167         [out] ITfDocumentMgr **ppdimPrev);
 168
 169     HRESULT IsThreadFocus(
 170         [out] BOOL *pfThreadFocus);
 171
 172     HRESULT GetFunctionProvider(
 173         [in] REFCLSID clsid,
 174         [out] ITfFunctionProvider **ppFuncProv);
 175
 176     HRESULT EnumFunctionProviders(
 177         [out] IEnumTfFunctionProviders **ppEnum);
 178
 179     HRESULT GetGlobalCompartment(
 180         [out] ITfCompartmentMgr **ppCompMgr);
 181 };
 182
 183 [
 184     object,
 185     uuid(d7540241-f9a1-4364-befc-dbcd2c4395b7),
 186     pointer_default(unique)
 187 ]
 188 interface ITfCompositionView : IUnknown
 189 {
 190     HRESULT GetOwnerClsid([out] CLSID *pclsid);
 191
 192     HRESULT GetRange([out] ITfRange **ppRange);
 193 }
 194
 195 [
 196     object,
 197     uuid(aa80e7f4-2021-11d2-93e0-0060b067b86e),
 198     pointer_default(unique)
 199 ]
 200 interface ITfDocumentMgr: IUnknown
 201 {
 202     HRESULT CreateContext(
 203         [in] TfClientId tidOwner,
 204         [in] DWORD dwFlags,
 205         [in, unique] IUnknown *punk,
 206         [out] ITfContext **ppic,
 207         [out] TfEditCookie *pecTextStore);
 208
 209     HRESULT Push(
 210         [in] ITfContext *pic);
 211
 212     const DWORD TF_POPF_ALL = 0x0001;
 213
 214     HRESULT Pop(
 215         [in] DWORD dwFlags);
 216
 217     HRESULT GetTop(
 218         [out] ITfContext **ppic);
 219
 220     HRESULT GetBase(
 221         [out] ITfContext **ppic);
 222
 223     HRESULT EnumContexts(
 224         [out] IEnumTfContexts **ppEnum);
 225 };
 226
 227 [
 228     object,
 229     uuid(aa80e7fd-2021-11d2-93e0-0060b067b86e),
 230     pointer_default(unique)
 231 ]
 232 interface ITfContext : IUnknown
 233 {
 234     const DWORD TF_ES_ASYNCDONTCARE = 0x0;
 235     const DWORD TF_ES_SYNC          = 0x1;
 236     const DWORD TF_ES_READ          = 0x2;
 237     const DWORD TF_ES_READWRITE     = 0x6;
 238     const DWORD TF_ES_ASYNC         = 0x8;
 239
 240     HRESULT RequestEditSession(
 241         [in] TfClientId tid,
 242         [in] ITfEditSession *pes,
 243         [in] DWORD dwFlags,
 244         [out] HRESULT *phrSession);
 245
 246     HRESULT InWriteSession(
 247         [in] TfClientId tid,
 248         [out] BOOL *pfWriteSession);
 249
 250     typedef [uuid(1690be9b-d3e9-49f6-8d8b-51b905af4c43)] enum { TF_AE_NONE, TF_AE_START, TF_AE_END } TfActiveSelEnd;
 251
 252     typedef [uuid(36ae42a4-6989-4bdc-b48a-6137b7bf2e42)] struct TF_SELECTIONSTYLE
 253     {
 254         TfActiveSelEnd ase;
 255         BOOL fInterimChar;
 256     } TF_SELECTIONSTYLE;
 257
 258     typedef [uuid(75eb22f2-b0bf-46a8-8006-975a3b6efcf1)] struct TF_SELECTION
 259     {
 260         ITfRange *range;
 261         TF_SELECTIONSTYLE style;
 262     } TF_SELECTION;
 263
 264     const ULONG TF_DEFAULT_SELECTION =  TS_DEFAULT_SELECTION;
 265
 266     HRESULT GetSelection(
 267         [in] TfEditCookie ec,
 268         [in] ULONG ulIndex,
 269         [in] ULONG ulCount,
 270         [out, size_is(ulCount), length_is(*pcFetched)] TF_SELECTION *pSelection,
 271         [out] ULONG *pcFetched);
 272
 273     HRESULT SetSelection(
 274         [in] TfEditCookie ec,
 275         [in] ULONG ulCount,
 276         [in, size_is(ulCount)] const TF_SELECTION *pSelection);
 277
 278     HRESULT GetStart(
 279         [in] TfEditCookie ec,
 280         [out] ITfRange **ppStart);
 281
 282     HRESULT GetEnd(
 283         [in] TfEditCookie ec,
 284         [out] ITfRange **ppEnd);
 285
 286     typedef [uuid(bc7d979a-846a-444d-afef-0a9bfa82b961)] TS_STATUS TF_STATUS;
 287     const DWORD TF_SD_READONLY    = TS_SD_READONLY;
 288     const DWORD TF_SD_LOADING     = TS_SD_LOADING;
 289     const DWORD TF_SS_DISJOINTSEL = TS_SS_DISJOINTSEL;
 290     const DWORD TF_SS_REGIONS     = TS_SS_REGIONS;
 291     const DWORD TF_SS_TRANSITORY  = TS_SS_TRANSITORY;
 292
 293
 294     HRESULT GetActiveView(
 295         [out] ITfContextView **ppView);
 296
 297     HRESULT EnumViews(
 298         [out] IEnumTfContextViews **ppEnum);
 299
 300     HRESULT GetStatus(
 301         [out] TF_STATUS *pdcs);
 302
 303     HRESULT GetProperty(
 304         [in] REFGUID guidProp,
 305         [out] ITfProperty **ppProp);
 306
 307     HRESULT GetAppProperty(
 308         [in] REFGUID guidProp,
 309         [out] ITfReadOnlyProperty **ppProp);
 310
 311     HRESULT TrackProperties(
 312         [in, size_is(cProp)] const GUID **prgProp,
 313         [in] ULONG cProp,
 314         [in, size_is(cAppProp)] const GUID **prgAppProp,
 315         [in] ULONG cAppProp,
 316         [out] ITfReadOnlyProperty **ppProperty);
 317
 318     HRESULT EnumProperties(
 319         [out] IEnumTfProperties **ppEnum);
 320
 321     HRESULT GetDocumentMgr(
 322         [out] ITfDocumentMgr **ppDm);
 323
 324     HRESULT CreateRangeBackup(
 325         [in] TfEditCookie ec,
 326         [in] ITfRange *pRange,
 327         [out] ITfRangeBackup **ppBackup);
 328
 329 };
 330
 331 const DWORD TF_INVALID_COOKIE = 0xffffffff;
 332
 333 [
 334   object,
 335   uuid(4ea48a35-60ae-446f-8fd6-e6a8d82459f7),
 336   pointer_default(unique)
 337 ]
 338 interface ITfSource : IUnknown
 339 {
 340     HRESULT AdviseSink(
 341         [in] REFIID riid,
 342         [in, iid_is(riid)] IUnknown *punk,
 343         [out] DWORD *pdwCookie);
 344
 345     HRESULT UnadviseSink(
 346         [in] DWORD dwCookie);
 347 };
 348
 349 [
 350   object,
 351   local,
 352   uuid(1F02B6C5-7842-4EE6-8A0B-9A24183A95CA),
 353   pointer_default(unique)
 354 ]
 355 interface ITfInputProcessorProfiles : IUnknown
 356 {
 357     HRESULT Register(
 358         [in] REFCLSID rclsid);
 359
 360     HRESULT Unregister(
 361         [in] REFCLSID rclsid);
 362
 363     HRESULT AddLanguageProfile(
 364         [in] REFCLSID rclsid,
 365         [in] LANGID langid,
 366         [in] REFGUID guidProfile,
 367         [in, size_is(cchDesc)] const WCHAR *pchDesc,
 368         [in] ULONG cchDesc,
 369         [in, size_is(cchFile)] const WCHAR *pchIconFile,
 370         [in] ULONG cchFile,
 371         [in] ULONG uIconIndex);
 372
 373     HRESULT RemoveLanguageProfile(
 374         [in] REFCLSID rclsid,
 375         [in] LANGID langid,
 376         [in] REFGUID guidProfile);
 377
 378     HRESULT EnumInputProcessorInfo(
 379         [out] IEnumGUID **ppEnum);
 380
 381     HRESULT GetDefaultLanguageProfile(
 382         [in] LANGID langid,
 383         [in] REFGUID catid,
 384         [out] CLSID *pclsid,
 385         [out] GUID *pguidProfile);
 386
 387     HRESULT SetDefaultLanguageProfile(
 388         [in] LANGID langid,
 389         [in] REFCLSID rclsid,
 390         [in] REFGUID guidProfiles);
 391
 392     HRESULT ActivateLanguageProfile(
 393         [in] REFCLSID rclsid,
 394         [in] LANGID langid,
 395         [in] REFGUID guidProfiles);
 396
 397     HRESULT GetActiveLanguageProfile(
 398         [in] REFCLSID rclsid,
 399         [out] LANGID *plangid,
 400         [out] GUID *pguidProfile);
 401
 402     HRESULT GetLanguageProfileDescription(
 403         [in] REFCLSID rclsid,
 404         [in] LANGID langid,
 405         [in] REFGUID guidProfile,
 406         [out] BSTR *pbstrProfile);
 407
 408     HRESULT GetCurrentLanguage(
 409         [out] LANGID *plangid);
 410
 411     HRESULT ChangeCurrentLanguage(
 412         [in] LANGID langid);
 413
 414     HRESULT GetLanguageList(
 415         [out] LANGID **ppLangId,
 416         [out] ULONG *pulCount);
 417
 418     HRESULT EnumLanguageProfiles(
 419         [in] LANGID langid,
 420         [out] IEnumTfLanguageProfiles **ppEnum);
 421
 422     HRESULT EnableLanguageProfile(
 423         [in] REFCLSID rclsid,
 424         [in] LANGID langid,
 425         [in] REFGUID guidProfile,
 426         [in] BOOL fEnable);
 427
 428     HRESULT IsEnabledLanguageProfile(
 429         [in] REFCLSID rclsid,
 430         [in] LANGID langid,
 431         [in] REFGUID guidProfile,
 432         [out] BOOL *pfEnable);
 433
 434     HRESULT EnableLanguageProfileByDefault(
 435         [in] REFCLSID rclsid,
 436         [in] LANGID langid,
 437         [in] REFGUID guidProfile,
 438         [in] BOOL fEnable);
 439
 440     HRESULT SubstituteKeyboardLayout(
 441         [in] REFCLSID rclsid,
 442         [in] LANGID langid,
 443         [in] REFGUID guidProfile,
 444         [in] HKL hKL);
 445 };
 446
 447 typedef [uuid(44d2825a-10e5-43b2-877f-6cb2f43b7e7e)]
 448 struct TF_INPUTPROCESSORPROFILE {
 449     DWORD dwProfileType;
 450     LANGID langid;
 451     CLSID clsid;
 452     GUID guidProfile;
 453     GUID catid;
 454     HKL hklSubstitute;
 455     DWORD dwCaps;
 456     HKL hkl;
 457     DWORD dwFlags;
 458 } TF_INPUTPROCESSORPROFILE;
 459
 460 [
 461     object,
 462     uuid(71c6e74d-0f28-11d8-a82a-00065b84435c),
 463     pointer_default(unique)
 464 ]
 465 interface IEnumTfInputProcessorProfiles : IUnknown
 466 {
 467     HRESULT Clone(
 468         [out] IEnumTfInputProcessorProfiles **ppEnum);
 469
 470     HRESULT Next(
 471         [in] ULONG ulCount,
 472         [out, size_is(ulCount), length_is(*pcFetch)] TF_INPUTPROCESSORPROFILE *pProfile,
 473         [out] ULONG *pcFetch);
 474
 475     HRESULT Reset();
 476
 477     HRESULT Skip(
 478         [in] ULONG ulCount);
 479 }
 480
 481 [
 482     object,
 483     uuid(71c6e74c-0f28-11d8-a82a-00065b84435c),
 484     pointer_default(unique)
 485 ]
 486 interface ITfInputProcessorProfileMgr : IUnknown
 487 {
 488     HRESULT ActivateProfile(
 489         [in] DWORD dwProfileType,
 490         [in] LANGID langid,
 491         [in] REFCLSID clsid,
 492         [in] REFGUID guidProfile,
 493         [in] HKL hkl,
 494         [in] DWORD dwFlags);
 495
 496     HRESULT DeactivateProfile(
 497         [in] DWORD dwProfileType,
 498         [in] LANGID langid,
 499         [in] REFCLSID clsid,
 500         [in] REFGUID guidProfile,
 501         [in] HKL hkl,
 502         [in] DWORD dwFlags);
 503
 504     HRESULT GetProfile(
 505         [in] DWORD dwProfileType,
 506         [in] LANGID langid,
 507         [in] REFCLSID clsid,
 508         [in] REFGUID guidProfile,
 509         [in] HKL hkl,
 510         [out] TF_INPUTPROCESSORPROFILE *pProfile);
 511
 512
 513     HRESULT EnumProfiles(
 514         [in] LANGID langid,
 515         [out] IEnumTfInputProcessorProfiles **ppEnum);
 516
 517     HRESULT ReleaseInputProcessor(
 518         [in] REFCLSID rclsid,
 519         [in] DWORD dwFlags);
 520
 521     HRESULT RegisterProfile(
 522         [in] REFCLSID rclsid,
 523         [in] LANGID langid,
 524         [in] REFGUID guidProfile,
 525         [in, size_is(cchDesc)] const WCHAR *pchDesc,
 526         [in] ULONG cchDesc,
 527         [in, size_is(cchFile)] const WCHAR *pchIconFile,
 528         [in] ULONG cchFile,
 529         [in] ULONG uIconIndex,
 530         [in] HKL hklsubstitute,
 531         [in] DWORD dwPreferredLayout,
 532         [in] BOOL bEnabledByDefault,
 533         [in] DWORD dwFlags);
 534
 535     HRESULT UnregisterProfile(
 536         [in] REFCLSID rclsid,
 537         [in] LANGID langid,
 538         [in] REFGUID guidProfile,
 539         [in] DWORD dwFlags);
 540
 541     HRESULT GetActiveProfile(
 542         [in] REFGUID catid,
 543         [out] TF_INPUTPROCESSORPROFILE *pProfile);
 544 }
 545
 546 typedef [uuid(c4cc07f1-80cc-4a7b-bc54-98512782cbe3)]
 547 enum {
 548     TF_LS_NONE      = 0,
 549     TF_LS_SOLID     = 1,
 550     TF_LS_DOT       = 2,
 551     TF_LS_DASH      = 3,
 552     TF_LS_SQUIGGLE  = 4
 553 } TF_DA_LINESTYLE;
 554
 555 typedef [uuid(d9b92e21-084a-401b-9c64-1e6dad91a1ab)]
 556 enum {
 557     TF_CT_NONE      = 0,
 558     TF_CT_SYSCOLOR  = 1,
 559     TF_CT_COLORREF  = 2
 560 } TF_DA_COLORTYPE;
 561
 562 typedef [uuid(90d0cb5e-6520-4a0f-b47c-c39bd955f0d6)]
 563 struct TF_DA_COLOR {
 564     TF_DA_COLORTYPE type;
 565     [switch_type(TF_DA_COLORTYPE), switch_is(type)]
 566     union {
 567         [case(TF_CT_SYSCOLOR)] int nIndex;
 568         [case(TF_CT_COLORREF)] COLORREF cr;
 569     };
 570 } TF_DA_COLOR;
 571
 572 typedef [uuid(33d2fe4b-6c24-4f67-8d75-3bc1819e4126)]
 573 enum {
 574     TF_ATTR_INPUT                = 0,
 575     TF_ATTR_TARGET_CONVERTED     = 1,
 576     TF_ATTR_CONVERTED            = 2,
 577     TF_ATTR_TARGET_NOTCONVERTED  = 3,
 578     TF_ATTR_INPUT_ERROR          = 4,
 579     TF_ATTR_FIXEDCONVERTED       = 5,
 580     TF_ATTR_OTHER                = -1
 581 } TF_DA_ATTR_INFO;
 582
 583 typedef [uuid(1bf1c305-419b-4182-a4d2-9bfadc3f021f)]
 584 struct TF_DISPLAYATTRIBUTE {
 585     TF_DA_COLOR      crText;
 586     TF_DA_COLOR      crBk;
 587     TF_DA_LINESTYLE  lsStyle;
 588     BOOL             fBoldLine;
 589     TF_DA_COLOR      crLine;
 590     TF_DA_ATTR_INFO  bAttr;
 591 } TF_DISPLAYATTRIBUTE;
 592
 593 [
 594     object,
 595     uuid(70528852-2f26-4aea-8c96-215150578932),
 596     pointer_default(unique)
 597 ]
 598 interface ITfDisplayAttributeInfo : IUnknown
 599 {
 600     HRESULT GetGUID([out] GUID *pguid);
 601
 602     HRESULT GetDescription([out] BSTR *pbstrDesc);
 603
 604     HRESULT GetAttributeInfo([out] TF_DISPLAYATTRIBUTE *pda);
 605
 606     HRESULT SetAttributeInfo([in] const TF_DISPLAYATTRIBUTE *pda);
 607
 608     HRESULT Reset();
 609 }
 610
 611 [
 612     object,
 613     uuid(7cef04d7-cb75-4e80-a7ab-5f5bc7d332de),
 614     pointer_default(unique)
 615 ]
 616 interface IEnumTfDisplayAttributeInfo : IUnknown
 617 {
 618     HRESULT Clone([out] IEnumTfDisplayAttributeInfo **ppEnum);
 619
 620     HRESULT Next(
 621             [in] ULONG ulCount,
 622             [out, size_is(ulCount), length_is(*pcFetched)] ITfDisplayAttributeInfo **rgInfo,
 623             [out] ULONG *pcFetched);
 624
 625     HRESULT Reset();
 626
 627     HRESULT Skip([in] ULONG ulCount);
 628 }
 629
 630 [
 631     object,
 632     local,
 633     uuid(8ded7393-5db1-475c-9e71-a39111b0ff67),
 634     pointer_default(unique)
 635 ]
 636 interface ITfDisplayAttributeMgr : IUnknown
 637 {
 638     HRESULT OnUpdateInfo();
 639
 640     HRESULT EnumDisplayAttributeInfo([out] IEnumTfDisplayAttributeInfo **ppEnum);
 641
 642     HRESULT GetDisplayAttributeInfo(
 643             [in] REFGUID guid,
 644             [out] ITfDisplayAttributeInfo **ppInfo,
 645             [out] CLSID *pclsidOwner);
 646
 647 }
 648
 649 [
 650   object,
 651   local,
 652   uuid(c3acefb5-f69d-4905-938f-fcadcf4be830),
 653   pointer_default(unique)
 654 ]
 655 interface ITfCategoryMgr : IUnknown
 656 {
 657     HRESULT RegisterCategory([in] REFCLSID rclsid,
 658                              [in] REFGUID rcatid,
 659                              [in] REFGUID rguid);
 660
 661     HRESULT UnregisterCategory([in] REFCLSID rclsid,
 662                                [in] REFGUID rcatid,
 663                                [in] REFGUID rguid);
 664
 665     HRESULT EnumCategoriesInItem([in] REFGUID rguid,
 666                                  [out] IEnumGUID **ppEnum);
 667
 668     HRESULT EnumItemsInCategory([in] REFGUID rcatid,
 669                                 [out] IEnumGUID **ppEnum);
 670
 671     HRESULT FindClosestCategory([in] REFGUID rguid,
 672                                 [out] GUID *pcatid,
 673                                 [in, size_is(ulCount)] const GUID **ppcatidList,
 674                                 [in] ULONG ulCount);
 675
 676     HRESULT RegisterGUIDDescription([in] REFCLSID rclsid,
 677                                     [in] REFGUID rguid,
 678                                     [in, size_is(cch)] const WCHAR *pchDesc,
 679                                     [in] ULONG cch);
 680
 681     HRESULT UnregisterGUIDDescription([in] REFCLSID rclsid,
 682                                       [in] REFGUID rguid);
 683
 684     HRESULT GetGUIDDescription([in] REFGUID rguid,
 685                                [out] BSTR *pbstrDesc);
 686
 687     HRESULT RegisterGUIDDWORD([in] REFCLSID rclsid,
 688                               [in] REFGUID rguid,
 689                               [in] DWORD dw);
 690
 691     HRESULT UnregisterGUIDDWORD([in] REFCLSID rclsid,
 692                                 [in] REFGUID rguid);
 693
 694     HRESULT GetGUIDDWORD([in] REFGUID rguid,
 695                          [out] DWORD *pdw);
 696
 697     HRESULT RegisterGUID([in] REFGUID rguid,
 698                          [out] TfGuidAtom *pguidatom);
 699
 700     HRESULT GetGUID([in] TfGuidAtom guidatom,
 701                     [out] GUID *pguid);
 702
 703     HRESULT IsEqualTfGuidAtom([in] TfGuidAtom guidatom,
 704                               [in] REFGUID rguid,
 705                               [out] BOOL *pfEqual);
 706 };
 707
 708 [
 709   object,
 710   uuid(8127d409-ccd3-4683-967a-b43d5b482bf7),
 711   pointer_default(unique)
 712 ]
 713 interface ITfTextEditSink : IUnknown
 714 {
 715     HRESULT OnEndEdit(
 716         [in] ITfContext *pic,
 717         [in] TfEditCookie ecReadOnly,
 718         [in] ITfEditRecord *pEditRecord);
 719 };
 720
 721 [
 722     object,
 723     uuid(5F20AA40-B57A-4F34-96AB-3576F377CC79),
 724     pointer_default(unique)
 725 ]
 726 interface ITfContextOwnerCompositionSink : IUnknown
 727 {
 728     HRESULT OnStartComposition(
 729         [in] ITfCompositionView *pComposition,
 730         [out] BOOL *pfOk);
 731
 732     HRESULT OnUpdateComposition(
 733         [in] ITfCompositionView *pComposition,
 734         [in] ITfRange *pRangeNew);
 735
 736     HRESULT OnEndComposition(
 737         [in] ITfCompositionView *pComposition);
 738 };
 739
 740 [
 741   object,
 742   uuid(3d61bf11-ac5f-42c8-a4cb-931bcc28c744),
 743   pointer_default(unique)
 744 ]
 745 interface IEnumTfLanguageProfiles : IUnknown
 746 {
 747     HRESULT Clone(
 748         [out] IEnumTfLanguageProfiles **ppEnum);
 749
 750     HRESULT Next(
 751         [in] ULONG ulCount,
 752         [out, size_is(ulCount), length_is(*pcFetch)] TF_LANGUAGEPROFILE *pProfile,
 753         [out] ULONG *pcFetch);
 754
 755     HRESULT Reset();
 756
 757     HRESULT Skip(
 758         [in] ULONG ulCount);
 759 };
 760
 761 [
 762   object,
 763   local,
 764   uuid(aa80e7f7-2021-11d2-93e0-0060b067b86e),
 765   pointer_default(unique)
 766 ]
 767 interface ITfTextInputProcessor : IUnknown
 768 {
 769     HRESULT Activate(
 770         [in] ITfThreadMgr *ptim,
 771         [in] TfClientId tid);
 772
 773     HRESULT Deactivate();
 774 };
 775
 776 [
 777   object,
 778   uuid(aa80e80e-2021-11d2-93e0-0060b067b86e),
 779   pointer_default(unique)
 780 ]
 781 interface ITfThreadMgrEventSink : IUnknown
 782 {
 783     HRESULT OnInitDocumentMgr(
 784         [in] ITfDocumentMgr *pdim);
 785
 786     HRESULT OnUninitDocumentMgr(
 787         [in] ITfDocumentMgr *pdim);
 788
 789     HRESULT OnSetFocus(
 790         [in] ITfDocumentMgr *pdimFocus,
 791         [in] ITfDocumentMgr *pdimPrevFocus);
 792
 793     HRESULT OnPushContext(
 794         [in] ITfContext *pic);
 795
 796     HRESULT OnPopContext(
 797         [in] ITfContext *pic);
 798 };
 799
 800 [
 801   object,
 802   local,
 803   uuid(aa80e7f0-2021-11d2-93e0-0060b067b86e),
 804   pointer_default(unique)
 805 ]
 806 interface ITfKeystrokeMgr : IUnknown
 807 {
 808     HRESULT AdviseKeyEventSink(
 809         [in] TfClientId tid,
 810         [in] ITfKeyEventSink *pSink,
 811         [in] BOOL fForeground);
 812
 813     HRESULT UnadviseKeyEventSink(
 814         [in] TfClientId tid);
 815
 816     HRESULT GetForeground(
 817         [out] CLSID *pclsid);
 818
 819     HRESULT TestKeyDown(
 820         [in] WPARAM wParam,
 821         [in] LPARAM lParam,
 822         [out] BOOL *pfEaten);
 823
 824     HRESULT TestKeyUp(
 825         [in] WPARAM wParam,
 826         [in] LPARAM lParam,
 827         [out] BOOL *pfEaten);
 828
 829     HRESULT KeyDown(
 830         [in] WPARAM wParam,
 831         [in] LPARAM lParam,
 832         [out] BOOL *pfEaten);
 833
 834     HRESULT KeyUp(
 835         [in] WPARAM wParam,
 836         [in] LPARAM lParam,
 837         [out] BOOL *pfEaten);
 838
 839     HRESULT GetPreservedKey(
 840         [in] ITfContext *pic,
 841         [in] const TF_PRESERVEDKEY *pprekey,
 842         [out] GUID *pguid);
 843
 844     HRESULT IsPreservedKey(
 845         [in] REFGUID rguid,
 846         [in] const TF_PRESERVEDKEY *pprekey,
 847         [out] BOOL *pfRegistered);
 848
 849     HRESULT PreserveKey(
 850         [in] TfClientId tid,
 851         [in] REFGUID rguid,
 852         [in] const TF_PRESERVEDKEY *prekey,
 853         [in, size_is(cchDesc)] const WCHAR *pchDesc,
 854         [in] ULONG cchDesc);
 855
 856     HRESULT UnpreserveKey(
 857         [in] REFGUID rguid,
 858         [in] const TF_PRESERVEDKEY *pprekey);
 859
 860     HRESULT SetPreservedKeyDescription(
 861         [in] REFGUID rguid,
 862         [in, size_is(cchDesc)] const WCHAR *pchDesc,
 863         [in] ULONG cchDesc);
 864
 865     HRESULT GetPreservedKeyDescription(
 866         [in] REFGUID rguid,
 867         [out] BSTR *pbstrDesc);
 868
 869     HRESULT SimulatePreservedKey(
 870         [in] ITfContext *pic,
 871         [in] REFGUID rguid,
 872         [out] BOOL *pfEaten);
 873 };
 874
 875 [
 876   object,
 877   local,
 878   uuid(aa80e7f5-2021-11d2-93e0-0060b067b86e),
 879   pointer_default(unique)
 880 ]
 881 interface ITfKeyEventSink : IUnknown
 882 {
 883     HRESULT OnSetFocus(
 884         [in] BOOL fForeground);
 885
 886     HRESULT OnTestKeyDown(
 887         [in] ITfContext *pic,
 888         [in] WPARAM wParam,
 889         [in] LPARAM lParam,
 890         [out] BOOL *pfEaten);
 891
 892     HRESULT OnTestKeyUp(
 893         [in] ITfContext *pic,
 894         [in] WPARAM wParam,
 895         [in] LPARAM lParam,
 896         [out] BOOL *pfEaten);
 897
 898     HRESULT OnKeyDown(
 899         [in] ITfContext *pic,
 900         [in] WPARAM wParam,
 901         [in] LPARAM lParam,
 902         [out] BOOL *pfEaten);
 903
 904     HRESULT OnKeyUp(
 905         [in] ITfContext *pic,
 906         [in] WPARAM wParam,
 907         [in] LPARAM lParam,
 908         [out] BOOL *pfEaten);
 909
 910     HRESULT OnPreservedKey(
 911         [in] ITfContext *pic,
 912         [in] REFGUID rguid,
 913         [out] BOOL *pfEaten);
 914 };
 915
 916 [
 917   object,
 918   local,
 919   uuid(8f1b8ad8-0b6b-4874-90c5-bd76011e8f7c),
 920   pointer_default(unique)
 921 ]
 922 interface ITfMessagePump : IUnknown
 923 {
 924     HRESULT PeekMessageA(
 925         [out] LPMSG pMsg,
 926         [in] HWND hwnd,
 927         [in] UINT wMsgFilterMin,
 928         [in] UINT wMsgFilterMax,
 929         [in] UINT wRemoveMsg,
 930         [out] BOOL *pfResult);
 931
 932     HRESULT GetMessageA(
 933         [out] LPMSG pMsg,
 934         [in] HWND hwnd,
 935         [in] UINT wMsgFilterMin,
 936         [in] UINT wMsgFilterMax,
 937         [out] BOOL *pfResult);
 938
 939     HRESULT PeekMessageW(
 940         [out] LPMSG pMsg,
 941         [in] HWND hwnd,
 942         [in] UINT wMsgFilterMin,
 943         [in] UINT wMsgFilterMax,
 944         [in] UINT wRemoveMsg,
 945         [out] BOOL *pfResult);
 946
 947     HRESULT GetMessageW(
 948         [out] LPMSG pMsg,
 949         [in] HWND hwnd,
 950         [in] UINT wMsgFilterMin,
 951         [in] UINT wMsgFilterMax,
 952         [out] BOOL *pfResult);
 953 };
 954
 955 [
 956   object,
 957   local,
 958   uuid(d60a7b49-1b9f-4be2-b702-47e9dc05dec3),
 959   pointer_default(unique)
 960 ]
 961 interface ITfClientId : IUnknown
 962 {
 963     HRESULT GetClientId(
 964         [in] REFCLSID rclsid,
 965         [out] TfClientId *ptid);
 966 };
 967
 968 [
 969   object,
 970   uuid(43c9fe15-f494-4c17-9de2-b8a4ac350aa8),
 971   pointer_default(unique)
 972 ]
 973 interface ITfLanguageProfileNotifySink : IUnknown
 974 {
 975     HRESULT OnLanguageChange(
 976         [in] LANGID langid,
 977         [out] BOOL *pfAccept);
 978
 979     HRESULT OnLanguageChanged();
 980 }
 981
 982 [
 983   object,
 984   uuid(aa80e803-2021-11d2-93e0-0060b067b86e),
 985   pointer_default(unique)
 986 ]
 987 interface ITfEditSession : IUnknown
 988 {
 989     HRESULT DoEditSession(
 990         [in] TfEditCookie ec);
 991 }
 992
 993 [
 994   object,
 995   uuid(aa80e7ff-2021-11d2-93e0-0060b067b86e),
 996   pointer_default(unique)
 997 ]
 998 interface ITfRange : IUnknown
 999 {
1000     const WCHAR TF_CHAR_EMBEDDED     = TS_CHAR_EMBEDDED;
1001
1002     typedef [uuid(cf610f06-2882-46f6-abe5-298568b664c4)] enum { TF_GRAVITY_BACKWARD = 0, TF_GRAVITY_FORWARD = 1 } TfGravity;
1003
1004     typedef [uuid(1e512533-bbdc-4530-9a8e-a1dc0af67468)] enum { TF_SD_BACKWARD = 0, TF_SD_FORWARD = 1 } TfShiftDir;
1005
1006     const DWORD TF_HF_OBJECT         = 1;
1007     const DWORD TF_TF_MOVESTART      = 1;
1008     const DWORD TF_TF_IGNOREEND      = 2;
1009     const DWORD TF_ST_CORRECTION     = 1;
1010     const DWORD TF_IE_CORRECTION     = 1;
1011
1012     typedef [uuid(49930d51-7d93-448c-a48c-fea5dac192b1)] struct  TF_HALTCOND
1013     {
1014         ITfRange *pHaltRange;
1015         TfAnchor aHaltPos;
1016         DWORD dwFlags;
1017     } TF_HALTCOND;
1018
1019     HRESULT GetText(
1020         [in] TfEditCookie ec,
1021         [in] DWORD dwFlags,
1022         [out, size_is(cchMax), length_is(*pcch)] WCHAR *pchText,
1023         [in] ULONG cchMax,
1024         [out] ULONG *pcch);
1025
1026     HRESULT SetText(
1027         [in] TfEditCookie ec,
1028         [in] DWORD dwFlags,
1029         [in, size_is(cch), unique] const WCHAR *pchText,
1030         [in] LONG cch);
1031
1032     HRESULT GetFormattedText(
1033         [in] TfEditCookie ec,
1034         [out] IDataObject **ppDataObject);
1035
1036     HRESULT GetEmbedded(
1037         [in] TfEditCookie ec,
1038         [in] REFGUID rguidService,
1039         [in] REFIID riid,
1040         [out, iid_is(riid)] IUnknown **ppunk);
1041
1042     HRESULT InsertEmbedded(
1043         [in] TfEditCookie ec,
1044         [in] DWORD dwFlags,
1045         [in] IDataObject *pDataObject);
1046
1047     HRESULT ShiftStart(
1048         [in] TfEditCookie ec,
1049         [in] LONG cchReq,
1050         [out] LONG *pcch,
1051         [in, unique] const TF_HALTCOND *pHalt);
1052
1053     HRESULT ShiftEnd(
1054         [in] TfEditCookie ec,
1055         [in] LONG cchReq,
1056         [out] LONG *pcch,
1057         [in, unique] const TF_HALTCOND *pHalt);
1058
1059     HRESULT ShiftStartToRange(
1060         [in] TfEditCookie ec,
1061         [in] ITfRange *pRange,
1062         [in] TfAnchor aPos);
1063
1064     HRESULT ShiftEndToRange(
1065         [in] TfEditCookie ec,
1066         [in] ITfRange *pRange,
1067         [in] TfAnchor aPos);
1068
1069     HRESULT ShiftStartRegion(
1070         [in] TfEditCookie ec,
1071         [in] TfShiftDir dir,
1072         [out] BOOL *pfNoRegion);
1073
1074     HRESULT ShiftEndRegion(
1075         [in] TfEditCookie ec,
1076         [in] TfShiftDir dir,
1077         [out] BOOL *pfNoRegion);
1078
1079     HRESULT IsEmpty(
1080         [in] TfEditCookie ec,
1081         [out] BOOL *pfEmpty);
1082
1083     HRESULT Collapse(
1084         [in] TfEditCookie ec,
1085         [in] TfAnchor aPos);
1086
1087     HRESULT IsEqualStart(
1088         [in] TfEditCookie ec,
1089         [in] ITfRange *pWith,
1090         [in] TfAnchor aPos,
1091         [out] BOOL *pfEqual);
1092
1093     HRESULT IsEqualEnd(
1094         [in] TfEditCookie ec,
1095         [in] ITfRange *pWith,
1096         [in] TfAnchor aPos,
1097         [out] BOOL *pfEqual);
1098
1099     HRESULT CompareStart(
1100         [in] TfEditCookie ec,
1101         [in] ITfRange *pWith,
1102         [in] TfAnchor aPos,
1103         [out] LONG *plResult);
1104
1105     HRESULT CompareEnd(
1106         [in] TfEditCookie ec,
1107         [in] ITfRange *pWith,
1108         [in] TfAnchor aPos,
1109         [out] LONG *plResult);
1110
1111     HRESULT AdjustForInsert(
1112         [in] TfEditCookie ec,
1113         [in] ULONG cchInsert,
1114         [out] BOOL *pfInsertOk);
1115
1116     HRESULT GetGravity(
1117         [out] TfGravity *pgStart,
1118         [out] TfGravity *pgEnd);
1119
1120     HRESULT SetGravity(
1121         [in] TfEditCookie ec,
1122         [in] TfGravity gStart,
1123         [in] TfGravity gEnd);
1124
1125     HRESULT Clone(
1126         [out] ITfRange **ppClone);
1127
1128     HRESULT GetContext(
1129         [out] ITfContext **ppContext);
1130 };
1131
1132 [
1133     object,
1134     uuid(057a6296-029b-4154-b79a-0d461d4ea94c),
1135     pointer_default(unique)
1136 ]
1137 interface ITfRangeACP : ITfRange
1138 {
1139     HRESULT GetExtent([out] LONG *pacpAnchor,
1140                       [out] LONG *pcch);
1141
1142     HRESULT SetExtent([in] LONG acpAnchor,
1143                       [in] LONG cch);
1144 }
1145
1146 [
1147     object,
1148     uuid(55ce16ba-3014-41c1-9ceb-fade1446ac6c),
1149     pointer_default(unique)
1150 ]
1151 interface ITfInsertAtSelection : IUnknown
1152 {
1153     const DWORD TF_IAS_NOQUERY   = 0x1;
1154     const DWORD TF_IAS_QUERYONLY = 0x2;
1155     const DWORD TF_IAS_NO_DEFAULT_COMPOSITION = 0x80000000;
1156
1157     HRESULT InsertTextAtSelection(
1158         [in] TfEditCookie ec,
1159         [in] DWORD dwFlags,
1160         [in, size_is(cch)] const WCHAR *pchText,
1161         [in] LONG cch,
1162         [out] ITfRange **ppRange);
1163
1164     HRESULT InsertEmbeddedAtSelection(
1165         [in] TfEditCookie ec,
1166         [in] DWORD dwFlags,
1167         [in] IDataObject *pDataObject,
1168         [out] ITfRange **ppRange);
1169 };
1170
1171 [
1172     object,
1173     uuid(6834b120-88cb-11d2-bf45-00105a2799b5),
1174     pointer_default(unique)
1175 ]
1176 interface ITfPropertyStore : IUnknown
1177 {
1178     const DWORD TF_TU_CORRECTION = 0x1;
1179
1180     HRESULT GetType([out] GUID *pguid);
1181
1182     HRESULT GetDataType([out] DWORD *pdwReserved);
1183
1184     HRESULT GetData([out] VARIANT *pvarValue);
1185
1186     HRESULT OnTextUpdated(
1187             [in] DWORD dwFlags,
1188             [in] ITfRange *pRangeNew,
1189             [out] BOOL *pfAccept);
1190
1191     HRESULT Shrink(
1192             [in] ITfRange *pRangeNew,
1193             [out] BOOL *pfFree);
1194
1195     HRESULT Divide(
1196             [in] ITfRange *pRangeThis,
1197             [in] ITfRange *pRangeNew,
1198             [out] ITfPropertyStore **ppPropStore);
1199
1200     HRESULT Clone(
1201             [out] ITfPropertyStore **pPropStore);
1202
1203     HRESULT GetPropertyRangeCreator(
1204             [out] CLSID *pclsid);
1205
1206     HRESULT Serialize(
1207             [in] IStream *pStream,
1208             [out] ULONG *pcb);
1209 }
1210
1211 [
1212     object,
1213     uuid(f99d3f40-8e32-11d2-bf46-00105a2799b5),
1214     pointer_default(unique)
1215 ]
1216 interface IEnumTfRanges : IUnknown
1217 {
1218     HRESULT Clone([out] IEnumTfRanges **ppEnum);
1219
1220     HRESULT Next(
1221             [in] ULONG ulCount,
1222             [out, size_is(ulCount), length_is(*pcFetched)] ITfRange **ppRange,
1223             [out] ULONG *pcFetched);
1224
1225     HRESULT Reset();
1226
1227     HRESULT Skip(ULONG ulCount);
1228 }
1229
1230 [
1231     object,
1232     uuid(5efd22Ba-7838-46cb-88e2-cadb14124f8f),
1233     pointer_default(unique)
1234 ]
1235 interface IEnumITfCompositionView : IUnknown
1236 {
1237     HRESULT Clone([out] IEnumITfCompositionView **ppEnum);
1238
1239     HRESULT Next(
1240             [in] ULONG ulCount,
1241             [out, size_is(ulCount), length_is(*pcFetched)] ITfCompositionView **rgCompositionView,
1242             [out] ULONG *pcFetched);
1243
1244     HRESULT Reset();
1245
1246     HRESULT Skip([in] ULONG ulCount);
1247 }
1248
1249 [
1250     object,
1251     uuid(20168d64-5a8f-4a5a-b7bd-cfa29f4D0fd9),
1252     pointer_default(unique)
1253 ]
1254 interface ITfComposition : IUnknown
1255 {
1256     HRESULT GetRange([out] ITfRange **ppRange);
1257
1258     HRESULT ShiftStart(
1259             [in] TfEditCookie ecWrite,
1260             [in] ITfRange *pNewStart);
1261
1262     HRESULT ShiftEnd(
1263             [in] TfEditCookie ecWrite,
1264             [in] ITfRange *pNewEnd);
1265
1266     HRESULT EndComposition([in] TfEditCookie ecWrite);
1267 }
1268
1269 [
1270     object,
1271     uuid(a781718c-579a-4b15-a280-32b8577acc5e),
1272     pointer_default(unique)
1273 ]
1274 interface ITfCompositionSink : IUnknown
1275 {
1276     HRESULT OnCompositionTerminated(
1277             [in] TfEditCookie ecWrite,
1278             [in] ITfComposition *pComposition);
1279 }
1280
1281 [
1282     object,
1283     uuid(d40C8aae-aC92-4fc7-9a11-0ee0e23aa39b),
1284     pointer_default(unique)
1285 ]
1286 interface ITfContextComposition : IUnknown
1287 {
1288     HRESULT StartComposition(
1289             [in] TfEditCookie ecWrite,
1290             [in] ITfRange *pCompositionRange,
1291             [in] ITfCompositionSink *pSink,
1292             [out] ITfComposition **ppComposition);
1293
1294     HRESULT EnumCompositions([out] IEnumITfCompositionView **ppEnum);
1295
1296     HRESULT FindComposition(
1297             [in] TfEditCookie ecRead,
1298             [in] ITfRange *pTestRange,
1299             [out] IEnumITfCompositionView **ppEnum);
1300
1301     HRESULT TakeOwnership(
1302             [in] TfEditCookie ecWrite,
1303             [in] ITfCompositionView *pComposition,
1304             [in] ITfCompositionSink *pSink,
1305             [out] ITfComposition **ppComposition);
1306 }
1307
1308 [
1309     object,
1310     uuid(86462810-593b-4916-9764-19c08e9ce110),
1311     pointer_default(unique)
1312 ]
1313 interface ITfContextOwnerCompositionServices : ITfContextComposition
1314 {
1315     HRESULT TerminateComposition([in] ITfCompositionView *pComposition);
1316 }
1317
1318 [
1319     object,
1320     uuid(4ef89150-0807-11d3-8df0-00105a2799b5),
1321     pointer_default(unique)
1322 ]
1323 interface ITfPersistentPropertyLoaderACP : IUnknown
1324 {
1325     HRESULT LoadProperty(
1326             [in] const TF_PERSISTENT_PROPERTY_HEADER_ACP *pHdr,
1327             [out] IStream **ppStream);
1328 }
1329
1330 [
1331     object,
1332     uuid(b23eb630-3e1c-11d3-a745-0050040ab407),
1333     pointer_default(unique)
1334 ]
1335 interface ITfContextOwnerServices : IUnknown
1336 {
1337     HRESULT OnLayoutChange();
1338
1339     HRESULT OnStatusChange([in] DWORD dwFlags);
1340
1341     HRESULT OnAttributeChange([in] REFGUID rguidAttribute);
1342
1343     HRESULT Serialize(
1344             [in] ITfProperty *pProp,
1345             [in] ITfRange *pRange,
1346             [out] TF_PERSISTENT_PROPERTY_HEADER_ACP *pHdr,
1347             [in] IStream *pStream);
1348
1349     HRESULT Unserialize(
1350             [in] ITfProperty *pProp,
1351             [in] const TF_PERSISTENT_PROPERTY_HEADER_ACP *pHdr,
1352             [in] IStream *pStream,
1353             [in] ITfPersistentPropertyLoaderACP *pLoader);
1354
1355     HRESULT ForceLoadProperty([in] ITfProperty *pProp);
1356
1357     HRESULT CreateRange(
1358             [in] LONG acpStart,
1359             [in] LONG acpEnd,
1360             [out] ITfRangeACP **ppRange);
1361 }
1362
1363 [
1364     object,
1365     uuid(17d49a3d-f8b8-4b2f-b254-52319dd64c53),
1366     pointer_default(unique)
1367 ]
1368 interface ITfReadOnlyProperty : IUnknown
1369 {
1370     HRESULT GetType([out] GUID *pguid);
1371
1372     HRESULT EnumRanges(
1373             [in] TfEditCookie ec,
1374             [out] IEnumTfRanges **ppEnum,
1375             [in] ITfRange *pTargetRange);
1376
1377     HRESULT GetValue(
1378             [in] TfEditCookie ec,
1379             [in] ITfRange *pRange,
1380             [out] VARIANT *pvarValue);
1381
1382     HRESULT GetContext([out] ITfContext **ppContext);
1383 }
1384
1385 [
1386     object,
1387     uuid(e2449660-9542-11d2-bf46-00105a2799b5),
1388     pointer_default(unique)
1389 ]
1390 interface ITfProperty : ITfReadOnlyProperty
1391 {
1392     HRESULT FindRange(
1393             [in] TfEditCookie ec,
1394             [in] ITfRange *pRange,
1395             [out] ITfRange **ppRange,
1396             [in] TfAnchor aPos);
1397
1398     HRESULT SetValueStore(
1399             [in] TfEditCookie ec,
1400             [in] ITfRange *pRange,
1401             [in] ITfPropertyStore *pPropStore);
1402
1403     HRESULT SetValue(
1404             [in] TfEditCookie ec,
1405             [in] ITfRange *pRange,
1406             [in] const VARIANT *pvarValue);
1407
1408     HRESULT Clear(
1409             [in] TfEditCookie ec,
1410             [in] ITfRange *pRange);
1411 }
1412
1413 [
1414   object,
1415   uuid(bb08f7a9-607a-4384-8623-056892b64371),
1416   pointer_default(unique)
1417 ]
1418 interface ITfCompartment : IUnknown
1419 {
1420     HRESULT SetValue(
1421         [in] TfClientId tid,
1422         [in] const VARIANT *pvarValue);
1423
1424     HRESULT GetValue(
1425         [out] VARIANT *pvarValue);
1426 };
1427
1428 [
1429   object,
1430   uuid(7dcf57ac-18ad-438b-824d-979bffb74b7c),
1431   pointer_default(unique)
1432 ]
1433 interface ITfCompartmentMgr : IUnknown
1434 {
1435     HRESULT GetCompartment(
1436         [in] REFGUID rguid,
1437         [out] ITfCompartment **ppcomp);
1438
1439     HRESULT ClearCompartment(
1440         [in] TfClientId tid,
1441         [in] REFGUID rguid);
1442
1443     HRESULT EnumCompartments(
1444         [out] IEnumGUID **ppEnum);
1445 };
1446
1447 [
1448   object,
1449   uuid(743abd5f-f26d-48df-8cc5-238492419b64),
1450   pointer_default(unique)
1451 ]
1452 interface ITfCompartmentEventSink : IUnknown
1453 {
1454     HRESULT OnChange(
1455         [in] REFGUID rguid);
1456 }
1457
1458 [
1459   object,
1460   uuid(8f1a7ea6-1654-4502-a86e-b2902344d507),
1461   pointer_default(unique)
1462 ]
1463 interface IEnumTfContexts : IUnknown
1464 {
1465     HRESULT Clone(
1466         [out] IEnumTfContexts **ppEnum);
1467
1468     HRESULT Next(
1469         [in] ULONG ulCount,
1470         [out, size_is(ulCount), length_is(*pcFetched)] ITfContext **rgContext,
1471         [out] ULONG *pcFetched);
1472
1473     HRESULT Reset();
1474
1475     HRESULT Skip(
1476         [in] ULONG ulCount);
1477 };
1478
1479 [
1480   object,
1481   uuid(aa80e808-2021-11d2-93e0-0060b067b86e),
1482   pointer_default(unique)
1483 ]
1484 interface IEnumTfDocumentMgrs : IUnknown
1485 {
1486     HRESULT Clone(
1487         [out] IEnumTfDocumentMgrs **ppEnum);
1488
1489     HRESULT Next(
1490         [in] ULONG ulCount,
1491         [out, size_is(ulCount), length_is(*pcFetched)] ITfDocumentMgr **rgDocumentMgr,
1492         [out] ULONG *pcFetched);
1493
1494     HRESULT Reset();
1495
1496     HRESULT Skip(
1497         [in] ULONG ulCount);
1498 };
1499
1500 [
1501   object,
1502   uuid(73131f9c-56a9-49dd-b0ee-d046633f7528),
1503   pointer_default(unique)
1504 ]
1505 interface ITfSourceSingle : IUnknown
1506 {
1507     HRESULT AdviseSingleSink(
1508         [in] TfClientId tid,
1509         [in] REFIID riid,
1510         [in, iid_is(riid)] IUnknown *punk);
1511
1512     HRESULT UnadviseSingleSink(
1513         [in] TfClientId tid,
1514         [in] REFIID riid);
1515 };
1516
1517 [
1518   object,
1519   local,
1520   uuid(c0f1db0c-3a20-405c-a303-96b6010a885f),
1521   pointer_default(unique)
1522 ]
1523 interface ITfThreadFocusSink : IUnknown
1524 {
1525     HRESULT OnSetThreadFocus();
1526
1527     HRESULT OnKillThreadFocus();
1528 };
1529
1530 [
1531   object,
1532   uuid(71c6e74e-0f28-11d8-a82a-00065b84435c),
1533   pointer_default(unique)
1534 ]
1535 interface ITfInputProcessorProfileActivationSink : IUnknown
1536 {
1537     HRESULT OnActivated(
1538         [in] DWORD dwProfileType,
1539         [in] LANGID langid,
1540         [in] REFCLSID clsid,
1541         [in] REFGUID catid,
1542         [in] REFGUID guidProfile,
1543         [in] HKL hkl,
1544         [in] DWORD dwFlags);
1545 }