lazarus/docs/xml/lcl/ldockctrledit.xml

<?xml version="1.0"?>
<fpdoc-descriptions>
  <package name="lcl">
    <!--
  ====================================================================
    LDockCtrlEdit
  ====================================================================
-->
    <module name="LDockCtrlEdit">
      <short>This unit contains a dialog to dock or undock a control to another</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>
      <!-- enumeration type Visibility: default -->
      <element name="TLazDockControlEditorDlgResult">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TLazDockControlEditorDlgResult.ldcedrNone">
        <short/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TLazDockControlEditorDlgResult.ldcedrUndock">
        <short/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TLazDockControlEditorDlgResult.ldcedrDockLeft">
        <short/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TLazDockControlEditorDlgResult.ldcedrDockRight">
        <short/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TLazDockControlEditorDlgResult.ldcedrDockTop">
        <short/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TLazDockControlEditorDlgResult.ldcedrDockBottom">
        <short/>
      </element>
      <!-- enumeration value Visibility: default -->
      <element name="TLazDockControlEditorDlgResult.ldcedrDockPage">
        <short/>
      </element>
      <!-- object Visibility: default -->
      <element name="TLazDockControlEditorDlg">
        <short>
          <var>TLazDockControlEditorDlg</var> - a dialog to control the docking or undocking of a control with another</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- variable Visibility: default -->
      <element name="TLazDockControlEditorDlg.CancelButton">
        <short>
          <var>CancelButton</var> - hitting this button cancels the action</short>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: default -->
      <element name="TLazDockControlEditorDlg.DockControlComboBox">
        <short>
          <var>DockControlComboBox</var> displays the various actions for selection</short>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: default -->
      <element name="TLazDockControlEditorDlg.DockPageButton">
        <short>
          <var>DockPageButton</var> - a SpeedButton for moving the whole page</short>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: default -->
      <element name="TLazDockControlEditorDlg.DockBottomButton">
        <short>
          <var>DockBottomButton</var> - a SpeedButton for docking the bottom border</short>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: default -->
      <element name="TLazDockControlEditorDlg.DockTopButton">
        <short>
          <var>DockTopButton</var> - a SpeedButton for docking the top border</short>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: default -->
      <element name="TLazDockControlEditorDlg.DockRightButton">
        <short>
          <var>DockRightButton</var> - a SpeedButton for docking the right border</short>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: default -->
      <element name="TLazDockControlEditorDlg.DockLeftButton">
        <short>
          <var>DockLeftButton</var> - a SpeedButton for docking the left border</short>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: default -->
      <element name="TLazDockControlEditorDlg.DockGroupBox">
        <short>
          <var>DockGroupBox</var> - a GroupBox to contain the docking buttons</short>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: default -->
      <element name="TLazDockControlEditorDlg.DockControlLabel">
        <short>
          <var>DockControlLabel</var> - a label for the dock control</short>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: default -->
      <element name="TLazDockControlEditorDlg.UndockButton">
        <short>
          <var>UndockButton</var> - a buton for undocking the control</short>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: default -->
      <element name="TLazDockControlEditorDlg.UndockGroupBox">
        <short>
          <var>UndockGroupBox</var> - a box to contain the undock button and any associated elements</short>
        <descr/>
        <seealso/>
      </element>
      <!-- procedure Visibility: default -->
      <element name="TLazDockControlEditorDlg.DockBottomButtonClick">
        <short>
          <var>DockBottomButtonClick</var> - method for responding to a click on the <var>DockBottomButton</var>
        </short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TLazDockControlEditorDlg.DockBottomButtonClick.Sender">
        <short/>
      </element>
      <!-- procedure Visibility: default -->
      <element name="TLazDockControlEditorDlg.DockControlComboBoxEditingDone">
        <short>
          <var>DockControlComboBoxEditingDone</var> - method invoked when editing of the ComboBox is done</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TLazDockControlEditorDlg.DockControlComboBoxEditingDone.Sender">
        <short/>
      </element>
      <!-- procedure Visibility: default -->
      <element name="TLazDockControlEditorDlg.DockLeftButtonClick">
        <short>
          <var>DockLeftButtonClick</var> - method to respond to a click on the DockLeftButton</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TLazDockControlEditorDlg.DockLeftButtonClick.Sender">
        <short/>
      </element>
      <!-- procedure Visibility: default -->
      <element name="TLazDockControlEditorDlg.DockPageButtonClick">
        <short>
          <var>DockPageButtonClick</var> - method to respond to a click on the <var>DockPageButton</var>
        </short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TLazDockControlEditorDlg.DockPageButtonClick.Sender">
        <short/>
      </element>
      <!-- procedure Visibility: default -->
      <element name="TLazDockControlEditorDlg.DockRightButtonClick">
        <short>
          <var>DockRightButtonClick</var> - method to respond to a click on the <var>DockRightButton</var>
        </short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TLazDockControlEditorDlg.DockRightButtonClick.Sender">
        <short/>
      </element>
      <!-- procedure Visibility: default -->
      <element name="TLazDockControlEditorDlg.DockTopButtonClick">
        <short>
          <var>DockTopButtonClick</var> - method to respond to a click on the <var>DockTopButton</var>
        </short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TLazDockControlEditorDlg.DockTopButtonClick.Sender">
        <short/>
      </element>
      <!-- procedure Visibility: default -->
      <element name="TLazDockControlEditorDlg.FormCreate">
        <short>
          <var>FormCreate</var> - method for creating the dialog form</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TLazDockControlEditorDlg.FormCreate.Sender">
        <short/>
      </element>
      <!-- procedure Visibility: default -->
      <element name="TLazDockControlEditorDlg.UndockButtonClick">
        <short>
          <var>UndockButtonClick</var> - method to respond to a click on the <var>UndockButton</var>
        </short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TLazDockControlEditorDlg.UndockButtonClick.Sender">
        <short/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TLazDockControlEditorDlg.FCurrentControlName">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TLazDockControlEditorDlg.FDlgResult">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TLazDockControlEditorDlg.CheckSetDlgResult">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TLazDockControlEditorDlg.CheckSetDlgResult.NewDlgResult">
        <short/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TLazDockControlEditorDlg.SetCurrentControlName">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TLazDockControlEditorDlg.SetCurrentControlName.AValue">
        <short/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TLazDockControlEditorDlg.UpdateButtonEnabled">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- property Visibility: public -->
      <element name="TLazDockControlEditorDlg.DlgResult">
        <short>
          <var>DlgResult</var> - the result of the dialog: shows whether a moving button, an enlarging button or another control was pressed</short>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: public -->
      <element name="TLazDockControlEditorDlg.CurrentControlName">
        <short>
          <var>CurrentControlName</var> - the name of the current control (the one being docked)</short>
        <descr/>
        <seealso/>
      </element>
      <element name="TLazDockControlEditorDlg.EnlargeGroupBox">
        <short>
          <var>EnlargeGroupBox</var> - a GroupBox to contain the Enlarge buttons</short>
      </element>
      <element name="TLazDockControlEditorDlg.EnlargeLeftSpeedButton">
        <short>
          <var>EnlargeLeftSpeedButton</var> - a SpeedButton for enlarging the docking control by moving the left border</short>
      </element>
      <element name="TLazDockControlEditorDlg.EnlargeRightSpeedButton">
        <short>
          <var>EnlargeRightSpeedButton</var> - a Speedbutton for enlarging the docking control by moving its right border</short>
      </element>
      <element name="TLazDockControlEditorDlg.EnlargeTopSpeedButton">
        <short>
          <var>EnlargeTopSpeedButton</var> - a SpeedButton for enlarging the docking control by moving its top border</short>
      </element>
      <element name="TLazDockControlEditorDlg.EnlargeBottomSpeedButton">
        <short>
          <var>EnlargeBottomSpeedButton</var> - a SpeedButton for enlarging the docking control by moving its bottom border</short>
      </element>
      <element name="TLazDockControlEditorDlg.EnlargeBottomSpeedButtonClick">
        <short>
          <var>EnlargeBottomSpeedButtonClick</var> - method to respond to a click on the <var>EnlargeBottomSpeedButton</var>
        </short>
      </element>
      <element name="TLazDockControlEditorDlg.EnlargeLeftSpeedButtonClick">
        <short>
          <var>EnlargeLeftSpeedButtonClick</var> - method to respond to a click on the <var>EnlargeLeftSpeedButton</var>
        </short>
      </element>
      <element name="TLazDockControlEditorDlg.EnlargeRightSpeedButtonClick">
        <short>
          <var>EnlargeRightSpeedButtonClick</var> - method to respond to a click on the <var>EnlargeRightSpeedButton</var>
        </short>
      </element>
      <element name="TLazDockControlEditorDlg.EnlargeTopSpeedButtonClick">
        <short>
          <var>EnlargeTopSpeedButtonClick</var> - method to respond to a click on the <var>EnlargeTopSpeedButton</var>
        </short>
      </element>
    </module>
    <!-- LDockCtrlEdit -->
  </package>
</fpdoc-descriptions>