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