1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
Documentation for LCL (Lazarus Component Library) and LazUtils (Lazarus
Utilities) are published under the Creative Commons Attribution-ShareAlike 4.0
International public license.
https://creativecommons.org/licenses/by-sa/4.0/legalcode.txt
https://gitlab.com/freepascal.org/lazarus/lazarus/-/blob/main/docs/cc-by-sa-4-0.txt
Copyright (c) 1997-2025, by the Lazarus Development Team.
-->
<fpdoc-descriptions>
<package name="LCL">
<!--
====================================================================
RubberBand
====================================================================
-->
<module name="RubberBand">
<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"/>
<element name="Controls"/>
<element name="TRubberBandShape">
<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>
<element name="TRubberBandShape.rbsLine">
<short>
Rubber-band selection is drawn as a line; can represent either a horizontal
or a vertical line.
</short>
</element>
<element name="TRubberBandShape.rbsRectangle">
<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>
<element name="TCustomRubberBand">
<short>
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>
<element name="TCustomRubberBand.FShape"/>
<element name="TCustomRubberBand.GetShape">
<short>Gets the value for the Shape property.</short>
<descr/>
<seealso>
<link id="TCustomRubberBand.Shape"/>
</seealso>
</element>
<element name="TCustomRubberBand.GetShape.Result">
<short>Value for the property.</short>
</element>
<element name="TCustomRubberBand.SetShape">
<short>Sets the value for the Shape property.</short>
<descr/>
<seealso>
<link id="TCustomRubberBand.Shape"/>
</seealso>
</element>
<element name="TCustomRubberBand.SetShape.AValue">
<short>New value for the property.</short>
</element>
<element name="TCustomRubberBand.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
<element name="TCustomRubberBand.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"/>
</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">
<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>
</fpdoc-descriptions>
|
