lazarus/docs/xml/lcl/checklst.xml

<?xml version="1.0"?>
<fpdoc-descriptions>
  <package name="lcl">
    <!--
  ====================================================================
    CheckLst
  ====================================================================
-->
    <module name="CheckLst">
      <short>Classes defining the CheckBox placed beside list items in a CheckList</short>
      <descr/>
      <!-- unresolved type reference Visibility: default -->
      <element name="Classes">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- unresolved type reference Visibility: default -->
      <element name="SysUtils">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- unresolved type reference Visibility: default -->
      <element name="LCLType">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- unresolved type reference Visibility: default -->
      <element name="GraphType">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- unresolved type reference Visibility: default -->
      <element name="Graphics">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- unresolved type reference Visibility: default -->
      <element name="LMessages">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- unresolved type reference Visibility: default -->
      <element name="Controls">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- unresolved type reference Visibility: default -->
      <element name="StdCtrls">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- object Visibility: default -->
      <element name="TCustomCheckListBox">
        <short>
          <var>TCustomCheckListBox</var> - base class for TCheckListBox, the box found on CheckLists</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TCustomCheckListBox.FItemDataOffset">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- function Visibility: private -->
      <element name="TCustomCheckListBox.GetChecked">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TCustomCheckListBox.GetChecked.Result">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TCustomCheckListBox.GetChecked.AIndex">
        <short/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TCustomCheckListBox.SetChecked">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TCustomCheckListBox.SetChecked.AIndex">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TCustomCheckListBox.SetChecked.AValue">
        <short/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TCustomCheckListBox.SendItemChecked">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TCustomCheckListBox.SendItemChecked.AIndex">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TCustomCheckListBox.SendItemChecked.AChecked">
        <short/>
      </element>
      <!-- procedure Visibility: protected -->
      <element name="TCustomCheckListBox.AssignItemDataToCache">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TCustomCheckListBox.AssignItemDataToCache.AIndex">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TCustomCheckListBox.AssignItemDataToCache.AData">
        <short/>
      </element>
      <!-- procedure Visibility: protected -->
      <element name="TCustomCheckListBox.AssignCacheToItemData">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TCustomCheckListBox.AssignCacheToItemData.AIndex">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TCustomCheckListBox.AssignCacheToItemData.AData">
        <short/>
      </element>
      <!-- function Visibility: protected -->
      <element name="TCustomCheckListBox.GetCachedDataSize">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TCustomCheckListBox.GetCachedDataSize.Result">
        <short/>
      </element>
      <!-- constructor Visibility: public -->
      <element name="TCustomCheckListBox.Create">
        <short>
          <var>Create</var> a new instance of <var>TCustomCheckListBox</var>
        </short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TCustomCheckListBox.Create.AOwner">
        <short/>
      </element>
      <!-- property Visibility: public -->
      <element name="TCustomCheckListBox.Checked">
        <short>
          <var>Checked</var> - True if the box with the specified Index has been checked</short>
        <descr/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TCustomCheckListBox.Checked.AIndex">
        <short/>
      </element>
      <!-- object Visibility: default -->
      <element name="TCheckListBox">
        <short>
          <var>TCheckListBox</var> - the box found beside each item on a <var>CheckList</var>
        </short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.Align">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.Anchors">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.BorderSpacing">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.BorderStyle">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.Constraints">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.ExtendedSelect">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.Items">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.ItemHeight">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.MultiSelect">
        <short>Allows multiple selected list items.</short>
        <seealso>
          <link id="StdCtrls"/>
        </seealso>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.OnClick">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.OnDblClick">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.OnDrawItem">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.OnEnter">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.OnExit">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.OnKeyPress">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.OnKeyDown">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.OnKeyUp">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.OnMouseMove">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.OnMouseDown">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.OnMouseUp">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.OnResize">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.ParentShowHint">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.ShowHint">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.Sorted">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.Style">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.TabOrder">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.TabStop">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.TopIndex">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TCheckListBox.Visible">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- procedure Visibility: default -->
      <element name="Register">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <element name="TCustomCheckListBox.Toggle">
        <short>
          <var>Toggle</var> the checked/unchecked state of this box </short>
      </element>
      <element name="TCustomCheckListBox.AllowGrayed">
        <short>
          <var>AllowGrayed</var> - if True, the box is allowed to be greyed, and impossible to select</short>
      </element>
      <element name="TCustomCheckListBox.State">
        <short>The <var>State</var> of the box with the specified index - checked, unchecked or greyed</short>
      </element>
      <element name="TCustomCheckListBox.Count"/>
      <element name="TCustomCheckListBox.OnClickCheck">
        <short>
          <var>OnClickCheck</var> - event handler for a mouse click on the CheckBox</short>
      </element>
      <element name="TCustomCheckListBox.OnItemClick">
        <short>
          <var>OnItemClick</var> - event handler for a mouse click on the data item associated with the checkbox</short>
      </element>
    </module>
    <!-- CheckLst -->
  </package>
</fpdoc-descriptions>