lazarus/docs/xml/lcl/dirsel.xml

<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
  <package name="lcl">
    <!--
  ====================================================================
    DirSel
  ====================================================================
-->
    <module name="DirSel">
      <short>A dialog for displaying a directory structure and selecting a directory</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="LResources">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- unresolved type reference Visibility: default -->
      <element name="Forms">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- unresolved type reference Visibility: default -->
      <element name="Controls">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- unresolved type reference Visibility: default -->
      <element name="Graphics">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- unresolved type reference Visibility: default -->
      <element name="Dialogs">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- unresolved type reference Visibility: default -->
      <element name="Buttons">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- unresolved type reference Visibility: default -->
      <element name="StdCtrls">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- unresolved type reference Visibility: default -->
      <element name="ComCtrls">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- unresolved type reference Visibility: default -->
      <element name="ExtCtrls">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- unresolved type reference Visibility: default -->
      <element name="FileCtrl">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- object Visibility: default -->
      <element name="TDirSelDlg">
        <short>
          <var>TDirSelDlg</var> - a dialog for selecting a directory from a TreeView list</short>
        <descr/>
        <errors/>
&#x9;<seealso><link id="#lcl.editbtn.tdirectoryedit">TDirectoryEdit</link>
&#x9;&#x9;<link id="#lcl.dialogs.tselectdirectorydialog">TSelectDirectoryDialog</link>
      </seealso>
      </element>
      <!-- variable Visibility: default -->
      <element name="TDirSelDlg.Button1">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: default -->
      <element name="TDirSelDlg.Button2">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: default -->
      <element name="TDirSelDlg.Label1">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: default -->
      <element name="TDirSelDlg.Panel1">
        <short>
          <var>Panel1</var> - the panel in which the control buttons are displayed</short>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: default -->
      <element name="TDirSelDlg.Panel2">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: default -->
      <element name="TDirSelDlg.Panel3">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: default -->
      <element name="TDirSelDlg.Panel4">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: default -->
      <element name="TDirSelDlg.TV">
        <short>
          <var>TV</var> - the Tree View that shows the directory structure</short>
        <descr/>
        <seealso/>
      </element>
      <!-- procedure Visibility: default -->
      <element name="TDirSelDlg.FormCreate">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDirSelDlg.FormCreate.Sender">
        <short/>
      </element>
      <!-- procedure Visibility: default -->
      <element name="TDirSelDlg.FormShow">
        <short>
          <var>FormShow</var> - method for displaying the created form</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDirSelDlg.FormShow.Sender">
        <short/>
      </element>
      <!-- procedure Visibility: default -->
      <element name="TDirSelDlg.TVExpanded">
        <short>
          <var>TVExpanded</var> - method for expanding the Tree View for the directory structure</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDirSelDlg.TVExpanded.Sender">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDirSelDlg.TVExpanded.Node">
        <short/>
      </element>
      <!-- procedure Visibility: default -->
      <element name="TDirSelDlg.TVItemDoubleClick">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDirSelDlg.TVItemDoubleClick.Sender">
        <short/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TDirSelDlg.FRootDir">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TDirSelDlg.FDir">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TDirSelDlg.FShowHidden">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TDirSelDlg.AddDirectories">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDirSelDlg.AddDirectories.Node">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDirSelDlg.AddDirectories.Dir">
        <short/>
      </element>
      <!-- function Visibility: private -->
      <element name="TDirSelDlg.GetAbsolutePath">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TDirSelDlg.GetAbsolutePath.Result">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDirSelDlg.GetAbsolutePath.Node">
        <short/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TDirSelDlg.SetDir">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDirSelDlg.SetDir.Value">
        <short/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TDirSelDlg.SetRootDir">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDirSelDlg.SetRootDir.Value">
        <short/>
      </element>
      <!-- function Visibility: public -->
      <element name="TDirSelDlg.SelectedDir">
        <short>
          <var>SelectedDir</var> - returns the name of the selected directory as a string</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TDirSelDlg.SelectedDir.Result">
        <short/>
      </element>
      <!-- property Visibility: public -->
      <element name="TDirSelDlg.Directory">
        <short>
          <var>Directory</var> - the currently selected directory: either the value inserted at the start, or the value selected from the Tree View</short>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: public -->
      <element name="TDirSelDlg.RootDirectory">
        <short>
          <var>RootDirectory</var> - the root directory from which the tree structure is derived</short>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: public -->
      <element name="TDirSelDlg.ShowHidden">
        <short>
          <var>ShowHidden</var> - if True, display the names of hidden directories</short>
        <descr>
          <p>
            <var>ShowHidden</var> - if True, display the names of hidden directories</p>
For example, in Windows and derivatives, display directories in and below the 'Windows' directory (mostly system files); in Unix/Linux etc, display directories prefixed with a dot (mostly configuration files, eg ' .lazarus ')
</descr>
        <seealso/>
      </element>
      <!-- variable Visibility: default -->
      <element name="DirSelDlg">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <element name="TDirSelDlg.btnOK">
        <short>
          <var>btnOK</var> - the 'OK' button for accepting a directory name (suggest the user changes the caption to 'OK')</short>
      </element>
      <element name="TDirSelDlg.btnCancel">
        <short>
          <var>btnCancel</var> - the 'Cancel' button if no selection is desired (suggest the user changes caption to 'Cancel')</short>
      </element>
      <element name="TDirSelDlg.lblDirectory">
        <short>
          <var>lblDirectory</var> - the label above the panel indicating that the directory is being displayed</short>
      </element>
      <element name="TDirSelDlg.DirectoryPanel">
        <short>
          <var>DirectoryPanel</var> - the panel in which the directory structure is displayed</short>
      </element>
    </module>
    <!-- DirSel -->
  </package>
</fpdoc-descriptions>