UI.xml 60 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377
  1. <Type Name="UI" FullName="Urho.Gui.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>UI subsystem. Manages the graphical user interface.
  14. </summary>
  15. <remarks>
  16. <para>Urho3D implements a simple, hierarchical user interface system based on rectangular elements. The elements provided are:</para>
  17. <list type="bullet">
  18. <item>
  19. <term>
  20. <see cref="T:Urho.BoderImage" />: a texture image with an optional border</term>
  21. </item>
  22. <item>
  23. <term>
  24. <see cref="T:Urho.Gui.Button" />: a pushbutton</term>
  25. </item>
  26. <item>
  27. <term>
  28. <see cref="T:Urho.Gui.CheckBox" />: a button that can be toggled on/off</term>
  29. </item>
  30. <item>
  31. <term>
  32. <see cref="T:Urho.Gui.Cursor" />: a mouse cursor</term>
  33. </item>
  34. <item>
  35. <term>
  36. <see cref="T:Urho.Gui.DropDownList" />: shows a vertical list of items (optionally scrollable) as a popup</term>
  37. </item>
  38. <item>
  39. <term>
  40. <see cref="T:Urho.Gui.LineEdit" />: a single-line text editor</term>
  41. </item>
  42. <item>
  43. <term>
  44. <see cref="T:Urho.Gui.ListView" />: shows a scrollable vertical list of items</term>
  45. </item>
  46. <item>
  47. <term>
  48. <see cref="T:Urho.Gui.Menu" />: a button which can show a popup element</term>
  49. </item>
  50. <item>
  51. <term>
  52. <see cref="T:Urho.Gui.ScrollBar" />: a slider with back and forward buttons</term>
  53. </item>
  54. <item>
  55. <term>
  56. <see cref="T:Urho.Gui.ScrollView" />: a scrollable view of child elements</term>
  57. </item>
  58. <item>
  59. <term>
  60. <see cref="T:Urho.Gui.Slider" />: a horizontal or vertical slider bar</term>
  61. </item>
  62. <item>
  63. <term>
  64. <see cref="T:Urho.Gui.Sprite" />: a texture image which supports subpixel positioning, scaling and rotating.</term>
  65. </item>
  66. <item>
  67. <term>
  68. <see cref="T:Urho.Gui.Text" />: static text that can be multiline</term>
  69. </item>
  70. <item>
  71. <term>
  72. <see cref="T:Urho.Gui.ToolTip" />: a popup which automatically displays itself when the cursor hovers on its parent element.</term>
  73. </item>
  74. <item>
  75. <term>
  76. <see cref="T:Urho.Gui.UIElement" />: container for other elements, renders nothing by itself</term>
  77. </item>
  78. <item>
  79. <term>
  80. <see cref="T:Urho.Gui.View3D" />: a window that renders a 3D viewport</term>
  81. </item>
  82. <item>
  83. <term>
  84. <see cref="T:Urho.Gui.Window" />: a movable and resizable window</term>
  85. </item>
  86. </list>
  87. <para>The root UI element can be queried from the UI subsystem. It is an empty canvas (<see cref="T:Urho.Gui.UIElement" />) as large as the application window, into which other elements can be added.</para>
  88. <para>Elements are added into each other similarly as scene nodes, using the <see cref="M:Urho.Gui.UIElement.AddChild" /> and <see cref="M:Urho.Gui.UIElement.RemoveChild" />. </para>
  89. <para>To allow the elements react to mouse input, either a mouse cursor element must be defined using the <see cref="P:Urho.Gui.UI.Cursor" /> property  or the operating system mouse cursor must be set visible from the <see cref="T:Urho.Input" /> subsystem.</para>
  90. <para>
  91. </para>
  92. <format type="text/html">
  93. <h2>
  94. <br />
  95. </h2>
  96. </format>
  97. </remarks>
  98. </Docs>
  99. <Members>
  100. <Member MemberName=".ctor">
  101. <MemberSignature Language="C#" Value="public UI ();" />
  102. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  103. <MemberType>Constructor</MemberType>
  104. <AssemblyInfo>
  105. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  106. </AssemblyInfo>
  107. <Attributes>
  108. <Attribute>
  109. <AttributeName>Preserve</AttributeName>
  110. </Attribute>
  111. </Attributes>
  112. <Parameters />
  113. <Docs>
  114. <summary>
  115. <para>Constructs a new instance of Urho.Gui.UI which is tied to the <see cref="P:Urho.Application.CurrentContext" />.</para>
  116. </summary>
  117. <remarks>
  118. </remarks>
  119. </Docs>
  120. </Member>
  121. <Member MemberName=".ctor">
  122. <MemberSignature Language="C#" Value="public UI (IntPtr handle);" />
  123. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  124. <MemberType>Constructor</MemberType>
  125. <AssemblyInfo>
  126. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  127. </AssemblyInfo>
  128. <Attributes>
  129. <Attribute>
  130. <AttributeName>Preserve</AttributeName>
  131. </Attribute>
  132. </Attributes>
  133. <Parameters>
  134. <Parameter Name="handle" Type="System.IntPtr" />
  135. </Parameters>
  136. <Docs>
  137. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  138. <summary>Constructs a new instance of Urho.Gui.UI, given a raw pointer to an unmanaged object</summary>
  139. <remarks>
  140. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  141. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  142. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  143. </remarks>
  144. </Docs>
  145. </Member>
  146. <Member MemberName=".ctor">
  147. <MemberSignature Language="C#" Value="public UI (Urho.Context context);" />
  148. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context context) cil managed" />
  149. <MemberType>Constructor</MemberType>
  150. <AssemblyInfo>
  151. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  152. </AssemblyInfo>
  153. <Attributes>
  154. <Attribute>
  155. <AttributeName>Preserve</AttributeName>
  156. </Attribute>
  157. </Attributes>
  158. <Parameters>
  159. <Parameter Name="context" Type="Urho.Context" />
  160. </Parameters>
  161. <Docs>
  162. <param name="context">The context that this object will be attached to.</param>
  163. <summary>
  164. <para>Constructs a new instance of Urho.Gui.UI linked to a specific <see cref="T:Urho.Context" />.</para>
  165. </summary>
  166. <remarks>
  167. </remarks>
  168. </Docs>
  169. </Member>
  170. <Member MemberName=".ctor">
  171. <MemberSignature Language="C#" Value="protected UI (Urho.UrhoObjectFlag emptyFlag);" />
  172. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  173. <MemberType>Constructor</MemberType>
  174. <AssemblyInfo>
  175. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  176. </AssemblyInfo>
  177. <Attributes>
  178. <Attribute>
  179. <AttributeName>Preserve</AttributeName>
  180. </Attribute>
  181. </Attributes>
  182. <Parameters>
  183. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  184. </Parameters>
  185. <Docs>
  186. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  187. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  188. <remarks>
  189. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  190. <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>
  191. <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>
  192. </remarks>
  193. </Docs>
  194. </Member>
  195. <Member MemberName="Clear">
  196. <MemberSignature Language="C#" Value="public void Clear ();" />
  197. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Clear() cil managed" />
  198. <MemberType>Method</MemberType>
  199. <AssemblyInfo>
  200. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  201. </AssemblyInfo>
  202. <ReturnValue>
  203. <ReturnType>System.Void</ReturnType>
  204. </ReturnValue>
  205. <Parameters />
  206. <Docs>
  207. <summary>
  208. Clear the UI (excluding the cursor.)
  209. </summary>
  210. <remarks>To be added.</remarks>
  211. </Docs>
  212. </Member>
  213. <Member MemberName="ClipboardText">
  214. <MemberSignature Language="C#" Value="public string ClipboardText { get; set; }" />
  215. <MemberSignature Language="ILAsm" Value=".property instance string ClipboardText" />
  216. <MemberType>Property</MemberType>
  217. <AssemblyInfo>
  218. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  219. </AssemblyInfo>
  220. <ReturnValue>
  221. <ReturnType>System.String</ReturnType>
  222. </ReturnValue>
  223. <Docs>
  224. <summary>
  225. Return clipboard text.
  226. Or
  227. Set clipboard text.
  228. </summary>
  229. <value>To be added.</value>
  230. <remarks>To be added.</remarks>
  231. </Docs>
  232. </Member>
  233. <Member MemberName="Cursor">
  234. <MemberSignature Language="C#" Value="public Urho.Gui.Cursor Cursor { get; set; }" />
  235. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Gui.Cursor Cursor" />
  236. <MemberType>Property</MemberType>
  237. <AssemblyInfo>
  238. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  239. </AssemblyInfo>
  240. <ReturnValue>
  241. <ReturnType>Urho.Gui.Cursor</ReturnType>
  242. </ReturnValue>
  243. <Docs>
  244. <summary>
  245. Return cursor.
  246. Or
  247. Set cursor UI element.
  248. </summary>
  249. <value>To be added.</value>
  250. <remarks>To be added.</remarks>
  251. </Docs>
  252. </Member>
  253. <Member MemberName="CursorPosition">
  254. <MemberSignature Language="C#" Value="public Urho.IntVector2 CursorPosition { get; }" />
  255. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.IntVector2 CursorPosition" />
  256. <MemberType>Property</MemberType>
  257. <AssemblyInfo>
  258. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  259. </AssemblyInfo>
  260. <ReturnValue>
  261. <ReturnType>Urho.IntVector2</ReturnType>
  262. </ReturnValue>
  263. <Docs>
  264. <summary>
  265. Return cursor position.
  266. </summary>
  267. <value>To be added.</value>
  268. <remarks>To be added.</remarks>
  269. </Docs>
  270. </Member>
  271. <Member MemberName="CustomSize">
  272. <MemberSignature Language="C#" Value="public Urho.IntVector2 CustomSize { get; set; }" />
  273. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.IntVector2 CustomSize" />
  274. <MemberType>Property</MemberType>
  275. <AssemblyInfo>
  276. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  277. </AssemblyInfo>
  278. <ReturnValue>
  279. <ReturnType>Urho.IntVector2</ReturnType>
  280. </ReturnValue>
  281. <Docs>
  282. <summary>Return root element custom size. Returns 0,0 when custom size is not being used and automatic resizing according to window size is in use instead (default.)
  283. Or
  284. Set custom size of the root element. This disables automatic resizing of the root element according to window size. Set custom size 0,0 to return to automatic resizing.</summary>
  285. <value>To be added.</value>
  286. <remarks>To be added.</remarks>
  287. </Docs>
  288. </Member>
  289. <Member MemberName="DebugDraw">
  290. <MemberSignature Language="C#" Value="public void DebugDraw (Urho.Gui.UIElement element);" />
  291. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void DebugDraw(class Urho.Gui.UIElement element) cil managed" />
  292. <MemberType>Method</MemberType>
  293. <AssemblyInfo>
  294. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  295. </AssemblyInfo>
  296. <ReturnValue>
  297. <ReturnType>System.Void</ReturnType>
  298. </ReturnValue>
  299. <Parameters>
  300. <Parameter Name="element" Type="Urho.Gui.UIElement" />
  301. </Parameters>
  302. <Docs>
  303. <param name="element">To be added.</param>
  304. <summary>
  305. Debug draw a UI element.
  306. </summary>
  307. <remarks>To be added.</remarks>
  308. </Docs>
  309. </Member>
  310. <Member MemberName="DefaultToolTipDelay">
  311. <MemberSignature Language="C#" Value="public float DefaultToolTipDelay { get; set; }" />
  312. <MemberSignature Language="ILAsm" Value=".property instance float32 DefaultToolTipDelay" />
  313. <MemberType>Property</MemberType>
  314. <AssemblyInfo>
  315. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  316. </AssemblyInfo>
  317. <ReturnValue>
  318. <ReturnType>System.Single</ReturnType>
  319. </ReturnValue>
  320. <Docs>
  321. <summary>
  322. Return tooltip default display delay in seconds.
  323. Or
  324. Set tooltip default display delay in seconds.
  325. </summary>
  326. <value>To be added.</value>
  327. <remarks>To be added.</remarks>
  328. </Docs>
  329. </Member>
  330. <Member MemberName="DoubleClickInterval">
  331. <MemberSignature Language="C#" Value="public float DoubleClickInterval { get; set; }" />
  332. <MemberSignature Language="ILAsm" Value=".property instance float32 DoubleClickInterval" />
  333. <MemberType>Property</MemberType>
  334. <AssemblyInfo>
  335. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  336. </AssemblyInfo>
  337. <ReturnValue>
  338. <ReturnType>System.Single</ReturnType>
  339. </ReturnValue>
  340. <Docs>
  341. <summary>
  342. Return UI element double click interval in seconds.
  343. Or
  344. Set UI element double click interval in seconds.
  345. </summary>
  346. <value>To be added.</value>
  347. <remarks>To be added.</remarks>
  348. </Docs>
  349. </Member>
  350. <Member MemberName="DragBeginDistance">
  351. <MemberSignature Language="C#" Value="public int DragBeginDistance { get; set; }" />
  352. <MemberSignature Language="ILAsm" Value=".property instance int32 DragBeginDistance" />
  353. <MemberType>Property</MemberType>
  354. <AssemblyInfo>
  355. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  356. </AssemblyInfo>
  357. <ReturnValue>
  358. <ReturnType>System.Int32</ReturnType>
  359. </ReturnValue>
  360. <Docs>
  361. <summary>
  362. Return UI drag start event distance threshold in pixels.
  363. Or
  364. Set UI drag event start distance threshold in pixels.
  365. </summary>
  366. <value>To be added.</value>
  367. <remarks>To be added.</remarks>
  368. </Docs>
  369. </Member>
  370. <Member MemberName="DragBeginInterval">
  371. <MemberSignature Language="C#" Value="public float DragBeginInterval { get; set; }" />
  372. <MemberSignature Language="ILAsm" Value=".property instance float32 DragBeginInterval" />
  373. <MemberType>Property</MemberType>
  374. <AssemblyInfo>
  375. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  376. </AssemblyInfo>
  377. <ReturnValue>
  378. <ReturnType>System.Single</ReturnType>
  379. </ReturnValue>
  380. <Docs>
  381. <summary>
  382. Return UI drag start event interval in seconds.
  383. Or
  384. Set UI drag event start interval in seconds.
  385. </summary>
  386. <value>To be added.</value>
  387. <remarks>To be added.</remarks>
  388. </Docs>
  389. </Member>
  390. <Member MemberName="Dragging">
  391. <MemberSignature Language="C#" Value="public bool Dragging { get; }" />
  392. <MemberSignature Language="ILAsm" Value=".property instance bool Dragging" />
  393. <MemberType>Property</MemberType>
  394. <AssemblyInfo>
  395. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  396. </AssemblyInfo>
  397. <ReturnValue>
  398. <ReturnType>System.Boolean</ReturnType>
  399. </ReturnValue>
  400. <Docs>
  401. <summary>Return whether a drag is in progress.</summary>
  402. <value>To be added.</value>
  403. <remarks>To be added.</remarks>
  404. </Docs>
  405. </Member>
  406. <Member MemberName="FocusChanged">
  407. <MemberSignature Language="C#" Value="public event Action&lt;Urho.Gui.FocusChangedEventArgs&gt; FocusChanged;" />
  408. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.Gui.FocusChangedEventArgs&gt; FocusChanged" />
  409. <MemberType>Event</MemberType>
  410. <AssemblyInfo>
  411. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  412. </AssemblyInfo>
  413. <ReturnValue>
  414. <ReturnType>System.Action&lt;Urho.Gui.FocusChangedEventArgs&gt;</ReturnType>
  415. </ReturnValue>
  416. <Docs>
  417. <summary>To be added.</summary>
  418. <remarks>
  419. <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToFocusChanged" /> method. That one will force that callback and will ignore any previously set events here.</para>
  420. </remarks>
  421. </Docs>
  422. </Member>
  423. <Member MemberName="FocusElement">
  424. <MemberSignature Language="C#" Value="public Urho.Gui.UIElement FocusElement { get; }" />
  425. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Gui.UIElement FocusElement" />
  426. <MemberType>Property</MemberType>
  427. <AssemblyInfo>
  428. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  429. </AssemblyInfo>
  430. <ReturnValue>
  431. <ReturnType>Urho.Gui.UIElement</ReturnType>
  432. </ReturnValue>
  433. <Docs>
  434. <summary>
  435. Return focused element.
  436. </summary>
  437. <value>To be added.</value>
  438. <remarks>To be added.</remarks>
  439. </Docs>
  440. </Member>
  441. <Member MemberName="FontHintLevel">
  442. <MemberSignature Language="C#" Value="public Urho.FontHintLevel FontHintLevel { get; set; }" />
  443. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.FontHintLevel FontHintLevel" />
  444. <MemberType>Property</MemberType>
  445. <AssemblyInfo>
  446. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  447. </AssemblyInfo>
  448. <ReturnValue>
  449. <ReturnType>Urho.FontHintLevel</ReturnType>
  450. </ReturnValue>
  451. <Docs>
  452. <summary>Return the current FreeType font hinting level.
  453. Or
  454. Set the hinting level used by FreeType fonts.</summary>
  455. <value>To be added.</value>
  456. <remarks>To be added.</remarks>
  457. </Docs>
  458. </Member>
  459. <Member MemberName="FontOversampling">
  460. <MemberSignature Language="C#" Value="public int FontOversampling { get; set; }" />
  461. <MemberSignature Language="ILAsm" Value=".property instance int32 FontOversampling" />
  462. <MemberType>Property</MemberType>
  463. <AssemblyInfo>
  464. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  465. </AssemblyInfo>
  466. <ReturnValue>
  467. <ReturnType>System.Int32</ReturnType>
  468. </ReturnValue>
  469. <Docs>
  470. <summary>Get the oversampling (horizonal stretching) used to improve subpixel font rendering. Only affects fonts smaller than the subpixel limit.
  471. Or
  472. Set the oversampling (horizonal stretching) used to improve subpixel font rendering. Only affects fonts smaller than the subpixel limit.</summary>
  473. <value>To be added.</value>
  474. <remarks>To be added.</remarks>
  475. </Docs>
  476. </Member>
  477. <Member MemberName="FontSubpixelThreshold">
  478. <MemberSignature Language="C#" Value="public float FontSubpixelThreshold { get; set; }" />
  479. <MemberSignature Language="ILAsm" Value=".property instance float32 FontSubpixelThreshold" />
  480. <MemberType>Property</MemberType>
  481. <AssemblyInfo>
  482. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  483. </AssemblyInfo>
  484. <ReturnValue>
  485. <ReturnType>System.Single</ReturnType>
  486. </ReturnValue>
  487. <Docs>
  488. <summary>Get the font subpixel threshold. Below this size, if the hint level is LIGHT or NONE, fonts will use subpixel positioning plus oversampling for higher-quality rendering. Has no effect at hint level NORMAL.
  489. Or
  490. Set the font subpixel threshold. Below this size, if the hint level is LIGHT or NONE, fonts will use subpixel positioning plus oversampling for higher-quality rendering. Has no effect at hint level NORMAL.</summary>
  491. <value>To be added.</value>
  492. <remarks>To be added.</remarks>
  493. </Docs>
  494. </Member>
  495. <Member MemberName="ForceAutoHint">
  496. <MemberSignature Language="C#" Value="public bool ForceAutoHint { get; set; }" />
  497. <MemberSignature Language="ILAsm" Value=".property instance bool ForceAutoHint" />
  498. <MemberType>Property</MemberType>
  499. <AssemblyInfo>
  500. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  501. </AssemblyInfo>
  502. <ReturnValue>
  503. <ReturnType>System.Boolean</ReturnType>
  504. </ReturnValue>
  505. <Docs>
  506. <summary>
  507. Return whether is using forced autohinting.
  508. Or
  509. Set whether to force font autohinting instead of using FreeType's TTF bytecode interpreter.
  510. </summary>
  511. <value>To be added.</value>
  512. <remarks>To be added.</remarks>
  513. </Docs>
  514. </Member>
  515. <Member MemberName="FrontElement">
  516. <MemberSignature Language="C#" Value="public Urho.Gui.UIElement FrontElement { get; }" />
  517. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Gui.UIElement FrontElement" />
  518. <MemberType>Property</MemberType>
  519. <AssemblyInfo>
  520. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  521. </AssemblyInfo>
  522. <ReturnValue>
  523. <ReturnType>Urho.Gui.UIElement</ReturnType>
  524. </ReturnValue>
  525. <Docs>
  526. <summary>
  527. Return topmost enabled root-level non-modal element.
  528. </summary>
  529. <value>To be added.</value>
  530. <remarks>To be added.</remarks>
  531. </Docs>
  532. </Member>
  533. <Member MemberName="GetDragElement">
  534. <MemberSignature Language="C#" Value="public Urho.Gui.UIElement GetDragElement (uint index);" />
  535. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Gui.UIElement GetDragElement(unsigned int32 index) cil managed" />
  536. <MemberType>Method</MemberType>
  537. <AssemblyInfo>
  538. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  539. </AssemblyInfo>
  540. <ReturnValue>
  541. <ReturnType>Urho.Gui.UIElement</ReturnType>
  542. </ReturnValue>
  543. <Parameters>
  544. <Parameter Name="index" Type="System.UInt32" />
  545. </Parameters>
  546. <Docs>
  547. <param name="index">To be added.</param>
  548. <summary>
  549. Return the drag element at index.
  550. </summary>
  551. <returns>To be added.</returns>
  552. <remarks>To be added.</remarks>
  553. </Docs>
  554. </Member>
  555. <Member MemberName="GetElementAt">
  556. <MemberSignature Language="C#" Value="public Urho.Gui.UIElement GetElementAt (Urho.IntVector2 position, bool enabledOnly = true);" />
  557. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Gui.UIElement GetElementAt(valuetype Urho.IntVector2 position, bool enabledOnly) cil managed" />
  558. <MemberType>Method</MemberType>
  559. <AssemblyInfo>
  560. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  561. </AssemblyInfo>
  562. <ReturnValue>
  563. <ReturnType>Urho.Gui.UIElement</ReturnType>
  564. </ReturnValue>
  565. <Parameters>
  566. <Parameter Name="position" Type="Urho.IntVector2" />
  567. <Parameter Name="enabledOnly" Type="System.Boolean" />
  568. </Parameters>
  569. <Docs>
  570. <param name="position">To be added.</param>
  571. <param name="enabledOnly">To be added.</param>
  572. <summary>
  573. Return UI element at screen coordinates. By default returns only input-enabled elements.
  574. </summary>
  575. <returns>To be added.</returns>
  576. <remarks>To be added.</remarks>
  577. </Docs>
  578. </Member>
  579. <Member MemberName="GetElementAt">
  580. <MemberSignature Language="C#" Value="public Urho.Gui.UIElement GetElementAt (int x, int y, bool enabledOnly = true);" />
  581. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Gui.UIElement GetElementAt(int32 x, int32 y, bool enabledOnly) cil managed" />
  582. <MemberType>Method</MemberType>
  583. <AssemblyInfo>
  584. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  585. </AssemblyInfo>
  586. <ReturnValue>
  587. <ReturnType>Urho.Gui.UIElement</ReturnType>
  588. </ReturnValue>
  589. <Parameters>
  590. <Parameter Name="x" Type="System.Int32" />
  591. <Parameter Name="y" Type="System.Int32" />
  592. <Parameter Name="enabledOnly" Type="System.Boolean" />
  593. </Parameters>
  594. <Docs>
  595. <param name="x">To be added.</param>
  596. <param name="y">To be added.</param>
  597. <param name="enabledOnly">To be added.</param>
  598. <summary>
  599. Return UI element at screen coordinates. By default returns only input-enabled elements.
  600. </summary>
  601. <returns>To be added.</returns>
  602. <remarks>To be added.</remarks>
  603. </Docs>
  604. </Member>
  605. <Member MemberName="GetElementAt">
  606. <MemberSignature Language="C#" Value="public Urho.Gui.UIElement GetElementAt (Urho.Gui.UIElement root, Urho.IntVector2 position, bool enabledOnly = true);" />
  607. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Gui.UIElement GetElementAt(class Urho.Gui.UIElement root, valuetype Urho.IntVector2 position, bool enabledOnly) cil managed" />
  608. <MemberType>Method</MemberType>
  609. <AssemblyInfo>
  610. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  611. </AssemblyInfo>
  612. <ReturnValue>
  613. <ReturnType>Urho.Gui.UIElement</ReturnType>
  614. </ReturnValue>
  615. <Parameters>
  616. <Parameter Name="root" Type="Urho.Gui.UIElement" />
  617. <Parameter Name="position" Type="Urho.IntVector2" />
  618. <Parameter Name="enabledOnly" Type="System.Boolean" />
  619. </Parameters>
  620. <Docs>
  621. <param name="root">To be added.</param>
  622. <param name="position">To be added.</param>
  623. <param name="enabledOnly">To be added.</param>
  624. <summary>To be added.</summary>
  625. <returns>To be added.</returns>
  626. <remarks>To be added.</remarks>
  627. </Docs>
  628. </Member>
  629. <Member MemberName="HasModalElement">
  630. <MemberSignature Language="C#" Value="public bool HasModalElement ();" />
  631. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool HasModalElement() cil managed" />
  632. <MemberType>Method</MemberType>
  633. <AssemblyInfo>
  634. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  635. </AssemblyInfo>
  636. <ReturnValue>
  637. <ReturnType>System.Boolean</ReturnType>
  638. </ReturnValue>
  639. <Parameters />
  640. <Docs>
  641. <summary>
  642. Return true when UI has modal element(s).
  643. </summary>
  644. <returns>To be added.</returns>
  645. <remarks>To be added.</remarks>
  646. </Docs>
  647. </Member>
  648. <Member MemberName="LoadLayout">
  649. <MemberSignature Language="C#" Value="public Urho.Gui.UIElement LoadLayout (Urho.IO.File source, Urho.Resources.XmlFile styleFile = null);" />
  650. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Gui.UIElement LoadLayout(class Urho.IO.File source, class Urho.Resources.XmlFile styleFile) cil managed" />
  651. <MemberType>Method</MemberType>
  652. <AssemblyInfo>
  653. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  654. </AssemblyInfo>
  655. <ReturnValue>
  656. <ReturnType>Urho.Gui.UIElement</ReturnType>
  657. </ReturnValue>
  658. <Parameters>
  659. <Parameter Name="source" Type="Urho.IO.File" />
  660. <Parameter Name="styleFile" Type="Urho.Resources.XmlFile" />
  661. </Parameters>
  662. <Docs>
  663. <param name="source">To be added.</param>
  664. <param name="styleFile">To be added.</param>
  665. <summary>To be added.</summary>
  666. <returns>To be added.</returns>
  667. <remarks>To be added.</remarks>
  668. </Docs>
  669. </Member>
  670. <Member MemberName="LoadLayout">
  671. <MemberSignature Language="C#" Value="public Urho.Gui.UIElement LoadLayout (Urho.MemoryBuffer source, Urho.Resources.XmlFile styleFile = null);" />
  672. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Gui.UIElement LoadLayout(class Urho.MemoryBuffer source, class Urho.Resources.XmlFile styleFile) cil managed" />
  673. <MemberType>Method</MemberType>
  674. <AssemblyInfo>
  675. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  676. </AssemblyInfo>
  677. <ReturnValue>
  678. <ReturnType>Urho.Gui.UIElement</ReturnType>
  679. </ReturnValue>
  680. <Parameters>
  681. <Parameter Name="source" Type="Urho.MemoryBuffer" />
  682. <Parameter Name="styleFile" Type="Urho.Resources.XmlFile" />
  683. </Parameters>
  684. <Docs>
  685. <param name="source">To be added.</param>
  686. <param name="styleFile">To be added.</param>
  687. <summary>To be added.</summary>
  688. <returns>To be added.</returns>
  689. <remarks>To be added.</remarks>
  690. </Docs>
  691. </Member>
  692. <Member MemberName="LoadLayout">
  693. <MemberSignature Language="C#" Value="public Urho.Gui.UIElement LoadLayout (Urho.Resources.XmlFile file, Urho.Resources.XmlFile styleFile = null);" />
  694. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Gui.UIElement LoadLayout(class Urho.Resources.XmlFile file, class Urho.Resources.XmlFile styleFile) cil managed" />
  695. <MemberType>Method</MemberType>
  696. <AssemblyInfo>
  697. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  698. </AssemblyInfo>
  699. <ReturnValue>
  700. <ReturnType>Urho.Gui.UIElement</ReturnType>
  701. </ReturnValue>
  702. <Parameters>
  703. <Parameter Name="file" Type="Urho.Resources.XmlFile" />
  704. <Parameter Name="styleFile" Type="Urho.Resources.XmlFile" />
  705. </Parameters>
  706. <Docs>
  707. <param name="file">To be added.</param>
  708. <param name="styleFile">To be added.</param>
  709. <summary>To be added.</summary>
  710. <returns>To be added.</returns>
  711. <remarks>To be added.</remarks>
  712. </Docs>
  713. </Member>
  714. <Member MemberName="LoadLayoutToElement">
  715. <MemberSignature Language="C#" Value="public void LoadLayoutToElement (Urho.Gui.UIElement container, Urho.Resources.ResourceCache cache, string name);" />
  716. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void LoadLayoutToElement(class Urho.Gui.UIElement container, class Urho.Resources.ResourceCache cache, string name) cil managed" />
  717. <MemberType>Method</MemberType>
  718. <AssemblyInfo>
  719. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  720. </AssemblyInfo>
  721. <ReturnValue>
  722. <ReturnType>System.Void</ReturnType>
  723. </ReturnValue>
  724. <Parameters>
  725. <Parameter Name="container" Type="Urho.Gui.UIElement" />
  726. <Parameter Name="cache" Type="Urho.Resources.ResourceCache" />
  727. <Parameter Name="name" Type="System.String" />
  728. </Parameters>
  729. <Docs>
  730. <param name="container">To be added.</param>
  731. <param name="cache">To be added.</param>
  732. <param name="name">To be added.</param>
  733. <summary>To be added.</summary>
  734. <remarks>To be added.</remarks>
  735. </Docs>
  736. </Member>
  737. <Member MemberName="MaxFontTextureSize">
  738. <MemberSignature Language="C#" Value="public int MaxFontTextureSize { get; set; }" />
  739. <MemberSignature Language="ILAsm" Value=".property instance int32 MaxFontTextureSize" />
  740. <MemberType>Property</MemberType>
  741. <AssemblyInfo>
  742. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  743. </AssemblyInfo>
  744. <ReturnValue>
  745. <ReturnType>System.Int32</ReturnType>
  746. </ReturnValue>
  747. <Docs>
  748. <summary>
  749. Return font texture maximum size.
  750. Or
  751. Set maximum font face texture size. Must be a power of two. Default is 2048.
  752. </summary>
  753. <value>To be added.</value>
  754. <remarks>To be added.</remarks>
  755. </Docs>
  756. </Member>
  757. <Member MemberName="NonFocusedMouseWheel">
  758. <MemberSignature Language="C#" Value="public bool NonFocusedMouseWheel { get; set; }" />
  759. <MemberSignature Language="ILAsm" Value=".property instance bool NonFocusedMouseWheel" />
  760. <MemberType>Property</MemberType>
  761. <AssemblyInfo>
  762. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  763. </AssemblyInfo>
  764. <ReturnValue>
  765. <ReturnType>System.Boolean</ReturnType>
  766. </ReturnValue>
  767. <Docs>
  768. <summary>Determines whether mouse wheel can control also a non-focused element..</summary>
  769. <value>To be added.</value>
  770. <remarks>To be added.</remarks>
  771. </Docs>
  772. </Member>
  773. <Member MemberName="NumDragElements">
  774. <MemberSignature Language="C#" Value="public uint NumDragElements { get; }" />
  775. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 NumDragElements" />
  776. <MemberType>Property</MemberType>
  777. <AssemblyInfo>
  778. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  779. </AssemblyInfo>
  780. <ReturnValue>
  781. <ReturnType>System.UInt32</ReturnType>
  782. </ReturnValue>
  783. <Docs>
  784. <summary>
  785. Return the number of currently dragged elements.
  786. </summary>
  787. <value>To be added.</value>
  788. <remarks>To be added.</remarks>
  789. </Docs>
  790. </Member>
  791. <Member MemberName="Render">
  792. <MemberSignature Language="C#" Value="public void Render (bool renderUICommand = false);" />
  793. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Render(bool renderUICommand) cil managed" />
  794. <MemberType>Method</MemberType>
  795. <AssemblyInfo>
  796. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  797. </AssemblyInfo>
  798. <ReturnValue>
  799. <ReturnType>System.Void</ReturnType>
  800. </ReturnValue>
  801. <Parameters>
  802. <Parameter Name="resetRenderTargets" Type="System.Boolean" />
  803. </Parameters>
  804. <Docs>
  805. <param name="renderUICommand">To be added.</param>
  806. <summary>
  807. 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.
  808. </summary>
  809. <remarks>To be added.</remarks>
  810. </Docs>
  811. </Member>
  812. <Member MemberName="RenderUpdate">
  813. <MemberSignature Language="C#" Value="public void RenderUpdate ();" />
  814. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RenderUpdate() cil managed" />
  815. <MemberType>Method</MemberType>
  816. <AssemblyInfo>
  817. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  818. </AssemblyInfo>
  819. <ReturnValue>
  820. <ReturnType>System.Void</ReturnType>
  821. </ReturnValue>
  822. <Parameters />
  823. <Docs>
  824. <summary>
  825. Update the UI for rendering. Called by HandleRenderUpdate().
  826. </summary>
  827. <remarks>To be added.</remarks>
  828. </Docs>
  829. </Member>
  830. <Member MemberName="Root">
  831. <MemberSignature Language="C#" Value="public Urho.Gui.UIElement Root { get; }" />
  832. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Gui.UIElement Root" />
  833. <MemberType>Property</MemberType>
  834. <AssemblyInfo>
  835. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  836. </AssemblyInfo>
  837. <ReturnValue>
  838. <ReturnType>Urho.Gui.UIElement</ReturnType>
  839. </ReturnValue>
  840. <Docs>
  841. <summary>
  842. Return root UI element.
  843. </summary>
  844. <value>To be added.</value>
  845. <remarks>To be added.</remarks>
  846. </Docs>
  847. </Member>
  848. <Member MemberName="RootModalElement">
  849. <MemberSignature Language="C#" Value="public Urho.Gui.UIElement RootModalElement { get; }" />
  850. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Gui.UIElement RootModalElement" />
  851. <MemberType>Property</MemberType>
  852. <AssemblyInfo>
  853. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  854. </AssemblyInfo>
  855. <ReturnValue>
  856. <ReturnType>Urho.Gui.UIElement</ReturnType>
  857. </ReturnValue>
  858. <Docs>
  859. <summary>
  860. Return root modal element.
  861. </summary>
  862. <value>To be added.</value>
  863. <remarks>To be added.</remarks>
  864. </Docs>
  865. </Member>
  866. <Member MemberName="SaveLayout">
  867. <MemberSignature Language="C#" Value="public bool SaveLayout (Urho.IO.File dest, Urho.Gui.UIElement element);" />
  868. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SaveLayout(class Urho.IO.File dest, class Urho.Gui.UIElement element) cil managed" />
  869. <MemberType>Method</MemberType>
  870. <AssemblyInfo>
  871. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  872. </AssemblyInfo>
  873. <ReturnValue>
  874. <ReturnType>System.Boolean</ReturnType>
  875. </ReturnValue>
  876. <Parameters>
  877. <Parameter Name="dest" Type="Urho.IO.File" />
  878. <Parameter Name="element" Type="Urho.Gui.UIElement" />
  879. </Parameters>
  880. <Docs>
  881. <param name="dest">To be added.</param>
  882. <param name="element">To be added.</param>
  883. <summary>To be added.</summary>
  884. <returns>To be added.</returns>
  885. <remarks>To be added.</remarks>
  886. </Docs>
  887. </Member>
  888. <Member MemberName="SaveLayout">
  889. <MemberSignature Language="C#" Value="public bool SaveLayout (Urho.MemoryBuffer dest, Urho.Gui.UIElement element);" />
  890. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SaveLayout(class Urho.MemoryBuffer dest, class Urho.Gui.UIElement element) cil managed" />
  891. <MemberType>Method</MemberType>
  892. <AssemblyInfo>
  893. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  894. </AssemblyInfo>
  895. <ReturnValue>
  896. <ReturnType>System.Boolean</ReturnType>
  897. </ReturnValue>
  898. <Parameters>
  899. <Parameter Name="dest" Type="Urho.MemoryBuffer" />
  900. <Parameter Name="element" Type="Urho.Gui.UIElement" />
  901. </Parameters>
  902. <Docs>
  903. <param name="dest">To be added.</param>
  904. <param name="element">To be added.</param>
  905. <summary>To be added.</summary>
  906. <returns>To be added.</returns>
  907. <remarks>To be added.</remarks>
  908. </Docs>
  909. </Member>
  910. <Member MemberName="Scale">
  911. <MemberSignature Language="C#" Value="public float Scale { get; set; }" />
  912. <MemberSignature Language="ILAsm" Value=".property instance float32 Scale" />
  913. <MemberType>Property</MemberType>
  914. <AssemblyInfo>
  915. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  916. </AssemblyInfo>
  917. <ReturnValue>
  918. <ReturnType>System.Single</ReturnType>
  919. </ReturnValue>
  920. <Docs>
  921. <summary>Return current UI scale.
  922. Or
  923. Set %UI scale. 1.0 is default (pixel perfect). Resize the root element to match.</summary>
  924. <value>To be added.</value>
  925. <remarks>To be added.</remarks>
  926. </Docs>
  927. </Member>
  928. <Member MemberName="SetCustomSize">
  929. <MemberSignature Language="C#" Value="public void SetCustomSize (int width, int height);" />
  930. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetCustomSize(int32 width, int32 height) cil managed" />
  931. <MemberType>Method</MemberType>
  932. <AssemblyInfo>
  933. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  934. </AssemblyInfo>
  935. <ReturnValue>
  936. <ReturnType>System.Void</ReturnType>
  937. </ReturnValue>
  938. <Parameters>
  939. <Parameter Name="width" Type="System.Int32" />
  940. <Parameter Name="height" Type="System.Int32" />
  941. </Parameters>
  942. <Docs>
  943. <param name="width">To be added.</param>
  944. <param name="height">To be added.</param>
  945. <summary>To be added.</summary>
  946. <remarks>To be added.</remarks>
  947. </Docs>
  948. </Member>
  949. <Member MemberName="SetFocusElement">
  950. <MemberSignature Language="C#" Value="public void SetFocusElement (Urho.Gui.UIElement element, bool byKey = false);" />
  951. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetFocusElement(class Urho.Gui.UIElement element, bool byKey) cil managed" />
  952. <MemberType>Method</MemberType>
  953. <AssemblyInfo>
  954. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  955. </AssemblyInfo>
  956. <ReturnValue>
  957. <ReturnType>System.Void</ReturnType>
  958. </ReturnValue>
  959. <Parameters>
  960. <Parameter Name="element" Type="Urho.Gui.UIElement" />
  961. <Parameter Name="byKey" Type="System.Boolean" />
  962. </Parameters>
  963. <Docs>
  964. <param name="element">To be added.</param>
  965. <param name="byKey">To be added.</param>
  966. <summary>
  967. Set focused UI element.
  968. </summary>
  969. <remarks>To be added.</remarks>
  970. </Docs>
  971. </Member>
  972. <Member MemberName="SetHeight">
  973. <MemberSignature Language="C#" Value="public void SetHeight (float height);" />
  974. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetHeight(float32 height) cil managed" />
  975. <MemberType>Method</MemberType>
  976. <AssemblyInfo>
  977. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  978. </AssemblyInfo>
  979. <ReturnValue>
  980. <ReturnType>System.Void</ReturnType>
  981. </ReturnValue>
  982. <Parameters>
  983. <Parameter Name="size" Type="System.Single" />
  984. </Parameters>
  985. <Docs>
  986. <param name="height">To be added.</param>
  987. <summary>To be added.</summary>
  988. <remarks>To be added.</remarks>
  989. </Docs>
  990. </Member>
  991. <Member MemberName="SetModalElement">
  992. <MemberSignature Language="C#" Value="public bool SetModalElement (Urho.Gui.UIElement modalElement, bool enable);" />
  993. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SetModalElement(class Urho.Gui.UIElement modalElement, bool enable) cil managed" />
  994. <MemberType>Method</MemberType>
  995. <AssemblyInfo>
  996. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  997. </AssemblyInfo>
  998. <ReturnValue>
  999. <ReturnType>System.Boolean</ReturnType>
  1000. </ReturnValue>
  1001. <Parameters>
  1002. <Parameter Name="modalElement" Type="Urho.Gui.UIElement" />
  1003. <Parameter Name="enable" Type="System.Boolean" />
  1004. </Parameters>
  1005. <Docs>
  1006. <param name="modalElement">To be added.</param>
  1007. <param name="enable">To be added.</param>
  1008. <summary>
  1009. Set modal element. Until all the modal elements are dismissed, all the inputs and events are only sent to them. Return true when successful.
  1010. Only the modal element can clear its modal status or when it is being destructed.
  1011. </summary>
  1012. <returns>To be added.</returns>
  1013. <remarks>To be added.</remarks>
  1014. </Docs>
  1015. </Member>
  1016. <Member MemberName="SetRenderToTexture">
  1017. <MemberSignature Language="C#" Value="public void SetRenderToTexture (Urho.UIComponent component, bool enable);" />
  1018. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetRenderToTexture(class Urho.UIComponent component, bool enable) cil managed" />
  1019. <MemberType>Method</MemberType>
  1020. <AssemblyInfo>
  1021. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1022. </AssemblyInfo>
  1023. <ReturnValue>
  1024. <ReturnType>System.Void</ReturnType>
  1025. </ReturnValue>
  1026. <Parameters>
  1027. <Parameter Name="component" Type="Urho.UIComponent" />
  1028. <Parameter Name="enable" Type="System.Boolean" />
  1029. </Parameters>
  1030. <Docs>
  1031. <param name="component">To be added.</param>
  1032. <param name="enable">To be added.</param>
  1033. <summary>To be added.</summary>
  1034. <remarks>To be added.</remarks>
  1035. </Docs>
  1036. </Member>
  1037. <Member MemberName="SetWidth">
  1038. <MemberSignature Language="C#" Value="public void SetWidth (float width);" />
  1039. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetWidth(float32 width) cil managed" />
  1040. <MemberType>Method</MemberType>
  1041. <AssemblyInfo>
  1042. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1043. </AssemblyInfo>
  1044. <ReturnValue>
  1045. <ReturnType>System.Void</ReturnType>
  1046. </ReturnValue>
  1047. <Parameters>
  1048. <Parameter Name="size" Type="System.Single" />
  1049. </Parameters>
  1050. <Docs>
  1051. <param name="width">To be added.</param>
  1052. <summary>To be added.</summary>
  1053. <remarks>To be added.</remarks>
  1054. </Docs>
  1055. </Member>
  1056. <Member MemberName="SubscribeToFocusChanged">
  1057. <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToFocusChanged (Action&lt;Urho.Gui.FocusChangedEventArgs&gt; handler);" />
  1058. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToFocusChanged(class System.Action`1&lt;valuetype Urho.Gui.FocusChangedEventArgs&gt; handler) cil managed" />
  1059. <MemberType>Method</MemberType>
  1060. <AssemblyInfo>
  1061. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1062. </AssemblyInfo>
  1063. <Attributes>
  1064. <Attribute>
  1065. <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.FocusChanged += ...' instead.")</AttributeName>
  1066. </Attribute>
  1067. </Attributes>
  1068. <ReturnValue>
  1069. <ReturnType>Urho.Subscription</ReturnType>
  1070. </ReturnValue>
  1071. <Parameters>
  1072. <Parameter Name="handler" Type="System.Action&lt;Urho.Gui.FocusChangedEventArgs&gt;" />
  1073. </Parameters>
  1074. <Docs>
  1075. <param name="handler">The handler to invoke when this event is raised.</param>
  1076. <summary>Subscribes to the FocusChanged event raised by the UI.</summary>
  1077. <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
  1078. <remarks>
  1079. <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
  1080. <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
  1081. <para>For a more event-like approach, use the <see cref="E:Urho.Gui.UI.FocusChanged" /> event.</para>
  1082. </remarks>
  1083. </Docs>
  1084. </Member>
  1085. <Member MemberName="SubscribeToUIDropFile">
  1086. <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToUIDropFile (Action&lt;Urho.Gui.UIDropFileEventArgs&gt; handler);" />
  1087. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToUIDropFile(class System.Action`1&lt;valuetype Urho.Gui.UIDropFileEventArgs&gt; handler) cil managed" />
  1088. <MemberType>Method</MemberType>
  1089. <AssemblyInfo>
  1090. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1091. </AssemblyInfo>
  1092. <Attributes>
  1093. <Attribute>
  1094. <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.UIDropFile += ...' instead.")</AttributeName>
  1095. </Attribute>
  1096. </Attributes>
  1097. <ReturnValue>
  1098. <ReturnType>Urho.Subscription</ReturnType>
  1099. </ReturnValue>
  1100. <Parameters>
  1101. <Parameter Name="handler" Type="System.Action&lt;Urho.Gui.UIDropFileEventArgs&gt;" />
  1102. </Parameters>
  1103. <Docs>
  1104. <param name="handler">The handler to invoke when this event is raised.</param>
  1105. <summary>Subscribes to the UIDropFile event raised by the UI.</summary>
  1106. <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
  1107. <remarks>
  1108. <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
  1109. <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
  1110. <para>For a more event-like approach, use the <see cref="E:Urho.Gui.UI.UIDropFile" /> event.</para>
  1111. </remarks>
  1112. </Docs>
  1113. </Member>
  1114. <Member MemberName="SubscribeToUIMouseClick">
  1115. <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToUIMouseClick (Action&lt;Urho.Gui.UIMouseClickEventArgs&gt; handler);" />
  1116. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToUIMouseClick(class System.Action`1&lt;valuetype Urho.Gui.UIMouseClickEventArgs&gt; handler) cil managed" />
  1117. <MemberType>Method</MemberType>
  1118. <AssemblyInfo>
  1119. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1120. </AssemblyInfo>
  1121. <Attributes>
  1122. <Attribute>
  1123. <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.UIMouseClick += ...' instead.")</AttributeName>
  1124. </Attribute>
  1125. </Attributes>
  1126. <ReturnValue>
  1127. <ReturnType>Urho.Subscription</ReturnType>
  1128. </ReturnValue>
  1129. <Parameters>
  1130. <Parameter Name="handler" Type="System.Action&lt;Urho.Gui.UIMouseClickEventArgs&gt;" />
  1131. </Parameters>
  1132. <Docs>
  1133. <param name="handler">The handler to invoke when this event is raised.</param>
  1134. <summary>Subscribes to the UIMouseClick event raised by the UI.</summary>
  1135. <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
  1136. <remarks>
  1137. <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
  1138. <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
  1139. <para>For a more event-like approach, use the <see cref="E:Urho.Gui.UI.UIMouseClick" /> event.</para>
  1140. </remarks>
  1141. </Docs>
  1142. </Member>
  1143. <Member MemberName="SubscribeToUIMouseClickEnd">
  1144. <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToUIMouseClickEnd (Action&lt;Urho.Gui.UIMouseClickEndEventArgs&gt; handler);" />
  1145. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToUIMouseClickEnd(class System.Action`1&lt;valuetype Urho.Gui.UIMouseClickEndEventArgs&gt; handler) cil managed" />
  1146. <MemberType>Method</MemberType>
  1147. <AssemblyInfo>
  1148. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1149. </AssemblyInfo>
  1150. <Attributes>
  1151. <Attribute>
  1152. <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.UIMouseClickEnd += ...' instead.")</AttributeName>
  1153. </Attribute>
  1154. </Attributes>
  1155. <ReturnValue>
  1156. <ReturnType>Urho.Subscription</ReturnType>
  1157. </ReturnValue>
  1158. <Parameters>
  1159. <Parameter Name="handler" Type="System.Action&lt;Urho.Gui.UIMouseClickEndEventArgs&gt;" />
  1160. </Parameters>
  1161. <Docs>
  1162. <param name="handler">The handler to invoke when this event is raised.</param>
  1163. <summary>Subscribes to the UIMouseClickEnd event raised by the UI.</summary>
  1164. <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
  1165. <remarks>
  1166. <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
  1167. <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
  1168. <para>For a more event-like approach, use the <see cref="E:Urho.Gui.UI.UIMouseClickEnd" /> event.</para>
  1169. </remarks>
  1170. </Docs>
  1171. </Member>
  1172. <Member MemberName="Type">
  1173. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  1174. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  1175. <MemberType>Property</MemberType>
  1176. <AssemblyInfo>
  1177. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1178. </AssemblyInfo>
  1179. <ReturnValue>
  1180. <ReturnType>Urho.StringHash</ReturnType>
  1181. </ReturnValue>
  1182. <Docs>
  1183. <summary>Urho's type system type.</summary>
  1184. <value>StringHash representing the type for this C# type.</value>
  1185. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  1186. </Docs>
  1187. </Member>
  1188. <Member MemberName="TypeName">
  1189. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  1190. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  1191. <MemberType>Property</MemberType>
  1192. <AssemblyInfo>
  1193. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1194. </AssemblyInfo>
  1195. <ReturnValue>
  1196. <ReturnType>System.String</ReturnType>
  1197. </ReturnValue>
  1198. <Docs>
  1199. <summary>Urho's low-level type name.</summary>
  1200. <value>Stringified low-level type name.</value>
  1201. <remarks>
  1202. </remarks>
  1203. </Docs>
  1204. </Member>
  1205. <Member MemberName="TypeNameStatic">
  1206. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  1207. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  1208. <MemberType>Property</MemberType>
  1209. <AssemblyInfo>
  1210. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1211. </AssemblyInfo>
  1212. <ReturnValue>
  1213. <ReturnType>System.String</ReturnType>
  1214. </ReturnValue>
  1215. <Docs>
  1216. <summary>Urho's low-level type name, accessible as a static method.</summary>
  1217. <value>Stringified low-level type name.</value>
  1218. <remarks>
  1219. </remarks>
  1220. </Docs>
  1221. </Member>
  1222. <Member MemberName="TypeStatic">
  1223. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  1224. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  1225. <MemberType>Property</MemberType>
  1226. <AssemblyInfo>
  1227. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1228. </AssemblyInfo>
  1229. <Attributes>
  1230. <Attribute>
  1231. <AttributeName>Preserve</AttributeName>
  1232. </Attribute>
  1233. </Attributes>
  1234. <ReturnValue>
  1235. <ReturnType>Urho.StringHash</ReturnType>
  1236. </ReturnValue>
  1237. <Docs>
  1238. <summary>Urho's low-level type, accessible as a static method.</summary>
  1239. <value>This returns the Urho's type and is surface for the low-level Urho code.</value>
  1240. <remarks>
  1241. </remarks>
  1242. </Docs>
  1243. </Member>
  1244. <Member MemberName="UIDropFile">
  1245. <MemberSignature Language="C#" Value="public event Action&lt;Urho.Gui.UIDropFileEventArgs&gt; UIDropFile;" />
  1246. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.Gui.UIDropFileEventArgs&gt; UIDropFile" />
  1247. <MemberType>Event</MemberType>
  1248. <AssemblyInfo>
  1249. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1250. </AssemblyInfo>
  1251. <ReturnValue>
  1252. <ReturnType>System.Action&lt;Urho.Gui.UIDropFileEventArgs&gt;</ReturnType>
  1253. </ReturnValue>
  1254. <Docs>
  1255. <summary>To be added.</summary>
  1256. <remarks>
  1257. <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToUIDropFile" /> method. That one will force that callback and will ignore any previously set events here.</para>
  1258. </remarks>
  1259. </Docs>
  1260. </Member>
  1261. <Member MemberName="UIMouseClick">
  1262. <MemberSignature Language="C#" Value="public event Action&lt;Urho.Gui.UIMouseClickEventArgs&gt; UIMouseClick;" />
  1263. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.Gui.UIMouseClickEventArgs&gt; UIMouseClick" />
  1264. <MemberType>Event</MemberType>
  1265. <AssemblyInfo>
  1266. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1267. </AssemblyInfo>
  1268. <ReturnValue>
  1269. <ReturnType>System.Action&lt;Urho.Gui.UIMouseClickEventArgs&gt;</ReturnType>
  1270. </ReturnValue>
  1271. <Docs>
  1272. <summary>To be added.</summary>
  1273. <remarks>
  1274. <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToUIMouseClick" /> method. That one will force that callback and will ignore any previously set events here.</para>
  1275. </remarks>
  1276. </Docs>
  1277. </Member>
  1278. <Member MemberName="UIMouseClickEnd">
  1279. <MemberSignature Language="C#" Value="public event Action&lt;Urho.Gui.UIMouseClickEndEventArgs&gt; UIMouseClickEnd;" />
  1280. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.Gui.UIMouseClickEndEventArgs&gt; UIMouseClickEnd" />
  1281. <MemberType>Event</MemberType>
  1282. <AssemblyInfo>
  1283. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1284. </AssemblyInfo>
  1285. <ReturnValue>
  1286. <ReturnType>System.Action&lt;Urho.Gui.UIMouseClickEndEventArgs&gt;</ReturnType>
  1287. </ReturnValue>
  1288. <Docs>
  1289. <summary>To be added.</summary>
  1290. <remarks>
  1291. <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToUIMouseClickEnd" /> method. That one will force that callback and will ignore any previously set events here.</para>
  1292. </remarks>
  1293. </Docs>
  1294. </Member>
  1295. <Member MemberName="Update">
  1296. <MemberSignature Language="C#" Value="public void Update (float timeStep);" />
  1297. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Update(float32 timeStep) cil managed" />
  1298. <MemberType>Method</MemberType>
  1299. <AssemblyInfo>
  1300. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1301. </AssemblyInfo>
  1302. <ReturnValue>
  1303. <ReturnType>System.Void</ReturnType>
  1304. </ReturnValue>
  1305. <Parameters>
  1306. <Parameter Name="timeStep" Type="System.Single" />
  1307. </Parameters>
  1308. <Docs>
  1309. <param name="timeStep">To be added.</param>
  1310. <summary>
  1311. Update the UI logic. Called by HandlePostUpdate().
  1312. </summary>
  1313. <remarks>To be added.</remarks>
  1314. </Docs>
  1315. </Member>
  1316. <Member MemberName="UseMutableGlyphs">
  1317. <MemberSignature Language="C#" Value="public bool UseMutableGlyphs { get; set; }" />
  1318. <MemberSignature Language="ILAsm" Value=".property instance bool UseMutableGlyphs" />
  1319. <MemberType>Property</MemberType>
  1320. <AssemblyInfo>
  1321. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1322. </AssemblyInfo>
  1323. <ReturnValue>
  1324. <ReturnType>System.Boolean</ReturnType>
  1325. </ReturnValue>
  1326. <Docs>
  1327. <summary>
  1328. Return whether is using mutable (eraseable) glyphs for fonts.
  1329. Or
  1330. Set whether to use mutable (eraseable) glyphs to ensure a font face never expands to more than one texture. Default false.
  1331. </summary>
  1332. <value>To be added.</value>
  1333. <remarks>To be added.</remarks>
  1334. </Docs>
  1335. </Member>
  1336. <Member MemberName="UseScreenKeyboard">
  1337. <MemberSignature Language="C#" Value="public bool UseScreenKeyboard { get; set; }" />
  1338. <MemberSignature Language="ILAsm" Value=".property instance bool UseScreenKeyboard" />
  1339. <MemberType>Property</MemberType>
  1340. <AssemblyInfo>
  1341. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1342. </AssemblyInfo>
  1343. <ReturnValue>
  1344. <ReturnType>System.Boolean</ReturnType>
  1345. </ReturnValue>
  1346. <Docs>
  1347. <summary>
  1348. Return whether focusing a %LineEdit will show the on-screen keyboard.
  1349. Or
  1350. Set whether to show the on-screen keyboard (if supported) when a %LineEdit is focused. Default true on mobile devices.
  1351. </summary>
  1352. <value>To be added.</value>
  1353. <remarks>To be added.</remarks>
  1354. </Docs>
  1355. </Member>
  1356. <Member MemberName="UseSystemClipboard">
  1357. <MemberSignature Language="C#" Value="public bool UseSystemClipboard { get; set; }" />
  1358. <MemberSignature Language="ILAsm" Value=".property instance bool UseSystemClipboard" />
  1359. <MemberType>Property</MemberType>
  1360. <AssemblyInfo>
  1361. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1362. </AssemblyInfo>
  1363. <ReturnValue>
  1364. <ReturnType>System.Boolean</ReturnType>
  1365. </ReturnValue>
  1366. <Docs>
  1367. <summary>
  1368. Return whether is using the system clipboard.
  1369. Or
  1370. Set whether to use system clipboard. Default false.
  1371. </summary>
  1372. <value>To be added.</value>
  1373. <remarks>To be added.</remarks>
  1374. </Docs>
  1375. </Member>
  1376. </Members>
  1377. </Type>