SciterSharpWindows.XML 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>SciterSharpWindows</name>
  5. </assembly>
  6. <members>
  7. <member name="M:SciterSharp.MessageBox.ShowMessageBox(SciterSharp.SciterWindow,System.String,System.String)">
  8. <summary>
  9. Show a system message-box owned by this Sciter window. If caption is null, it will be the title of the Sciter window
  10. </summary>
  11. <param name="wnd"></param>
  12. <param name="text"></param>
  13. <param name="caption"></param>
  14. </member>
  15. <member name="T:SciterSharp.Interop.PInvokeWindows.MessageBoxOptions">
  16. <summary>
  17. Flags that define appearance and behaviour of a standard message box displayed by a call to the MessageBox function.
  18. </summary>
  19. </member>
  20. <member name="T:SciterSharp.Interop.PInvokeWindows.MessageBoxResult">
  21. <summary>
  22. Represents possible values returned by the MessageBox function.
  23. </summary>
  24. </member>
  25. <member name="T:SciterSharp.Interop.ScreenCapture">
  26. <summary>
  27. Provides functions to capture the entire screen, or a particular window, and save it to a file.
  28. </summary>
  29. </member>
  30. <member name="M:SciterSharp.Interop.ScreenCapture.CaptureScreen">
  31. <summary>
  32. Creates an Image object containing a screen shot of the entire desktop
  33. </summary>
  34. <returns></returns>
  35. </member>
  36. <member name="M:SciterSharp.Interop.ScreenCapture.CaptureWindow(System.IntPtr)">
  37. <summary>
  38. Creates an Image object containing a screen shot of a specific window
  39. </summary>
  40. <param name="handle">The handle to the window. (In windows forms, this is obtained by the Handle property)</param>
  41. <returns></returns>
  42. </member>
  43. <member name="M:SciterSharp.Interop.ScreenCapture.CaptureWindowToFile(System.IntPtr,System.String,System.Drawing.Imaging.ImageFormat)">
  44. <summary>
  45. Captures a screen shot of a specific window, and saves it to a file
  46. </summary>
  47. <param name="handle"></param>
  48. <param name="filename"></param>
  49. <param name="format"></param>
  50. </member>
  51. <member name="M:SciterSharp.Interop.ScreenCapture.CaptureScreenToFile(System.String,System.Drawing.Imaging.ImageFormat)">
  52. <summary>
  53. Captures a screen shot of the entire desktop, and saves it to a file
  54. </summary>
  55. <param name="filename"></param>
  56. <param name="format"></param>
  57. </member>
  58. <member name="T:SciterSharp.Interop.ScreenCapture.GDI32">
  59. <summary>
  60. Helper class containing Gdi32 API functions
  61. </summary>
  62. </member>
  63. <member name="T:SciterSharp.Interop.ScreenCapture.User32">
  64. <summary>
  65. Helper class containing User32 API functions
  66. </summary>
  67. </member>
  68. <member name="M:SciterSharp.SciterDebugOutputHandler.#ctor">
  69. <summary>
  70. Setup a global debug output handler
  71. </summary>
  72. </member>
  73. <member name="M:SciterSharp.SciterDebugOutputHandler.#ctor(System.IntPtr)">
  74. <summary>
  75. Setup a Sciter window specific debug output handler
  76. </summary>
  77. <param name="hwnd"></param>
  78. </member>
  79. <member name="M:SciterSharp.SciterElement.Test(System.String)">
  80. <summary>
  81. Test this element against CSS selector(s)
  82. </summary>
  83. </member>
  84. <member name="M:SciterSharp.SciterImage.#ctor(System.Byte[])">
  85. <summary>
  86. Loads image from PNG or JPG image buffer
  87. </summary>
  88. </member>
  89. <member name="M:SciterSharp.SciterImage.#ctor(System.IntPtr,System.UInt32,System.UInt32,System.Boolean)">
  90. <summary>
  91. Loads image from RAW BGRA pixmap data
  92. Size of pixmap data is pixmapWidth*pixmapHeight*4
  93. construct image from B[n+0],G[n+1],R[n+2],A[n+3] data
  94. </summary>
  95. </member>
  96. <member name="M:SciterSharp.SciterImage.Save(System.UInt32,System.UInt32)">
  97. <summary>
  98. Save this image to png/jpeg stream of bytes
  99. </summary>
  100. <param name="bpp">24 or 32 if alpha needed</param>
  101. <param name="quality">png: 0, jpeg: 10 - 100</param>
  102. </member>
  103. <member name="M:SciterSharp.SciterHost.AttachEvh(SciterSharp.SciterEventHandler)">
  104. <summary>
  105. Attacheds a window level event-handler: it receives every event for all elements of the page.
  106. You can only attach a single event-handler.
  107. </summary>
  108. <param name="evh"></param>
  109. </member>
  110. <member name="M:SciterSharp.SciterHost.InvokePost(System.Action)">
  111. <summary>
  112. Posts a message to the UI thread to invoke the given Action. This methods returns immediatly, does not wait for the message processing.
  113. </summary>
  114. <param name="what">The delegate which will be invoked</param>
  115. </member>
  116. <member name="M:SciterSharp.SciterHost.InvokeSend(System.Action,System.UInt32)">
  117. <summary>
  118. Sends a message to the UI thread to invoke the given Action. This methods waits for the message processing until timeout is exceeded.
  119. </summary>
  120. <param name="what">The delegate which will be invoked</param>
  121. </member>
  122. <member name="M:SciterSharp.SciterHost.DebugInspect">
  123. <summary>
  124. Runs the inspector process, waits 1 second, and calls view.connectToInspector() to inspect your page.
  125. Assumes that the 'inspector(.exe)' executable is in the same directory of OmniCode.dll assembly (so just it to its dir)
  126. (Before everything it kills any previous instance of the inspector process)
  127. </summary>
  128. </member>
  129. <member name="M:SciterSharp.SciterHost.DebugInspect(System.String)">
  130. <summary>
  131. Runs the inspector process, waits 1 second, and calls view.connectToInspector() to inspect your page.
  132. (Before everything it kills any previous instance of the inspector process)
  133. </summary>
  134. <param name="inspector_exe_path">Path to the inspector executable, can be an absolute or relative path.</param>
  135. </member>
  136. <member name="M:SciterSharp.SciterHost.PostNotification(System.IntPtr,System.IntPtr,System.UInt32)">
  137. <summary>
  138. Sciter cross-platform alternative for posting a message in the message queue.
  139. It will be received as a SC_POSTED_NOTIFICATION notification by this SciterHost instance.
  140. Override OnPostedNotification() to handle it.
  141. </summary>
  142. <param name="timeout">
  143. If timeout is > 0 this methods SENDs the message instead of POSTing and this is the timeout for waiting the processing of the message. Leave it as 0 for actually POSTing the message.
  144. </param>
  145. </member>
  146. <member name="M:SciterSharp.SciterValue.MakeError(System.String)">
  147. <summary>
  148. Returns SciterValue representing error.
  149. If such value is used as a return value from native function the script runtime will throw an error in script rather than returning that value.
  150. </summary>
  151. </member>
  152. <member name="M:SciterSharp.SciterWindow.CreateWindow(SciterSharp.Interop.PInvokeUtils.RECT,SciterSharp.Interop.SciterXDef.SCITER_CREATE_WINDOW_FLAGS,System.IntPtr)">
  153. <summary>
  154. Creates the Sciter window and returns the native handle
  155. </summary>
  156. <param name="frame">Rectangle of the window</param>
  157. <param name="creationFlags">Flags for the window creation, defaults to SW_MAIN | SW_TITLEBAR | SW_RESIZEABLE | SW_CONTROLS | SW_ENABLE_DEBUG</param>
  158. </member>
  159. <member name="M:SciterSharp.SciterWindow.CenterTopLevelWindow">
  160. <summary>
  161. Centers the window in the screen. You must call it after the window is created, but before it is shown to avoid flickering
  162. </summary>
  163. </member>
  164. <member name="M:SciterSharp.SciterWindow.GetPrimaryMonitorScreenSize">
  165. <summary>
  166. Cross-platform handy method to get the size of the screen
  167. </summary>
  168. <returns>SIZE measures of the screen of primary monitor</returns>
  169. </member>
  170. <member name="M:SciterSharp.SciterWindow.LoadPage(System.String)">
  171. <summary>
  172. Loads the page resource from the given URL or file path
  173. </summary>
  174. <param name="url_or_filepath">URL or file path of the page</param>
  175. </member>
  176. <member name="M:SciterSharp.SciterWindow.LoadHtml(System.String,System.String)">
  177. <summary>
  178. Loads HTML input from a string
  179. </summary>
  180. <param name="html">HTML of the page to be loaded</param>
  181. <param name="baseUrl">Base Url given to the loaded page</param>
  182. </member>
  183. <member name="M:SciterSharp.SciterWindow.Close">
  184. <summary>
  185. Close the window. Posts WM_CLOSE message on Windows.
  186. </summary>
  187. </member>
  188. <member name="M:SciterSharp.SciterWindow.ElementAtPoint(System.Int32,System.Int32)">
  189. <summary>
  190. Find element at point x/y of the window, client area relative
  191. </summary>
  192. </member>
  193. <member name="M:SciterSharp.SciterWindow.ElementByUID(System.UInt32)">
  194. <summary>
  195. Searches this windows DOM tree for element with the given UID
  196. </summary>
  197. <returns>The element, or null if it doesn't exists</returns>
  198. </member>
  199. <member name="M:SciterSharp.SciterWindow.UpdateWindow">
  200. <summary>
  201. Update pending changes in Sciter window and forces painting if necessary
  202. </summary>
  203. </member>
  204. <member name="M:SciterSharp.SciterWindow.SetMediaType(System.String)">
  205. <summary>
  206. For example media type can be "handheld", "projection", "screen", "screen-hires", etc.
  207. By default sciter window has "screen" media type.
  208. Media type name is used while loading and parsing style sheets in the engine so
  209. you should call this function* before* loading document in it.
  210. </summary>
  211. </member>
  212. <member name="M:SciterSharp.SciterWindow.SetMediaVars(SciterSharp.SciterValue)">
  213. <summary>
  214. For example media type can be "handheld:true", "projection:true", "screen:true", etc.
  215. By default sciter window has "screen:true" and "desktop:true"/"handheld:true" media variables.
  216. Media variables can be changed in runtime. This will cause styles of the document to be reset.
  217. </summary>
  218. <param name="mediaVars">Map that contains name/value pairs - media variables to be set</param>
  219. </member>
  220. <member name="F:SciterSharp.Interop.SciterXBehaviors.EVENT_GROUPS.HANDLE_MOUSE">
  221. attached/detached
  222. </member>
  223. <member name="F:SciterSharp.Interop.SciterXBehaviors.EVENT_GROUPS.HANDLE_KEY">
  224. mouse events
  225. </member>
  226. <member name="F:SciterSharp.Interop.SciterXBehaviors.EVENT_GROUPS.HANDLE_FOCUS">
  227. key events
  228. </member>
  229. <member name="F:SciterSharp.Interop.SciterXBehaviors.EVENT_GROUPS.HANDLE_SCROLL">
  230. focus events, if this flag is set it also means that element it attached to is focusable
  231. </member>
  232. <member name="F:SciterSharp.Interop.SciterXBehaviors.EVENT_GROUPS.HANDLE_TIMER">
  233. scroll events
  234. </member>
  235. <member name="F:SciterSharp.Interop.SciterXBehaviors.EVENT_GROUPS.HANDLE_SIZE">
  236. timer event
  237. </member>
  238. <member name="F:SciterSharp.Interop.SciterXBehaviors.EVENT_GROUPS.HANDLE_DRAW">
  239. size changed event
  240. </member>
  241. <member name="F:SciterSharp.Interop.SciterXBehaviors.EVENT_GROUPS.HANDLE_DATA_ARRIVED">
  242. drawing request (event)
  243. </member>
  244. <member name="F:SciterSharp.Interop.SciterXBehaviors.EVENT_GROUPS.HANDLE_BEHAVIOR_EVENT">
  245. requested data () has been delivered
  246. </member>
  247. <member name="F:SciterSharp.Interop.SciterXBehaviors.EVENT_GROUPS.HANDLE_METHOD_CALL">
  248. logical, synthetic events:
  249. BUTTON_CLICK, HYPERLINK_CLICK, etc.,
  250. a.k.a. notifications from intrinsic behaviors
  251. </member>
  252. <member name="F:SciterSharp.Interop.SciterXBehaviors.EVENT_GROUPS.HANDLE_SCRIPTING_METHOD_CALL">
  253. behavior specific methods
  254. </member>
  255. <member name="F:SciterSharp.Interop.SciterXBehaviors.EVENT_GROUPS.HANDLE_TISCRIPT_METHOD_CALL">
  256. behavior specific methods
  257. </member>
  258. <member name="F:SciterSharp.Interop.SciterXBehaviors.EVENT_GROUPS.HANDLE_EXCHANGE">
  259. behavior specific methods using direct tiscript::value's
  260. </member>
  261. <member name="F:SciterSharp.Interop.SciterXBehaviors.EVENT_GROUPS.HANDLE_GESTURE">
  262. system drag-n-drop
  263. </member>
  264. <member name="F:SciterSharp.Interop.SciterXBehaviors.EVENT_GROUPS.HANDLE_ALL">
  265. touch input events
  266. </member>
  267. <member name="F:SciterSharp.Interop.SciterXBehaviors.GESTURE_PARAMS.flags">
  268. <summary>
  269. GESTURE_TYPE_FLAGS or GESTURE_STATE combination
  270. </summary>
  271. </member>
  272. <member name="F:SciterSharp.Interop.SciterXDef.LoadResult.LOAD_OK">
  273. <summary>
  274. do default loading if data not set
  275. </summary>
  276. </member>
  277. <member name="F:SciterSharp.Interop.SciterXDef.LoadResult.LOAD_DISCARD">
  278. <summary>
  279. discard request completely
  280. </summary>
  281. </member>
  282. <member name="F:SciterSharp.Interop.SciterXDef.LoadResult.LOAD_DELAYED">
  283. <summary>
  284. data will be delivered later by the host
  285. Host application must call SciterDataReadyAsync(,,, requestId) on each LOAD_DELAYED request to avoid memory leaks.
  286. </summary>
  287. </member>
  288. <member name="F:SciterSharp.Interop.SciterXDef.LoadResult.LOAD_MYSELF">
  289. <summary>
  290. you return LOAD_MYSELF result to indicate that your (the host) application took or will take care about HREQUEST in your code completely.
  291. Use sciter-x-request.h[pp] API functions with SCN_LOAD_DATA::requestId handle.
  292. </summary>
  293. </member>
  294. <member name="F:SciterSharp.Interop.SciterXDef.SCITER_RT_OPTIONS.SCITER_SMOOTH_SCROLL">
  295. <summary>value:TRUE - enable, value:FALSE - disable, enabled by default</summary>
  296. </member>
  297. <member name="F:SciterSharp.Interop.SciterXDef.SCITER_RT_OPTIONS.SCITER_CONNECTION_TIMEOUT">
  298. <summary>value: milliseconds, connection timeout of http client</summary>
  299. </member>
  300. <member name="F:SciterSharp.Interop.SciterXDef.SCITER_RT_OPTIONS.SCITER_HTTPS_ERROR">
  301. <summary>value: 0 - drop connection, 1 - use builtin dialog, 2 - accept connection silently</summary>
  302. </member>
  303. <member name="F:SciterSharp.Interop.SciterXDef.SCITER_RT_OPTIONS.SCITER_FONT_SMOOTHING">
  304. <summary>value: 0 - system default, 1 - no smoothing, 2 - std smoothing, 3 - clear type</summary>
  305. </member>
  306. <member name="F:SciterSharp.Interop.SciterXDef.SCITER_RT_OPTIONS.SCITER_TRANSPARENT_WINDOW">
  307. <summary>
  308. Windows Aero support, value:
  309. 0 - normal drawing,
  310. 1 - window has transparent background after calls DwmExtendFrameIntoClientArea() or DwmEnableBlurBehindWindow()
  311. </summary>
  312. </member>
  313. <member name="F:SciterSharp.Interop.SciterXDef.SCITER_RT_OPTIONS.SCITER_SET_GPU_BLACKLIST">
  314. <summary>
  315. hWnd = NULL,
  316. value = LPCBYTE, json - GPU black list, see: gpu-blacklist.json resource.
  317. </summary>
  318. </member>
  319. <member name="F:SciterSharp.Interop.SciterXDef.SCITER_RT_OPTIONS.SCITER_SET_SCRIPT_RUNTIME_FEATURES">
  320. <summary>value - combination of SCRIPT_RUNTIME_FEATURES flags.</summary>
  321. </member>
  322. <member name="F:SciterSharp.Interop.SciterXDef.SCITER_RT_OPTIONS.SCITER_SET_GFX_LAYER">
  323. <summary>hWnd = NULL, value - GFX_LAYER</summary>
  324. </member>
  325. <member name="F:SciterSharp.Interop.SciterXDef.SCITER_RT_OPTIONS.SCITER_SET_DEBUG_MODE">
  326. <summary>hWnd, value - TRUE/FALSE</summary>
  327. </member>
  328. <member name="F:SciterSharp.Interop.SciterXDef.SCITER_RT_OPTIONS.SCITER_SET_UX_THEMING">
  329. <summary>
  330. hWnd = NULL, value - BOOL, TRUE - the engine will use "unisex" theme that is common for all platforms.
  331. That UX theme is not using OS primitives for rendering input elements. Use it if you want exactly
  332. the same (modulo fonts) look-n-feel on all platforms.
  333. </summary>
  334. </member>
  335. <member name="F:SciterSharp.Interop.SciterXDef.SCITER_RT_OPTIONS.SCITER_ALPHA_WINDOW">
  336. <summary>hWnd, value - TRUE/FALSE - window uses per pixel alpha (e.g. WS_EX_LAYERED/UpdateLayeredWindow() window)</summary>
  337. </member>
  338. <member name="F:SciterSharp.Interop.SciterXDef.SCITER_CREATE_WINDOW_FLAGS.SW_CHILD">
  339. <summary>Child window only, if this flag is set all other flags ignored</summary>
  340. </member>
  341. <member name="F:SciterSharp.Interop.SciterXDef.SCITER_CREATE_WINDOW_FLAGS.SW_TITLEBAR">
  342. <summary>Toplevel window, has titlebar</summary>
  343. </member>
  344. <member name="F:SciterSharp.Interop.SciterXDef.SCITER_CREATE_WINDOW_FLAGS.SW_RESIZEABLE">
  345. <summary>Has resizeable frame</summary>
  346. </member>
  347. <member name="F:SciterSharp.Interop.SciterXDef.SCITER_CREATE_WINDOW_FLAGS.SW_TOOL">
  348. <summary>Is tool window</summary>
  349. </member>
  350. <member name="F:SciterSharp.Interop.SciterXDef.SCITER_CREATE_WINDOW_FLAGS.SW_CONTROLS">
  351. <summary>Has minimize / maximize buttons</summary>
  352. </member>
  353. <member name="F:SciterSharp.Interop.SciterXDef.SCITER_CREATE_WINDOW_FLAGS.SW_GLASSY">
  354. <summary>Glassy window ( DwmExtendFrameIntoClientArea on windows )</summary>
  355. </member>
  356. <member name="F:SciterSharp.Interop.SciterXDef.SCITER_CREATE_WINDOW_FLAGS.SW_ALPHA">
  357. <summary>Transparent window ( e.g. WS_EX_LAYERED on Windows )</summary>
  358. </member>
  359. <member name="F:SciterSharp.Interop.SciterXDef.SCITER_CREATE_WINDOW_FLAGS.SW_MAIN">
  360. <summary>Main window of the app, will terminate app on close</summary>
  361. </member>
  362. <member name="F:SciterSharp.Interop.SciterXDef.SCITER_CREATE_WINDOW_FLAGS.SW_POPUP">
  363. <summary> The window is created as topmost</summary>
  364. </member>
  365. <member name="F:SciterSharp.Interop.SciterXDef.SCITER_CREATE_WINDOW_FLAGS.SW_ENABLE_DEBUG">
  366. <summary>Make this window inspector ready</summary>
  367. </member>
  368. <member name="F:SciterSharp.Interop.SciterXDef.SCITER_CREATE_WINDOW_FLAGS.SW_OWNS_VM">
  369. <summary>It has its own script VM</summary>
  370. </member>
  371. <member name="T:SciterSharp.WinForms.SciterControl">
  372. <summary>
  373. Represents a SciterWindow control.
  374. </summary>
  375. </member>
  376. </members>
  377. </doc>