1<?xml version="1.0"?>
2<fpdoc-descriptions>
3  <package name="EasyDockMgr">
4    <module name="uMakeSite">
5      <element name="TDockMaster">
6        <short>A DockMaster with extended capabilities, ready for use in any application.</short>
7        <descr>
8          <p>This DockMaster allows one to make forms dockable, and to add elastic docksites to forms. It defines the event handlers, installed in such controls.</p>
9        </descr>
10      </element>
11      <element name="TDockMaster.FormEndDock">
12        <short>OnEndDock handler for dockable forms.</short>
13        <descr>
14          <p>This handler immediately wraps a floating form into a floathost site, to keep it dockable on all platforms.</p>
15        </descr>
16      </element>
17      <element name="TDockMaster.ReloadForm">
18        <short>Reload a dockable form from an layout descriptor.</short>
19        <descr>
20          <p>When a form of the given name already exists on the Screen, all other parameters are ignored and this form is returned.</p>
21          <p>Otherwise the Factory is asked to provide the requested form.</p>
22          <p>When no form has been retrieved so far, AName is assumed to contain an standard form name, from which the form can be created. An eventually existing instance number is stripped from AName, and the result is prefixed by an 'T' for the classname of the form. This ClassName must have been registered, otherwise no form can be created. The new form is named as AName.</p>
23          <p>When AName is the empty string, a default form is created (for demonstration/debugging purposes).</p>
24          <p>When fVisible is True, the new form is made visible immediately.</p>
25        </descr>
26      </element>
27      <element name="TDockMaster.Factory">
28        <short>The default owner of all dockable forms.</short>
29        <descr>
30          <p>When not Nil, the Factory is asked to reload a form.</p>
31        </descr>
32      </element>
33      <element name="TDockMaster.ForIDE">
34        <short>An experimental switch, intended to make the DockMaster work for the Lazarus IDE.</short>
35      </element>
36      <element name="TDockMaster.WrapDockable">
37        <short>Internal function to wrap a floating form into a floathost site.</short>
38      </element>
39      <element name="TDockMaster.Create">
40        <short>This constructor installs the DockMaster singleton.</short>
41      </element>
42      <element name="DockMaster">
43        <short>The enhanced DockMaster singleton, otherwise same as DockLoader (retyped).</short>
44      </element>
45      <element name="TDockMaster.AddElasticSites">
46        <short>Adds elastic docksites to a form.</short>
47        <descr>
48          <p>Elastic docksites are normally invisible panels, that enlarge as soon as someting is docked into them. The user can make the form grow accordingly, so that the docked control looks like attached to the form - depending on where exactly the control is docked.</p>
49          <p>Elastic docksites are persistent, i.e. are saved and restored together with a screen layout.</p>
50          <p>Sides is the set of form sides, on which elastic sites shall be added.</p>
51          <p>Elastic sites should not be added to dockable forms, else docking into docked forms may cause trouble.</p>
52        </descr>
53      </element>
54      <element name="TDockMaster.CreateDockable">
55        <short>Creates a dockable form from its name.</short>
56        <descr>The form is created by <link id="TDockMaster.ReloadForm">ReloadForm</link>, then made dockable by <link id="TDockMaster.MakeDockable">MakeDockable</link>
57        </descr>
58      </element>
59      <element name="TDockMaster.MakeDockable">
60        <short>Make a control dockable.</short>
61        <descr>
62          <p>The control (typically a form) is made dockable on all platforms.</p>
63          <p>fWrap indicates that the control shall have a floathost site (required on most platforms).</p>
64          <p>fVisible indicates whether the control shall be made visible. Leave False when otherwise flicker will occur.</p>
65        </descr>
66      </element>
67      <element name="TDockMaster.DumpSites">
68        <short>Debug feature for console applications.</short>
69      </element>
70      <element name="TDockMaster.LoadFromStream">
71        <short>Reloads a layout from a stream.</short>
72      </element>
73      <element name="TDockMaster.SaveToStream">
74        <short>Saves the current screen layout to a stream.</short>
75      </element>
76      <element name="TDockMaster.ReloadDockedControl">
77        <short>Reloads a docked control from its descriptor string.</short>
78        <descr>
79          <p>First a form of the given name is searched on Screen, before <link id="easydocksite.TCustomDockMaster.ReloadControl">ReloadControl</link> is tried.</p>
80          <p>When nothing has been reloaded, and TryCreateControls is True, then a form is created by <link id="TDockMaster.ReloadForm">ReloadForm</link>.</p>
81        </descr>
82      </element>
83      <element name="TDockMaster.LoadFromFile">
84        <short>Restores a screen layout from a file.</short>
85      </element>
86      <element name="TDockMaster.SaveToFile">
87        <short>Saves the current screen layout as an file.</short>
88      </element>
89    </module>
90  </package>
91</fpdoc-descriptions>
92