PageRenderTime 49ms CodeModel.GetById 15ms RepoModel.GetById 0ms app.codeStats 0ms

/Dlls/Delta.Scenes.UserInterfaces.xml

#
XML | 1478 lines | 1478 code | 0 blank | 0 comment | 0 complexity | 873e657cc50af9f23a219ef19ca8db56 MD5 | raw file
Possible License(s): Apache-2.0

Large files files are truncated, but you can click here to view the full file

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Delta.Scenes.UserInterfaces</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Delta.Scenes.UserInterfaces.Controls.TextBox">
  8. <summary>
  9. This class represents a simple (single-line) Text box control which
  10. allows the user doing input like e.g. to enter his name and confirm it by
  11. an the 'Enter' key.
  12. </summary>
  13. </member>
  14. <member name="T:Delta.Scenes.UserInterfaces.Controls.Label">
  15. <summary>
  16. This is a simple label control for displaying (read-only) text on a
  17. screen.
  18. </summary>
  19. </member>
  20. <member name="F:Delta.Scenes.UserInterfaces.Controls.Label.VersionNumber">
  21. <summary>
  22. The current version of the implementation of this control class.
  23. </summary>
  24. </member>
  25. <member name="F:Delta.Scenes.UserInterfaces.Controls.Label.text">
  26. <summary>
  27. Text to display on this label.
  28. </summary>
  29. </member>
  30. <member name="F:Delta.Scenes.UserInterfaces.Controls.Label.lastText">
  31. <summary>
  32. The last set text of this element which is used to "detect" text
  33. changes of the element by the user.
  34. </summary>
  35. </member>
  36. <member name="F:Delta.Scenes.UserInterfaces.Controls.Label.labelDesign">
  37. <summary>
  38. Label design
  39. </summary>
  40. </member>
  41. <member name="M:Delta.Scenes.UserInterfaces.Controls.Label.#ctor">
  42. <summary>
  43. Create label
  44. </summary>
  45. </member>
  46. <member name="M:Delta.Scenes.UserInterfaces.Controls.Label.Save(System.IO.BinaryWriter)">
  47. <summary>
  48. Saves all data which are necessary to restore the object again.
  49. </summary>
  50. <param name="dataWriter">
  51. The writer which contains the stream where the data should be saved
  52. into now.
  53. </param>
  54. </member>
  55. <member name="M:Delta.Scenes.UserInterfaces.Controls.Label.Load(System.IO.BinaryReader)">
  56. <summary>
  57. Loads and restores all previously saved values that belongs to this
  58. class only from the given data reader.
  59. </summary>
  60. <param name="dataReader">
  61. The reader which contains the stream with the saved data which needs to
  62. be loaded now.
  63. </param>
  64. </member>
  65. <member name="M:Delta.Scenes.UserInterfaces.Controls.Label.OnSizeChanging(Delta.Utilities.Datatypes.Size)">
  66. <summary>
  67. On size changing
  68. </summary>
  69. <param name="oldSize">Old size</param>
  70. <returns>
  71. 'True' if the new value can be used or 'false' if the change should be
  72. aborted.
  73. </returns>
  74. </member>
  75. <member name="M:Delta.Scenes.UserInterfaces.Controls.Label.OnDesignChanging(Delta.Scenes.ControlDesign)">
  76. <summary>
  77. On design changed
  78. </summary>
  79. <param name="oldDesign">Old design</param>
  80. <returns>
  81. 'True' if the new value can be used or 'false' if the change should be
  82. aborted.
  83. </returns>
  84. </member>
  85. <member name="M:Delta.Scenes.UserInterfaces.Controls.Label.OnTextChanging(System.String)">
  86. <summary>
  87. On text changing
  88. </summary>
  89. <param name="oldText">Old text</param>
  90. <returns>
  91. 'True' if the new value can be used or 'false' if the change should be
  92. aborted.
  93. </returns>
  94. </member>
  95. <member name="M:Delta.Scenes.UserInterfaces.Controls.Label.DetectChanges">
  96. <summary>
  97. This method implements the checks of the changes which are should be
  98. detected in this element. It also cares about triggering the events and
  99. the event handler methods.
  100. </summary>
  101. </member>
  102. <member name="M:Delta.Scenes.UserInterfaces.Controls.Label.DrawData">
  103. <summary>
  104. Draws all data of this Label which needs to be visualized.
  105. </summary>
  106. <remarks>
  107. This method will only be called if the Label is in a visible state.
  108. </remarks>
  109. </member>
  110. <member name="M:Delta.Scenes.UserInterfaces.Controls.Label.GetDisplayText">
  111. <summary>
  112. Get display text
  113. </summary>
  114. </member>
  115. <member name="M:Delta.Scenes.UserInterfaces.Controls.Label.DrawDebugInfo">
  116. <summary>
  117. Draw debug info
  118. </summary>
  119. </member>
  120. <member name="M:Delta.Scenes.UserInterfaces.Controls.Label.ShortElementInfo">
  121. <summary>
  122. Short control info
  123. </summary>
  124. </member>
  125. <member name="P:Delta.Scenes.UserInterfaces.Controls.Label.Text">
  126. <summary>
  127. The displayed text, will be localized automatically (make sure you have
  128. an entry for this in your Localization.xml content file).
  129. </summary>
  130. </member>
  131. <member name="P:Delta.Scenes.UserInterfaces.Controls.Label.TextContentElement">
  132. <summary>
  133. The content element which
  134. </summary>
  135. <returns>Dockable element</returns>
  136. </member>
  137. <member name="P:Delta.Scenes.UserInterfaces.Controls.Label.IsTextElementAutoSizing">
  138. <summary>
  139. Indicates if the TextContentElement applies the same size as the Label
  140. every time the size of this Label changes
  141. <para />
  142. Note: Default is 'true'.
  143. </summary>
  144. </member>
  145. <member name="P:Delta.Scenes.UserInterfaces.Controls.Label.TextDrawArea">
  146. <summary>
  147. Text draw area
  148. </summary>
  149. </member>
  150. <member name="P:Delta.Scenes.UserInterfaces.Controls.Label.FallbackDesign">
  151. <summary>
  152. Defines the theme which will be used if no "Theme" was set explicitely.
  153. </summary>
  154. </member>
  155. <member name="P:Delta.Scenes.UserInterfaces.Controls.Label.TextFont">
  156. <summary>
  157. The font which is used to displaying the text.
  158. </summary>
  159. <remarks>
  160. This value get updated everytime the design of the Label changes.
  161. </remarks>
  162. <returns>Font</returns>
  163. </member>
  164. <member name="E:Delta.Scenes.UserInterfaces.Controls.Label.TextChanged">
  165. <summary>
  166. Occurs every time the text of the label will be changed.
  167. </summary>
  168. </member>
  169. <member name="T:Delta.Scenes.UserInterfaces.Controls.Label.TextChangedEvent">
  170. <summary>
  171. The delegate declaration for the text changed event.
  172. </summary>
  173. <param name="sender">Sender</param>
  174. <param name="inputData">The data of that event</param>
  175. </member>
  176. <member name="T:Delta.Scenes.UserInterfaces.Controls.Label.LabelTests">
  177. <summary>
  178. Tests for Label controls
  179. </summary>
  180. </member>
  181. <member name="F:Delta.Scenes.UserInterfaces.Controls.Label.LabelTests.TestLabelDesign">
  182. <summary>
  183. Test label design
  184. </summary>
  185. </member>
  186. <member name="M:Delta.Scenes.UserInterfaces.Controls.Label.LabelTests.Clone">
  187. <summary>
  188. Clone
  189. </summary>
  190. </member>
  191. <member name="M:Delta.Scenes.UserInterfaces.Controls.Label.LabelTests.DisplayLabel">
  192. <summary>
  193. Display label
  194. </summary>
  195. </member>
  196. <member name="M:Delta.Scenes.UserInterfaces.Controls.Label.LabelTests.DisabledLabel">
  197. <summary>
  198. Disabled label
  199. </summary>
  200. </member>
  201. <member name="M:Delta.Scenes.UserInterfaces.Controls.Label.LabelTests.TextAlignment">
  202. <summary>
  203. Text alignment
  204. </summary>
  205. </member>
  206. <member name="M:Delta.Scenes.UserInterfaces.Controls.Label.LabelTests.DisplayMultilineText">
  207. <summary>
  208. Display multiline text
  209. </summary>
  210. </member>
  211. <member name="M:Delta.Scenes.UserInterfaces.Controls.Label.LabelTests.Docking">
  212. <summary>
  213. Docking
  214. </summary>
  215. </member>
  216. <member name="M:Delta.Scenes.UserInterfaces.Controls.Label.LabelTests.Alignment">
  217. <summary>
  218. Alignment
  219. </summary>
  220. </member>
  221. <member name="M:Delta.Scenes.UserInterfaces.Controls.Label.LabelTests.ChildAlignment">
  222. <summary>
  223. Child alignment
  224. </summary>
  225. </member>
  226. <member name="M:Delta.Scenes.UserInterfaces.Controls.Label.LabelTests.DrawLabelDepthTest">
  227. <summary>
  228. Draw Label Depth Test
  229. </summary>
  230. </member>
  231. <member name="F:Delta.Scenes.UserInterfaces.Controls.TextBox.VersionNumber">
  232. <summary>
  233. The current version of the implementation of this class.
  234. </summary>
  235. </member>
  236. <member name="F:Delta.Scenes.UserInterfaces.Controls.TextBox.textCursor">
  237. <summary>
  238. The instance of the text cursor we show if the text editing mode is
  239. enabled.
  240. </summary>
  241. </member>
  242. <member name="M:Delta.Scenes.UserInterfaces.Controls.TextBox.#ctor">
  243. <summary>
  244. Creates a Text box instance.
  245. </summary>
  246. </member>
  247. <member name="M:Delta.Scenes.UserInterfaces.Controls.TextBox.Save(System.IO.BinaryWriter)">
  248. <summary>
  249. Saves all data which are necessary to restore the object again.
  250. </summary>
  251. <param name="dataWriter">
  252. The writer which contains the stream where the data should be saved
  253. into now.
  254. </param>
  255. </member>
  256. <member name="M:Delta.Scenes.UserInterfaces.Controls.TextBox.Load(System.IO.BinaryReader)">
  257. <summary>
  258. Loads and restores all previously saved values that belongs to this
  259. class only from the given data reader.
  260. </summary>
  261. <param name="dataReader">
  262. The reader which contains the stream with the saved data which needs to
  263. be loaded now.
  264. </param>
  265. </member>
  266. <member name="M:Delta.Scenes.UserInterfaces.Controls.TextBox.OnInputEvent(Delta.InputSystem.CommandTrigger)">
  267. <summary>
  268. On input event
  269. </summary>
  270. <param name="input">Input data</param>
  271. </member>
  272. <member name="M:Delta.Scenes.UserInterfaces.Controls.TextBox.OnTextChanging(System.String)">
  273. <summary>
  274. On text changing
  275. </summary>
  276. <param name="oldText">Old text</param>
  277. <returns>
  278. 'True' if the new value can be used or 'false' if the change should be
  279. aborted.
  280. </returns>
  281. </member>
  282. <member name="M:Delta.Scenes.UserInterfaces.Controls.TextBox.UpdateDrawData">
  283. <summary>
  284. Updates all data of this element which are required for the following
  285. draw call.
  286. </summary>
  287. <remarks>
  288. This method will only be called if the element is in an enabled state.
  289. </remarks>
  290. </member>
  291. <member name="M:Delta.Scenes.UserInterfaces.Controls.TextBox.DrawData">
  292. <summary>
  293. Draws all data of this TextBox which needs to be visualized.
  294. </summary>
  295. <remarks>
  296. This method will only be called if the TextBox is in a visible state.
  297. </remarks>
  298. </member>
  299. <member name="M:Delta.Scenes.UserInterfaces.Controls.TextBox.DrawDebugInfo">
  300. <summary>
  301. Draw debug info
  302. </summary>
  303. </member>
  304. <member name="P:Delta.Scenes.UserInterfaces.Controls.TextBox.MaxCharacters">
  305. <summary>
  306. Maximum characters
  307. </summary>
  308. </member>
  309. <member name="P:Delta.Scenes.UserInterfaces.Controls.TextBox.IsReadOnly">
  310. <summary>
  311. Is the Text box read only
  312. </summary>
  313. </member>
  314. <member name="P:Delta.Scenes.UserInterfaces.Controls.TextBox.FallbackDesign">
  315. <summary>
  316. Defines the design which will be used if no "Design" was set
  317. explicitely.
  318. </summary>
  319. </member>
  320. <member name="P:Delta.Scenes.UserInterfaces.Controls.TextBox.IsTextEditingOn">
  321. <summary>
  322. Is text editing on
  323. </summary>
  324. </member>
  325. <member name="T:Delta.Scenes.UserInterfaces.Controls.TextBox.TextCursor">
  326. <summary>
  327. Text cursor
  328. </summary>
  329. </member>
  330. <member name="F:Delta.Scenes.UserInterfaces.Controls.TextBox.TextCursor.BlinkInterval">
  331. <summary>
  332. The interval time (in seconds) for change the visible state from the
  333. cursor
  334. </summary>
  335. </member>
  336. <member name="F:Delta.Scenes.UserInterfaces.Controls.TextBox.TextCursor.Owner">
  337. <summary>
  338. The Text box where the cursor belongs to.
  339. </summary>
  340. </member>
  341. <member name="F:Delta.Scenes.UserInterfaces.Controls.TextBox.TextCursor.fullTextWidth">
  342. <summary>
  343. The with of the whole text of the TextBox (required for setting the
  344. cursor position correctly for all text alignment modes).
  345. </summary>
  346. </member>
  347. <member name="F:Delta.Scenes.UserInterfaces.Controls.TextBox.TextCursor.cursorTextWidth">
  348. <summary>
  349. The current from the text beginning to know where to draw the final
  350. current cursor line
  351. </summary>
  352. </member>
  353. <member name="F:Delta.Scenes.UserInterfaces.Controls.TextBox.TextCursor.currentDrawnTime">
  354. <summary>
  355. The duration (in seconds) thenceforth the cursor is shown.
  356. (-> Used for the "blinking effect")
  357. </summary>
  358. </member>
  359. <member name="M:Delta.Scenes.UserInterfaces.Controls.TextBox.TextCursor.#ctor(Delta.Scenes.UserInterfaces.Controls.TextBox)">
  360. <summary>
  361. Create text cursor
  362. </summary>
  363. <param name="setOwner">Set owner</param>
  364. </member>
  365. <member name="M:Delta.Scenes.UserInterfaces.Controls.TextBox.TextCursor.OnOwnerTextHasChanged">
  366. <summary>
  367. Occurs every time the amount of text character changes, e.g by
  368. adding or removing one while the text editing mode is enabled.
  369. </summary>
  370. </member>
  371. <member name="M:Delta.Scenes.UserInterfaces.Controls.TextBox.TextCursor.Update">
  372. <summary>
  373. Does all the magic to handle the cursor events like blinking.
  374. </summary>
  375. </member>
  376. <member name="M:Delta.Scenes.UserInterfaces.Controls.TextBox.TextCursor.Draw(Delta.Utilities.Datatypes.Color)">
  377. <summary>
  378. Visualizes the cursor.
  379. </summary>
  380. </member>
  381. <member name="M:Delta.Scenes.UserInterfaces.Controls.TextBox.TextCursor.StartBlinking">
  382. <summary>
  383. Starts the blinking of the cursor.
  384. </summary>
  385. </member>
  386. <member name="M:Delta.Scenes.UserInterfaces.Controls.TextBox.TextCursor.StopBlinking">
  387. <summary>
  388. Stops the blinking of the cursor.
  389. </summary>
  390. </member>
  391. <member name="P:Delta.Scenes.UserInterfaces.Controls.TextBox.TextCursor.IsVisibleNow">
  392. <summary>
  393. Returns 'true' if the cursor can/needs to be shown now.
  394. </summary>
  395. </member>
  396. <member name="P:Delta.Scenes.UserInterfaces.Controls.TextBox.TextCursor.CharNumber">
  397. <summary>
  398. Sets the cursor position after specified char (by its number,
  399. 1 - ...).
  400. </summary>
  401. </member>
  402. <member name="T:Delta.Scenes.UserInterfaces.Controls.TextBox.Tests">
  403. <summary>
  404. Tests for TextBox controls
  405. </summary>
  406. </member>
  407. <member name="M:Delta.Scenes.UserInterfaces.Controls.TextBox.Tests.DisplayTextbox">
  408. <summary>
  409. Display text box
  410. </summary>
  411. </member>
  412. <member name="T:Delta.Scenes.UserInterfaces.Controls.Image">
  413. <summary>
  414. This class represents a control for displaying images via materials on
  415. the screen.
  416. </summary>
  417. </member>
  418. <member name="P:Delta.Scenes.UserInterfaces.Controls.Image.FallbackDesign">
  419. <summary>
  420. Defines the theme which will be used if no "Theme" was set explicitely.
  421. </summary>
  422. </member>
  423. <member name="T:Delta.Scenes.UserInterfaces.Controls.Image.ImageTests">
  424. <summary>
  425. Tests for Image controls
  426. </summary>
  427. </member>
  428. <member name="M:Delta.Scenes.UserInterfaces.Controls.Image.ImageTests.AddChild">
  429. <summary>
  430. Add child. Note: Too slow for a dynamic unit test.
  431. </summary>
  432. </member>
  433. <member name="M:Delta.Scenes.UserInterfaces.Controls.Image.ImageTests.DisplayImage">
  434. <summary>
  435. Display image
  436. </summary>
  437. </member>
  438. <member name="M:Delta.Scenes.UserInterfaces.Controls.Image.ImageTests.Hovering">
  439. <summary>
  440. Hovering
  441. </summary>
  442. </member>
  443. <member name="M:Delta.Scenes.UserInterfaces.Controls.Image.ImageTests.DisplayImageRotated">
  444. <summary>
  445. Display image rotated
  446. </summary>
  447. </member>
  448. <member name="M:Delta.Scenes.UserInterfaces.Controls.Image.ImageTests.MouseDrag">
  449. <summary>
  450. Mouse drag. Testing with depth values
  451. </summary>
  452. </member>
  453. <member name="M:Delta.Scenes.UserInterfaces.Controls.Image.ImageTests.MouseDragComplexDepths">
  454. <summary>
  455. Mouse drag. Testing with complex, nested depth values
  456. </summary>
  457. </member>
  458. <member name="T:Delta.Scenes.UserInterfaces.Designs.CheckboxDesign">
  459. <summary>
  460. The design for a Checkbox or RadioButton control.
  461. </summary>
  462. </member>
  463. <member name="T:Delta.Scenes.UserInterfaces.Designs.TextControlDesign">
  464. <summary>
  465. Label design.
  466. TODO: add better description.
  467. </summary>
  468. </member>
  469. <member name="P:Delta.Scenes.UserInterfaces.Designs.ITextDesign.TextFont">
  470. <summary>
  471. The font which is used to displaying the text.
  472. </summary>
  473. </member>
  474. <member name="P:Delta.Scenes.UserInterfaces.Designs.ITextDesign.DisabledTextFont">
  475. <summary>
  476. The font which is used to displaying the text if the control is in the
  477. "Disabled" state.
  478. </summary>
  479. </member>
  480. <member name="F:Delta.Scenes.UserInterfaces.Designs.TextControlDesign.VersionNumber">
  481. <summary>
  482. The current version of the implementation of this class.
  483. </summary>
  484. </member>
  485. <member name="F:Delta.Scenes.UserInterfaces.Designs.TextControlDesign.textFont">
  486. <summary>
  487. Text font used, usually set because this is a text control design
  488. after all. If nothing is set will be set to the fallback Font.Default.
  489. </summary>
  490. </member>
  491. <member name="F:Delta.Scenes.UserInterfaces.Designs.TextControlDesign.disabledTextFont">
  492. <summary>
  493. Disabled text font used, can be null when it is never accessed.
  494. </summary>
  495. </member>
  496. <member name="M:Delta.Scenes.UserInterfaces.Designs.TextControlDesign.DrawControl(Delta.Scenes.BaseControl,Delta.Utilities.Datatypes.Rectangle)">
  497. <summary>
  498. Draw control. Note: This method will only be called if the control
  499. state is at least visible.
  500. </summary>
  501. <param name="control">Control to draw in this design.</param>
  502. <param name="drawArea">The draw area.</param>
  503. </member>
  504. <member name="M:Delta.Scenes.UserInterfaces.Designs.TextControlDesign.Save(System.IO.BinaryWriter)">
  505. <summary>
  506. Saves all data which are necessary to restore the object again.
  507. </summary>
  508. <param name="dataWriter">The writer which contains the stream where the data should be saved
  509. into now.</param>
  510. </member>
  511. <member name="M:Delta.Scenes.UserInterfaces.Designs.TextControlDesign.Load(System.IO.BinaryReader)">
  512. <summary>
  513. Loads and restores all previously saved values that belongs to this
  514. class only from the given data reader.
  515. </summary>
  516. <param name="dataReader">The reader which contains the stream with the saved data which needs to
  517. be loaded now.</param>
  518. </member>
  519. <member name="M:Delta.Scenes.UserInterfaces.Designs.TextControlDesign.GetControlStyle(Delta.Scenes.BaseControl)">
  520. <summary>
  521. Returns the set style of the controls based on its current state.
  522. </summary>
  523. <param name="control">Control</param>
  524. </member>
  525. <member name="P:Delta.Scenes.UserInterfaces.Designs.TextControlDesign.TextFont">
  526. <summary>
  527. Gets or sets the font which is used to displaying the text.
  528. </summary>
  529. </member>
  530. <member name="P:Delta.Scenes.UserInterfaces.Designs.TextControlDesign.DisabledTextFont">
  531. <summary>
  532. Gets or sets the font which is used to displaying the text if the
  533. control is in the "Disabled" state.
  534. </summary>
  535. </member>
  536. <member name="P:Delta.Scenes.UserInterfaces.Designs.TextControlDesign.TextColor">
  537. <summary>
  538. Get the color of the displayed text. To change the text color a new
  539. font must be initialized (like with all font properties).
  540. </summary>
  541. </member>
  542. <member name="P:Delta.Scenes.UserInterfaces.Designs.TextControlDesign.TextBackground">
  543. <summary>
  544. The own background design for the text area instead of the "global"
  545. background design (enabled state).
  546. </summary>
  547. </member>
  548. <member name="P:Delta.Scenes.UserInterfaces.Designs.TextControlDesign.TextHoverBackground">
  549. <summary>
  550. The own background design for the text area instead of the "global"
  551. background design (hovered state).
  552. </summary>
  553. </member>
  554. <member name="P:Delta.Scenes.UserInterfaces.Designs.TextControlDesign.DisabledTextBackground">
  555. <summary>
  556. The own background design for the text area instead of the "global"
  557. background design (disabled state).
  558. </summary>
  559. </member>
  560. <member name="P:Delta.Scenes.UserInterfaces.Designs.TextControlDesign.Pressed">
  561. <summary>
  562. Gets or sets the design to show when the button is pressed. Note: This
  563. design is optional, which means if it isn't set, the "basic" rendering
  564. (with BackgroundDesign and HoverDesign) behavior will be used instead.
  565. </summary>
  566. </member>
  567. <member name="T:Delta.Scenes.UserInterfaces.Designs.TextControlDesign.TextControlDesignTests">
  568. <summary>
  569. Tests for TextControlDesign
  570. </summary>
  571. </member>
  572. <member name="M:Delta.Scenes.UserInterfaces.Designs.TextControlDesign.TextControlDesignTests.SaveAndLoad">
  573. <summary>
  574. Save and load
  575. </summary>
  576. </member>
  577. <member name="F:Delta.Scenes.UserInterfaces.Designs.CheckboxDesign.VersionNumber">
  578. <summary>
  579. The current version of the implementation of this class.
  580. </summary>
  581. </member>
  582. <member name="M:Delta.Scenes.UserInterfaces.Designs.CheckboxDesign.DrawControl(Delta.Scenes.BaseControl,Delta.Utilities.Datatypes.Rectangle)">
  583. <summary>
  584. Draw control
  585. </summary>
  586. <param name="control">Control</param>
  587. <param name="drawArea">Draw area</param>
  588. </member>
  589. <member name="M:Delta.Scenes.UserInterfaces.Designs.CheckboxDesign.Save(System.IO.BinaryWriter)">
  590. <summary>
  591. Saves all data which are necessary to restore the object again.
  592. </summary>
  593. <param name="dataWriter">The writer which contains the stream where the data should be saved
  594. into now.</param>
  595. </member>
  596. <member name="M:Delta.Scenes.UserInterfaces.Designs.CheckboxDesign.Load(System.IO.BinaryReader)">
  597. <summary>
  598. Loads and restores all previously saved values that belongs to this
  599. class only from the given data reader.
  600. </summary>
  601. <param name="dataReader">The reader which contains the stream with the saved data which needs to
  602. be loaded now.</param>
  603. </member>
  604. <member name="P:Delta.Scenes.UserInterfaces.Designs.CheckboxDesign.CheckedSymbol">
  605. <summary>
  606. Represents the design if the "Checked" property is enabled
  607. (control enabled state).
  608. </summary>
  609. </member>
  610. <member name="P:Delta.Scenes.UserInterfaces.Designs.CheckboxDesign.CheckedSymbolHover">
  611. <summary>
  612. Represents the design if the "Checked" property is enabled and the
  613. control is hovered.
  614. </summary>
  615. </member>
  616. <member name="P:Delta.Scenes.UserInterfaces.Designs.CheckboxDesign.DisabledCheckedSymbol">
  617. <summary>
  618. Represents the design if the "Checked" property is enabled
  619. (control disabled state).
  620. </summary>
  621. </member>
  622. <member name="P:Delta.Scenes.UserInterfaces.Designs.CheckboxDesign.UncheckedSymbol">
  623. <summary>
  624. Represents the design if the "Checked" property is not enabled
  625. (control enabled state).
  626. </summary>
  627. </member>
  628. <member name="P:Delta.Scenes.UserInterfaces.Designs.CheckboxDesign.UncheckedSymbolHover">
  629. <summary>
  630. Represents the design if the "Checked" property is not enabled and the
  631. control is hovered.
  632. </summary>
  633. </member>
  634. <member name="P:Delta.Scenes.UserInterfaces.Designs.CheckboxDesign.DisabledUncheckedSymbol">
  635. <summary>
  636. Represents the design if the "Checked" property is not enabled
  637. (control disabled state).
  638. </summary>
  639. </member>
  640. <member name="T:Delta.Scenes.UserInterfaces.Designs.BorderedControlDesign">
  641. <summary>
  642. That design is thought when the control can contain different sized
  643. content and the controls should scale to it. With a non-bordered design
  644. the control can be look totally miss-stretched but this design will
  645. prevent that (based on the set border width).
  646. </summary>
  647. </member>
  648. <member name="T:Delta.Scenes.UserInterfaces.Designs.IBorderedDesign">
  649. <summary>
  650. IBordered design
  651. </summary>
  652. </member>
  653. <member name="P:Delta.Scenes.UserInterfaces.Designs.IBorderedDesign.BorderWidth">
  654. <summary>
  655. The width of the border which will be used for drawing the control.
  656. </summary>
  657. <value>
  658. The width of the border.
  659. </value>
  660. <returns>Float</returns>
  661. </member>
  662. <member name="F:Delta.Scenes.UserInterfaces.Designs.BorderedControlDesign.DefaultBorderWidth">
  663. <summary>
  664. The thicknes of the border for every "BorderedDesign" which is set by
  665. default.
  666. </summary>
  667. </member>
  668. <member name="M:Delta.Scenes.UserInterfaces.Designs.BorderedControlDesign.#ctor">
  669. <summary>
  670. Create bordered design
  671. </summary>
  672. </member>
  673. <member name="M:Delta.Scenes.UserInterfaces.Designs.BorderedControlDesign.DrawControl(Delta.Scenes.BaseControl,Delta.Utilities.Datatypes.Rectangle)">
  674. <summary>
  675. Draw control
  676. </summary>
  677. <param name="control">Control</param>
  678. <param name="drawArea">Draw area</param>
  679. </member>
  680. <member name="M:Delta.Scenes.UserInterfaces.Designs.BorderedControlDesign.GetDockingArea(Delta.Utilities.Datatypes.Rectangle,System.Single,Delta.Scenes.UserInterfaces.Designs.BorderedControlDesign.DockingMode,System.Single)">
  681. <summary>
  682. Get docking area
  683. </summary>
  684. <param name="totalArea">Total area</param>
  685. <param name="fillingStrength">Filling strength</param>
  686. <param name="wishedDocking">Wished docking</param>
  687. <param name="borderThickness">Border thickness</param>
  688. <returns></returns>
  689. </member>
  690. <member name="M:Delta.Scenes.UserInterfaces.Designs.BorderedControlDesign.DrawStyleBordered(Delta.Scenes.UserInterfaces.Designs.IBorderedDesign,Delta.Scenes.BaseControl,Delta.Rendering.Basics.Materials.Material2DColored,Delta.Utilities.Datatypes.Rectangle)">
  691. <summary>
  692. Draw style bordered
  693. </summary>
  694. <param name="controlDesign">Control design</param>
  695. <param name="control">Control</param>
  696. <param name="style">The style.</param>
  697. <param name="drawArea">Draw area</param>
  698. </member>
  699. <member name="P:Delta.Scenes.UserInterfaces.Designs.BorderedControlDesign.BorderWidth">
  700. <summary>
  701. The width of the border which will be used for drawing the control.
  702. </summary>
  703. <returns>Float</returns>
  704. </member>
  705. <member name="T:Delta.Scenes.UserInterfaces.Designs.BorderedControlDesign.DockingMode">
  706. <summary>
  707. Docking mode
  708. </summary>
  709. </member>
  710. <member name="T:Delta.Scenes.UserInterfaces.Screen">
  711. <summary>
  712. The first concrete implementation of an UI screen which can keep all
  713. required UI controls for the interaction with and navigation for the
  714. user. It also provides background image which is drawn based on the given
  715. screen area.
  716. </summary>
  717. </member>
  718. <member name="M:Delta.Scenes.UserInterfaces.Screen.#ctor">
  719. <summary>
  720. Creates a custom screen to be filled with UI by the caller. Note: This
  721. is usually just used for unit-testing, but games and applications will
  722. also use it when they are not loading scenes and screens via content.
  723. </summary>
  724. </member>
  725. <member name="M:Delta.Scenes.UserInterfaces.Screen.#ctor(System.String,System.Boolean)">
  726. <summary>
  727. Creates an user interface screen from the content file with all stored
  728. controls. Note: If the 'screenContentName' value is empty or null or
  729. starts with "&gt;" (like "&gt;DummyScreen&lt;"), then the new screen
  730. will be empty and has to be filled and opened by the caller
  731. (automaticallyOpenScreen will be ignored).
  732. </summary>
  733. <param name="screenContentName">
  734. Scene name to load. Use the empty constructor to create scenes
  735. dynamically without content!
  736. </param>
  737. <param name="automaticallyOpenScreen"></param>
  738. </member>
  739. <member name="M:Delta.Scenes.UserInterfaces.Screen.GetRadioButtons(System.Object)">
  740. <summary>
  741. Get all RadioButton's which have the same (given) "GroupControl".
  742. Currently only needed in the RadioButton class.
  743. </summary>
  744. <param name="searchingGroupTag">Searching group tag</param>
  745. <returns>Array of radio buttons for this group tag</returns>
  746. </member>
  747. <member name="T:Delta.Scenes.UserInterfaces.Controls.TODODropdownBox">
  748. <summary>
  749. Dropdownbox
  750. TODO: finish this!
  751. </summary>
  752. </member>
  753. <member name="F:Delta.Scenes.UserInterfaces.Controls.TODODropdownBox.SavingClassName">
  754. <summary>
  755. The name of the class which is saved in the content data to
  756. describe and "detect" the data in the loading code again.
  757. </summary>
  758. </member>
  759. <member name="F:Delta.Scenes.UserInterfaces.Controls.TODODropdownBox.WorkingVersion">
  760. <summary>
  761. The current version of the implementation of this class.
  762. </summary>
  763. </member>
  764. <member name="F:Delta.Scenes.UserInterfaces.Controls.TODODropdownBox.items">
  765. <summary>
  766. Items
  767. </summary>
  768. </member>
  769. <member name="F:Delta.Scenes.UserInterfaces.Controls.TODODropdownBox.selectedIndex">
  770. <summary>
  771. Selected index
  772. </summary>
  773. </member>
  774. <member name="F:Delta.Scenes.UserInterfaces.Controls.TODODropdownBox.itemsLabel">
  775. <summary>
  776. Items label
  777. </summary>
  778. </member>
  779. <member name="M:Delta.Scenes.UserInterfaces.Controls.TODODropdownBox.#ctor">
  780. <summary>
  781. Create dropdownbox
  782. </summary>
  783. </member>
  784. <member name="M:Delta.Scenes.UserInterfaces.Controls.TODODropdownBox.ShowDropDownList">
  785. <summary>
  786. Draw drop down list
  787. </summary>
  788. </member>
  789. <member name="M:Delta.Scenes.UserInterfaces.Controls.TODODropdownBox.HideDropDownList">
  790. <summary>
  791. Hide drop down list
  792. </summary>
  793. </member>
  794. <member name="P:Delta.Scenes.UserInterfaces.Controls.TODODropdownBox.Items">
  795. <summary>
  796. Items
  797. </summary>
  798. </member>
  799. <member name="P:Delta.Scenes.UserInterfaces.Controls.TODODropdownBox.SelectedItem">
  800. <summary>
  801. Selected item
  802. </summary>
  803. </member>
  804. <member name="P:Delta.Scenes.UserInterfaces.Controls.TODODropdownBox.SelectedIndex">
  805. <summary>
  806. Selected index
  807. </summary>
  808. </member>
  809. <member name="P:Delta.Scenes.UserInterfaces.Controls.TODODropdownBox.ExpanderArea">
  810. <summary>
  811. Expander area
  812. </summary>
  813. </member>
  814. <member name="E:Delta.Scenes.UserInterfaces.Controls.TODODropdownBox.SelectionChanged">
  815. <summary>
  816. Occurs every time the selected object resp index is changed.
  817. </summary>
  818. </member>
  819. <member name="T:Delta.Scenes.UserInterfaces.Controls.TODODropdownBox.SelectedIndexChangedDelegate">
  820. <summary>
  821. The delegate declaration for the "DropdownBox.IndexChanged" event.
  822. </summary>
  823. <param name="newIndex"></param>
  824. </member>
  825. <member name="T:Delta.Scenes.UserInterfaces.Controls.TODODropdownBox.DropdownBoxTests">
  826. <summary>
  827. Tests for DropdownBox controls
  828. TODO: Check these tests out and maybe rewrite them
  829. </summary>
  830. </member>
  831. <member name="M:Delta.Scenes.UserInterfaces.Controls.TODODropdownBox.DropdownBoxTests.DisplayDropdownbox">
  832. <summary>
  833. Dropdownbox label
  834. </summary>
  835. </member>
  836. <member name="M:Delta.Scenes.UserInterfaces.Controls.TODODropdownBox.DropdownBoxTests.DisplayNonAutoSizeDropdownbox">
  837. <summary>
  838. Display non auto size dropdownbox
  839. </summary>
  840. </member>
  841. <member name="M:Delta.Scenes.UserInterfaces.Controls.TODODropdownBox.DropdownBoxTests.DisplayRotatedDropdownbox">
  842. <summary>
  843. Display rotated dropdownbox
  844. </summary>
  845. </member>
  846. <member name="T:Delta.Scenes.UserInterfaces.Controls.Slider">
  847. <summary>
  848. This is a slider control which allows changing the value (limited by
  849. 'MinValue' and 'MaxValue' range) by dragging the "knob" symbol.
  850. Note: This control has no Rotation because we never use rotated
  851. sliders (would be very strange)! If you set a rotation value then it
  852. will be reset to zero and you get a warning.
  853. </summary>
  854. </member>
  855. <member name="T:Delta.Scenes.UserInterfaces.Controls.Button">
  856. <summary>
  857. A button control which supports additionally to the normal control states
  858. the 'Pressed' state and also a 'Clicked' event.
  859. </summary>
  860. </member>
  861. <member name="F:Delta.Scenes.UserInterfaces.Controls.Button.SavingClassName">
  862. <summary>
  863. The name of the control class which is saved in the content data to
  864. describe and "detect" the data in the loading code again.
  865. </summary>
  866. </member>
  867. <member name="F:Delta.Scenes.UserInterfaces.Controls.Button.WorkingVersion">
  868. <summary>
  869. The current version of the implementation of this control class.
  870. </summary>
  871. </member>
  872. <member name="M:Delta.Scenes.UserInterfaces.Controls.Button.OnInputEvent(Delta.InputSystem.CommandTrigger)">
  873. <summary>
  874. On input event
  875. </summary>
  876. <param name="input">Input</param>
  877. </member>
  878. <member name="M:Delta.Scenes.UserInterfaces.Controls.Button.OnClicked(Delta.InputSystem.CommandTrigger,System.Boolean)">
  879. <summary>
  880. On clicked
  881. </summary>
  882. <param name="input">Input data like the click position.</param>
  883. <param name="isInsideControl">
  884. 'True' if the event is occurring inside the control, otherwise 'false'.
  885. </param>
  886. </member>
  887. <member name="P:Delta.Scenes.UserInterfaces.Controls.Button.FallbackDesign">
  888. <summary>
  889. Defines the theme which will be used if no "Theme" was set explicitely.
  890. </summary>
  891. </member>
  892. <member name="E:Delta.Scenes.UserInterfaces.Controls.Button.Clicked">
  893. <summary>
  894. Occurs if the left pointing device button was pressed.
  895. </summary>
  896. </member>
  897. <member name="P:Delta.Scenes.UserInterfaces.Controls.Button.ClickedSound">
  898. <summary>
  899. The sound which will be played if this button is clicked (Optional).
  900. </summary>
  901. </member>
  902. <member name="T:Delta.Scenes.UserInterfaces.Controls.Button.ControlInputEvent">
  903. <summary>
  904. The delegate declaration for any input event that will forwarded to an
  905. UI control.
  906. </summary>
  907. <param name="sender">Sender</param>
  908. <param name="input">The data of that event</param>
  909. </member>
  910. <member name="T:Delta.Scenes.UserInterfaces.Controls.Button.ButtonTests">
  911. <summary>
  912. Tests for Button controls
  913. </summary>
  914. </member>
  915. <member name="M:Delta.Scenes.UserInterfaces.Controls.Button.ButtonTests.DisplayButton">
  916. <summary>
  917. Display button
  918. </summary>
  919. </member>
  920. <member name="M:Delta.Scenes.UserInterfaces.Controls.Button.ButtonTests.DisabledButton">
  921. <summary>
  922. Disabled button
  923. </summary>
  924. </member>
  925. <member name="M:Delta.Scenes.UserInterfaces.Controls.Button.ButtonTests.DestroyButton">
  926. <summary>
  927. Destroy button
  928. </summary>
  929. </member>
  930. <member name="M:Delta.Scenes.UserInterfaces.Controls.Button.ButtonTests.CursorMoveTest">
  931. <summary>
  932. Cursor move test
  933. </summary>
  934. </member>
  935. <member name="M:Delta.Scenes.UserInterfaces.Controls.Button.ButtonTests.UsingChilds">
  936. <summary>
  937. Using childs
  938. </summary>
  939. </member>
  940. <member name="M:Delta.Scenes.UserInterfaces.Controls.Button.ButtonTests.Rotation">
  941. <summary>
  942. Rotation
  943. </summary>
  944. </member>
  945. <member name="M:Delta.Scenes.UserInterfaces.Controls.Button.ButtonTests.DepthLayers">
  946. <summary>
  947. Depth layers
  948. </summary>
  949. </member>
  950. <member name="F:Delta.Scenes.UserInterfaces.Controls.Slider.VersionNumber">
  951. <summary>
  952. The current version of the implementation of this class.
  953. </summary>
  954. </member>
  955. <member name="F:Delta.Scenes.UserInterfaces.Controls.Slider.lastValue">
  956. <summary>
  957. The last set slider value which is used to "detect" value changes of
  958. this slider by the user.
  959. </summary>
  960. </member>
  961. <member name="F:Delta.Scenes.UserInterfaces.Controls.Slider.marker">
  962. <summary>
  963. The marker which indicates visually the current set value.
  964. </summary>
  965. </member>
  966. <member name="F:Delta.Scenes.UserInterfaces.Controls.Slider.isMarkerValueUpdateRequired">
  967. <summary>
  968. Indicates if the marker value needs to be re-computed by because of the
  969. new slider value or is it already done by a visual click on the slider.
  970. </summary>
  971. </member>
  972. <member name="M:Delta.Scenes.UserInterfaces.Controls.Slider.#ctor">
  973. <summary>
  974. Creates a slider
  975. </summary>
  976. </member>
  977. <member name="M:Delta.Scenes.UserInterfaces.Controls.Slider.Save(System.IO.BinaryWriter)">
  978. <summary>
  979. Saves all data which are necessary to restore the object again.
  980. </summary>
  981. <param name="dataWriter">
  982. The writer which contains the stream where the data should be saved
  983. into now.
  984. </param>
  985. </member>
  986. <member name="M:Delta.Scenes.UserInterfaces.Controls.Slider.Load(System.IO.BinaryReader)">
  987. <summary>
  988. Loads and restores all previously saved values that belongs to this
  989. class only from the given data reader.
  990. </summary>
  991. <param name="dataReader">
  992. The reader which contains the stream with the saved data which needs to
  993. be loaded now.
  994. </param>
  995. </member>
  996. <member name="M:Delta.Scenes.UserInterfaces.Controls.Slider.OnInputEvent(Delta.InputSystem.CommandTrigger)">
  997. <summary>
  998. On input event
  999. </summary>
  1000. <param name="input">Input event</param>
  1001. </member>
  1002. <member name="M:Delta.Scenes.UserInterfaces.Controls.Slider.OnSizeChanging(Delta.Utilities.Datatypes.Size)">
  1003. <summary>
  1004. On size changing
  1005. </summary>
  1006. <param name="oldSize">Old size</param>
  1007. <returns>
  1008. 'True' if the new value can be used or 'false' if the change should be
  1009. aborted.
  1010. </returns>
  1011. </member>
  1012. <member name="M:Delta.Scenes.UserInterfaces.Controls.Slider.OnDesignChanging(Delta.Scenes.ControlDesign)">
  1013. <summary>
  1014. On design changed
  1015. </summary>
  1016. <param name="oldDesign">Old design</param>
  1017. <returns>
  1018. 'True' if the new value can be used or 'false' if the change should be
  1019. aborted.
  1020. </returns>
  1021. </member>
  1022. <member name="M:Delta.Scenes.UserInterfaces.Controls.Slider.OnValueChanging(System.Single)">
  1023. <summary>
  1024. On value changing
  1025. </summary>
  1026. <param name="oldValue">Old value</param>
  1027. <returns>
  1028. 'True' if the new value can be used or 'false' if the change should be
  1029. aborted.
  1030. </returns>
  1031. </member>
  1032. <member name="M:Delta.Scenes.UserInterfaces.Controls.Slider.ComputeNewCurrentValue(Delta.Utilities.Datatypes.Point)">
  1033. <summary>
  1034. Compute new current value of the slider based on the (clicked) position
  1035. on the track bar.
  1036. Note: This is the "visual version" of setting the "Value" property.
  1037. </summary>
  1038. <param name="clickedPosition">Clicked screen position</param>
  1039. </member>
  1040. <member name="M:Delta.Scenes.UserInterfaces.Controls.Slider.DetectChanges">
  1041. <summary>
  1042. This method implements the checks of the changes which are should be
  1043. detected in this element. It also cares about triggering the events and
  1044. the event handler methods.
  1045. </summary>
  1046. </member>
  1047. <member name="M:Delta.Scenes.UserInterfaces.Controls.Slider.UpdateDrawData">
  1048. <summary>
  1049. Updates all data of this element which are required for the following
  1050. draw call.
  1051. </summary>
  1052. <remarks>
  1053. This method will only be called if the element is in an enabled state.
  1054. </remarks>
  1055. </member>
  1056. <member name="M:Delta.Scenes.UserInterfaces.Controls.Slider.DrawDebugInfo">
  1057. <summary>
  1058. Draw debug info
  1059. </summary>
  1060. </member>
  1061. <member name="P:Delta.Scenes.UserInterfaces.Controls.Slider.MinValue">
  1062. <summary>
  1063. The minimum value of the slider.
  1064. </summary>
  1065. </member>
  1066. <member name="P:Delta.Scenes.UserInterfaces.Controls.Slider.MaxValue">
  1067. <summary>
  1068. The maximum value of the slider.
  1069. </summary>
  1070. </member>
  1071. <member name="P:Delta.Scenes.UserInterfaces.Controls.Slider.Value">
  1072. <summary>
  1073. The current value of the slider.
  1074. </summary>
  1075. </member>
  1076. <member name="P:Delta.Scenes.UserInterfaces.Controls.Slider.FallbackDesign">
  1077. <summary>
  1078. Defines the design which will be used if no "Design" was set
  1079. explicitely.
  1080. </summary>
  1081. </member>
  1082. <member name="P:Delta.Scenes.UserInterfaces.Controls.Slider.TrackbarDrawArea">
  1083. <summary>
  1084. The drawing area of the slider track bar.
  1085. </summary>
  1086. <remarks>
  1087. This value will be computed automatically by the 'DrawData()' method.
  1088. </remarks>
  1089. </member>
  1090. <member name="P:Delta.Scenes.UserInterfaces.Controls.Slider.MarkerDrawArea">
  1091. <summary>
  1092. The drawing area of the slider marker.
  1093. </summary>
  1094. <remarks>
  1095. There is no need to cache that value because this property is only
  1096. called once, in the 'SliderDesign' to draw the slider marker.
  1097. </remarks>
  1098. </member>
  1099. <member name="E:Delta.Scenes.UserInterfaces.Controls.Slider.ValueChanged">
  1100. <summary>
  1101. Occurs every time the value of the slider is changed.
  1102. </summary>
  1103. </member>
  1104. <member name="T:Delta.Scenes.UserInterfaces.Controls.Slider.SliderMarker">
  1105. <summary>
  1106. Slider marker
  1107. </summary>
  1108. </member>
  1109. <member name="F:Delta.Scenes.UserInterfaces.Controls.Slider.SliderMarker.lastSliderValueInPercent">
  1110. <summary>
  1111. The last set value which is used to "detect" the value changes.
  1112. </summary>
  1113. </member>
  1114. <member name="F:Delta.Scenes.UserInterfaces.Controls.Slider.SliderMarker.owner">
  1115. <summary>
  1116. The slider where this marker is attached to.
  1117. </summary>
  1118. </member>
  1119. <member name="M:Delta.Scenes.UserInterfaces.Controls.Slider.SliderMarker.#ctor(Delta.Scenes.UserInterfaces.Controls.Slider)">
  1120. <summary>
  1121. Create slider knob
  1122. </summary>
  1123. </member>
  1124. <member name="M:Delta.Scenes.UserInterfaces.Contro…

Large files files are truncated, but you can click here to view the full file