lazarus/docs/xml/lcl/filectrl.xml

<?xml version="1.0"?>
<fpdoc-descriptions>
  <package name="lcl">
    <!--
  ====================================================================
    FileCtrl
  ====================================================================
-->
    <module name="FileCtrl">
      <short>Class definitions for a box with a list of files for selection</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="StdCtrls">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- unresolved type reference Visibility: default -->
      <element name="FileUtil">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- enumeration type Visibility: default -->
      <element name="TFileAttr">
        <short>
          <var>TFileAttr</var> - enumerated type listing file attributes for a file list box</short>
        <descr/>
        <seealso/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TFileAttr.ftReadOnly">
        <short/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TFileAttr.ftHidden">
        <short/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TFileAttr.ftSystem">
        <short/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TFileAttr.ftVolumeID">
        <short/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TFileAttr.ftDirectory">
        <short/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TFileAttr.ftArchive">
        <short/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TFileAttr.ftNormal">
        <short/>
      </element>
      <!-- set type Visibility: default -->
      <element name="TFileType">
        <short>
          <var>TFileType</var> - set of file attributes</short>
        <descr/>
        <seealso/>
      </element>
      <!-- object Visibility: default -->
      <element name="TCustomFileListBox">
        <short>
          <var>TCustomFileListBox</var> : base type for <var>TFileListBox</var> - a tool for listing files for selection</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TCustomFileListBox.FDrive">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TCustomFileListBox.FDirectory">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TCustomFileListBox.FFileName">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TCustomFileListBox.FFileType">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TCustomFileListBox.FMask">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TCustomFileListBox.FOnChange">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TCustomFileListBox.FLastChangeFileName">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- function Visibility: private -->
      <element name="TCustomFileListBox.MaskIsStored">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TCustomFileListBox.MaskIsStored.Result">
        <short/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TCustomFileListBox.SetDirectory">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TCustomFileListBox.SetDirectory.AValue">
        <short/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TCustomFileListBox.SetDrive">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TCustomFileListBox.SetDrive.AValue">
        <short/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TCustomFileListBox.SetFileName">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TCustomFileListBox.SetFileName.AValue">
        <short/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TCustomFileListBox.SetFileType">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TCustomFileListBox.SetFileType.AValue">
        <short/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TCustomFileListBox.SetMask">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TCustomFileListBox.SetMask.AValue">
        <short/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TCustomFileListBox.UpdateSelectedFileName">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- procedure Visibility: protected -->
      <element name="TCustomFileListBox.DoChangeFile">
        <short>
          <var>DoChangeFile</var> - method to change a file selection: calls the <var>OnChange</var> event handler</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- procedure Visibility: protected -->
      <element name="TCustomFileListBox.UpdateFileList">
        <short>
          <var>UpdateFileList</var> - brings the list of files up to date, taking into account any changes</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- procedure Visibility: protected -->
      <element name="TCustomFileListBox.Click" link="#LCL.Controls.TControl.Click">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- procedure Visibility: protected -->
      <element name="TCustomFileListBox.Loaded" link="#rtl.Classes.TComponent.Loaded">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function Visibility: protected -->
      <element name="TCustomFileListBox.IndexOfFile">
        <short>
          <var>IndexOfFile</var> - number of the selected file in the list of files</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TCustomFileListBox.IndexOfFile.Result">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TCustomFileListBox.IndexOfFile.AFilename">
        <short/>
      </element>
      <!-- procedure Visibility: protected -->
      <element name="TCustomFileListBox.KeyUp" link="#LCL.Controls.TWinControl.KeyUp">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TCustomFileListBox.KeyUp.Key">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TCustomFileListBox.KeyUp.Shift">
        <short/>
      </element>
      <!-- constructor Visibility: public -->
      <element name="TCustomFileListBox.Create" link="#rtl.Classes.TComponent.Create">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TCustomFileListBox.Create.TheOwner">
        <short/>
      </element>
      <!-- destructor Visibility: public -->
      <element name="TCustomFileListBox.Destroy" link="#rtl.Classes.TComponent.Destroy">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- property Visibility: public -->
      <element name="TCustomFileListBox.Drive">
        <short>The <var>Drive</var> on which the file is located (applies to Windows systems)</short>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: public -->
      <element name="TCustomFileListBox.Directory">
        <short>The <var>Directory</var> or Folder in which the file is located</short>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: public -->
      <element name="TCustomFileListBox.FileName">
        <short>
          <var>FileName</var> - the name of the selected file</short>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: public -->
      <element name="TCustomFileListBox.FileType">
        <short>
          <var>FileType</var> - the type or attributes of the selected file</short>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: public -->
      <element name="TCustomFileListBox.Mask">
        <short>The search <var>Mask</var> used to find the file</short>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: public -->
      <element name="TCustomFileListBox.OnChange">
        <short>
          <var>OnChange</var> - event handler for a change in the file list or the selection</short>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: public -->
      <element name="TCustomFileListBox.Sorted" link="#LCL.StdCtrls.TCustomListBox.Sorted">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- object Visibility: default -->
      <element name="TFileListBox">
        <short>
          <var>TFileListBox</var> - a tool for listing files for selection</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.Align" link="#LCL.Controls.TControl.Align">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.Anchors" link="#LCL.Controls.TControl.Anchors">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.BorderStyle" link="#LCL.Controls.TWinControl.BorderStyle">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.Constraints" link="#LCL.Controls.TControl.Constraints">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.ExtendedSelect" link="#LCL.StdCtrls.TCustomListBox.ExtendedSelect">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.FileType" link="#LCL.FileCtrl.TCustomFileListBox.FileType">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.Font" link="#LCL.Controls.TControl.Font">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.IntegralHeight" link="#LCL.StdCtrls.TCustomListBox.IntegralHeight">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.ItemHeight" link="#LCL.StdCtrls.TCustomListBox.ItemHeight">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.Mask" link="#LCL.FileCtrl.TCustomFileListBox.Mask">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.MultiSelect" link="#LCL.StdCtrls.TCustomListBox.MultiSelect">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.OnChange" link="#LCL.FileCtrl.TCustomFileListBox.OnChange">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.OnClick" link="#LCL.Controls.TControl.OnClick">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.OnDblClick" link="#LCL.Controls.TControl.OnDblClick">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.OnEnter" link="#LCL.Controls.TWinControl.OnEnter">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.OnExit" link="#LCL.Controls.TWinControl.OnExit">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.OnMouseWheel" link="#LCL.Controls.TControl.OnMouseWheel">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.OnMouseWheelDown" link="#LCL.Controls.TControl.OnMouseWheelDown">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.OnMouseWheelUp" link="#LCL.Controls.TControl.OnMouseWheelUp">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.OnResize" link="#LCL.Controls.TControl.OnResize">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.ParentFont" link="#LCL.Controls.TControl.ParentFont">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.PopupMenu" link="#LCL.Controls.TControl.PopupMenu">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.ShowHint" link="#LCL.Controls.TControl.ShowHint">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.Sorted" link="#LCL.StdCtrls.TCustomListBox.Sorted">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.Style" link="#LCL.StdCtrls.TCustomListBox.Style">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.TabStop" link="#LCL.Controls.TWinControl.TabStop">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.TopIndex" link="#LCL.StdCtrls.TCustomListBox.TopIndex">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: published -->
      <element name="TFileListBox.Visible" link="#LCL.Controls.TControl.Visible">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- procedure Visibility: default -->
      <element name="Register">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <element name="TFileListBox.Directory" link="#LCL.FileCtrl.TCustomFileListBox.Directory"/>
      <element name="TFileListBox.DragCursor" link="#LCL.Controls.TControl.DragCursor"/>
      <element name="TFileListBox.DragMode" link="#LCL.Controls.TControl.DragMode"/>
      <element name="TFileListBox.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop"/>
      <element name="TFileListBox.OnDragOver" link="#LCL.Controls.TControl.OnDragOver"/>
      <element name="TFileListBox.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag"/>
      <element name="TFileListBox.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag"/>
      <element name="TFileListBox.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
      <element name="MiniMizeName">
        <short>
          <var>MiniMizeName</var> This function will return a shortened version of <var>FileName</var>, so that it fits on the given <var>Canvas</var>, with a given <var>MaxWidth</var>.</short>
        <descr>
          <p>
            <var>MiniMizeName</var> This function will return a shortened version of FileName, so that it fits on the given Canvas, with a given MaxWidth.</p>
          <p>eg. C:\Documents and Settings\User\Application Data\Microsoft\Word\custom.dic  would become something like: C:\...\Word\custom.dic</p>
        </descr>
      </element>
    </module>
    <!-- FileCtrl -->
  </package>
</fpdoc-descriptions>