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