← Back to branch summary

~ubuntu-branches/ubuntu/saucy/lazarus/saucy

« back to all changes in this revision

Viewing changes to .pc/spell_errors.diff/docs/xml/lcl/lclclasses.xml

  • Committer: Package Import Robot
  • Author(s): Paul Gevers, Abou Al Montacir, Bart Martens, Paul Gevers
  • Date: 2013-06-08 14:12:17 UTC
  • mfrom: (1.1.9)
  • Revision ID: package-import@ubuntu.com-20130608141217-7k0cy9id8ifcnutc
Tags: 1.0.8+dfsg-1
http://bugs.debian.org/708695
[ Abou Al Montacir ]
* New upstream major release and multiple maintenace release offering many
  fixes and new features marking a new milestone for the Lazarus development
  and its stability level.
  - The detailed list of changes can be found here:
    http://wiki.lazarus.freepascal.org/Lazarus_1.0_release_notes
    http://wiki.lazarus.freepascal.org/Lazarus_1.0_fixes_branch
* LCL changes:
  - LCL is now a normal package.
      + Platform independent parts of the LCL are now in the package LCLBase
      + LCL is automatically recompiled when switching the target platform,
        unless pre-compiled binaries for this target are already installed.
      + No impact on existing projects.
      + Linker options needed by LCL are no more added to projects that do
        not use the LCL package.
  - Minor changes in LCL basic classes behaviour
      + TCustomForm.Create raises an exception if a form resource is not
        found.
      + TNotebook and TPage: a new implementation of these classes was added.
      + TDBNavigator: It is now possible to have focusable buttons by setting
        Options = [navFocusableButtons] and TabStop = True, useful for
        accessibility and for devices with neither mouse nor touch screen.
      + Names of TControlBorderSpacing.GetSideSpace and GetSpace were swapped
        and are now consistent. GetSideSpace = Around + GetSpace.
      + TForm.WindowState=wsFullscreen was added
      + TCanvas.TextFitInfo was added to calculate how many characters will
        fit into a specified Width. Useful for word-wrapping calculations.
      + TControl.GetColorResolvingParent and
        TControl.GetRGBColorResolvingParent were added, simplifying the work
        to obtain the final color of the control while resolving clDefault
        and the ParentColor.
      + LCLIntf.GetTextExtentExPoint now has a good default implementation
        which works in any platform not providing a specific implementation.
        However, Widgetset specific implementation is better, when available.
      + TTabControl was reorganized. Now it has the correct class hierarchy
        and inherits from TCustomTabControl as it should.
  - New unit in the LCL:
      + lazdialogs.pas: adds non-native versions of various native dialogs,
        for example TLazOpenDialog, TLazSaveDialog, TLazSelectDirectoryDialog.
        It is used by widgetsets which either do not have a native dialog, or
        do not wish to use it because it is limited. These dialogs can also be
        used by user applications directly.
      + lazdeviceapis.pas: offers an interface to more hardware devices such
        as the accelerometer, GPS, etc. See LazDeviceAPIs
      + lazcanvas.pas: provides a TFPImageCanvas descendent implementing
        drawing in a LCL-compatible way, but 100% in Pascal.
      + lazregions.pas. LazRegions is a wholly Pascal implementation of
        regions for canvas clipping, event clipping, finding in which control
        of a region tree one an event should reach, for drawing polygons, etc.
      + customdrawncontrols.pas, customdrawndrawers.pas,
        customdrawn_common.pas, customdrawn_android.pas and
        customdrawn_winxp.pas: are the Lazarus Custom Drawn Controls -controls
        which imitate the standard LCL ones, but with the difference that they
        are non-native and support skinning.
  - New APIs added to the LCL to improve support of accessibility software
    such as screen readers.
* IDE changes:
  - Many improvments.
  - The detailed list of changes can be found here:
    http://wiki.lazarus.freepascal.org/New_IDE_features_since#v1.0_.282012-08-29.29
    http://wiki.lazarus.freepascal.org/Lazarus_1.0_release_notes#IDE_Changes
* Debugger / Editor changes:
  - Added pascal sources and breakpoints to the disassembler
  - Added threads dialog.
