include/oleacc.idl

   1 /*
   2  * Copyright (C) 2005 Dmitry Timoshkov
   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 import "oaidl.idl";
  20
  21 #ifndef __WIDL__
  22 #define threading(model)
  23 #endif
  24
  25 cpp_quote("#define NAVDIR_MIN        0")
  26 cpp_quote("#define NAVDIR_UP         1")
  27 cpp_quote("#define NAVDIR_DOWN       2")
  28 cpp_quote("#define NAVDIR_LEFT       3")
  29 cpp_quote("#define NAVDIR_RIGHT      4")
  30 cpp_quote("#define NAVDIR_NEXT       5")
  31 cpp_quote("#define NAVDIR_PREVIOUS   6")
  32 cpp_quote("#define NAVDIR_FIRSTCHILD 7")
  33 cpp_quote("#define NAVDIR_LASTCHILD  8")
  34 cpp_quote("#define NAVDIR_MAX        9")
  35
  36 cpp_quote("#define ROLE_SYSTEM_TITLEBAR     1")
  37 cpp_quote("#define ROLE_SYSTEM_MENUBAR      2")
  38 cpp_quote("#define ROLE_SYSTEM_SCROLLBAR    3")
  39 cpp_quote("#define ROLE_SYSTEM_GRIP         4")
  40 cpp_quote("#define ROLE_SYSTEM_SOUND        5")
  41 cpp_quote("#define ROLE_SYSTEM_CURSOR       6")
  42 cpp_quote("#define ROLE_SYSTEM_CARET        7")
  43 cpp_quote("#define ROLE_SYSTEM_ALERT        8")
  44 cpp_quote("#define ROLE_SYSTEM_WINDOW       9")
  45 cpp_quote("#define ROLE_SYSTEM_CLIENT       10")
  46 cpp_quote("#define ROLE_SYSTEM_MENUPOPUP    11")
  47 cpp_quote("#define ROLE_SYSTEM_MENUITEM     12")
  48 cpp_quote("#define ROLE_SYSTEM_TOOLTIP      13")
  49 cpp_quote("#define ROLE_SYSTEM_APPLICATION  14")
  50 cpp_quote("#define ROLE_SYSTEM_DOCUMENT     15")
  51 cpp_quote("#define ROLE_SYSTEM_PANE         16")
  52 cpp_quote("#define ROLE_SYSTEM_CHART        17")
  53 cpp_quote("#define ROLE_SYSTEM_DIALOG       18")
  54 cpp_quote("#define ROLE_SYSTEM_BORDER       19")
  55 cpp_quote("#define ROLE_SYSTEM_GROUPING     20")
  56 cpp_quote("#define ROLE_SYSTEM_SEPARATOR    21")
  57 cpp_quote("#define ROLE_SYSTEM_TOOLBAR      22")
  58 cpp_quote("#define ROLE_SYSTEM_STATUSBAR    23")
  59 cpp_quote("#define ROLE_SYSTEM_TABLE        24")
  60 cpp_quote("#define ROLE_SYSTEM_COLUMNHEADER 25")
  61 cpp_quote("#define ROLE_SYSTEM_ROWHEADER    26")
  62 cpp_quote("#define ROLE_SYSTEM_COLUMN       27")
  63 cpp_quote("#define ROLE_SYSTEM_ROW          28")
  64 cpp_quote("#define ROLE_SYSTEM_CELL         29")
  65 cpp_quote("#define ROLE_SYSTEM_LINK         30")
  66 cpp_quote("#define ROLE_SYSTEM_HELPBALLOON  31")
  67 cpp_quote("#define ROLE_SYSTEM_CHARACTER    32")
  68 cpp_quote("#define ROLE_SYSTEM_LIST         33")
  69 cpp_quote("#define ROLE_SYSTEM_LISTITEM     34")
  70 cpp_quote("#define ROLE_SYSTEM_OUTLINE      35")
  71 cpp_quote("#define ROLE_SYSTEM_OUTLINEITEM  36")
  72 cpp_quote("#define ROLE_SYSTEM_PAGETAB      37")
  73 cpp_quote("#define ROLE_SYSTEM_PROPERTYPAGE 38")
  74 cpp_quote("#define ROLE_SYSTEM_INDICATOR    39")
  75 cpp_quote("#define ROLE_SYSTEM_GRAPHIC      40")
  76 cpp_quote("#define ROLE_SYSTEM_STATICTEXT   41")
  77 cpp_quote("#define ROLE_SYSTEM_TEXT         42")
  78 cpp_quote("#define ROLE_SYSTEM_PUSHBUTTON   43")
  79 cpp_quote("#define ROLE_SYSTEM_CHECKBUTTON  44")
  80 cpp_quote("#define ROLE_SYSTEM_RADIOBUTTON  45")
  81 cpp_quote("#define ROLE_SYSTEM_COMBOBOX     46")
  82 cpp_quote("#define ROLE_SYSTEM_DROPLIST     47")
  83 cpp_quote("#define ROLE_SYSTEM_PROGRESSBAR  48")
  84 cpp_quote("#define ROLE_SYSTEM_DIAL         49")
  85 cpp_quote("#define ROLE_SYSTEM_HOTKEYFIELD  50")
  86 cpp_quote("#define ROLE_SYSTEM_SLIDER       51")
  87 cpp_quote("#define ROLE_SYSTEM_SPINBUTTON   52")
  88 cpp_quote("#define ROLE_SYSTEM_DIAGRAM      53")
  89 cpp_quote("#define ROLE_SYSTEM_ANIMATION    54")
  90 cpp_quote("#define ROLE_SYSTEM_EQUATION     55")
  91 cpp_quote("#define ROLE_SYSTEM_BUTTONDROPDOWN 56")
  92 cpp_quote("#define ROLE_SYSTEM_BUTTONMENU   57")
  93 cpp_quote("#define ROLE_SYSTEM_BUTTONDROPDOWNGRID 58")
  94 cpp_quote("#define ROLE_SYSTEM_WHITESPACE   59")
  95 cpp_quote("#define ROLE_SYSTEM_PAGETABLIST  60")
  96 cpp_quote("#define ROLE_SYSTEM_CLOCK        61")
  97 cpp_quote("#define ROLE_SYSTEM_SPLITBUTTON  62")
  98 cpp_quote("#define ROLE_SYSTEM_IPADDRESS    63")
  99 cpp_quote("#define ROLE_SYSTEM_OUTLINEBUTTON 64")
 100
 101 cpp_quote("#define SELFLAG_NONE            0x00")
 102 cpp_quote("#define SELFLAG_TAKEFOCUS       0x01")
 103 cpp_quote("#define SELFLAG_TAKESELECTION   0x02")
 104 cpp_quote("#define SELFLAG_EXTENDSELECTION 0x04")
 105 cpp_quote("#define SELFLAG_ADDSELECTION    0x08")
 106 cpp_quote("#define SELFLAG_REMOVESELECTION 0x10")
 107 cpp_quote("#define SELFLAG_VALID           0x1f")
 108
 109 cpp_quote("#ifndef STATE_SYSTEM_UNAVAILABLE")
 110 cpp_quote("#define STATE_SYSTEM_NORMAL          0x00000000")
 111 cpp_quote("#define STATE_SYSTEM_UNAVAILABLE     0x00000001")
 112 cpp_quote("#define STATE_SYSTEM_SELECTED        0x00000002")
 113 cpp_quote("#define STATE_SYSTEM_FOCUSED         0x00000004")
 114 cpp_quote("#define STATE_SYSTEM_PRESSED         0x00000008")
 115 cpp_quote("#define STATE_SYSTEM_CHECKED         0x00000010")
 116 cpp_quote("#define STATE_SYSTEM_MIXED           0x00000020")
 117 cpp_quote("#define STATE_SYSTEM_INDETERMINATE   STATE_SYSTEM_MIXED")
 118 cpp_quote("#define STATE_SYSTEM_READONLY        0x00000040")
 119 cpp_quote("#define STATE_SYSTEM_HOTTRACKED      0x00000080")
 120 cpp_quote("#define STATE_SYSTEM_DEFAULT         0x00000100")
 121 cpp_quote("#define STATE_SYSTEM_EXPANDED        0x00000200")
 122 cpp_quote("#define STATE_SYSTEM_COLLAPSED       0x00000400")
 123 cpp_quote("#define STATE_SYSTEM_BUSY            0x00000800")
 124 cpp_quote("#define STATE_SYSTEM_FLOATING        0x00001000")
 125 cpp_quote("#define STATE_SYSTEM_MARQUEED        0x00002000")
 126 cpp_quote("#define STATE_SYSTEM_ANIMATED        0x00004000")
 127 cpp_quote("#define STATE_SYSTEM_INVISIBLE       0x00008000")
 128 cpp_quote("#define STATE_SYSTEM_OFFSCREEN       0x00010000")
 129 cpp_quote("#define STATE_SYSTEM_SIZEABLE        0x00020000")
 130 cpp_quote("#define STATE_SYSTEM_MOVEABLE        0x00040000")
 131 cpp_quote("#define STATE_SYSTEM_SELFVOICING     0x00080000")
 132 cpp_quote("#define STATE_SYSTEM_FOCUSABLE       0x00100000")
 133 cpp_quote("#define STATE_SYSTEM_SELECTABLE      0x00200000")
 134 cpp_quote("#define STATE_SYSTEM_LINKED          0x00400000")
 135 cpp_quote("#define STATE_SYSTEM_TRAVERSED       0x00800000")
 136 cpp_quote("#define STATE_SYSTEM_MULTISELECTABLE 0x01000000")
 137 cpp_quote("#define STATE_SYSTEM_EXTSELECTABLE   0x02000000")
 138 cpp_quote("#define STATE_SYSTEM_ALERT_LOW       0x04000000")
 139 cpp_quote("#define STATE_SYSTEM_ALERT_MEDIUM    0x08000000")
 140 cpp_quote("#define STATE_SYSTEM_ALERT_HIGH      0x10000000")
 141 cpp_quote("#define STATE_SYSTEM_PROTECTED       0x20000000")
 142 cpp_quote("#define STATE_SYSTEM_VALID           0x7FFFFFFF")
 143 cpp_quote("#endif")
 144 cpp_quote("#ifndef STATE_SYSTEM_HASPOPUP")
 145 cpp_quote("#define STATE_SYSTEM_HASPOPUP        0x40000000")
 146 cpp_quote("#endif")
 147
 148 typedef GUID MSAAPROPID;
 149
 150 typedef enum AnnoScope
 151 {
 152     ANNO_THIS,
 153     ANNO_CONTAINER
 154 } AnnoScope;
 155
 156 [
 157   local,
 158   object,
 159   uuid(618736e0-3c3d-11cf-810c-00aa00389b71),
 160   pointer_default(unique)
 161 ]
 162 interface IAccessible : IDispatch
 163 {
 164     typedef [unique] IAccessible  *LPACCESSIBLE;
 165     const long DISPID_ACC_PARENT     = -5000;
 166     const long DISPID_ACC_CHILDCOUNT = -5001;
 167     const long DISPID_ACC_CHILD      = -5002;
 168     const long DISPID_ACC_NAME       = -5003;
 169     const long DISPID_ACC_VALUE      = -5004;
 170     const long DISPID_ACC_DESCRIPTION= -5005;
 171     const long DISPID_ACC_ROLE       = -5006;
 172     const long DISPID_ACC_STATE      = -5007;
 173     const long DISPID_ACC_HELP       = -5008;
 174     const long DISPID_ACC_HELPTOPIC  = -5009;
 175     const long DISPID_ACC_KEYBOARDSHORTCUT = -5010;
 176     const long DISPID_ACC_FOCUS      = -5011;
 177     const long DISPID_ACC_SELECTION  = -5012;
 178     const long DISPID_ACC_DEFAULTACTION = -5013;
 179     const long DISPID_ACC_SELECT     = -5014;
 180     const long DISPID_ACC_LOCATION   = -5015;
 181     const long DISPID_ACC_NAVIGATE   = -5016;
 182     const long DISPID_ACC_HITTEST    = -5017;
 183     const long DISPID_ACC_DODEFAULTACTION = -5018;
 184
 185     [hidden, propget, id(DISPID_ACC_PARENT)] HRESULT accParent([out, retval]IDispatch** ppdispParent);
 186     [hidden, propget, id(DISPID_ACC_CHILDCOUNT)] HRESULT accChildCount([out, retval] long* pcountChildren);
 187     [hidden, propget, id(DISPID_ACC_CHILD)] HRESULT accChild([in] VARIANT varChildID, [out, retval]IDispatch **ppdispChild);
 188     [hidden, propget, id(DISPID_ACC_NAME)] HRESULT accName([in]VARIANT varID, [out, retval] BSTR* pszName);
 189     [hidden, propget, id(DISPID_ACC_VALUE)] HRESULT accValue([in]VARIANT varID, [out, retval] BSTR* pszValue);
 190     [hidden, propget, id(DISPID_ACC_DESCRIPTION)] HRESULT accDescription([in]VARIANT varID, [out, retval] BSTR* pszDescription);
 191     [hidden, propget, id(DISPID_ACC_ROLE)] HRESULT accRole([in]VARIANT varID, [out, retval]VARIANT* pvarRole);
 192     [hidden, propget, id(DISPID_ACC_STATE)] HRESULT accState([in]VARIANT varID, [out, retval]VARIANT* pvarState);
 193     [hidden, propget, id(DISPID_ACC_HELP)] HRESULT accHelp([in]VARIANT varID, [out, retval]BSTR* pszHelp);
 194     [hidden, propget, id(DISPID_ACC_HELPTOPIC)] HRESULT accHelpTopic([out]BSTR* pszHelpFile, [in]VARIANT varID, [out, retval] long* pidTopic);
 195     [hidden, propget, id(DISPID_ACC_KEYBOARDSHORTCUT)] HRESULT accKeyboardShortcut([in]VARIANT varID, [out, retval] BSTR* pszKeyboardShortcut);
 196     [hidden, propget, id(DISPID_ACC_FOCUS)] HRESULT accFocus([out, retval] VARIANT* pvarID);
 197     [hidden, propget, id(DISPID_ACC_SELECTION)] HRESULT accSelection([out, retval] VARIANT* pvarID);
 198     [hidden, propget, id(DISPID_ACC_DEFAULTACTION)] HRESULT accDefaultAction([in]VARIANT varID, [out, retval] BSTR* pszDefaultAction);
 199
 200     [hidden, id(DISPID_ACC_SELECT)] HRESULT accSelect([in]long flagsSelect, [in]VARIANT varID);
 201     [hidden, id(DISPID_ACC_LOCATION)] HRESULT accLocation([out]long* pxLeft, [out]long* pyTop, [out]long* pcxWidth, [out]long* pcyHeight, [in]VARIANT varID);
 202     [hidden, id(DISPID_ACC_NAVIGATE)] HRESULT accNavigate([in]long navDir, [in]VARIANT varStart, [out, retval] VARIANT* pvarEnd);
 203     [hidden, id(DISPID_ACC_HITTEST)] HRESULT accHitTest([in]long xLeft, [in]long yTop, [out,retval] VARIANT* pvarID);
 204     [hidden, id(DISPID_ACC_DODEFAULTACTION)] HRESULT accDoDefaultAction([in]VARIANT varID);
 205
 206     [hidden, propput, id(DISPID_ACC_NAME)] HRESULT accName([in]VARIANT varID, [in]BSTR pszName);
 207     [hidden, propput, id(DISPID_ACC_VALUE)] HRESULT accValue([in]VARIANT varID, [out, retval]BSTR pszValue);
 208 }
 209
 210 [
 211     object,
 212     uuid(03022430-ABC4-11d0-BDE2-00AA001A1953),
 213     hidden,
 214     oleautomation,
 215     pointer_default(unique)
 216 ]
 217 interface IAccessibleHandler : IUnknown
 218 {
 219     typedef [unique] IAccessibleHandler *LPACCESSIBLEHANDLER;
 220
 221     HRESULT AccessibleObjectFromID( [in] long hwnd, [in] long lObjectID, [out] LPACCESSIBLE *pIAccessible );
 222 }
 223
 224 [
 225     object,
 226     uuid(7852b78d-1cfd-41c1-a615-9c0c85960b5f),
 227     pointer_default(unique)
 228 ]
 229 interface IAccIdentity : IUnknown
 230 {
 231     HRESULT GetIdentityString ([in] DWORD dwIDChild, [out] BYTE **ppIDString, [out] DWORD *pdwIDStringLen);
 232 }
 233
 234 [
 235     object,
 236     uuid(76c0dbbb-15e0-4e7b-b61b-20eeea2001e0),
 237     pointer_default(unique)
 238 ]
 239 interface IAccPropServer: IUnknown
 240 {
 241     HRESULT GetPropValue ([in] const BYTE *pIDString, [in] DWORD  dwIDStringLen, [in] MSAAPROPID idProp,
 242         [out] VARIANT *pvarValue, [out] BOOL *pfHasProp);
 243 }
 244
 245 [
 246     object,
 247     uuid(6e26e776-04f0-495d-80e4-3330352e3169),
 248     pointer_default(unique)
 249 ]
 250 interface IAccPropServices : IUnknown
 251 {
 252     HRESULT SetPropValue([in] const BYTE *pIDString, [in] DWORD dwIDStringLen, [in] MSAAPROPID idProp, [in] VARIANT var);
 253
 254     HRESULT SetPropServer([in] const BYTE * pIDString, [in] DWORD dwIDStringLen, [in] const MSAAPROPID* paProps,
 255                     [in] int cProps, [in] IAccPropServer* pServer, [in] AnnoScope AnnoScope);
 256
 257     HRESULT ClearProps([in] const BYTE *pIDString, [in] DWORD dwIDStringLen, [in] const MSAAPROPID* paProps, [in] int cProps);
 258
 259     HRESULT SetHwndProp([in] HWND hwnd, [in] DWORD idObject, [in] DWORD idChild,
 260                     [in] MSAAPROPID idProp, [in] VARIANT var);
 261
 262     HRESULT SetHwndPropStr([in] HWND hwnd, [in] DWORD idObject, [in] DWORD idChild,
 263                     [in] MSAAPROPID idProp, [in] LPWSTR str);
 264
 265     HRESULT SetHwndPropServer([in] HWND hwnd, [in] DWORD idObject, [in] DWORD idChild,
 266                     [in] const MSAAPROPID* paProps, [in] int cProps, [in] IAccPropServer* pServer, [in] AnnoScope AnnoScope);
 267
 268     HRESULT ClearHwndProps([in] HWND hwnd, [in] DWORD idObject, [in] DWORD idChild,
 269                     [in] const MSAAPROPID* paProps, [in] int cProps);
 270
 271     HRESULT ComposeHwndIdentityString([in] HWND hwnd, [in] DWORD idObject, [in] DWORD idChild,
 272                     [out] BYTE **ppIDString, [out] DWORD* pdwIDStringLen);
 273
 274     HRESULT DecomposeHwndIdentityString([in] const BYTE *pIDString, [in] DWORD dwIDStringLen,
 275                     [out] HWND* phwnd, [out] DWORD* pidObject, [out] DWORD* pidChild);
 276
 277     HRESULT SetHmenuProp([in] HMENU hmenu, [in] DWORD idChild, [in] MSAAPROPID idProp, [in] VARIANT var);
 278
 279     HRESULT SetHmenuPropStr([in] HMENU hmenu, [in] DWORD idChild, [in] MSAAPROPID idProp, [in] LPWSTR str);
 280
 281     HRESULT SetHmenuPropServer([in] HMENU hmenu, [in] DWORD idChild, [in] const MSAAPROPID* paProps,
 282                     [in] int cProps, [in] IAccPropServer* pServer, [in] AnnoScope AnnoScope);
 283
 284     HRESULT ClearHmenuProps([in] HMENU hmenu, [in] DWORD idChild, [in] const MSAAPROPID* paProps, [in] int cProps);
 285
 286     HRESULT ComposeHmenuIdentityString([in] HMENU hmenu, [in] DWORD idChild,
 287                     [out] BYTE **ppIDString, [out] DWORD *pdwIDStringLen);
 288
 289     HRESULT DecomposeHmenuIdentityString([in] const BYTE *pIDString, [in] DWORD dwIDStringLen,
 290                     [out] HMENU *phmenu, [out] DWORD *pidChild);
 291 }
 292
 293 [
 294     uuid(1ea4dbf0-3c3b-11cf-810c-00aa00389b71),
 295     lcid(0),
 296     version(1.1),
 297     hidden
 298 ]
 299 library Accessibility
 300 {
 301     importlib ("stdole2.tlb");
 302     interface IAccessible;
 303     interface IAccessibleHandler;
 304
 305     interface IAccIdentity;
 306     interface IAccPropServer;
 307     interface IAccPropServices;
 308
 309     [
 310         uuid(b5f8350b-0548-48b1-a6ee-88bd00b4a5e7),
 311         threading(apartment)
 312     ]
 313     coclass CAccPropServices
 314     {
 315         interface IAccPropServices;
 316     }
 317 };
 318
 319 cpp_quote("DEFINE_GUID(CLSID_AccPropServices, 0xb5f8350b, 0x0548, 0x48b1, 0xa6, 0xee, 0x88, 0xbd, 0x00, 0xb4, 0xa5, 0xe7);")
 320 cpp_quote("DEFINE_GUID(IIS_IsOleaccProxy, 0x902697fa, 0x80e4, 0x4560, 0x80, 0x2a, 0xa1, 0x3f, 0x22, 0xa6, 0x47, 0x09);")
 321
 322 cpp_quote("LRESULT WINAPI LresultFromObject(REFIID,WPARAM,LPUNKNOWN);")
 323 cpp_quote("HRESULT WINAPI ObjectFromLresult(LRESULT,REFIID,WPARAM,void **);")
 324 cpp_quote("HRESULT WINAPI WindowFromAccessibleObject(IAccessible *,HWND *);")
 325 cpp_quote("HRESULT WINAPI AccessibleObjectFromWindow(HWND,DWORD,REFIID,void **);")
 326 cpp_quote("HRESULT WINAPI AccessibleObjectFromEvent(HWND,DWORD,DWORD,IAccessible **,VARIANT *);")
 327 cpp_quote("HRESULT WINAPI AccessibleObjectFromPoint(POINT,IAccessible **,VARIANT *);")
 328 cpp_quote("HRESULT WINAPI AccessibleChildren(IAccessible *,LONG,LONG,VARIANT *,LONG *);")
 329
 330 cpp_quote("void WINAPI GetOleaccVersionInfo(DWORD *,DWORD *);")
 331 cpp_quote("HRESULT WINAPI CreateStdAccessibleObject(HWND,LONG,REFIID,void **);")
 332 cpp_quote("HRESULT WINAPI CreateStdAccessibleProxyA(HWND,LPCSTR,LONG,REFIID,void **);")
 333 cpp_quote("HRESULT WINAPI CreateStdAccessibleProxyW(HWND,LPCWSTR,LONG,REFIID,void **);")
 334 cpp_quote("#define CreateStdAccessibleProxy WINELIB_NAME_AW(CreateStdAccessibleProxy)")
 335
 336 cpp_quote("UINT WINAPI GetRoleTextA(DWORD,LPSTR,UINT);")
 337 cpp_quote("UINT WINAPI GetRoleTextW(DWORD,LPWSTR,UINT);")
 338 cpp_quote("#define GetRoleText WINELIB_NAME_AW(GetRoleText)")
 339 cpp_quote("UINT WINAPI GetStateTextA(DWORD,LPSTR,UINT);")
 340 cpp_quote("UINT WINAPI GetStateTextW(DWORD,LPWSTR,UINT);")
 341 cpp_quote("#define GetStateText WINELIB_NAME_AW(GetStateText)")