mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-04-17 17:49:28 +02:00
Docs: Documentation updates for LCL and LazUtils. Issue #37199, patch from Don Siders.
git-svn-id: trunk@63341 -
This commit is contained in:
juha
parent
1db124462b
commit
71129ed43e
docs/xml
@ -408,30 +408,30 @@
|
||||
<short>Path and file name to use in the function</short>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="ForceDirectory">
|
||||
<short>
|
||||
Creates the specified directory if it does not already exist
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>ForceDirectory</var> is a Boolean function which creates the specified directory if it does not already exist. ForceDirectory ensures that a trailing path delimiter exists in DirectoryName prior to checking the file system. Each directory in the specified path is examined in the function using DirPathExists. ForceDirectory calls CreateDirUTF8 if a directory does not exist, and may exit with a return value of False if directory creation is not successful.
|
||||
<var>ForceDirectory</var> is a Boolean function which creates the specified directory if it does not already exist. ForceDirectory ensures that a trailing path delimiter exists in <var>DirectoryName</var> prior to checking the file system. Duplicate adjacent path delimiters (like '//foo//bar/foobar/' or '\\foo\\bar\foobar\') are removed prior to checking the directory path.
|
||||
</p>
|
||||
<p>
|
||||
The return value is True if all directories in the path information already exist, or are successfully created in the function.
|
||||
Each directory in the specified path is validated by calling <var>DirPathExists</var>. ForceDirectory calls <var>CreateDirUTF8</var> if a directory does not exist, and may exit with a return value of <b>False</b> if directory creation is not successful.
|
||||
</p>
|
||||
<p>
|
||||
The return value is <b>True</b> if all directories in the path information already exist, or are successfully created in the function.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="ForceDirectoriesUTF8"/>
|
||||
<link id="DirPathExists"/>
|
||||
<link id="CreateDirUtf8"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="ForceDirectory.Result">
|
||||
<short>Returns True if directory exists or if it was successfully created</short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="ForceDirectory.DirectoryName">
|
||||
<short>Path information for the operation</short>
|
||||
</element>
|
||||
|
||||
@ -3841,6 +3841,29 @@
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TNoteBookStringsTabControl.GetPopupMenu" link="#LCL.Controls.TControl.PopupMenu">
|
||||
<short>
|
||||
Gets the value for the PopupMenu property
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>GetPopupMenu</var> is an overridden <var>TPopupMenu</var> function which implements the read access specifier for the <var>PopupMenu</var> property. The return value contains the TPopupMenu instance from the <var>Parent</var> control when it is derived from TTabControl and <var>Options</var> contains the value <var>nboHidePageListPopup</var>. Otherwise, the inherited method in <var>TControl</var> is called to get the popup menu instance for the control.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#LCL.Menus.TPopupMenu"/>
|
||||
<link id="#LCL.Controls.TControl.GetPopupMenu"/>
|
||||
<link id="#LCL.Controls.TControl.PopupMenu"/>
|
||||
<link id="#LCL.Controls.TControl.Parent"/>
|
||||
<link id="TTabControl"/>
|
||||
<link id="TPageControl.Options"/>
|
||||
<link id="CTabControlOption.nboHidePageListPopup"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TNoteBookStringsTabControl.GetPopupMenu.Result">
|
||||
<short>Value for the property</short>
|
||||
</element>
|
||||
|
||||
<element name="TNoteBookStringsTabControl.WSRegisterClass">
|
||||
<short/>
|
||||
<descr/>
|
||||
|
||||
@ -2,98 +2,139 @@
|
||||
<fpdoc-descriptions>
|
||||
<package name="LCL">
|
||||
<!--
|
||||
====================================================================
|
||||
RubberBand
|
||||
====================================================================
|
||||
-->
|
||||
====================================================================
|
||||
RubberBand
|
||||
====================================================================
|
||||
-->
|
||||
<module name="RubberBand">
|
||||
<short>Describes <var>TRubberBand</var>, for drawing a ring resembling a rubber band around a selection</short>
|
||||
<descr/>
|
||||
<short>
|
||||
Implements <var>TRubberBand</var> used to draw a "rubber-band" selection
|
||||
</short>
|
||||
<descr>
|
||||
<file>RubberBand.pas</file> contains types and classes needed to implement a rubber-band selection control in the Lazarus Component Library (LCL).
|
||||
</descr>
|
||||
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="Classes">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="Controls">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- enumeration type Visibility: default -->
|
||||
<element name="Classes"/>
|
||||
<element name="Controls"/>
|
||||
|
||||
<element name="TRubberBandShape">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Defines the shape drawn for a rubber-band selection</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TRubberBandShape</var> is an enumerated type with values that define the shape for the rubber-band selection drawn in <var>TCustomRubberBand</var> and descendent classes. TRubberBandShape is the type used to implement the <var>Shape</var> property in TCustomRubberBand.
|
||||
</p>
|
||||
<p>
|
||||
TRubberBandShape corresponds to the shape values expected in the QT widgetset.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TCustomRubberBand.Shape"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- enumeration value Visibility: default -->
|
||||
<element name="TRubberBandShape.rbsLine">
|
||||
<short/>
|
||||
<short>
|
||||
Rubber-band selection is drawn as a line; can represent either a horizontal or a vertical line
|
||||
</short>
|
||||
</element>
|
||||
<!-- enumeration value Visibility: default -->
|
||||
<element name="TRubberBandShape.rbsRectangle">
|
||||
<short/>
|
||||
<short>
|
||||
Rubber-band selection is drawn as a rectangle; may be a filled semi-transparent rectangle or a dotted outline depending on the style
|
||||
</short>
|
||||
</element>
|
||||
<!-- object Visibility: default -->
|
||||
|
||||
<element name="TCustomRubberBand">
|
||||
<short>
|
||||
<var>TCustomRubberBand</var> - base class for <var>TRubberBand</var>, for drawing a ring resembling a rubber band around a selection</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
Base class which implements a rubber-band selection
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TCustomRubberBand</var> is a <var>TWinControl</var> descendant which implements a control used to draw rubber-band selections in the Lazarus Component Library (LCL). TCustomRubberBand is used to provide support for selection shape maps used in widgetset classes, especially widgetset design-time classes.
|
||||
</p>
|
||||
<p>
|
||||
Set the value in the <var>Shape</var> property to control the appearance for the rubber-band selection drawn for the target platform.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomRubberBand.FShape">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- function Visibility: private -->
|
||||
|
||||
<element name="TCustomRubberBand.FShape"/>
|
||||
|
||||
<element name="TCustomRubberBand.GetShape">
|
||||
<short/>
|
||||
<short>Gets the value for the Shape property</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="TCustomRubberBand.Shape"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TCustomRubberBand.GetShape.Result">
|
||||
<short/>
|
||||
<short>Value for the property</short>
|
||||
</element>
|
||||
<!-- procedure Visibility: private -->
|
||||
|
||||
<element name="TCustomRubberBand.SetShape">
|
||||
<short/>
|
||||
<short>Sets the value for the Shape property</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="TCustomRubberBand.Shape"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomRubberBand.SetShape.AValue">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- constructor Visibility: public -->
|
||||
<element name="TCustomRubberBand.Create" link="#rtl.Classes.TComponent.Create">
|
||||
<short/>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomRubberBand.Create.AOwner">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomRubberBand.Shape">
|
||||
<short>The <var>Shape</var> of the rubber band device: a line or a rectangle around the selection</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TRubberBand">
|
||||
<short>
|
||||
<var>TRubberBand</var> for drawing a ring resembling a rubber band around a selection</short>
|
||||
<short>New value for the property</short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomRubberBand.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
|
||||
|
||||
<element name="TCustomRubberBand.Create" link="#rtl.Classes.TComponent.Create">
|
||||
<short>Constructor for the class instance</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Create</var> is the overridden constructor for the class instance, and calls the inherited constructor on entry to the method. Create sets the default value for the <var>Shape</var> property to <var>rsLine</var>.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TCustomRubberBand.Shape"/>
|
||||
<link id="TRubberBandShape.rsLine"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TCustomRubberBand.Create.AOwner">
|
||||
<short>Owner of the class instance</short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomRubberBand.Shape">
|
||||
<short>
|
||||
The <var>Shape</var> of the rubber band device: a line or a rectangle around the selection
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Shape</var> is a <var>TRubberBandShape</var> property which contains the shape drawn for the rubber-band selection. The default value for the property is <var>rbsLine</var>.
|
||||
</p>
|
||||
<p>
|
||||
Values in the Shape property correspond to the shape values used in the QT widgetset. See <link id="TRubberBandShape">TRubberBandShape</link> for more information about the enumeration values and their meanings.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TRubberBandShape"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TRubberBand" link="TCustomRubberBand">
|
||||
<short>
|
||||
Implements a rubber-band selection
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TRubberBand</var> is a <var>TCustomRubberBand</var> descendant which which implements a control used to draw rubber-band selections in the Lazarus Component Library (LCL). TRubberBand is used to provide support for selection shape maps used in widgetset classes, especially widgetset design-time classes.
|
||||
</p>
|
||||
<p>
|
||||
Set the value in the <var>Shape</var> property to control the appearance for the rubber-band selection drawn for the target platform.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TCustomRubberBand"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
</module>
|
||||
<!-- RubberBand -->
|
||||
</package>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user