1<?xml version="1.0"?>
2<fpdoc-descriptions>
3  <package name="EasyDockMgr">
4    <module name="EasyDockSite">
5      <element name="TEasyDockManager">
6        <short>A docking manager base class, implementing some default functionality.</short>
7      </element>
8      <element name="TCustomDockMaster">
9        <short>The DockMaster base class, managing docking and screen layout issues in an application.</short>
10        <descr>
11          <p>The global DockLoader variable represents the installed DockMaster singleton.</p>
12          <p>It provides means to make forms dockable on all platforms (MakeDockable), and to save and reload screen layouts.</p>
13        </descr>
14      </element>
15      <element name="TCustomDockMaster.TryCreateControls">
16        <short>Indicates whether the DockMaster should try to create docked controls himself, when a layout is restored.</short>
17      </element>
18      <element name="TCustomDockMaster.MakeDockable">
19        <short>Makes a form dockable, on all platforms.</short>
20        <descr>
21          <p>All docking-related properties of the given form are set to appropriate values.</p>
22          <p>fWrap indicates whether the form shall be wrapped into a FloatHost site. The Result is that FloatHost form, always Nil in the default implementation.</p>
23          <p>fVisible indicates whether the form shall be made visible immediately. Leave the form invisible when otherwise further customization would cause the form to flicker.</p>
24        </descr>
25      </element>
26      <element name="TCustomDockMaster.SaveControl">
27        <short>Returns an string, containing all required information for reloading the control later.</short>
28        <descr>
29          <p>The content of the string is not restricted in any way, it only must be understood by ReloadControl.</p>
30          <p>
31            <ol>
32              <li>When the control is a TCustomDockSite, its SaveSite method can provide the string;</li>
33              <li>else an installed AppLoadStore callback can provide the string;</li>
34              <li>else an OnSave handler can provide the string.</li>
35              <li>When no string has been provided so far, a default control-descriptor string is created.</li>
36            </ol>
37          </p>
38        </descr>
39      </element>
40      <element name="TCustomDockMaster.ReloadControl">
41        <short>Provides a docked control when a layout is restored.</short>
42        <descr>
43          <p>The descriptor string is parsed into ControlDescriptor, accessible to the subsequently called procedures.</p>
44          <p>
45            <ol>
46              <li>When the string begins with a CustomDockSiteID, it is passed to TCustomDockSite.ReloadSite.</li>
47              <li>Else an AppLoadStore or OnRestore handler is invoked, if installed.</li>
48              <li>When no control has been provided, FindOwnedComponent is invoked.</li>
49              <li>When TryCreateControls is True, the control is created from its registered ClassName.</li>
50              <li>As a last resort the site.ReloadDockedControl is invoked.</li>
51            </ol>
52          </p>
53        </descr>
54      </element>
55      <element name="TCustomDockMaster.OnSave">
56        <short>Application handler for SaveControl.</short>
57      </element>
58      <element name="TCustomDockMaster.OnRestore">
59        <short>Application handler for ReloadControl.</short>
60      </element>
61      <element name="TCustomDockMaster.ControlDescriptor">
62        <short>Descriptor of the control, that currently shall be restored.</short>
63      </element>
64      <element name="TCustomDockSite">
65        <short>A general persistent docksite.</short>
66      </element>
67      <element name="TCustomDockSite.ReloadSite">
68        <short>Restores a docksite from its description.</short>
69        <descr>This is a class function, because it will create and return a new docksite.</descr>
70      </element>
71      <element name="TCustomDockSite.SaveSite">
72        <short>Returns the docksite descriptor as a string.</short>
73        <descr>The string begins with the CustomDockSiteID, to distinguish a docksite from any other docked control. The rest is added by SaveToStream.</descr>
74      </element>
75      <element name="TCustomDockSite.LoadFromStream">
76        <short>Reloads the docked controls from a stream.</short>
77        <descr>
78          <p>The DockManager is asked to restore the docked controls.</p>
79          <p>Unmanaged docksites must overwrite this method, to process their own descriptor string.</p>
80        </descr>
81      </element>
82      <element name="TCustomDockSite.SaveToStream">
83        <short>Saves the docksite description to the stream.</short>
84        <descr>
85          <p>The description actually is saved by the DockManager.</p>
86          <p>Unmanaged docksites must overwrite this method, to provide their own descriptor string.</p>
87        </descr>
88      </element>
89      <element name="CustomDockSiteID">
90        <short>The marker for an docksite layout descriptor.</short>
91        <descr>
92          <p>This marker is used in layout descriptor strings, to distinguish docksites from other controls.</p>
93          <p>Default descriptor strings start with the control name, so that values in the range 2..32 can be used as markers for special docksites, like custom docksites (1) or notebooks (2). These non-standard markers must be handled by application specific loaders, e.g. DockMaster.OnRestore handlers.</p>
94        </descr>
95      </element>
96      <element name="TOnReloadControl">
97        <short>Event handler type for the DockMaster OnReload event.</short>
98        <descr>
99          <p>The handler creates the docked control from the descriptor in AName.</p>
100          <p>AOwner is the default owner for the new control.</p>
101          <p>When the handler returns Nil, the DockMaster tries to create the control by default procedures. I.e. an application specific handler must only handle non-standard situations.</p>
102        </descr>
103      </element>
104      <element name="TOnSaveControl">
105        <short>Event handler type for the DockMaster OnSave event.</short>
106        <descr>
107          <p>The handler must handle all non-standard situations, when a specific control requires special construction or configuration. When an empty string is returned, the DockMaster creates an standard descriptor for the control.</p>
108          <p>The result is a descriptor string, that is passed to the OnReload handler when the layout is restored later. It's suggested to prefix the string with a special marker byte, in the range 3..32.</p>
109        </descr>
110        <seealso>
111          <link id="CustomDockSiteID"/>
112          <link id="TOnReloadControl"/>
113        </seealso>
114      </element>
115      <element name="TDockSiteClass">
116        <short>Class type of a persistent docksite.</short>
117        <descr>Docksites derived from this type are handled automatically be the DockMaster, when a docking layout is saved and reloaded.</descr>
118      </element>
119    </module>
120  </package>
121</fpdoc-descriptions>
122