UI.xml 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830
  1. <Type Name="UI" FullName="Urho.UI">
  2. <TypeSignature Language="C#" Value="public class UI : Urho.UrhoObject" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit UI extends Urho.UrhoObject" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>Urho.UrhoObject</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>
  14. %UI subsystem. Manages the graphical user interface.
  15. </summary>
  16. <remarks>To be added.</remarks>
  17. </Docs>
  18. <Members>
  19. <Member MemberName=".ctor">
  20. <MemberSignature Language="C#" Value="public UI (IntPtr handle);" />
  21. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  22. <MemberType>Constructor</MemberType>
  23. <AssemblyInfo>
  24. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  25. </AssemblyInfo>
  26. <Parameters>
  27. <Parameter Name="handle" Type="System.IntPtr" />
  28. </Parameters>
  29. <Docs>
  30. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  31. <summary>Constructs a new instance of UI, given a raw pointer to an unmanaged object</summary>
  32. <remarks>
  33. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  34. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  35. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  36. </remarks>
  37. </Docs>
  38. </Member>
  39. <Member MemberName=".ctor">
  40. <MemberSignature Language="C#" Value="public UI (Urho.Context context);" />
  41. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context context) cil managed" />
  42. <MemberType>Constructor</MemberType>
  43. <AssemblyInfo>
  44. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  45. </AssemblyInfo>
  46. <Parameters>
  47. <Parameter Name="context" Type="Urho.Context" />
  48. </Parameters>
  49. <Docs>
  50. <param name="context">The context that this object will be attached to.</param>
  51. <summary>Creates an instance of UI that is attached to an execution context.</summary>
  52. <remarks>
  53. <para>This creates an instance of UI attached to the specified execution context.</para>
  54. </remarks>
  55. </Docs>
  56. </Member>
  57. <Member MemberName=".ctor">
  58. <MemberSignature Language="C#" Value="public UI (Urho.UrhoObjectFlag emptyFlag);" />
  59. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  60. <MemberType>Constructor</MemberType>
  61. <AssemblyInfo>
  62. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  63. </AssemblyInfo>
  64. <Parameters>
  65. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  66. </Parameters>
  67. <Docs>
  68. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  69. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  70. <remarks>
  71. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  72. <para>This essentially circumvents the default path that creates a new object and sets the handle and does not call RegisterObject on the target, you must do this on your own constructor.</para>
  73. <para>You would typically chain to this constructor from your own, and then set the handle to the unmanaged object from your code, and then register your object.</para>
  74. </remarks>
  75. </Docs>
  76. </Member>
  77. <Member MemberName="BaseType">
  78. <MemberSignature Language="C#" Value="public override Urho.StringHash BaseType { get; }" />
  79. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash BaseType" />
  80. <MemberType>Property</MemberType>
  81. <AssemblyInfo>
  82. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  83. </AssemblyInfo>
  84. <ReturnValue>
  85. <ReturnType>Urho.StringHash</ReturnType>
  86. </ReturnValue>
  87. <Docs>
  88. <summary>Urho's type system base type.</summary>
  89. <value>StringHash representing the base type for this Urho type.</value>
  90. <remarks>This returns the Urho type system base type and is surfaced for low-level Urho code.</remarks>
  91. </Docs>
  92. </Member>
  93. <Member MemberName="Clear">
  94. <MemberSignature Language="C#" Value="public void Clear ();" />
  95. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Clear() cil managed" />
  96. <MemberType>Method</MemberType>
  97. <AssemblyInfo>
  98. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  99. </AssemblyInfo>
  100. <ReturnValue>
  101. <ReturnType>System.Void</ReturnType>
  102. </ReturnValue>
  103. <Parameters />
  104. <Docs>
  105. <summary>
  106. Clear the UI (excluding the cursor.)
  107. </summary>
  108. <remarks>To be added.</remarks>
  109. </Docs>
  110. </Member>
  111. <Member MemberName="ClipboardText">
  112. <MemberSignature Language="C#" Value="public string ClipboardText { get; set; }" />
  113. <MemberSignature Language="ILAsm" Value=".property instance string ClipboardText" />
  114. <MemberType>Property</MemberType>
  115. <AssemblyInfo>
  116. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  117. </AssemblyInfo>
  118. <ReturnValue>
  119. <ReturnType>System.String</ReturnType>
  120. </ReturnValue>
  121. <Docs>
  122. <summary>
  123. Return clipboard text.
  124. Or
  125. Set clipboard text.
  126. </summary>
  127. <value>To be added.</value>
  128. <remarks>To be added.</remarks>
  129. </Docs>
  130. </Member>
  131. <Member MemberName="Cursor">
  132. <MemberSignature Language="C#" Value="public Urho.Cursor Cursor { get; set; }" />
  133. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Cursor Cursor" />
  134. <MemberType>Property</MemberType>
  135. <AssemblyInfo>
  136. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  137. </AssemblyInfo>
  138. <ReturnValue>
  139. <ReturnType>Urho.Cursor</ReturnType>
  140. </ReturnValue>
  141. <Docs>
  142. <summary>
  143. Return cursor.
  144. Or
  145. Set cursor UI element.
  146. </summary>
  147. <value>To be added.</value>
  148. <remarks>To be added.</remarks>
  149. </Docs>
  150. </Member>
  151. <Member MemberName="CursorPosition">
  152. <MemberSignature Language="C#" Value="public Urho.IntVector2 CursorPosition { get; }" />
  153. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.IntVector2 CursorPosition" />
  154. <MemberType>Property</MemberType>
  155. <AssemblyInfo>
  156. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  157. </AssemblyInfo>
  158. <ReturnValue>
  159. <ReturnType>Urho.IntVector2</ReturnType>
  160. </ReturnValue>
  161. <Docs>
  162. <summary>
  163. Return cursor position.
  164. </summary>
  165. <value>To be added.</value>
  166. <remarks>To be added.</remarks>
  167. </Docs>
  168. </Member>
  169. <Member MemberName="DebugDraw">
  170. <MemberSignature Language="C#" Value="public void DebugDraw (Urho.UIElement element);" />
  171. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void DebugDraw(class Urho.UIElement element) cil managed" />
  172. <MemberType>Method</MemberType>
  173. <AssemblyInfo>
  174. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  175. </AssemblyInfo>
  176. <ReturnValue>
  177. <ReturnType>System.Void</ReturnType>
  178. </ReturnValue>
  179. <Parameters>
  180. <Parameter Name="element" Type="Urho.UIElement" />
  181. </Parameters>
  182. <Docs>
  183. <param name="element">To be added.</param>
  184. <summary>
  185. Debug draw a UI element.
  186. </summary>
  187. <remarks>To be added.</remarks>
  188. </Docs>
  189. </Member>
  190. <Member MemberName="DefaultToolTipDelay">
  191. <MemberSignature Language="C#" Value="public float DefaultToolTipDelay { get; set; }" />
  192. <MemberSignature Language="ILAsm" Value=".property instance float32 DefaultToolTipDelay" />
  193. <MemberType>Property</MemberType>
  194. <AssemblyInfo>
  195. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  196. </AssemblyInfo>
  197. <ReturnValue>
  198. <ReturnType>System.Single</ReturnType>
  199. </ReturnValue>
  200. <Docs>
  201. <summary>
  202. Return tooltip default display delay in seconds.
  203. Or
  204. Set tooltip default display delay in seconds.
  205. </summary>
  206. <value>To be added.</value>
  207. <remarks>To be added.</remarks>
  208. </Docs>
  209. </Member>
  210. <Member MemberName="DoubleClickInterval">
  211. <MemberSignature Language="C#" Value="public float DoubleClickInterval { get; set; }" />
  212. <MemberSignature Language="ILAsm" Value=".property instance float32 DoubleClickInterval" />
  213. <MemberType>Property</MemberType>
  214. <AssemblyInfo>
  215. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  216. </AssemblyInfo>
  217. <ReturnValue>
  218. <ReturnType>System.Single</ReturnType>
  219. </ReturnValue>
  220. <Docs>
  221. <summary>
  222. Return UI element double click interval in seconds.
  223. Or
  224. Set UI element double click interval in seconds.
  225. </summary>
  226. <value>To be added.</value>
  227. <remarks>To be added.</remarks>
  228. </Docs>
  229. </Member>
  230. <Member MemberName="DragBeginDistance">
  231. <MemberSignature Language="C#" Value="public int DragBeginDistance { get; set; }" />
  232. <MemberSignature Language="ILAsm" Value=".property instance int32 DragBeginDistance" />
  233. <MemberType>Property</MemberType>
  234. <AssemblyInfo>
  235. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  236. </AssemblyInfo>
  237. <ReturnValue>
  238. <ReturnType>System.Int32</ReturnType>
  239. </ReturnValue>
  240. <Docs>
  241. <summary>
  242. Return UI drag start event distance threshold in pixels.
  243. Or
  244. Set UI drag event start distance threshold in pixels.
  245. </summary>
  246. <value>To be added.</value>
  247. <remarks>To be added.</remarks>
  248. </Docs>
  249. </Member>
  250. <Member MemberName="DragBeginInterval">
  251. <MemberSignature Language="C#" Value="public float DragBeginInterval { get; set; }" />
  252. <MemberSignature Language="ILAsm" Value=".property instance float32 DragBeginInterval" />
  253. <MemberType>Property</MemberType>
  254. <AssemblyInfo>
  255. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  256. </AssemblyInfo>
  257. <ReturnValue>
  258. <ReturnType>System.Single</ReturnType>
  259. </ReturnValue>
  260. <Docs>
  261. <summary>
  262. Return UI drag start event interval in seconds.
  263. Or
  264. Set UI drag event start interval in seconds.
  265. </summary>
  266. <value>To be added.</value>
  267. <remarks>To be added.</remarks>
  268. </Docs>
  269. </Member>
  270. <Member MemberName="FocusElement">
  271. <MemberSignature Language="C#" Value="public Urho.UIElement FocusElement { get; }" />
  272. <MemberSignature Language="ILAsm" Value=".property instance class Urho.UIElement FocusElement" />
  273. <MemberType>Property</MemberType>
  274. <AssemblyInfo>
  275. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  276. </AssemblyInfo>
  277. <ReturnValue>
  278. <ReturnType>Urho.UIElement</ReturnType>
  279. </ReturnValue>
  280. <Docs>
  281. <summary>
  282. Return focused element.
  283. </summary>
  284. <value>To be added.</value>
  285. <remarks>To be added.</remarks>
  286. </Docs>
  287. </Member>
  288. <Member MemberName="ForceAutoHint">
  289. <MemberSignature Language="C#" Value="public bool ForceAutoHint { get; set; }" />
  290. <MemberSignature Language="ILAsm" Value=".property instance bool ForceAutoHint" />
  291. <MemberType>Property</MemberType>
  292. <AssemblyInfo>
  293. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  294. </AssemblyInfo>
  295. <ReturnValue>
  296. <ReturnType>System.Boolean</ReturnType>
  297. </ReturnValue>
  298. <Docs>
  299. <summary>
  300. Return whether is using forced autohinting.
  301. Or
  302. Set whether to force font autohinting instead of using FreeType's TTF bytecode interpreter.
  303. </summary>
  304. <value>To be added.</value>
  305. <remarks>To be added.</remarks>
  306. </Docs>
  307. </Member>
  308. <Member MemberName="FrontElement">
  309. <MemberSignature Language="C#" Value="public Urho.UIElement FrontElement { get; }" />
  310. <MemberSignature Language="ILAsm" Value=".property instance class Urho.UIElement FrontElement" />
  311. <MemberType>Property</MemberType>
  312. <AssemblyInfo>
  313. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  314. </AssemblyInfo>
  315. <ReturnValue>
  316. <ReturnType>Urho.UIElement</ReturnType>
  317. </ReturnValue>
  318. <Docs>
  319. <summary>
  320. Return topmost enabled root-level non-modal element.
  321. </summary>
  322. <value>To be added.</value>
  323. <remarks>To be added.</remarks>
  324. </Docs>
  325. </Member>
  326. <Member MemberName="GetDragElement">
  327. <MemberSignature Language="C#" Value="public Urho.UIElement GetDragElement (uint index);" />
  328. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.UIElement GetDragElement(unsigned int32 index) cil managed" />
  329. <MemberType>Method</MemberType>
  330. <AssemblyInfo>
  331. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  332. </AssemblyInfo>
  333. <ReturnValue>
  334. <ReturnType>Urho.UIElement</ReturnType>
  335. </ReturnValue>
  336. <Parameters>
  337. <Parameter Name="index" Type="System.UInt32" />
  338. </Parameters>
  339. <Docs>
  340. <param name="index">To be added.</param>
  341. <summary>
  342. Return the drag element at index.
  343. </summary>
  344. <returns>To be added.</returns>
  345. <remarks>To be added.</remarks>
  346. </Docs>
  347. </Member>
  348. <Member MemberName="GetElementAt">
  349. <MemberSignature Language="C#" Value="public Urho.UIElement GetElementAt (Urho.IntVector2 position, bool enabledOnly);" />
  350. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.UIElement GetElementAt(valuetype Urho.IntVector2 position, bool enabledOnly) cil managed" />
  351. <MemberType>Method</MemberType>
  352. <AssemblyInfo>
  353. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  354. </AssemblyInfo>
  355. <ReturnValue>
  356. <ReturnType>Urho.UIElement</ReturnType>
  357. </ReturnValue>
  358. <Parameters>
  359. <Parameter Name="position" Type="Urho.IntVector2" />
  360. <Parameter Name="enabledOnly" Type="System.Boolean" />
  361. </Parameters>
  362. <Docs>
  363. <param name="position">To be added.</param>
  364. <param name="enabledOnly">To be added.</param>
  365. <summary>
  366. Return UI element at screen coordinates. By default returns only input-enabled elements.
  367. </summary>
  368. <returns>To be added.</returns>
  369. <remarks>To be added.</remarks>
  370. </Docs>
  371. </Member>
  372. <Member MemberName="GetElementAt">
  373. <MemberSignature Language="C#" Value="public Urho.UIElement GetElementAt (int x, int y, bool enabledOnly);" />
  374. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.UIElement GetElementAt(int32 x, int32 y, bool enabledOnly) cil managed" />
  375. <MemberType>Method</MemberType>
  376. <AssemblyInfo>
  377. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  378. </AssemblyInfo>
  379. <ReturnValue>
  380. <ReturnType>Urho.UIElement</ReturnType>
  381. </ReturnValue>
  382. <Parameters>
  383. <Parameter Name="x" Type="System.Int32" />
  384. <Parameter Name="y" Type="System.Int32" />
  385. <Parameter Name="enabledOnly" Type="System.Boolean" />
  386. </Parameters>
  387. <Docs>
  388. <param name="x">To be added.</param>
  389. <param name="y">To be added.</param>
  390. <param name="enabledOnly">To be added.</param>
  391. <summary>
  392. Return UI element at screen coordinates. By default returns only input-enabled elements.
  393. </summary>
  394. <returns>To be added.</returns>
  395. <remarks>To be added.</remarks>
  396. </Docs>
  397. </Member>
  398. <Member MemberName="HasModalElement">
  399. <MemberSignature Language="C#" Value="public bool HasModalElement ();" />
  400. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool HasModalElement() cil managed" />
  401. <MemberType>Method</MemberType>
  402. <AssemblyInfo>
  403. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  404. </AssemblyInfo>
  405. <ReturnValue>
  406. <ReturnType>System.Boolean</ReturnType>
  407. </ReturnValue>
  408. <Parameters />
  409. <Docs>
  410. <summary>
  411. Return true when UI has modal element(s).
  412. </summary>
  413. <returns>To be added.</returns>
  414. <remarks>To be added.</remarks>
  415. </Docs>
  416. </Member>
  417. <Member MemberName="IsDragging">
  418. <MemberSignature Language="C#" Value="public bool IsDragging ();" />
  419. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsDragging() cil managed" />
  420. <MemberType>Method</MemberType>
  421. <AssemblyInfo>
  422. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  423. </AssemblyInfo>
  424. <ReturnValue>
  425. <ReturnType>System.Boolean</ReturnType>
  426. </ReturnValue>
  427. <Parameters />
  428. <Docs>
  429. <summary>
  430. Return whether a drag is in progress.
  431. </summary>
  432. <returns>To be added.</returns>
  433. <remarks>To be added.</remarks>
  434. </Docs>
  435. </Member>
  436. <Member MemberName="IsNonFocusedMouseWheel">
  437. <MemberSignature Language="C#" Value="public bool IsNonFocusedMouseWheel ();" />
  438. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsNonFocusedMouseWheel() cil managed" />
  439. <MemberType>Method</MemberType>
  440. <AssemblyInfo>
  441. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  442. </AssemblyInfo>
  443. <ReturnValue>
  444. <ReturnType>System.Boolean</ReturnType>
  445. </ReturnValue>
  446. <Parameters />
  447. <Docs>
  448. <summary>
  449. Return whether mouse wheel can control also a non-focused element.
  450. </summary>
  451. <returns>To be added.</returns>
  452. <remarks>To be added.</remarks>
  453. </Docs>
  454. </Member>
  455. <Member MemberName="LoadLayout">
  456. <MemberSignature Language="C#" Value="public Urho.UIElement LoadLayout (Urho.XMLFile file, Urho.XMLFile styleFile);" />
  457. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.UIElement LoadLayout(class Urho.XMLFile file, class Urho.XMLFile styleFile) cil managed" />
  458. <MemberType>Method</MemberType>
  459. <AssemblyInfo>
  460. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  461. </AssemblyInfo>
  462. <ReturnValue>
  463. <ReturnType>Urho.UIElement</ReturnType>
  464. </ReturnValue>
  465. <Parameters>
  466. <Parameter Name="file" Type="Urho.XMLFile" />
  467. <Parameter Name="styleFile" Type="Urho.XMLFile" />
  468. </Parameters>
  469. <Docs>
  470. <param name="file">To be added.</param>
  471. <param name="styleFile">To be added.</param>
  472. <summary>
  473. Load a UI layout from an XML file. Optionally specify another XML file for element style. Return the root element.
  474. </summary>
  475. <returns>To be added.</returns>
  476. <remarks>To be added.</remarks>
  477. </Docs>
  478. </Member>
  479. <Member MemberName="LoadLayoutToElement">
  480. <MemberSignature Language="C#" Value="public void LoadLayoutToElement (Urho.UIElement container, Urho.ResourceCache cache, string name);" />
  481. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void LoadLayoutToElement(class Urho.UIElement container, class Urho.ResourceCache cache, string name) cil managed" />
  482. <MemberType>Method</MemberType>
  483. <AssemblyInfo>
  484. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  485. </AssemblyInfo>
  486. <ReturnValue>
  487. <ReturnType>System.Void</ReturnType>
  488. </ReturnValue>
  489. <Parameters>
  490. <Parameter Name="container" Type="Urho.UIElement" />
  491. <Parameter Name="cache" Type="Urho.ResourceCache" />
  492. <Parameter Name="name" Type="System.String" />
  493. </Parameters>
  494. <Docs>
  495. <param name="container">To be added.</param>
  496. <param name="cache">To be added.</param>
  497. <param name="name">To be added.</param>
  498. <summary>To be added.</summary>
  499. <remarks>To be added.</remarks>
  500. </Docs>
  501. </Member>
  502. <Member MemberName="MaxFontTextureSize">
  503. <MemberSignature Language="C#" Value="public int MaxFontTextureSize { get; set; }" />
  504. <MemberSignature Language="ILAsm" Value=".property instance int32 MaxFontTextureSize" />
  505. <MemberType>Property</MemberType>
  506. <AssemblyInfo>
  507. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  508. </AssemblyInfo>
  509. <ReturnValue>
  510. <ReturnType>System.Int32</ReturnType>
  511. </ReturnValue>
  512. <Docs>
  513. <summary>
  514. Return font texture maximum size.
  515. Or
  516. Set maximum font face texture size. Must be a power of two. Default is 2048.
  517. </summary>
  518. <value>To be added.</value>
  519. <remarks>To be added.</remarks>
  520. </Docs>
  521. </Member>
  522. <Member MemberName="NumDragElements">
  523. <MemberSignature Language="C#" Value="public uint NumDragElements { get; }" />
  524. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 NumDragElements" />
  525. <MemberType>Property</MemberType>
  526. <AssemblyInfo>
  527. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  528. </AssemblyInfo>
  529. <ReturnValue>
  530. <ReturnType>System.UInt32</ReturnType>
  531. </ReturnValue>
  532. <Docs>
  533. <summary>
  534. Return the number of currently dragged elements.
  535. </summary>
  536. <value>To be added.</value>
  537. <remarks>To be added.</remarks>
  538. </Docs>
  539. </Member>
  540. <Member MemberName="Render">
  541. <MemberSignature Language="C#" Value="public void Render (bool resetRenderTargets);" />
  542. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Render(bool resetRenderTargets) cil managed" />
  543. <MemberType>Method</MemberType>
  544. <AssemblyInfo>
  545. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  546. </AssemblyInfo>
  547. <ReturnValue>
  548. <ReturnType>System.Void</ReturnType>
  549. </ReturnValue>
  550. <Parameters>
  551. <Parameter Name="resetRenderTargets" Type="System.Boolean" />
  552. </Parameters>
  553. <Docs>
  554. <param name="resetRenderTargets">To be added.</param>
  555. <summary>
  556. Render the UI. If resetRenderTargets is true, is assumed to be the default UI render to backbuffer called by Engine, and will be performed only once. Additional UI renders to a different rendertarget may be triggered from the renderpath.
  557. </summary>
  558. <remarks>To be added.</remarks>
  559. </Docs>
  560. </Member>
  561. <Member MemberName="RenderUpdate">
  562. <MemberSignature Language="C#" Value="public void RenderUpdate ();" />
  563. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RenderUpdate() cil managed" />
  564. <MemberType>Method</MemberType>
  565. <AssemblyInfo>
  566. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  567. </AssemblyInfo>
  568. <ReturnValue>
  569. <ReturnType>System.Void</ReturnType>
  570. </ReturnValue>
  571. <Parameters />
  572. <Docs>
  573. <summary>
  574. Update the UI for rendering. Called by HandleRenderUpdate().
  575. </summary>
  576. <remarks>To be added.</remarks>
  577. </Docs>
  578. </Member>
  579. <Member MemberName="Root">
  580. <MemberSignature Language="C#" Value="public Urho.UIElement Root { get; }" />
  581. <MemberSignature Language="ILAsm" Value=".property instance class Urho.UIElement Root" />
  582. <MemberType>Property</MemberType>
  583. <AssemblyInfo>
  584. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  585. </AssemblyInfo>
  586. <ReturnValue>
  587. <ReturnType>Urho.UIElement</ReturnType>
  588. </ReturnValue>
  589. <Docs>
  590. <summary>
  591. Return root UI element.
  592. </summary>
  593. <value>To be added.</value>
  594. <remarks>To be added.</remarks>
  595. </Docs>
  596. </Member>
  597. <Member MemberName="RootModalElement">
  598. <MemberSignature Language="C#" Value="public Urho.UIElement RootModalElement { get; }" />
  599. <MemberSignature Language="ILAsm" Value=".property instance class Urho.UIElement RootModalElement" />
  600. <MemberType>Property</MemberType>
  601. <AssemblyInfo>
  602. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  603. </AssemblyInfo>
  604. <ReturnValue>
  605. <ReturnType>Urho.UIElement</ReturnType>
  606. </ReturnValue>
  607. <Docs>
  608. <summary>
  609. Return root modal element.
  610. </summary>
  611. <value>To be added.</value>
  612. <remarks>To be added.</remarks>
  613. </Docs>
  614. </Member>
  615. <Member MemberName="SetFocusElement">
  616. <MemberSignature Language="C#" Value="public void SetFocusElement (Urho.UIElement element, bool byKey);" />
  617. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetFocusElement(class Urho.UIElement element, bool byKey) cil managed" />
  618. <MemberType>Method</MemberType>
  619. <AssemblyInfo>
  620. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  621. </AssemblyInfo>
  622. <ReturnValue>
  623. <ReturnType>System.Void</ReturnType>
  624. </ReturnValue>
  625. <Parameters>
  626. <Parameter Name="element" Type="Urho.UIElement" />
  627. <Parameter Name="byKey" Type="System.Boolean" />
  628. </Parameters>
  629. <Docs>
  630. <param name="element">To be added.</param>
  631. <param name="byKey">To be added.</param>
  632. <summary>
  633. Set focused UI element.
  634. </summary>
  635. <remarks>To be added.</remarks>
  636. </Docs>
  637. </Member>
  638. <Member MemberName="SetModalElement">
  639. <MemberSignature Language="C#" Value="public bool SetModalElement (Urho.UIElement modalElement, bool enable);" />
  640. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SetModalElement(class Urho.UIElement modalElement, bool enable) cil managed" />
  641. <MemberType>Method</MemberType>
  642. <AssemblyInfo>
  643. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  644. </AssemblyInfo>
  645. <ReturnValue>
  646. <ReturnType>System.Boolean</ReturnType>
  647. </ReturnValue>
  648. <Parameters>
  649. <Parameter Name="modalElement" Type="Urho.UIElement" />
  650. <Parameter Name="enable" Type="System.Boolean" />
  651. </Parameters>
  652. <Docs>
  653. <param name="modalElement">To be added.</param>
  654. <param name="enable">To be added.</param>
  655. <summary>
  656. Set modal element. Until all the modal elements are dismissed, all the inputs and events are only sent to them. Return true when successful.
  657. Only the modal element can clear its modal status or when it is being destructed.
  658. </summary>
  659. <returns>To be added.</returns>
  660. <remarks>To be added.</remarks>
  661. </Docs>
  662. </Member>
  663. <Member MemberName="SetNonFocusedMouseWheel">
  664. <MemberSignature Language="C#" Value="public void SetNonFocusedMouseWheel (bool nonFocusedMouseWheel);" />
  665. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetNonFocusedMouseWheel(bool nonFocusedMouseWheel) cil managed" />
  666. <MemberType>Method</MemberType>
  667. <AssemblyInfo>
  668. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  669. </AssemblyInfo>
  670. <ReturnValue>
  671. <ReturnType>System.Void</ReturnType>
  672. </ReturnValue>
  673. <Parameters>
  674. <Parameter Name="nonFocusedMouseWheel" Type="System.Boolean" />
  675. </Parameters>
  676. <Docs>
  677. <param name="nonFocusedMouseWheel">To be added.</param>
  678. <summary>
  679. Set whether mouse wheel can control also a non-focused element.
  680. </summary>
  681. <remarks>To be added.</remarks>
  682. </Docs>
  683. </Member>
  684. <Member MemberName="Type">
  685. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  686. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  687. <MemberType>Property</MemberType>
  688. <AssemblyInfo>
  689. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  690. </AssemblyInfo>
  691. <ReturnValue>
  692. <ReturnType>Urho.StringHash</ReturnType>
  693. </ReturnValue>
  694. <Docs>
  695. <summary>Urho's type system type.</summary>
  696. <value>StringHash representing the type for this C# type.</value>
  697. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  698. </Docs>
  699. </Member>
  700. <Member MemberName="TypeName">
  701. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  702. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  703. <MemberType>Property</MemberType>
  704. <AssemblyInfo>
  705. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  706. </AssemblyInfo>
  707. <ReturnValue>
  708. <ReturnType>System.String</ReturnType>
  709. </ReturnValue>
  710. <Docs>
  711. <summary>Urho's low-level type name.</summary>
  712. <value>Stringified low-level type name.</value>
  713. <remarks></remarks>
  714. </Docs>
  715. </Member>
  716. <Member MemberName="TypeNameStatic">
  717. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  718. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  719. <MemberType>Property</MemberType>
  720. <AssemblyInfo>
  721. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  722. </AssemblyInfo>
  723. <ReturnValue>
  724. <ReturnType>System.String</ReturnType>
  725. </ReturnValue>
  726. <Docs>
  727. <summary>Urho's low-level type name, accessible as a static method.</summary>
  728. <value>Stringified low-level type name.</value>
  729. <remarks></remarks>
  730. </Docs>
  731. </Member>
  732. <Member MemberName="TypeStatic">
  733. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  734. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  735. <MemberType>Property</MemberType>
  736. <AssemblyInfo>
  737. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  738. </AssemblyInfo>
  739. <ReturnValue>
  740. <ReturnType>Urho.StringHash</ReturnType>
  741. </ReturnValue>
  742. <Docs>
  743. <summary>To be added.</summary>
  744. <value>To be added.</value>
  745. <remarks>To be added.</remarks>
  746. </Docs>
  747. </Member>
  748. <Member MemberName="Update">
  749. <MemberSignature Language="C#" Value="public void Update (float timeStep);" />
  750. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Update(float32 timeStep) cil managed" />
  751. <MemberType>Method</MemberType>
  752. <AssemblyInfo>
  753. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  754. </AssemblyInfo>
  755. <ReturnValue>
  756. <ReturnType>System.Void</ReturnType>
  757. </ReturnValue>
  758. <Parameters>
  759. <Parameter Name="timeStep" Type="System.Single" />
  760. </Parameters>
  761. <Docs>
  762. <param name="timeStep">To be added.</param>
  763. <summary>
  764. Update the UI logic. Called by HandlePostUpdate().
  765. </summary>
  766. <remarks>To be added.</remarks>
  767. </Docs>
  768. </Member>
  769. <Member MemberName="UseMutableGlyphs">
  770. <MemberSignature Language="C#" Value="public bool UseMutableGlyphs { get; set; }" />
  771. <MemberSignature Language="ILAsm" Value=".property instance bool UseMutableGlyphs" />
  772. <MemberType>Property</MemberType>
  773. <AssemblyInfo>
  774. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  775. </AssemblyInfo>
  776. <ReturnValue>
  777. <ReturnType>System.Boolean</ReturnType>
  778. </ReturnValue>
  779. <Docs>
  780. <summary>
  781. Return whether is using mutable (eraseable) glyphs for fonts.
  782. Or
  783. Set whether to use mutable (eraseable) glyphs to ensure a font face never expands to more than one texture. Default false.
  784. </summary>
  785. <value>To be added.</value>
  786. <remarks>To be added.</remarks>
  787. </Docs>
  788. </Member>
  789. <Member MemberName="UseScreenKeyboard">
  790. <MemberSignature Language="C#" Value="public bool UseScreenKeyboard { get; set; }" />
  791. <MemberSignature Language="ILAsm" Value=".property instance bool UseScreenKeyboard" />
  792. <MemberType>Property</MemberType>
  793. <AssemblyInfo>
  794. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  795. </AssemblyInfo>
  796. <ReturnValue>
  797. <ReturnType>System.Boolean</ReturnType>
  798. </ReturnValue>
  799. <Docs>
  800. <summary>
  801. Return whether focusing a %LineEdit will show the on-screen keyboard.
  802. Or
  803. Set whether to show the on-screen keyboard (if supported) when a %LineEdit is focused. Default true on mobile devices.
  804. </summary>
  805. <value>To be added.</value>
  806. <remarks>To be added.</remarks>
  807. </Docs>
  808. </Member>
  809. <Member MemberName="UseSystemClipboard">
  810. <MemberSignature Language="C#" Value="public bool UseSystemClipboard { get; set; }" />
  811. <MemberSignature Language="ILAsm" Value=".property instance bool UseSystemClipboard" />
  812. <MemberType>Property</MemberType>
  813. <AssemblyInfo>
  814. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  815. </AssemblyInfo>
  816. <ReturnValue>
  817. <ReturnType>System.Boolean</ReturnType>
  818. </ReturnValue>
  819. <Docs>
  820. <summary>
  821. Return whether is using the system clipboard.
  822. Or
  823. Set whether to use system clipboard. Default false.
  824. </summary>
  825. <value>To be added.</value>
  826. <remarks>To be added.</remarks>
  827. </Docs>
  828. </Member>
  829. </Members>
  830. </Type>