paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-09-11 18:39:05 +02:00
Code Issues Packages Projects Releases Wiki Activity

LCL: Improve TForm documentation. Issue #33791, patch from AlexeyT.

Browse Source 
git-svn-id: trunk@58180 -
This commit is contained in:
juha 2018-06-08 10:06:02 +00:00
parent 9d70b9ea78
commit 62ba86833c
1 changed files with 32 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
docs/xml/lcl/forms.xml
View File

@ -1349,9 +1349,9 @@
</p> </p>
<ul> <ul>
<li> <li>
dmDesktop - on the full desktop dmDesktop - no attempt to choose specific monitor.
</li><li> </li><li>
dmPrimary - on the primary monitor dmPrimary - on the primary monitor.
</li><li> </li><li>
dmMainForm - on the same monitor as the main form. If there is no main form then use dmPrimary behavior. dmMainForm - on the same monitor as the main form. If there is no main form then use dmPrimary behavior.
</li><li> </li><li>
@ -1510,13 +1510,13 @@
</p> </p>
<ul> <ul>
<li> <li>
caNone: do nothing (don't close) caNone: do nothing (don't close).
</li><li> </li><li>
caHide: hide the form (default for modal forms) caHide: hide the form (default for modal forms).
</li><li> </li><li>
caFree: destroy the form caFree: destroy the form.
</li><li> </li><li>
caMinimize: minimize the form (MDI child default) caMinimize: minimize the form (MDI child default).
</li> </li>
</ul> </ul>
<p> <p>
@ -3315,8 +3315,7 @@ ShowModal creates its own event loop calling ProcessMessages.
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomForm.DefaultControl"> <element name="TCustomForm.DefaultControl">
<short>The control associated with the default action for this form.</short> <short>The control associated with the default action for this form.</short>
<descr> <descr>This is typically a button such as 'Accept'
&#x9;&#x9; This is typically a button such as 'Accept'
which is highlighted in some way on-screen to indicate which is highlighted in some way on-screen to indicate
that this is the default action, that this is the default action,
and is selected either by hitting 'Return' or 'Enter' and is selected either by hitting 'Return' or 'Enter'
@ -3325,8 +3324,19 @@ ShowModal creates its own event loop calling ProcessMessages.
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomForm.DefaultMonitor"> <element name="TCustomForm.DefaultMonitor">
<short>The monitor type on which the form shall appear.</short> <short>The monitor on which the form will appear.</short>
<descr> <descr>Possible values:
<ul>
<li>
dmDesktop - no attempt to choose specific monitor.
</li><li>
dmPrimary - on the primary monitor.
</li><li>
dmMainForm - on the same monitor as the main form. If there is no main form then use dmPrimary behavior.
</li><li>
dmActiveForm - on the same monitor as the currently active form. If there is no active form use dmMainForm behavior.
</li>
</ul>
</descr> </descr>
<seealso> <seealso>
</seealso> </seealso>
@ -3349,9 +3359,18 @@ ShowModal creates its own event loop calling ProcessMessages.
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomForm.FormStyle"> <element name="TCustomForm.FormStyle">
<short>Determines the <link id="#lcl.Controls.TFormStyle">Style</link> of the form (MDI, splash...). <short>Determines the style of the form.
</short> </short>
<descr> <descr>
Possible values:
<ul>
<li>fsNormal - usual style.</li>
<li>fsStayOnTop - form is positioned above all application's forms, except those which have fsStayOnTop style.</li>
<li>fsSystemStayOnTop - form is positioned above all OS windows, except other OS top-level windows.</li>
<li>fsSplash - form is border-less.</li>
<li>fsMDIForm - MDI parent form.</li>
<li>fsMDIChild - MDI child form.</li>
</ul>
</descr> </descr>
<seealso> <seealso>
<link id="#lcl.Controls.TFormStyle"/> <link id="#lcl.Controls.TFormStyle"/>
@ -9261,10 +9280,10 @@ ShowModal creates its own event loop calling ProcessMessages.
For creating forms without resources you have 3 options: For creating forms without resources you have 3 options:
</p> </p>
<ul> <ul>
<li>Create a TForm class (not a descendant)</li> <li>Create a TForm class (not a descendant).</li>
<li>Construct your form using the CreateNew() constructor.</li> <li>Construct your form using the CreateNew() constructor.</li>
<li>It is also possible to disable the exception by setting the global <li>It is also possible to disable the exception by setting the global
variable RequireDerivedFormResource to False. </li> variable RequireDerivedFormResource to False.</li>
</ul> </ul>
<p> <p>
History: History: