lazarus/docs/xml/lcl/arrow.xml

<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
  <package name="lcl">
    <!--
      ====================================================================
        Arrow
      ====================================================================
    -->
    <module name="Arrow">
      <short>Defines an Arrow symbol widely used in forms.</short>
      <descr>
        <p>
          <file>arrow.pp</file> implements a control used to draw an arrow. Its size, direction, color and shadow can be adjusted. It is part of the Lazarus Component Library (<b>LCL</b>).
        </p>
        <p>
          The following components are added to the Lazarus IDE component palette:
        </p>
        <p>
          <b>Misc</b> Tab
        </p>
        <ul>
          <li>TArrow</li>
        </ul>
      </descr>

      <!-- unresolved references -->
      <element name="Classes"/>
      <element name="Types"/>
      <element name="Math"/>
      <element name="Controls"/>
      <element name="Graphics"/>
      <element name="IndustrialBase"/>

      <!-- enumeration type Visibility: default -->
      <element name="TArrowType">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TArrowType.atUp">
        <short/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TArrowType.atDown">
        <short/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TArrowType.atLeft">
        <short/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TArrowType.atRight">
        <short/>
      </element>
      <!-- enumeration type Visibility: default -->
      <element name="TShadowType">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TShadowType.stNone">
        <short/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TShadowType.stIn">
        <short/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TShadowType.stOut">
        <short/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TShadowType.stEtchedIn">
        <short/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TShadowType.stEtchedOut">
        <short/>
      </element>
      <!-- object Visibility: default -->
      <element name="TArrow">
        <short><var>TArrow</var> - an arrow symbol widely used in forms.</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TArrow.FArrowType">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TArrow.FShadowType">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- function Visibility: private -->
      <element name="TArrow.GetShadowType">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TArrow.GetShadowType.Result">
        <short/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TArrow.SetShadowType">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TArrow.SetShadowType.AValue">
        <short/>
      </element>

      <element name="TArrow.GetControlClassDefaultSize" link="#lcl.controls.TControl.GetControlClassDefaultSize"/>

       <!-- function Visibility: private -->
      <element name="TArrow.GetArrowType">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TArrow.GetArrowType.Result">
        <short/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TArrow.SetArrowType">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TArrow.SetArrowType.AValue">
        <short/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TArrow.SetProps">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- procedure Visibility: protected -->
      <element name="TArrow.Paint" link="#lcl.controls.TCustomControl.Paint">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- constructor Visibility: public -->
      <element name="TArrow.Create" link="#rtl.classes.TComponent.Create">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TArrow.Create.AOwner">
        <short/>
      </element>
      <!-- destructor Visibility: public -->
      <element name="TArrow.Destroy" link="#rtl.classes.TComponent.Destroy">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TArrow.Loaded" link="#rtl.classes.TComponent.Loaded">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TArrow.InitializeWnd" link="#lcl.controls.TWinControl.InitializeWnd">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TArrow.Align" link="#lcl.controls.TControl.Align">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TArrow.Anchors" link="#lcl.controls.TControl.Anchors">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TArrow.ArrowType">
        <short><var>ArrowType</var> - pointing up, down, left or right.</short>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TArrow.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TArrow.ShadowType">
        <short>
          <var>ShadowType</var> - the type of shadowing: None, In, Out, EtchedIn, EtchedOut.
        </short>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TArrow.Visible" link="#lcl.controls.TControl.Visible">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TArrow.OnClick" link="#lcl.controls.TControl.OnClick">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TArrow.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TArrow.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TArrow.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TArrow.OnChangeBounds" link="#lcl.controls.TControl.OnChangeBounds">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TArrow.OnResize" link="#lcl.controls.TControl.OnResize">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TArrow.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="TArrow.OnDblClick" link="#lcl.controls.TControl.OnDblClick"/>

      <!-- property Visibility: published -->
      <element name="TArrow.PopupMenu" link="#lcl.controls.TControl.PopupMenu">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <!-- procedure Visibility: default -->
      <element name="Register">
        <short>Registers components for use in the Lazarus IDE.</short>
        <descr>
          <p>
            The following components are added to the Lazarus IDE component palette:
          </p>
          <p>
            <b>Misc</b> Tab
          </p>
          <ul>
            <li>TArrow</li>
          </ul>
        </descr>
        <seealso/>
      </element>

    </module>
    <!-- Arrow -->
  </package>
</fpdoc-descriptions>