paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-25 07:00:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LCL/industrialbase. Adds topic content.

Browse Source
This commit is contained in:
dsiders 2022-08-20 01:09:53 +01:00
parent adaf3f4e19
commit 7efaa3308d
1 changed files with 73 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

117
docs/xml/lcl/industrialbase.xml
View File

@ -10,84 +10,113 @@ IndustrialBase
<module name="IndustrialBase"> <module name="IndustrialBase">
<short> <short>
Contains the base class for graphic controls that support anti-aliasing. Contains the base class for a graphic control with an anti-aliasing setting.
</short> </short>
<descr> <descr>
<p> <p>
<file>industrialbase.pp</file> contains the base class for graphic controls <file>industrialbase.pp</file> contains the base class for a graphic control
that support anti-aliasing. with an anti-aliasing setting.
</p>
<p>
<file>industrialbase.pp</file> is part of the Lazarus Component Library (LCL).
</p> </p>
</descr> </descr>
<!-- class Visibility: default -->
<element name="TIndustrialBase"> <element name="TIndustrialBase">
<short></short> <short>
Implements the base class for a control with an anti-aliasing setting.
</short>
<descr> <descr>
<p>
<var>TIndustrialBase</var> is a <var>TGraphicControl</var> descendant. It
extends the ancestor class with an AntiAliasingMode property which indicates
if anti-aliasing is enabled on the Canvas for the control. The property
emulates the behavior implemented in the TCustomImage / TImage component.
</p>
<p>
TIndustrialBase is the ancestor for the TArrow class.
</p>
</descr> </descr>
<errors>
</errors>
<seealso> <seealso>
<link id="#lcl.controls.TGraphicControl">TGraphicControl</link>
<link id="#lcl.arrow.TArrow">TArrow</link>
</seealso> </seealso>
</element> </element>
<!-- variable Visibility: private --> <!-- private -->
<element name="TIndustrialBase.FAntiAliasingMode"> <element name="TIndustrialBase.FAntiAliasingMode"/>
<short></short> <element name="TIndustrialBase.SetAntiAliasingMode"/>
<descr> <element name="TIndustrialBase.SetAntiAliasingMode.AValue"/>
</descr>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: private --> <!-- protected -->
<element name="TIndustrialBase.SetAntiAliasingMode">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TIndustrialBase.SetAntiAliasingMode.AValue">
<short></short>
</element>
<!-- procedure Visibility: protected -->
<element name="TIndustrialBase.GraphicChanged"> <element name="TIndustrialBase.GraphicChanged">
<short></short> <short>
Causes the control to be redrawn when it is parented and visible.
</short>
<descr> <descr>
<p>
Calls the Invalidate method to request an update to the control. No actions
are performed in the method if Parent has not be assigned, or the control is
not Visible.
</p>
<p>
GraphicChanged is called when the value in AntiAliasingMode is updated.
</p>
</descr> </descr>
<errors>
</errors>
<seealso> <seealso>
</seealso> </seealso>
</element> </element>
<!-- constructor Visibility: public --> <!-- public -->
<element name="TIndustrialBase.Create"> <element name="TIndustrialBase.Create">
<short></short> <short>Constructor for the class instance.</short>
<descr> <descr>
<p>
<var>Create</var> is the overridden constructor in
<var>TIndustrialBase</var>. It calls the inherited method on entry to set the Owner for the class instance, and to allocate resources for the Canvas property.
</p>
<p>
Create sets the default value for the AntiAliasingMode property to
amDontCare; this causes the default setting for the platform or widgetset to
be used. The initial bounds for the control are set in the method, and the
control style flags are updated to remove the csSetCaption flag.
</p>
</descr> </descr>
<errors>
</errors>
<seealso> <seealso>
<link id="TIndustrialBase.AntiAliasingMode"/>
</seealso> </seealso>
</element> </element>
<!-- argument Visibility: default -->
<element name="TIndustrialBase.Create.aOwner"> <element name="TIndustrialBase.Create.aOwner">
<short></short> <short>Owner of the class instance.</short>
</element> </element>
<!-- property Visibility: published --> <!-- published -->
<element name="TIndustrialBase.AntiAliasingMode"> <element name="TIndustrialBase.AntiAliasingMode">
<short></short> <short>
Indicates whether anti-aliased drawing is enabled for the control Canvas.
</short>
<descr> <descr>
<p>
<var>AntiAliasingMode</var> is a <var>TAntialiasingMode</var> property which
indicates whether anti-aliased drawing is enabled for the control Canvas. It emulates the behavior implemented in the TCustomImage / TImage component.
</p>
<p>
Anti-aliased drawing is a technique used to reduce the "stair-stepping"
effect for edges or lines in an image. It combines the colors for adjacent
pixels to soften a hard edge, and make the image look more realistic.
</p>
<p>
The default value for the property is amDontCare, and indicates that the
default setting for the platform or widgetset is used. Changing the property
value causes GraphicChanged to be called to redraw the control when allowed.
</p>
<p>
Descendent classes, like TArrow, use the value to configure the corresponding property in its control Canvas.
</p>
</descr> </descr>
<seealso> <seealso>
<link id="#lcl.graphics.TAntialiasingMode">TAntialiasingMode</link>
<link id="#lcl.graphics.TCanvas.AntialiasingMode">TCanvas.AntialiasingMode</link>
</seealso> </seealso>
</element> </element>