* Components changes:
  - TAChart: many fixes and new features
  - CodeTool: support Delphi style generics and new syntax extensions.
  - AggPas: removed to honor free licencing. (Closes: Bug#708695)
[Bart Martens]
* New debian/watch file fixing issues with upstream RC release.
[Abou Al Montacir]
* Avoid changing files in .pc hidden directory, these are used by quilt for
  internal purpose and could lead to surprises during build.
[Paul Gevers]
* Updated get-orig-source target and it compinion script orig-tar.sh so that they
  repack the source file, allowing bug 708695 to be fixed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
.pc/spell_errors.diff/docs/xml/lcl/lclclasses.xml
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<fpdoc-descriptions>
 
3
  <package name="lcl">
 
4
    <!--
 
5
  ====================================================================
 
6
    LCLClasses
 
7
  ====================================================================
 
8
-->
 
9
    <module name="LCLClasses">
 
10
      <short>Defines the base class for all LCL TComponents including controls</short>
 
11
      <descr/>
 
12
      <!-- unresolved type reference Visibility: default -->
 
13
      <element name="Classes">
 
14
        <short/>
 
15
        <descr/>
 
16
        <seealso/>
 
17
      </element>
 
18
      <!-- unresolved type reference Visibility: default -->
 
19
      <element name="WSLCLClasses">
 
20
        <short/>
 
21
        <descr/>
 
22
        <seealso/>
 
23
      </element>
 
24
<!-- object Visibility: default -->
 
25
      <element name="TLCLComponent">
 
26
        <short>The base class for LCL components associated with widgets.
 
27
        </short>
 
28
        <descr/>
 
29
        <errors/>
 
30
        <seealso/>
 
31
      </element>
 
32
      <!-- variable Visibility: private -->
 
33
      <element name="TLCLComponent.FWidgetSetClass" link="TLCLComponent.WidgetSetClass"/>
 
34
      <element name="TLCLComponent.FLCLRefCount" link="TLCLComponent.LCLRefCount"/>
 
35
      <!-- property Visibility: protected -->
 
36
      <element name="TLCLComponent.WidgetSetClass">
 
37
        <short>The widget for this component is derived from WidgetSetClass.
 
38
        </short>
 
39
        <descr/>
 
40
        <seealso/>
 
41
      </element>
 
42
      <element name="TLCLComponent.WSRegisterClass">
 
43
        <short>Registers this component class with the current WidgetSet.
 
44
        </short>
 
45
      </element>
 
46
      <!-- class function Visibility: default -->
 
47
      <element name="TLCLComponent.GetWSComponentClass">
 
48
        <short>This method allows descendents to override the WidgetSetClass.
 
49
        </short>
 
50
        <descr>
 
51
        </descr>
 
52
        <errors>
 
53
        </errors>
 
54
        <seealso>
 
55
        </seealso>
 
56
      </element>
 
57
      <element name="TLCLComponent.GetWSComponentClass.Result">
 
58
        <short/>
 
59
      </element>
 
60
      <element name="TLCLComponent.GetWSComponentClass.ASelf">
 
61
        <short/>
 
62
      </element>
 
63
      <element name="TLCLComponent.Create"/>
 
64
      <element name="TLCLComponent.Create.TheOwner">
 
65
        <short/>
 
66
      </element>
 
67
      <element name="TLCLComponent.Destroy"/>
 
68
      <!-- function Visibility: public -->
 
69
      <element name="TLCLComponent.NewInstance">
 
70
        <short>Registers the class and initializes WidgetSetClass.
 
71
        </short>
 
72
        <descr/>
 
73
        <errors/>
 
74
        <seealso>
 
75
          <link id="TLCLComponent.WidgetSetClass"/>
 
76
          <link id="#rtl.System.TObject.NewInstance">TObject.NewInstance</link>
 
77
        </seealso>
 
78
      </element>
 
79
      <element name="TLCLComponent.NewInstance.Result">
 
80
        <short/>
 
81
      </element>
 
82
      <!-- procedure Visibility: public -->
 
83
      <element name="TLCLComponent.RemoveAllHandlersOfObject">
 
84
        <short>Override this method to remove all references to notification handlers in AnObject.
 
85
        </short>
 
86
        <descr>An override is required as soon as a component allows to add notification handlers.
 
87
          Then all such handlers must be removed, when their owner (AnObject) is destroyed.
 
88
        </descr>
 
89
        <errors/>
 
90
        <seealso/>
 
91
      </element>
 
92
      <element name="TLCLComponent.RemoveAllHandlersOfObject.AnObject">
 
93
        <short>The object whose handlers shall be removed.
 
94
        </short>
 
95
      </element>
 
96
      <element name="TLCLComponent.IncLCLRefCount" link="TLCLComponent.LCLRefCount"/>
 
97
      <element name="TLCLComponent.DecLCLRefCount" link="TLCLComponent.LCLRefCount"/>
 
98
      <element name="TLCLComponent.LCLRefCount">
 
99
        <short>The number of references to this component.</short>
 
100
        <descr>
 
101
        </descr>
 
102
      <notes><note>Which are the possible owners of such references?</note>
 
103
        </notes>
 
104
      </element>
 
105
<!-- object Visibility: default -->
 
106
      <element name="TLCLReferenceComponent">
 
107
        <short>Base class for all components having an associated widget.
 
108
        </short>
 
109
        <descr>
 
110
          <p>
 
111
            The widget is created by the LCL control whenever required,
 
112
            and its reference is stored in FReferencePtr.
 
113
            This reference is for internal use by the LCL control, not by application code.
 
114
          </p>
 
115
          <p>This reference is different from the OS/window manager specific window Handle.</p>
 
116
          <p>Applications only can send messages to a windowed control, using its window Handle.</p>
 
117
        </descr>
 
118
        <seealso>
 
119
          <link id="TLCLReferenceComponent.ReferenceNeeded"/>
 
120
        </seealso>
 
121
      <notes><note>can be?</note>
 
122
        </notes>
 
123
      </element>
 
124
      <!-- variable Visibility: private -->
 
125
      <element name="TLCLReferenceComponent.FReferencePtr">
 
126
        <short>Pointer to a widget class Reference.</short>
 
127
        <descr>
 
128
        </descr>
 
129
        <seealso>
 
130
        </seealso>
 
131
      </element>
 
132
      <!-- variable Visibility: private -->
 
133
      <element name="TLCLReferenceComponent.FCreating">
 
134
        <short>Set while we are creating the Reference.</short>
 
135
        <descr>
 
136
        </descr>
 
137
        <seealso>
 
138
        </seealso>
 
139
      </element>
 
140
      <!-- function Visibility: private -->
 
141
      <element name="TLCLReferenceComponent.GetHandle" link="TLCLReferenceComponent.Handle"/>
 
142
      <element name="TLCLReferenceComponent.GetHandle.Result">
 
143
        <short/>
 
144
      </element>
 
145
      <!-- function Visibility: private -->
 
146
      <element name="TLCLReferenceComponent.GetReferenceAllocated">
 
147
        <short>Checks for a valid widget reference.
 
148
        </short>
 
149
        <descr>
 
150
        </descr>
 
151
        <errors>
 
152
        </errors>
 
153
        <seealso>
 
154
        </seealso>
 
155
      </element>
 
156
      <element name="TLCLReferenceComponent.GetReferenceAllocated.Result">
 
157
        <short/>
 
158
      </element>
 
159
      <!-- function Visibility: protected -->
 
160
      <element name="TLCLReferenceComponent.CreateParams">
 
161
        <short>Override this method to supply specific widget creation parameters.
 
162
        </short>
 
163
      </element>
 
164
      <element name="TLCLReferenceComponent.CreateParams.AParams">
 
165
        <short>The parameter record to update.</short>
 
166
      </element>
 
167
      <!-- function Visibility: protected -->
 
168
      <element name="TLCLReferenceComponent.DestroyReference">
 
169
        <short>Destroys the reference object.
 
170
        </short>
 
171
      </element>
 
172
      <!-- function Visibility: protected -->
 
173
      <element name="TLCLReferenceComponent.GetReferenceHandle">
 
174
        <short>Override this method to return the Handle from the reference
 
175
        </short>
 
176
      <notes><note>what is Handle?</note>
 
177
        </notes>
 
178
      </element>
 
179
      <element name="TLCLReferenceComponent.GetReferenceHandle.Result">
 
180
        <short/>
 
181
      </element>
 
182
      <!-- function Visibility: protected -->
 
183
      <element name="TLCLReferenceComponent.ReferenceCreated">
 
184
        <short>Called after the Reference is created.</short>
 
185
      </element>
 
186
      <!-- function Visibility: protected -->
 
187
      <element name="TLCLReferenceComponent.ReferenceDestroying">
 
188
        <short>Called before the Reference is destroyed</short>
 
189
      </element>
 
190
      <!-- function Visibility: protected -->
 
191
      <element name="TLCLReferenceComponent.ReferenceNeeded">
 
192
        <short>Creates a Reference, if not already done.
 
193
        </short>
 
194
      </element>
 
195
      <!-- function Visibility: protected -->
 
196
      <element name="TLCLReferenceComponent.WSCreateReference">
 
197
        <short>Tells the widgetset to create a Reference.
 
198
        </short>
 
199
        <descr>This implementation returns Nil, should be overriden in every derived class.
 
200
        </descr>
 
201
      </element>
 
202
      <element name="TLCLReferenceComponent.WSCreateReference.Result">
 
203
        <short/>
 
204
      </element>
 
205
      <element name="TLCLReferenceComponent.WSCreateReference.AParams">
 
206
        <short/>
 
207
      </element>
 
208
      <!-- function Visibility: protected -->
 
209
      <element name="TLCLReferenceComponent.WSDestroyReference">
 
210
        <short>Tells the widgetset to destroy the Reference.</short>
 
211
      </element>
 
212
      <!-- function Visibility: public -->
 
213
      <element name="TLCLReferenceComponent.Destroy"/>
 
214
      <element name="TLCLReferenceComponent.Handle">
 
215
        <short>Get the Handle of this component.</short>
 
216
        <descr>The Handle is  sort of pointer or reference, allocated by the operating system or widgetset to this component.
 
217
          A window handle can be used for sending messages to the component.</descr>
 
218
      <notes><note>?</note>
 
219
        </notes>
 
220
      </element>
 
221
      <element name="TLCLReferenceComponent.HandleAllocated" link="TLCLReferenceComponent.ReferenceAllocated"/>
 
222
      <element name="TLCLReferenceComponent.ReferenceAllocated">
 
223
        <short>If True, a Reference has been allocated for this component.
 
224
        </short>
 
225
      </element>
 
226
    </module>
 
227
    <!-- LCLClasses -->
 
228
  </package>
 
229
</fpdoc-descriptions>