/docs/xml/lcl/comctrls.xml

http://github.com/graemeg/lazarus · XML · 18815 lines · 15749 code · 5 blank · 3061 comment · 0 complexity · 1c2943d4d86527605716a476f26eac71 MD5 · raw file

Large files are truncated click here to view the full file

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <fpdoc-descriptions>
  3. <package name="LCL">
  4. <!--
  5. ====================================================================
  6. ComCtrls
  7. ====================================================================
  8. -->
  9. <module name="ComCtrls">
  10. <short>Several controls commonly used in Lazarus forms</short>
  11. <descr/>
  12. <!-- unresolved type reference Visibility: default -->
  13. <element name="SysUtils"/>
  14. <!-- unresolved type reference Visibility: default -->
  15. <element name="Classes"/>
  16. <!-- unresolved type reference Visibility: default -->
  17. <element name="Math"/>
  18. <!-- unresolved type reference Visibility: default -->
  19. <element name="FPCAdds"/>
  20. <!-- unresolved type reference Visibility: default -->
  21. <element name="LCLStrConsts"/>
  22. <!-- unresolved type reference Visibility: default -->
  23. <element name="LResources"/>
  24. <!-- unresolved type reference Visibility: default -->
  25. <element name="LCLIntf"/>
  26. <!-- unresolved type reference Visibility: default -->
  27. <element name="LCLType"/>
  28. <!-- unresolved type reference Visibility: default -->
  29. <element name="LCLProc"/>
  30. <!-- unresolved type reference Visibility: default -->
  31. <element name="AvgLvlTree"/>
  32. <!-- unresolved type reference Visibility: default -->
  33. <element name="LMessages"/>
  34. <!-- unresolved type reference Visibility: default -->
  35. <element name="ImgList"/>
  36. <!-- unresolved type reference Visibility: default -->
  37. <element name="ActnList"/>
  38. <!-- unresolved type reference Visibility: default -->
  39. <element name="GraphType"/>
  40. <!-- unresolved type reference Visibility: default -->
  41. <element name="Graphics"/>
  42. <!-- unresolved type reference Visibility: default -->
  43. <element name="Menus"/>
  44. <!-- unresolved type reference Visibility: default -->
  45. <element name="Controls"/>
  46. <!-- unresolved type reference Visibility: default -->
  47. <element name="Forms"/>
  48. <!-- unresolved type reference Visibility: default -->
  49. <element name="StdCtrls"/>
  50. <!-- unresolved type reference Visibility: default -->
  51. <element name="ExtCtrls"/>
  52. <!-- unresolved type reference Visibility: default -->
  53. <element name="ToolWin"/>
  54. <!-- unresolved type reference Visibility: default -->
  55. <element name="CommCtrl"/>
  56. <!-- unresolved type reference Visibility: default -->
  57. <element name="Buttons"/>
  58. <!-- object Visibility: default -->
  59. <!-- enumeration type Visibility: default -->
  60. <element name="THitTest">
  61. <short>
  62. <var>THitTest</var> - enumerated type giving permissable results of a hit test (position of a mouse click etc relative to objects on a form)</short>
  63. <descr/>
  64. <seealso/>
  65. </element>
  66. <!-- enumeration value Visibility: default -->
  67. <element name="THitTest.htAbove">
  68. <short/>
  69. </element>
  70. <!-- enumeration value Visibility: default -->
  71. <element name="THitTest.htBelow">
  72. <short/>
  73. </element>
  74. <!-- enumeration value Visibility: default -->
  75. <element name="THitTest.htNowhere">
  76. <short/>
  77. </element>
  78. <!-- enumeration value Visibility: default -->
  79. <element name="THitTest.htOnItem">
  80. <short/>
  81. </element>
  82. <!-- enumeration value Visibility: default -->
  83. <element name="THitTest.htOnButton">
  84. <short/>
  85. </element>
  86. <!-- enumeration value Visibility: default -->
  87. <element name="THitTest.htOnIcon">
  88. <short/>
  89. </element>
  90. <!-- enumeration value Visibility: default -->
  91. <element name="THitTest.htOnIndent">
  92. <short/>
  93. </element>
  94. <!-- enumeration value Visibility: default -->
  95. <element name="THitTest.htOnLabel">
  96. <short/>
  97. </element>
  98. <!-- enumeration value Visibility: default -->
  99. <element name="THitTest.htOnRight">
  100. <short/>
  101. </element>
  102. <!-- enumeration value Visibility: default -->
  103. <element name="THitTest.htOnStateIcon">
  104. <short/>
  105. </element>
  106. <!-- enumeration value Visibility: default -->
  107. <element name="THitTest.htToLeft">
  108. <short/>
  109. </element>
  110. <!-- enumeration value Visibility: default -->
  111. <element name="THitTest.htToRight">
  112. <short/>
  113. </element>
  114. <!-- set type Visibility: default -->
  115. <element name="THitTests">
  116. <short>
  117. <var>THitTests</var> - set of <var>THitTest</var>
  118. </short>
  119. <descr/>
  120. <seealso/>
  121. </element>
  122. <!-- enumeration type Visibility: default -->
  123. <element name="TStatusPanelStyle">
  124. <short>
  125. <var>TStatusPanelStyle</var> - enumerated type for panel style</short>
  126. <descr/>
  127. <seealso/>
  128. </element>
  129. <!-- enumeration value Visibility: default -->
  130. <element name="TStatusPanelStyle.psText">
  131. <short/>
  132. </element>
  133. <!-- enumeration value Visibility: default -->
  134. <element name="TStatusPanelStyle.psOwnerDraw">
  135. <short/>
  136. </element>
  137. <!-- enumeration type Visibility: default -->
  138. <element name="TStatusPanelBevel">
  139. <short>
  140. <var>TStatusPanelBevel</var> - enumerated type for panel bevel style</short>
  141. <descr/>
  142. <seealso/>
  143. </element>
  144. <!-- enumeration value Visibility: default -->
  145. <element name="TStatusPanelBevel.pbNone">
  146. <short/>
  147. </element>
  148. <!-- enumeration value Visibility: default -->
  149. <element name="TStatusPanelBevel.pbLowered">
  150. <short/>
  151. </element>
  152. <!-- enumeration value Visibility: default -->
  153. <element name="TStatusPanelBevel.pbRaised">
  154. <short/>
  155. </element>
  156. <!-- enumeration type Visibility: default -->
  157. <element name="TPanelPart">
  158. <short>
  159. <var>TPanelPart</var> - enumerated type listing the possible parts that comprise a Panel</short>
  160. <descr/>
  161. <seealso/>
  162. </element>
  163. <!-- enumeration value Visibility: default -->
  164. <element name="TPanelPart.ppText">
  165. <short/>
  166. </element>
  167. <!-- enumeration value Visibility: default -->
  168. <element name="TPanelPart.ppBorder">
  169. <short/>
  170. </element>
  171. <!-- enumeration value Visibility: default -->
  172. <element name="TPanelPart.ppWidth">
  173. <short/>
  174. </element>
  175. <!-- set type Visibility: default -->
  176. <element name="TPanelParts">
  177. <short>
  178. <var>TPanelParts</var> - set ot <var>TPanelPart</var>
  179. </short>
  180. <descr/>
  181. <seealso/>
  182. </element>
  183. <!-- object Visibility: default -->
  184. <element name="TStatusPanel">
  185. <short>
  186. <var>TStatusPanel</var> - one of the panels contained in a <var>StatusBar</var>
  187. </short>
  188. <descr/>
  189. <errors/>
  190. <seealso/>
  191. </element>
  192. <!-- variable Visibility: private -->
  193. <element name="TStatusPanel.FText">
  194. <short/>
  195. <descr/>
  196. <seealso/>
  197. </element>
  198. <!-- variable Visibility: private -->
  199. <element name="TStatusPanel.FWidth">
  200. <short/>
  201. <descr/>
  202. <seealso/>
  203. </element>
  204. <!-- variable Visibility: private -->
  205. <element name="TStatusPanel.FAlignment">
  206. <short/>
  207. <descr/>
  208. <seealso/>
  209. </element>
  210. <!-- variable Visibility: private -->
  211. <element name="TStatusPanel.FBevel">
  212. <short/>
  213. <descr/>
  214. <seealso/>
  215. </element>
  216. <!-- variable Visibility: private -->
  217. <element name="TStatusPanel.FParentBiDiMode">
  218. <short/>
  219. <descr/>
  220. <seealso/>
  221. </element>
  222. <!-- variable Visibility: private -->
  223. <element name="TStatusPanel.FStyle">
  224. <short/>
  225. <descr/>
  226. <seealso/>
  227. </element>
  228. <!-- procedure Visibility: private -->
  229. <element name="TStatusPanel.SetAlignment">
  230. <short/>
  231. <descr/>
  232. <errors/>
  233. <seealso/>
  234. </element>
  235. <!-- argument Visibility: default -->
  236. <element name="TStatusPanel.SetAlignment.Value">
  237. <short/>
  238. </element>
  239. <!-- procedure Visibility: private -->
  240. <element name="TStatusPanel.SetBevel">
  241. <short/>
  242. <descr/>
  243. <errors/>
  244. <seealso/>
  245. </element>
  246. <!-- argument Visibility: default -->
  247. <element name="TStatusPanel.SetBevel.Value">
  248. <short/>
  249. </element>
  250. <!-- procedure Visibility: private -->
  251. <element name="TStatusPanel.SetStyle">
  252. <short/>
  253. <descr/>
  254. <errors/>
  255. <seealso/>
  256. </element>
  257. <!-- argument Visibility: default -->
  258. <element name="TStatusPanel.SetStyle.Value">
  259. <short/>
  260. </element>
  261. <!-- procedure Visibility: private -->
  262. <element name="TStatusPanel.SetText">
  263. <short/>
  264. <descr/>
  265. <errors/>
  266. <seealso/>
  267. </element>
  268. <!-- argument Visibility: default -->
  269. <element name="TStatusPanel.SetText.Value">
  270. <short/>
  271. </element>
  272. <!-- procedure Visibility: private -->
  273. <element name="TStatusPanel.SetWidth">
  274. <short/>
  275. <descr/>
  276. <errors/>
  277. <seealso/>
  278. </element>
  279. <!-- argument Visibility: default -->
  280. <element name="TStatusPanel.SetWidth.Value">
  281. <short/>
  282. </element>
  283. <!-- function Visibility: protected -->
  284. <element name="TStatusPanel.GetDisplayName">
  285. <short>
  286. <var>GetDisplayName</var> - looks first at the <var>Text</var> property; if it is blank calls inherited method</short>
  287. <descr/>
  288. <errors/>
  289. <seealso>
  290. <link id="#rtl.Classes.TCollectionItem.GetDisplayName">TCollectionItem.GetDisplayName</link>
  291. </seealso>
  292. </element>
  293. <!-- function result Visibility: default -->
  294. <element name="TStatusPanel.GetDisplayName.Result">
  295. <short/>
  296. </element>
  297. <!-- procedure Visibility: protected -->
  298. <element name="TStatusPanel.PanelChanged">
  299. <short>
  300. <var>PanelChanged</var> - method for dealing with a status panel, one or more of whose parts has changed</short>
  301. <descr/>
  302. <errors/>
  303. <seealso/>
  304. </element>
  305. <!-- argument Visibility: default -->
  306. <element name="TStatusPanel.PanelChanged.Parts">
  307. <short/>
  308. </element>
  309. <!-- procedure Visibility: protected -->
  310. <element name="TStatusPanel.SetIndex">
  311. <short>
  312. <var>SetIndex</var> saves the old index value, checks that the supplied value is different then calls inherited method</short>
  313. <descr/>
  314. <errors/>
  315. <seealso>
  316. <link id="#rtl.Classes.TCollectionItem.SetIndex">TCollectionItem.SetIndex</link>
  317. </seealso>
  318. </element>
  319. <!-- argument Visibility: default -->
  320. <element name="TStatusPanel.SetIndex.Value">
  321. <short/>
  322. </element>
  323. <!-- constructor Visibility: public -->
  324. <element name="TStatusPanel.Create">
  325. <short>
  326. <var>Create</var> - constructor for <var>TStatusPanel</var>: sets default width, alignment and bevel, calls inherited <var>Create</var> and loads into StatusBar</short>
  327. <descr/>
  328. <errors/>
  329. <seealso>
  330. <link id="#rtl.Classes.TCollectionItem.Create">TCollectionItem.Create</link>
  331. </seealso>
  332. </element>
  333. <!-- argument Visibility: default -->
  334. <element name="TStatusPanel.Create.aCollection">
  335. <short/>
  336. </element>
  337. <!-- destructor Visibility: public -->
  338. <element name="TStatusPanel.Destroy">
  339. <short>
  340. <var>Destroy</var> - destructor for <var>TStatusPanel</var>: calls inherited <var>Destroy</var> and removes itself from the StatusBar</short>
  341. <descr/>
  342. <errors/>
  343. <seealso>
  344. <link id="#rtl.Classes.TCollectionItem.Destroy">TCollectionItem.Destroy</link>
  345. </seealso>
  346. </element>
  347. <!-- procedure Visibility: public -->
  348. <element name="TStatusPanel.Assign">
  349. <short>
  350. <var>Assign</var> copies text, width, alignment, bevel and style properties from <var>Source</var> if it is of correct type, otherwise calls inherited <var>Assign</var> (which will probably raise an exception)</short>
  351. <descr/>
  352. <errors/>
  353. <seealso>
  354. <link id="#rtl.Classes.TPersistent.Assign">TPersistent.Assign</link>
  355. </seealso>
  356. </element>
  357. <!-- argument Visibility: default -->
  358. <element name="TStatusPanel.Assign.Source">
  359. <short/>
  360. </element>
  361. <!-- function Visibility: public -->
  362. <element name="TStatusPanel.StatusBar">
  363. <short>The <var>StatusBar</var> that contains this <var>StatusPanel</var>
  364. </short>
  365. <descr/>
  366. <errors/>
  367. <seealso/>
  368. </element>
  369. <!-- function result Visibility: default -->
  370. <element name="TStatusPanel.StatusBar.Result">
  371. <short/>
  372. </element>
  373. <!-- property Visibility: published -->
  374. <element name="TStatusPanel.Alignment">
  375. <short>
  376. <var>Alignment</var> - whether left- or right-justified or centered</short>
  377. <descr>Only supported on Windows.</descr>
  378. <seealso/>
  379. </element>
  380. <!-- property Visibility: published -->
  381. <element name="TStatusPanel.Bevel">
  382. <short>The type of <var>Bevel</var> for the display</short>
  383. <descr>Only supported on Windows.</descr>
  384. <seealso/>
  385. </element>
  386. <!-- property Visibility: published -->
  387. <element name="TStatusPanel.Style">
  388. <short>
  389. <var>Style</var> - whether text or something drawn by the owner</short>
  390. <descr/>
  391. <seealso/>
  392. </element>
  393. <!-- property Visibility: published -->
  394. <element name="TStatusPanel.Text">
  395. <short>
  396. <var>Text</var> - the string for display in the StatusBar</short>
  397. <descr/>
  398. <seealso/>
  399. </element>
  400. <!-- property Visibility: published -->
  401. <element name="TStatusPanel.Width">
  402. <short>The <var>Width</var> of this panel on the StatusBar</short>
  403. <descr/>
  404. <seealso/>
  405. </element>
  406. <!-- object Visibility: default -->
  407. <element name="TStatusPanels">
  408. <short>
  409. <var>TStatusPanels</var> - the collection of Status Panels in this StatusBar</short>
  410. <descr/>
  411. <errors/>
  412. <seealso/>
  413. </element>
  414. <!-- variable Visibility: private -->
  415. <element name="TStatusPanels.FStatusBar">
  416. <short/>
  417. <descr/>
  418. <seealso/>
  419. </element>
  420. <!-- function Visibility: private -->
  421. <element name="TStatusPanels.GetItem" link="#rtl.Classes.TCollection.GetItem">
  422. <short/>
  423. <descr/>
  424. <errors/>
  425. <seealso/>
  426. </element>
  427. <!-- function result Visibility: default -->
  428. <element name="TStatusPanels.GetItem.Result">
  429. <short/>
  430. </element>
  431. <!-- argument Visibility: default -->
  432. <element name="TStatusPanels.GetItem.Index">
  433. <short/>
  434. </element>
  435. <!-- procedure Visibility: private -->
  436. <element name="TStatusPanels.SetItem" link="#rtl.Classes.TCollection.SetItem">
  437. <short/>
  438. <descr/>
  439. <errors/>
  440. <seealso/>
  441. </element>
  442. <!-- argument Visibility: default -->
  443. <element name="TStatusPanels.SetItem.Index">
  444. <short/>
  445. </element>
  446. <!-- argument Visibility: default -->
  447. <element name="TStatusPanels.SetItem.Value">
  448. <short/>
  449. </element>
  450. <!-- function Visibility: protected -->
  451. <element name="TStatusPanels.GetOwner">
  452. <short>
  453. <var>GetOwner</var> returns a Status Bar, overriding the inherited method</short>
  454. <descr/>
  455. <errors/>
  456. <seealso>
  457. <link id="#rtl.Classes.TPersistent.GetOwner">TPersistent.GetOwner</link>
  458. </seealso>
  459. </element>
  460. <!-- function result Visibility: default -->
  461. <element name="TStatusPanels.GetOwner.Result">
  462. <short/>
  463. </element>
  464. <!-- procedure Visibility: protected -->
  465. <element name="TStatusPanels.Update" link="#rtl.Classes.TCollection.Update">
  466. <short/>
  467. <descr/>
  468. <errors/>
  469. <seealso/>
  470. </element>
  471. <!-- argument Visibility: default -->
  472. <element name="TStatusPanels.Update.Item">
  473. <short/>
  474. </element>
  475. <!-- constructor Visibility: public -->
  476. <element name="TStatusPanels.Create">
  477. <short>
  478. <var>Create</var> - constructor for <var>TStatusPanels</var>: calls inherited <var>Create</var> and attaches itself to StatusBar</short>
  479. <descr/>
  480. <errors/>
  481. <seealso>
  482. <link id="#rtl.Classes.TCollection.Create">TCollection.Create</link>
  483. </seealso>
  484. </element>
  485. <!-- argument Visibility: default -->
  486. <element name="TStatusPanels.Create.TheStatusBar">
  487. <short/>
  488. </element>
  489. <!-- function Visibility: public -->
  490. <element name="TStatusPanels.Add" link="#rtl.Classes.TCollection.Add">
  491. <short/>
  492. <descr/>
  493. <errors/>
  494. <seealso/>
  495. </element>
  496. <!-- function result Visibility: default -->
  497. <element name="TStatusPanels.Add.Result">
  498. <short/>
  499. </element>
  500. <!-- property Visibility: public -->
  501. <element name="TStatusPanels.Items" link="#rtl.Classes.TCollection.Items">
  502. <short/>
  503. <descr/>
  504. <seealso/>
  505. </element>
  506. <!-- argument Visibility: default -->
  507. <element name="TStatusPanels.Items.Index">
  508. <short/>
  509. </element>
  510. <!-- property Visibility: public -->
  511. <element name="TStatusPanels.StatusBar">
  512. <short>The <var>StatusBar</var> to which this collection of Status Panels belongs</short>
  513. <descr/>
  514. <seealso/>
  515. </element>
  516. <!-- object Visibility: default -->
  517. <element name="TStatusBar">
  518. <short>
  519. <var>TStatusBar</var> - a strip along the bottom of a form for displaying information on current status</short>
  520. <descr>
  521. <p>
  522. <var>TStatusBar</var> - a strip along the bottom of a form for displaying information on current status</p>
  523. <p>The bar may consist of a single <var>SimplePanel</var>, in which case the displayed text is contained in <var>SimpleText</var>.</p>
  524. <p>However if <var>SimplePanel</var> is false, then there can be multiple panels or sub-sections of the status bar, whose properties are described in <var>Panels</var>.</p>
  525. <p>The property <var>SimpleText</var> can be assigned programatically to display the value of some variable, such as the position of the Splitter in the example</p>
  526. </descr>
  527. <example file="extctrls/statusbar.pas"/>
  528. </element>
  529. <!-- variable Visibility: private -->
  530. <element name="TStatusBar.FCanvas">
  531. <short/>
  532. <descr/>
  533. <seealso/>
  534. </element>
  535. <!-- variable Visibility: private -->
  536. <element name="TStatusBar.FHandlePanelCount">
  537. <short/>
  538. <descr/>
  539. <seealso/>
  540. </element>
  541. <!-- variable Visibility: private -->
  542. <element name="TStatusBar.FHandleObjectNeedsUpdate">
  543. <short/>
  544. <descr/>
  545. <seealso/>
  546. </element>
  547. <!-- variable Visibility: private -->
  548. <element name="TStatusBar.FHandleUpdatePanelIndex">
  549. <short/>
  550. <descr/>
  551. <seealso/>
  552. </element>
  553. <!-- variable Visibility: private -->
  554. <element name="TStatusBar.FUpdateLock">
  555. <short/>
  556. <descr/>
  557. <seealso/>
  558. </element>
  559. <!-- variable Visibility: private -->
  560. <element name="TStatusBar.FPanels">
  561. <short/>
  562. <descr/>
  563. <seealso/>
  564. </element>
  565. <!-- variable Visibility: private -->
  566. <element name="TStatusBar.FSimpleText">
  567. <short/>
  568. <descr/>
  569. <seealso/>
  570. </element>
  571. <!-- variable Visibility: private -->
  572. <element name="TStatusBar.FSimplePanel">
  573. <short/>
  574. <descr/>
  575. <seealso/>
  576. </element>
  577. <!-- variable Visibility: private -->
  578. <element name="TStatusBar.FOnHint">
  579. <short/>
  580. <descr/>
  581. <seealso/>
  582. </element>
  583. <!-- procedure Visibility: private -->
  584. <element name="TStatusBar.SetPanels">
  585. <short/>
  586. <descr/>
  587. <errors/>
  588. <seealso/>
  589. </element>
  590. <!-- argument Visibility: default -->
  591. <element name="TStatusBar.SetPanels.Value">
  592. <short/>
  593. </element>
  594. <!-- procedure Visibility: private -->
  595. <element name="TStatusBar.SetSimpleText">
  596. <short/>
  597. <descr/>
  598. <errors/>
  599. <seealso/>
  600. </element>
  601. <!-- argument Visibility: default -->
  602. <element name="TStatusBar.SetSimpleText.Value">
  603. <short/>
  604. </element>
  605. <!-- procedure Visibility: private -->
  606. <element name="TStatusBar.SetSimplePanel">
  607. <short/>
  608. <descr/>
  609. <errors/>
  610. <seealso/>
  611. </element>
  612. <!-- argument Visibility: default -->
  613. <element name="TStatusBar.SetSimplePanel.Value">
  614. <short/>
  615. </element>
  616. <!-- procedure Visibility: protected -->
  617. <element name="TStatusBar.CreateWnd">
  618. <short>
  619. <var>CreateWnd</var> calls inherited method, then fixes handles if needed</short>
  620. <descr/>
  621. <errors/>
  622. <seealso>
  623. <link id="#LCL.Controls.TWinControl.CreateWnd">TWinControl.CreateWnd</link>
  624. </seealso>
  625. </element>
  626. <!-- procedure Visibility: protected -->
  627. <element name="TStatusBar.DestroyWnd">
  628. <short>
  629. <var>DestroyWnd</var> calls inherited method and frees handles</short>
  630. <descr/>
  631. <errors/>
  632. <seealso>
  633. <link id="#LCL.Controls.TWinControl.DestroyWnd">TWinControl.DestroyWnd</link>
  634. </seealso>
  635. </element>
  636. <!-- procedure Visibility: protected -->
  637. <element name="TStatusBar.Loaded">
  638. <short>
  639. <var>Loaded</var> calls inherited method and fixes handles if needed</short>
  640. <descr/>
  641. <errors/>
  642. <seealso>
  643. <link id="#LCL.Controls.TWinControl.Loaded">TWinControl.Loaded</link>
  644. </seealso>
  645. </element>
  646. <!-- procedure Visibility: protected -->
  647. <element name="TStatusBar.UpdateHandleObject">
  648. <short>
  649. <var>UpdateHandleObject</var> - updates all panel parts that have been changed</short>
  650. <descr/>
  651. <errors/>
  652. <seealso/>
  653. </element>
  654. <!-- argument Visibility: default -->
  655. <element name="TStatusBar.UpdateHandleObject.PanelIndex">
  656. <short/>
  657. </element>
  658. <!-- constructor Visibility: public -->
  659. <element name="TStatusBar.Create">
  660. <short>
  661. <var>Create</var> - constructor for <var>TStatusBar</var>: calls inherited <var>Create</var> and initialises a number of local variables</short>
  662. <descr>
  663. <p>
  664. <var>Create</var> - constructor for TStatusBar: calls inherited <var>Create</var> and initialises a number of local variables</p>
  665. <p>Among the variables initialised are:</p>
  666. <p>AutoHint (False), Canvas, ControlStyle, Colour, Align, AutoSize, and SimplePanel (True)</p>
  667. </descr>
  668. <errors/>
  669. <seealso>
  670. <link id="#rtl.Classes.TComponent.Create">TComponent.Create</link>
  671. <link id="#lcl.Controls.TWinControl.Create">TWinControl.Create</link>
  672. </seealso>
  673. </element>
  674. <!-- argument Visibility: default -->
  675. <element name="TStatusBar.Create.TheOwner">
  676. <short/>
  677. </element>
  678. <!-- destructor Visibility: public -->
  679. <element name="TStatusBar.Destroy">
  680. <short>
  681. <var>Destroy</var> - destructor for <var>TStatusBar</var>: frees canvas and panels, then calls inherited <var>Destroy</var>
  682. </short>
  683. <descr/>
  684. <errors/>
  685. <seealso>
  686. <link id="#rtl.Classes.TComponent.Destroy">TComponent.Destroy</link>
  687. <link id="#lcl.Controls.TWinControl.Destroy">TWinControl.Destroy</link>
  688. </seealso>
  689. </element>
  690. <!-- procedure Visibility: public -->
  691. <element name="TStatusBar.InvalidatePanel">
  692. <short>
  693. <var>InvalidatePanel</var> - renders the panel with specified index non-valid</short>
  694. <descr/>
  695. <errors/>
  696. <seealso/>
  697. </element>
  698. <!-- argument Visibility: default -->
  699. <element name="TStatusBar.InvalidatePanel.PanelIndex">
  700. <short/>
  701. </element>
  702. <!-- argument Visibility: default -->
  703. <element name="TStatusBar.InvalidatePanel.PanelParts">
  704. <short/>
  705. </element>
  706. <!-- procedure Visibility: public -->
  707. <element name="TStatusBar.BeginUpdate">
  708. <short>
  709. <var>BeginUpdate</var> - starts the update process</short>
  710. <descr/>
  711. <errors/>
  712. <seealso/>
  713. </element>
  714. <!-- procedure Visibility: public -->
  715. <element name="TStatusBar.EndUpdate">
  716. <short>
  717. <var>EndUpdate</var> - finishes the update process</short>
  718. <descr/>
  719. <errors/>
  720. <seealso/>
  721. </element>
  722. <!-- function Visibility: public -->
  723. <element name="TStatusBar.UpdatingStatusBar">
  724. <short>
  725. <var>UpdatingStatusBar</var> - returns True if the status bar is being updated</short>
  726. <descr/>
  727. <errors/>
  728. <seealso/>
  729. </element>
  730. <!-- function result Visibility: default -->
  731. <element name="TStatusBar.UpdatingStatusBar.Result">
  732. <short/>
  733. </element>
  734. <!-- property Visibility: public -->
  735. <element name="TStatusBar.Canvas">
  736. <short>The <var>Canvas</var> where the Panels of the StatusBar are to be Painted</short>
  737. <descr/>
  738. <seealso/>
  739. </element>
  740. <!-- property Visibility: published -->
  741. <element name="TStatusBar.Action" link="#LCL.Controls.TControl.Action">
  742. <short/>
  743. <descr/>
  744. <seealso/>
  745. </element>
  746. <!-- property Visibility: published -->
  747. <element name="TStatusBar.Panels">
  748. <short>
  749. <var>Panels</var> - the list of strings to be placed in the sub-panels of <var>TStatusBar</var>
  750. </short>
  751. <descr>
  752. <p>If <var>SimplePanel</var> is false, the contents of <var>Panels</var> is displayed. </p>
  753. <p>Contents can be adjusted with a stringlist editor that pops up when the ellipsis (...) next to <var>Panels</var> in the Object Inspector is selected and allows insertion of an arbitrary number of sub-panels with their own strings</p>
  754. </descr>
  755. </element>
  756. <!-- property Visibility: published -->
  757. <element name="TStatusBar.SimpleText">
  758. <short>
  759. <var>SimpleText</var> - a character string containing the information to be displayed in the Status Bar</short>
  760. <descr>
  761. <p>
  762. <var>SimpleText</var> - a character string containing the information to be displayed in the Status Bar</p>
  763. <p>This is displayed if <var>SimplePanel</var> is true; otherwise the information in Panels is displayed.</p>
  764. </descr>
  765. </element>
  766. <!-- property Visibility: published -->
  767. <element name="TStatusBar.SimplePanel">
  768. <short>
  769. <var>SimplePanel </var>- boolean. Is there just one continuous panel, or several sub-panels?</short>
  770. <descr>
  771. <p>
  772. <var>SimplePanel </var>- boolean. Is there just one continuous panel, or several sub-panels?</p>
  773. <p>If true, the value of <var>SimpleText</var> is displayed; if false, the contents of <var>Panels</var> is displayed. </p>
  774. <p>Contents can be adjusted with a stringlist editor that pops up when the ellipsis (...) next to <var>Panels</var> is selected and allows insertion of an arbitrary number of sub-panels with their own strings</p>
  775. </descr>
  776. </element>
  777. <!-- property Visibility: published -->
  778. <element name="TStatusBar.Visible" link="#LCL.Controls.TControl.Visible">
  779. <short/>
  780. <descr/>
  781. <seealso/>
  782. </element>
  783. <!-- property Visibility: published -->
  784. <element name="TStatusBar.Color" link="#LCL.Controls.TControl.Color">
  785. <short/>
  786. <descr/>
  787. <seealso/>
  788. </element>
  789. <!-- property Visibility: published -->
  790. <element name="TStatusBar.OnDblClick" link="#LCL.Controls.TControl.OnDblClick">
  791. <short/>
  792. <descr/>
  793. <seealso/>
  794. </element>
  795. <!-- property Visibility: published -->
  796. <element name="TStatusBar.OnHint">
  797. <short>Event handler for showing a hint when required</short>
  798. <descr/>
  799. <seealso/>
  800. </element>
  801. <!-- property Visibility: published -->
  802. <element name="TStatusBar.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
  803. <short/>
  804. <descr/>
  805. <seealso/>
  806. </element>
  807. <!-- object Visibility: default -->
  808. <element name="TCustomPage">
  809. <short>
  810. <var>TCustomPage</var>: The base type for
  811. <var>Page</var>
  812. </short>
  813. <descr>
  814. <var>TCustomPage</var>: The base type for the tabbed pages found in notebooks
  815. </descr>
  816. <seealso>
  817. <link id="#lcl.ExtCtrls.Multi-PageControls">Multi-PageControls</link>
  818. </seealso>
  819. </element>
  820. <!-- variable Visibility: private -->
  821. <element name="TCustomPage.FFlags">
  822. <short/>
  823. <descr/>
  824. <seealso/>
  825. </element>
  826. <!-- variable Visibility: private -->
  827. <element name="TCustomPage.FImageIndex">
  828. <short/>
  829. <descr/>
  830. <seealso/>
  831. </element>
  832. <!-- function Visibility: private -->
  833. <element name="TCustomPage.GetTabVisible">
  834. <short/>
  835. <descr/>
  836. <errors/>
  837. <seealso/>
  838. </element>
  839. <!-- function result Visibility: default -->
  840. <element name="TCustomPage.GetTabVisible.Result">
  841. <short/>
  842. </element>
  843. <!-- procedure Visibility: private -->
  844. <element name="TCustomPage.SetImageIndex">
  845. <short/>
  846. <descr/>
  847. <errors/>
  848. <seealso/>
  849. </element>
  850. <!-- argument Visibility: default -->
  851. <element name="TCustomPage.SetImageIndex.AValue">
  852. <short/>
  853. </element>
  854. <!-- procedure Visibility: private -->
  855. <element name="TCustomPage.SetTabVisible">
  856. <short/>
  857. <descr/>
  858. <errors/>
  859. <seealso/>
  860. </element>
  861. <!-- argument Visibility: default -->
  862. <element name="TCustomPage.SetTabVisible.AValue">
  863. <short/>
  864. </element>
  865. <!-- procedure Visibility: protected -->
  866. <element name="TCustomPage.WMPaint" link="#LCL.Controls.TWinControl.WMPaint">
  867. <short/>
  868. <descr/>
  869. <errors/>
  870. <seealso/>
  871. </element>
  872. <!-- argument Visibility: default -->
  873. <element name="TCustomPage.WMPaint.Msg">
  874. <short/>
  875. </element>
  876. <!-- procedure Visibility: protected -->
  877. <element name="TCustomPage.SetParent" link="#LCL.Controls.TControl.SetParent">
  878. <short/>
  879. <descr/>
  880. <errors/>
  881. <seealso/>
  882. </element>
  883. <!-- argument Visibility: default -->
  884. <element name="TCustomPage.SetParent.AParent">
  885. <short/>
  886. </element>
  887. <!-- property Visibility: protected -->
  888. <element name="TCustomPage.Flags">
  889. <short/>
  890. <descr/>
  891. <seealso/>
  892. </element>
  893. <!-- procedure Visibility: protected -->
  894. <element name="TCustomPage.CMHitTest" link="#LCL.Controls.TControl.CMHitTest">
  895. <short/>
  896. <descr/>
  897. <errors/>
  898. <seealso/>
  899. </element>
  900. <!-- argument Visibility: default -->
  901. <element name="TCustomPage.CMHitTest.Message">
  902. <short/>
  903. </element>
  904. <!-- procedure Visibility: protected -->
  905. <element name="TCustomPage.DestroyHandle" link="#LCL.Controls.TWinControl.DestroyHandle">
  906. <short/>
  907. <descr/>
  908. <errors/>
  909. <seealso/>
  910. </element>
  911. <!-- function Visibility: protected -->
  912. <element name="TCustomPage.GetPageIndex">
  913. <short>
  914. <var>GetPageIndex</var> - returns the index of the current page</short>
  915. <descr/>
  916. <errors/>
  917. <seealso/>
  918. </element>
  919. <!-- function result Visibility: default -->
  920. <element name="TCustomPage.GetPageIndex.Result">
  921. <short/>
  922. </element>
  923. <!-- procedure Visibility: protected -->
  924. <element name="TCustomPage.SetPageIndex">
  925. <short>
  926. <var>SetPageIndex</var> - specifies an index for the current page</short>
  927. <descr/>
  928. <errors/>
  929. <seealso/>
  930. </element>
  931. <!-- argument Visibility: default -->
  932. <element name="TCustomPage.SetPageIndex.AValue">
  933. <short/>
  934. </element>
  935. <!-- property Visibility: protected -->
  936. <element name="TCustomPage.TabVisible">
  937. <short>
  938. <var>TabVisible</var> - is the Tab for this page visible?</short>
  939. <descr/>
  940. <seealso/>
  941. </element>
  942. <!-- variable Visibility: private -->
  943. <element name="TCustomPage.FTabVisible">
  944. <short/>
  945. <descr/>
  946. <seealso/>
  947. </element>
  948. <!-- variable Visibility: private -->
  949. <element name="TCustomPage.FOnHide">
  950. <short/>
  951. <descr/>
  952. <seealso/>
  953. </element>
  954. <!-- variable Visibility: private -->
  955. <element name="TCustomPage.FOnShow">
  956. <short/>
  957. <descr/>
  958. <seealso/>
  959. </element>
  960. <!-- function Visibility: protected -->
  961. <element name="TCustomPage.DialogChar" link="#LCL.Controls.TControl.DialogChar">
  962. <short/>
  963. <descr/>
  964. <errors/>
  965. <seealso/>
  966. </element>
  967. <!-- function result Visibility: default -->
  968. <element name="TCustomPage.DialogChar.Result">
  969. <short/>
  970. </element>
  971. <!-- argument Visibility: default -->
  972. <element name="TCustomPage.DialogChar.Message">
  973. <short/>
  974. </element>
  975. <!-- procedure Visibility: protected -->
  976. <element name="TCustomPage.DoHide">
  977. <short>
  978. <var>DoHide</var> - perform the code for the <var>OnHide</var> event handler</short>
  979. <descr/>
  980. <errors/>
  981. <seealso/>
  982. </element>
  983. <!-- procedure Visibility: protected -->
  984. <element name="TCustomPage.DoShow">
  985. <short>
  986. <var>DoShow</var> - perform the code for the <var>OnShow</var> event handler</short>
  987. <descr/>
  988. <errors/>
  989. <seealso/>
  990. </element>
  991. <!-- constructor Visibility: public -->
  992. <element name="TCustomPage.Create">
  993. <short>
  994. <var>Create</var> - constructor for <var>TCustomPage</var>: calls inherited <var>Create</var> then initialises style, visibility, alignment and caption</short>
  995. <descr/>
  996. <errors/>
  997. <seealso>
  998. <link id="#lcl.Controls.TControl.Create">TControl.Create</link>
  999. </seealso>
  1000. </element>
  1001. <!-- argument Visibility: default -->
  1002. <element name="TCustomPage.Create.TheOwner">
  1003. <short/>
  1004. </element>
  1005. <!-- procedure Visibility: public -->
  1006. <element name="TCustomPage.AdjustClientRect" link="#LCL.Controls.TWinControl.AdjustClientRect">
  1007. <descr/>
  1008. <errors/>
  1009. <seealso/>
  1010. </element>
  1011. <!-- argument Visibility: default -->
  1012. <element name="TCustomPage.AdjustClientRect.ARect">
  1013. <short/>
  1014. </element>
  1015. <element name="TCustomPage.AutoSizeDelayed" link="#lcl.Controls.TControl.AutoSizeDelayed"/>
  1016. <!-- function result Visibility: default -->
  1017. <element name="TCustomPage.AutoSizeDelayed.Result">
  1018. <short/>
  1019. </element>
  1020. <element name="TCustomPage.IsControlVisible" link="#lcl.Controls.TControl.IsControlVisible"/>
  1021. <!-- function result Visibility: default -->
  1022. <element name="TCustomPage.IsControlVisible.Result">
  1023. <short/>
  1024. </element>
  1025. <!-- property Visibility: public -->
  1026. <element name="TCustomPage.Visible" link="#lcl.Controls.TControl.Visible">
  1027. <short/>
  1028. <descr/>
  1029. <seealso/>
  1030. </element>
  1031. <!-- property Visibility: public -->
  1032. <element name="TCustomPage.PageIndex">
  1033. <short>
  1034. <var>PageIndex </var>- integer index value for this page in the notebook</short>
  1035. </element>
  1036. <element name="TCustomPage.VisibleIndex">
  1037. <short>
  1038. <var>VisibleIndex</var> - returns the index number of a visible page</short>
  1039. </element>
  1040. <!-- function result Visibility: default -->
  1041. <element name="TCustomPage.VisibleIndex.Result">
  1042. <short/>
  1043. </element>
  1044. <element name="TCustomPage.OnHide">
  1045. <short>
  1046. <var>OnHide</var> - event handler for hiding this page in a notebook</short>
  1047. </element>
  1048. <element name="TCustomPage.OnShow">
  1049. <short>
  1050. <var>OnShow</var> - event handler for showing (making visible) this page of a notebook</short>
  1051. </element>
  1052. <!-- function Visibility: public -->
  1053. <element name="TCustomPage.CanTab" link="#LCL.Controls.TControl.CanTab"/>
  1054. <!-- function result Visibility: default -->
  1055. <element name="TCustomPage.CanTab.Result"/>
  1056. <!-- function Visibility: public -->
  1057. <element name="TCustomPage.IsVisible">
  1058. <short/>
  1059. <descr/>
  1060. <errors/>
  1061. <seealso/>
  1062. </element>
  1063. <!-- function result Visibility: default -->
  1064. <element name="TCustomPage.IsVisible.Result">
  1065. <short/>
  1066. </element>
  1067. <!-- property Visibility: public -->
  1068. <element name="TCustomPage.ImageIndex">
  1069. <short>
  1070. <var>ImageIndex</var> - integer index value for the image associated with this page</short>
  1071. </element>
  1072. <!-- property Visibility: public -->
  1073. <element name="TCustomPage.Left" link="#lcl.Controls.TControl.Left">
  1074. <short/>
  1075. <descr/>
  1076. <seealso/>
  1077. </element>
  1078. <!-- property Visibility: public -->
  1079. <element name="TCustomPage.Top" link="#lcl.Controls.TControl.Top">
  1080. <short/>
  1081. <descr/>
  1082. <seealso/>
  1083. </element>
  1084. <!-- property Visibility: public -->
  1085. <element name="TCustomPage.Width" link="#lcl.Controls.TControl.Width">
  1086. <short/>
  1087. <descr/>
  1088. <seealso/>
  1089. </element>
  1090. <!-- property Visibility: public -->
  1091. <element name="TCustomPage.Height" link="#lcl.Controls.TControl.Height">
  1092. <short/>
  1093. <descr/>
  1094. <seealso/>
  1095. </element>
  1096. <!-- property Visibility: public -->
  1097. <element name="TCustomPage.TabOrder" link="#lcl.Controls.TWinControl.TabOrder">
  1098. <short/>
  1099. <descr/>
  1100. <seealso/>
  1101. </element>
  1102. <!-- "class of" type Visibility: default -->
  1103. <element name="TCustomPageClass">
  1104. <short>
  1105. <var>TCustomPageClass</var> - class of <var>TCustomPage</var>
  1106. </short>
  1107. <descr/>
  1108. <seealso/>
  1109. </element>
  1110. <!-- object Visibility: default -->
  1111. <element name="TNBPages">
  1112. <short>
  1113. <var>TNBPages</var> - NoteBook Pages: an array of strings containing the names of the pages</short>
  1114. </element>
  1115. <!-- variable Visibility: private -->
  1116. <element name="TNBPages.FPageList">
  1117. <short/>
  1118. <descr/>
  1119. <seealso/>
  1120. </element>
  1121. <!-- variable Visibility: private -->
  1122. <element name="TNBPages.FNotebook">
  1123. <short/>
  1124. <descr/>
  1125. <seealso/>
  1126. </element>
  1127. <!-- function Visibility: protected -->
  1128. <element name="TNBPages.Get" link="#rtl.Classes.TStrings.Get">
  1129. <short/>
  1130. <descr/>
  1131. <errors/>
  1132. <seealso/>
  1133. </element>
  1134. <!-- function result Visibility: default -->
  1135. <element name="TNBPages.Get.Result">
  1136. <short/>
  1137. </element>
  1138. <!-- argument Visibility: default -->
  1139. <element name="TNBPages.Get.Index">
  1140. <short/>
  1141. </element>
  1142. <!-- function Visibility: protected -->
  1143. <element name="TNBPages.GetCount" link="#rtl.Classes.TStrings.GetCount">
  1144. <short/>
  1145. <descr/>
  1146. <errors/>
  1147. <seealso/>
  1148. </element>
  1149. <!-- function result Visibility: default -->
  1150. <element name="TNBPages.GetCount.Result">
  1151. <short/>
  1152. </element>
  1153. <!-- function Visibility: protected -->
  1154. <element name="TNBPages.GetObject" link="#rtl.Classes.TStrings.GetObject">
  1155. <short/>
  1156. <descr/>
  1157. <errors/>
  1158. <seealso/>
  1159. </element>
  1160. <!-- function result Visibility: default -->
  1161. <element name="TNBPages.GetObject.Result">
  1162. <short/>
  1163. </element>
  1164. <!-- argument Visibility: default -->
  1165. <element name="TNBPages.GetObject.Index">
  1166. <short/>
  1167. </element>
  1168. <!-- procedure Visibility: protected -->
  1169. <element name="TNBPages.Put" link="#rtl.Classes.TStrings.Put">
  1170. <short/>
  1171. <descr/>
  1172. <errors/>
  1173. <seealso/>
  1174. </element>
  1175. <!-- argument Visibility: default -->
  1176. <element name="TNBPages.Put.Index">
  1177. <short/>
  1178. </element>
  1179. <!-- argument Visibility: default -->
  1180. <element name="TNBPages.Put.S">
  1181. <short/>
  1182. </element>
  1183. <!-- constructor Visibility: public -->
  1184. <element name="TNBPages.Create">
  1185. <descr/>
  1186. <errors/>
  1187. <seealso>
  1188. <link id="#rtl.System.TObject.Create">TObject.Create</link>
  1189. </seealso>
  1190. <short>
  1191. <var>Create</var> - constructor for <var>TNBPages</var>: calls inherited <var>Create</var> then sets up the list of pages on the notebook</short>
  1192. </element>
  1193. <!-- argument Visibility: default -->
  1194. <element name="TNBPages.Create.thePageList">
  1195. <short/>
  1196. </element>
  1197. <!-- argument Visibility: default -->
  1198. <element name="TNBPages.Create.theNotebook">
  1199. <short/>
  1200. </element>
  1201. <!-- procedure Visibility: public -->
  1202. <element name="TNBPages.Clear" link="#rtl.Classes.TStrings.Clear">
  1203. <short/>
  1204. <descr/>
  1205. <errors/>
  1206. <seealso/>
  1207. </element>
  1208. <!-- procedure Visibility: public -->
  1209. <element name="TNBPages.Delete" link="#rtl.Classes.TStrings.Delete">
  1210. <short/>
  1211. <descr/>
  1212. <errors/>
  1213. <seealso/>
  1214. </element>
  1215. <!-- argument Visibility: default -->
  1216. <element name="TNBPages.Delete.Index">
  1217. <short/>
  1218. </element>
  1219. <!-- procedure Visibility: public -->
  1220. <element name="TNBPages.Insert" link="#rtl.Classes.TStrings.Insert">
  1221. <short/>
  1222. <descr/>
  1223. <errors/>
  1224. <seealso/>
  1225. </element>
  1226. <!-- argument Visibility: default -->
  1227. <element name="TNBPages.Insert.Index">
  1228. <short/>
  1229. </element>
  1230. <!-- argument Visibility: default -->
  1231. <element name="TNBPages.Insert.S">
  1232. <short/>
  1233. </element>
  1234. <!-- procedure Visibility: public -->
  1235. <element name="TNBPages.Move" link="#rtl.Classes.TStrings.Move">
  1236. <short/>
  1237. <descr/>
  1238. <errors/>
  1239. <seealso/>
  1240. </element>
  1241. <!-- argument Visibility: default -->
  1242. <element name="TNBPages.Move.CurIndex">
  1243. <short/>
  1244. </element>
  1245. <!-- argument Visibility: default -->
  1246. <element name="TNBPages.Move.NewIndex">
  1247. <short/>
  1248. </element>
  1249. <!-- procedure type Visibility: default -->
  1250. <element name="TTabChangingEvent">
  1251. <short>
  1252. <var>TTabChangingEvent</var> - generic event handling method for a change in a notebook Tab</short>
  1253. <descr/>
  1254. <seealso/>
  1255. </element>
  1256. <!-- argument Visibility: default -->
  1257. <element name="TTabChangingEvent.Sender">
  1258. <short/>
  1259. </element>
  1260. <!-- argument Visibility: default -->
  1261. <element name="TTabChangingEvent.AllowChange">
  1262. <short/>
  1263. </element>
  1264. <!-- enumeration type Visibility: default -->
  1265. <element name="TTabPosition">
  1266. <short>
  1267. <var>TTabPosition</var> - enumerated type for position of tab relative to page: top, bottom, left or right</short>
  1268. <descr/>
  1269. <seealso/>
  1270. </element>
  1271. <!-- enumeration value Visibility: default -->
  1272. <element name="TTabPosition.tpTop">
  1273. <short/>
  1274. </element>
  1275. <!-- enumeration value Visibility: default -->
  1276. <element name="TTabPosition.tpBottom">
  1277. <short/>
  1278. </element>
  1279. <!-- enumeration value Visibility: default -->
  1280. <element name="TTabPosition.tpLeft">
  1281. <short/>
  1282. </element>
  1283. <!-- enumeration value Visibility: default -->
  1284. <element name="TTabPosition.tpRight">
  1285. <short/>
  1286. </element>
  1287. <!-- enumeration type Visibility: default -->
  1288. <element name="TTabStyle">
  1289. <short>
  1290. <var>TTabStyle</var> - enumerated type for tab style: normal, buttons or flat buttons</short>
  1291. <descr/>
  1292. <seealso/>
  1293. </element>
  1294. <!-- enumeration value Visibility: default -->
  1295. <element name="TTabStyle.tsTabs">
  1296. <short/>
  1297. </element>
  1298. <!-- enumeration value Visibility: default -->
  1299. <element name="TTabStyle.tsButtons">
  1300. <short/>
  1301. </element>
  1302. <!-- enumeration value Visibility: default -->
  1303. <element name="TTabStyle.tsFlatButtons">
  1304. <short/>
  1305. </element>
  1306. <!-- procedure type Visibility: default -->
  1307. <element name="TTabGetImageEvent">
  1308. <short>
  1309. <var>TTabGetImageEvent</var> - generic event handling method for getting an image for a Tab</short>
  1310. <descr/>
  1311. <seealso/>
  1312. </element>
  1313. <!-- argument Visibility: default -->
  1314. <element name="TTabGetImageEvent.Sender">
  1315. <short/>
  1316. </element>
  1317. <!-- argument Visibility: default -->
  1318. <element name="TTabGetImageEvent.TabIndex">
  1319. <short/>
  1320. </element>
  1321. <!-- argument Visibility: default -->
  1322. <element name="TTabGetImageEvent.ImageIndex">
  1323. <short/>
  1324. </element>
  1325. <!-- enumeration type Visibility: default -->
  1326. <element name="TCTabControlOption">
  1327. <short>
  1328. <var>TCTabControlOption</var> - Show the close button on a tab, allow multi-line tabs</short>
  1329. <descr/>
  1330. <seealso/>
  1331. </element>
  1332. <!-- enumeration value Visibility: default -->
  1333. <element name="TCTabControlOption.nboShowCloseButtons">
  1334. <short/>
  1335. </element>
  1336. <!-- enumeration value Visibility: default -->
  1337. <element name="TCTabControlOption.nboMultiLine">
  1338. <short/>
  1339. </element>
  1340. <!-- set type Visibility: default -->
  1341. <element name="TCTabControlOptions">
  1342. <short>
  1343. <var>TCTabControlOptions</var> - set of <var>TCTabControlOption</var>
  1344. </short>
  1345. <descr/>
  1346. <seealso/>
  1347. </element>
  1348. <element name="TCustomTabControl">
  1349. <short>
  1350. <var>TCustomTabControl</var>: The base type for <var>TTabControl</var> and <var>TPageControl</var>
  1351. </short>
  1352. <descr>
  1353. <p>
  1354. <var>TCustom Notebook</var>: The base type for
  1355. <var>TTabControl</var> and
  1356. <var>TPageControl</var>
  1357. </p>
  1358. <p>A tab control has a series of <var>Tabs</var>, and it may or may not contain pages.</p>
  1359. </descr>
  1360. <seealso>
  1361. <link id="#lcl.ExtCtrls.Multi-PageControls">Multi-PageControls</link>
  1362. </seealso>
  1363. </element>
  1364. <!-- variable Visibility: private -->
  1365. <element name="TCustomTabControl.FAccess">
  1366. <short/>
  1367. <descr/>
  1368. </element>
  1369. <!-- variable Visibility: private -->
  1370. <element name="TCustomTabControl.FAddingPages">
  1371. <short/>
  1372. <descr/>
  1373. <seealso/>
  1374. </element>
  1375. <!-- variable Visibility: private -->
  1376. <element name="TCustomTabControl.FImages">
  1377. <short/>
  1378. <descr/>
  1379. <seealso/>
  1380. </element>
  1381. <!-- variable Visibility: private -->
  1382. <element name="TCustomTabControl.FLoadedPageIndex">
  1383. <short/>
  1384. <descr/>
  1385. <seealso/>
  1386. </element>
  1387. <!-- variable Visibility: private -->
  1388. <element name="TCustomTabControl.FOnChanging">
  1389. <short/>
  1390. <descr/>
  1391. <seealso/>
  1392. </element>
  1393. <!-- variable Visibility: private -->
  1394. <element name="TCustomTabControl.FOnCloseTabClicked"/>
  1395. <!-- variable Visibility: private -->
  1396. <element name="TCustomTabControl.FOnGetImageIndex">
  1397. <short/>
  1398. <descr/>
  1399. <seealso/>
  1400. </element>
  1401. <!-- variable Visibility: private -->
  1402. <element name="TCustomTabControl.fOnPageChanged">
  1403. <short/>
  1404. <descr/>
  1405. <seealso/>
  1406. </element>
  1407. <!-- variable Visibility: private -->
  1408. <element name="TCustomTabControl.FOptions">
  1409. <short/>
  1410. <descr/>
  1411. <seealso/>
  1412. </element>
  1413. <!-- variable Visibility: private -->
  1414. <element name="TCustomTabControl.FPageIndex">
  1415. <short/>
  1416. <descr/>
  1417. <seealso/>
  1418. </element>
  1419. <!-- variable Visibility: private -->
  1420. <element name="TCustomTabControl.FPageIndexOnLastChange">
  1421. <short/>
  1422. <descr/>
  1423. <seealso/>
  1424. </element>
  1425. <!-- variable Visibility: private -->
  1426. <element name="TCustomTabControl.FPageList">
  1427. <short/>
  1428. <descr/>
  1429. <seealso/>
  1430. </element>
  1431. <!-- variable Visibility: private -->
  1432. <element name="TCustomTabControl.FShowTabs">
  1433. <short/>
  1434. <descr/>
  1435. <seealso/>
  1436. </element>
  1437. <!-- variable Visibility: private -->
  1438. <element name="TCustomTabControl.FTabPosition">
  1439. <short/>
  1440. <descr/>
  1441. <seealso/>
  1442. </element>
  1443. <!-- procedure Visibility: private -->
  1444. <element name=