Lazarus 2.2.0 release notes: what changed

Revision 1 to 2. Removed lines have a minus sign; added lines have a plus sign.

Old	New		Line
1	1		## LazUtils Changes
2	2
3	3		### FileExistsUTF8 uses SysUtils.FileExists
4	4
5	5		- Old behavior: FileExistsUTF8 supported Unicode in fpc 2.6.x under Windows
6	6		- New behavior: FileExistsUTF8 now calls SysUtils.FileExists, which supports Unicode under Windows since fpc 3.0
7	7		- Reason: Simplified
8	8
9	9		### Masks unit
10	10
11	11		- An mechanism to disable sets in a specified mask is implemented. For this purpose a new parameter Options: TMaskOptions is introduced. Specifying moDisableSets in the Options parameter will disable interpreting '\[' as the begin of a set in the specified mask.
12	12		- Example: MatchesMask('\[x\]','\[x\]',\[moDisableSets\]) will return True.
13	13
14	14		### LazFreeType
15	15
16	16		- Freetype font rendering units were moved to a package of its own "components/freetype/freetypelaz.lpk"
17	17		- Reason: Units have grown to an impressive number
18	18
19	19		### PasWStr unit removed
20	20
21	21		- The PasWStr unit has been removed.
22	22		- Reason: it contained functional code only if the compiler was pre 3.0.
23	23		- Remedy: remove PasWStr from your uses clause.
24	24
25	25		## LCL Interfaces Changes
26	26
27	27		### Internal component registration and TLCLComponent.NewInstance was optimized
28	28
29	29		LCL components are registered and mapped to a widgetset by TLCLComponent.NewInstance. This is an undocumented implementation detail and should not affect any components outside of LCL itself. However some external components could support widgetsets the same way. Then "class procedure WSRegisterClass; override;" is needed having a call to "RegisterWSComponent()". It was added to component OpenGlContext in trunk r63636. Please use it as an example if needed.
30	30
31	31		### Widgetsets
32	32
33	33		- Qt5 widgetset needs libQt5Pas v 1.2.8 since result of QWidget_winId() is changed from PtrInt to PtrUInt.
34	34		- Windows: Qt5Pas1.dll is already in lazarus trunk binaries directory.
35	35		- Linux: distributions should rebuild libQt5Pas packages.
36	36		- macOS: you should rebuild libQt5Pas against downloaded Qt5Pas libs (Qt5-5.6 is minimum).
37	37
38	38		- Qt5 added QLCLOpenGLWidget into libQt5Pas v.1.2.8 for full OpenGL component support.
39	39
40	40		- Qt, Qt5 and Gtk2: Form dimensions are accurate now on x11 (frame around form).
41	41		- Solution is provided by creating dummy widget before Application.MainForm.Handle is created. This can be disabled via command line switch "-disableaccurateframe". This feature is used inside WidgetSet.GetWindowRect() only.
42	42
43	43		- Qt and Qt5: Form dimensions are accurate now on MS Windows and macOS.
44	44		- This is accomplished by creating winID if form isn't mapped yet inside WidgetSet.GetWindowRect().
45	45
46	46		## LCL Changes
47	47
48	48		### TLazIntfImage.Create with size and description flags need no CreateData anymore
49	49
50	50		- Old: After creating of a TLazIntfImage with size and flags CreateData has to be called
51	51		- New: Creating of a TLazIntfImage with size and flags internal calls CreateData
52	52		- Reason: Simplify, see [Issue \#35035](https://bugs.freepascal.org/view.php?id=35035)
53	53
54	54		### TValueListEditor
55	55
56	56		- Old behaviour: having the current NameValueSeparator (by default: '=') in the Key column was allowed.
57	57		- New behaviour: you cannot have a NameValueSeparator in the Key column. If you type the NameValueSeparator in the Key column, the focus will move to the Value Column. If you paste it into the column, it will be removed (without any feedback or warning).
58	58		- Reason: By design a Key can never have a NameValueSeparator in it. Having it there causes havoc. See [this forum post](https://forum.lazarus.freepascal.org/index.php?topic=51977.0;topicseen).
59	59		- Note: This new behaviour is not Delphi compatible (which is a conscious design decision), Delphi raises an exception if you try to type or paste a NameValueSeparator in the Key column.
60	60		- Revision: r64089 and r64090.
61	61
62	62		### TShellTreeView
63	63
64	64		- New event OnAddItem gives possibility for finer control over what to add to the tree.
65	65		- Shell icons are displayed automatically in Windows when no imagelist is attached and when UseBuiltInIcons is true.
66	66
67	67		### TShellListView
68	68
69	69		- New event OnAddItem gives possibility for finer control over what to add to the listview.
70	70		- New property MaskCaseSensitivity to allow e.g. case-insensitive masks on *nix. The property defaults to platfom standard behaviour.
71	71		- Shell icons are displayed automatically in Windows when no imagelist is attached and when UseBuiltInIcons is true.
72	72
73	73		### New Screen temporary cursor
74	74
75	75		Screen has new methods:
76	76
77	77		- BeginTempCursor / EndTempCursor
78	78		- BeginWaitCursor / EndWaitCursor
79	79		- BeginScreenCursor / EndScreenCursor
80	80
81	81		These should be used for temporary cursor changes instead of setting the Screen.Cursor property directly. They ensure that valid cursor values are restored.
82	82
83	83		### TMaskEdit
84	84
85	85		- New property ValidationErrorMode to allow not raising an exception when validation fails, but instead firing an OnValidationError event.
86	86		- New property EnableSets to allow specifying sets in the EditMask property.
87	87
88	88		### TGroupBox, TRadioGroup, TCheckGroup
89	89
90	90		- Old behaviour Win32: You could set property Color and it was directly displayed.
91	91		- New behaviour Win32: If you want to change the color, you have to set ParentBackground := False;
92	92		- Reason: TGroupBox and TRadioGroup are now transparent like in Delphi (Delphi does not have a TCheckGroup). See [Issue \#37151](https://bugs.freepascal.org/view.php?id=37151)
93	93
94	94		### TFrame
95	95
96	96		- Old behaviour Win32: You couldn't change the color of TFrame.
97	97		- New behaviour Win32: If you want to change the color, you have to set ParentBackground := False;
98	98		- Reason: Default TFrame is transparent, but you can change the color if you want. See [Issue \#35229](https://bugs.freepascal.org/view.php?id=35229)
99	99
100	100		### T(Float)SpinEdit
101	101
102	102		- New property EditorEnabled to disable direct user input in the edit. If set to False, users can only change the value by using the spinners or the arrowkeys.
103	103
104	104		### TListBox
105	105
106	106		- Old: ScrollWidth always was received from OS.
107	107		- New: If ScrollWidth is set, this value is taken. If default 0 is set, at runtime the ScrollWidth is received from OS.
108	108		- Reason: Enabling of ScrollBar. See [Issue \#19079](https://bugs.freepascal.org/view.php?id=19079)
109	109
110	110		## IDE Changes
111	111
112	112		- Added IDE macro \$(OutputFile) for the outputfile of the project. This usually corresponds to \$(TargetFile), except when having a host application, in which case \$(TargetFile) is the host application, while \$(OutputFile) is the project executable (or library).
113	113		- Codetools support for anonymous functions
114	114		- "Close tabs to the right" in Source-Notebook
115	115		- Buttons for closing pages on the left, right and others in Search Results window
116	116		- An options page "Environment \> IDE Startup" in the IDE Options dialog. Allows selecting a project type to be created when the IDE starts.
117	117		- Object Inspector
118	118		- Keep Expanded/Collapsed states in the component tree after adding or deleting a component or changing Z-order.
119	119		- Remember Expanded/Collapsed states in the component tree when switching between designer forms.
120	120		- Editor window for collections, like Fields, Columns, Params etc. shows now collections of same type when switching between controls of same class.
121	121
122	122		- Project Inspector
123	123		- GUI for Min / Max version of a package requirement, similar what the Package Editor has.
124	124		- Editor
125	125		- Added commands (key-shortcut) for
126	126		- Swap line/selection up/down (selection is extended to full lines)
127	127		- Duplicate line/selection (selection is extended to full lines)
128	128		- Copy/Cut append to clipboard (with space separator, unless already present)
129	129		- Copy/Cut (append) line/selection to clipboard (selection is extended to full lines, and also always includes line with caret)
130	130		- Option to prevent Select-All/Paragraph/ToBrace from scrolling
131	131		- Identifier Completion to trigger on any input, not just on dot. (Optional, must be enabled first)
132	132
133	133		- Extension of master PO files (a.k.a. templates) is changed from .po to .pot.
134	134		- Example for IDE translation:
135	135
136	136
137	137
138	138		Previously we had:
139	139
140	140
141	141
142	142		Template: lazaruside.po
143	143
144	144		German: lazaruside.de.po
145	145
146	146		Russian: lazaruside.ru.po
147	147
148	148		Spanish: lazaruside.es.po
149	149
150	150
151	151
152	152		Now we have (note extension of the template):
153	153
154	154
155	155
156	156		Template: lazaruside.pot
157	157
158	158		German: lazaruside.de.po
159	159
160	160		Russian: lazaruside.ru.po
161	161
162	162		Spanish: lazaruside.es.po
163	163
164	164		:* Reasons:
165	165
166	166		:** .pot is an 'industry standard' extension for PO template files. As a consequence, PO editors can now open our templates 'out of the box' and automate creation of translations.
167	167
168	168		:** It is much simpler to detect template files now that dotted unit names are allowed.
169	169
170	170		:* Remedy: You can safely remove .po template files from your project after you rebuild your project with the new IDE (at this point .pot files should be generated).
171	171
172	172		- Project Groups:
173	173		- Option frame under Tools / Options
174	174		- Load last open project group on start (option to disable)
175	175		- More / Undo menu item to undo a delete
176	176		- More / Info menu item to show some stats. At the moment it shows all source directories.
177	177		- Find in Files has a new option "Search in project group".
178	178		- Option to redirect the IDE command Compile/Build project to Compile/Build the selected target in the project group editor. For example Ctrl-F9 can compile the whole project group.
179	179		- Designer
180	180		- Change background color of non form designer to clWindow. Color is now changeable per option.
181	181		- Remove environment option "Reduced designer painting" to prevent painting artefacts. See [Issue \#23741](https://bugs.freepascal.org/view.php?id=23741) or [Issue \#33781](https://bugs.freepascal.org/view.php?id=33781)
182	182		- Package Manager
183	183		- When creating new package or component, suggested name is not localized anymore (always 'NewPackage' for every language). This change prevents crashes on attempt to create a new package when IDE interface language has non-latin alphabet.
184	184
185	185		- macOS: relocation of the Lazarus IDE "Lazarus \> Tools \> Options" menu to "Lazarus \> Preferences".
186	186
187	187		#### Debugger
188	188
189	189		- LazDebugger-FP (FpDebug) v1.0 is now the default for new installations on Windows and Linux. Users with existing config should change their settings.
190	190		- GDB(mi): comes now with gdb version 9.2 modified for use with unicode. (for 32 and 64 bit)
191	191
192	192		:* GDB(mi) Debugger: Stepping from exception to finally/except now works under Win64 SEH. (Requires updated GDB)
193	193
194	194		:* GDB(mi) Debugger: Updated GDB for Win64 to 8.2
195	195
196	196		:* GDB(mi) Applying a condition to a breakpoint will now mark the breakpoint as invalid, if gdb does not accept the condition. The breakpoint may still break (or not), but the condition was not set.
197	197
198	198		:* Debugger Config: The IDE now provides the ability to set up different debugger-configs as named profiles.
199	199
200	200		:* "Run to Cursor" in addition to the existing "Step over to Cursor", the debugger (gdbmi/fpdebug) now provide "Run to Cursor".
201	201
202	202		## Components
203	203
204	204		- OpenGL: full support for Qt5 widgetset
205	205
206	206		### AnchorDocking
207	207
208	208		- New button to minimize a docked site.
209	209		- Allow ManualDock for target AnchorDockPanel.
210	210		- New option "Multiline Tabs" for docked pages added.
211	211		- New option "Floating windows on top" added. If there are undocked windows shown, show these on top of main window. In a own application, there can be set DockMaster.MainDockForm, then all floating windows are shown on top of it. If MainDockForm is not set, Application.MainForm is used.
212	212		- AnchorDocking can load layouts HighDPI aware
213	213
214	214		### Spotter
215	215
216	216		- New IDE addon, showing a search list of all IDE commands.
217	217
218	218		### TAChart
219	219
220	220		- New chart tools "TAxisClickTool", "TTitleFootClickTool" and "TLegendClickTool": Create OnClick events when the user clicks on a chart axis or its title, the chart title or footer, or the chart legend, respectively. Good for creating an interactive GUI for formatting charts.
221	221		- New property "AllowPanning" to turn built-in panning on/off.
222	222		- New property "LimitToExtent" for zooming tools, avoids zooming out of the chart's full extent.
223	223		- New property "Wordwrap" for chart axis titles as well as chart title and footer.
224	224		- New series type "TPolygonSeries" which draws a filled closed polygon. Can be the basis of GIS and contour plots.
225	225		- Property editor for TSeriesPointerStyle.
226	226		- TBarSeries:
227	227		- New property "BarShape" for drawing alternative shapes (cylinder, hexagonal prism, pyramid or cone) instead of rectangular bar.
228	228		- TPieSeries:
229	229		- Impoved painting of 3D pie series due to new properties: "DepthBrightnessDelta" allowing to darken or brighten the sides of the pie slices, "Orientation" and "ViewAngle" for different views of the series
230	230		- New property "InnerRadiusPercent" allowing to draw a chart (donut).
231	231		- New property "MarkPositionCentered" for attaching data point labels to the pie center instead of the pie perimeter.
232	232		- New property "StartAngle" to define the position of the first pie slice.
233	233		- New property "AngleRange" to define tha total angular range between first and last slice.
234	234		- TListChartSource can be sorted by X, Y, XList, YList, Color, Text, or in a user-specific way defined by the event OnCompare.
235	235		- New "TSortedChartSource" which, if inserted between original chart source and series, allows sorting of TUserDefinedChartSource or TCalculatedChartSource by the same criteria as TListChartSource.
236	236		- New property "AdjustSides" of TChartExtentLink allowing to automatically align the sides of aligned charts to each other (in case of differently sized axis labels and/or titles).
237	237		- New component "TChartLiveView" which represents a scrolling viewport for a large amount of data arriving by and by.
238	238
239	239		### TSpinEditEx
240	240
241	241		- New property "ThousandSeparator" to allow displaying the value with thousandseparators inserted.
242	242
243	243		### TFloatSpinEditEx
244	244
245	245		- Entering text in scientific notation (e.g. "1.23E3") is now supported.
246	246		- New property DisplayMode that controls in wether or not to use scientific notation. If set to dmAuto the following new properties control how the value is displayed:
247	247		- Property ExponentialFormatLimitPos controls from which positive exponent on scientific notation is used for displaying.
248	248		- Property ExponentialFormatLimitNeg controls from which negative exponent on scientific notation is used for displaying.
249	249		- New property Precision controls the precion used when value is displayed in scientific notation.
250	250
251	251		### DockedFormEditor
252	252
253	253		- New package DockedFormEditor added. For more info see [[DockedFormEditor]].
254	254		- Replacement for Sparta_DockedFormEditor. All Sparta packages are now marked as deprecated and will be removed in a future Lazarus version.
255	255		- Optional Anchor Designer included.
256	256
257	257		### Jedi Code Format
258	258
259	259		- Various improvement for the parser. It now supports most modern Object Pascal syntax.
260	260
261	261		### Delphi Compiler Tool
262	262
263	263		Use the Delphi command line compiler in Lazarus: [[Lazarus Delphi Compiler Tool]]
264	264
265	265		## Changes affecting compatibility
266	266
267	267		### LazUtils
268	268
269	269		#### PO files
270	270
271	271		- Trailing lineendings are not forcibly added to multiline strings in PO files anymore. Now multiline strings in PO files match exactly corresponding resource strings.
272	272
273	273		:* Reasons:
274	274
275	275		:** PO format does not prohibit multiline strings without trailing lineendings (and e.g. recent versions of Poedit do not complain about them).
276	276
277	277		:** New behavior unbreaks loading multiline translations from MO files.
278	278
279	279		:* Note that all multiline strings with mismatching trailing lineendings will be marked as fuzzy during translation update.
280	280
281	281		#### LConvEncoding
282	282
283	283		##### Global variable ConvertEncodingErrorRaisesException replaced with ConvertEncodingErrorMode
284	284
285	285		The unit had global variable ConvertEncodingErrorRaisesException (boolean) which is now replaced by the enumeration:
286	286
287	287		``` pascal
288	288		type
289	289		TConvertEncodingErrorMode = (
290	290		ceemSkip,
291	291		ceemException,
292	292		ceemReplace,
293	293		ceemReturnEmpty
294	294		);
295	295		var
296	296		ConvertEncodingErrorMode: TConvertEncodingErrorMode = ceemSkip;
297	297		```
298	298
299	299		#### UITypes unit is deprecated
300	300
301	301		The UITypes unit is deprecated in favor of System.UITypes, which is available in FPC 3.2.0 and up.
302	302
303	303		- Reason: System.UITypes is a superset of UITypes and contains some additional constants (Delphi-compatible).
304	304		- Remedy: Use System.UITypes unit instead of UITypes unit in your programs.
305	305
306	306		### LCL incompatibilities
307	307
308	308		#### TMaskEdit: hexadecimal and binary characters
309	309
310	310		Mask support for hexadecimal and binary characters was added (this is a Lazarus extension, Delphi does not support this).
311	311
312	312		- Old behavior: the characters 'h', 'H', 'b' and 'B' had no special meaning in the EditMask property.
313	313		- New behavior: these characters now are mask characters for hexadecimal and binary input respectively.
314	314		- Reason: nice to have feature (QT5 supports it natively).
315	315		- Remedy: if you need one of these characters as a literal in your EditMask: escape them with a '\\'.
316	316
317	317		#### TMaskEdit: 'C' in EditMask now actually means a character (other than blank) is needed
318	318
319	319		- Old behaviour: both 'c' and 'C' in EditMaks were treated as "any Utf8 char but not necessary".
320	320		- New behaviour: 'C' is now treated as "any Utf8 char, but NOT SpaceChar".
321	321		- Reason: Delphi compatibility.
322	322		- Remedy: use 'c', not 'C', if any character (including SpaceChar) should be accepted.
323	323
324	324		#### TMaskEdit: Validate takes in account Upper- and LowerCase for 'c' and 'C' in EditMask
325	325
326	326		- Old behavior: upper- or lowercase was checked (if so specified by '\>' or '\<' in EditMask) for 'a', 'A', 'l', 'L', 'h' and 'H', but not for 'c' and 'C'.
327	327		- New behaviour: upper- or lowercase is now also checked for 'c' and 'C'.
328	328		- Reason: consistency.
329	329		- Remedy: if you need the old behaviour, insert '\<\>' before 'c' or 'C'.
330	330
331	331		#### TCanvas.PolyBezier default behavior
332	332
333	333		The default value of the Continuous parameter was changed because it breaks Delphi compatibility.
334	334
335	335		- Old behavior: There are several overloads and optional parameters of the canvas' `PolyBezier` method. In the Delphi-compatible call having only the points array as a parameter, the `Continuous` argument has the default value `false`.
336	336		- New behavior: The argument `Continuous` has the value `true` now.
337	337		- Reason: The Delphi `PolyBezier` behavior is different from the Lazarus behaviour with the same call parameters; it draws the Bezier curve like Lazarus using `Continuous = true`.
338	338		- Remedy: To obtain the old behavior expand the parameter list by the `Continuous` parameter set to `false`.
339	339
340	340		#### TImageList stores compressed images in LFM
341	341
342	342		- Old: TCustomImageList stored binary bitmap data of the base resolution.
343	343		- New: The binary bitmap data streamed to LFM is compressed with ZLib.
344	344		- Reason: smaller LFM and EXE files.
345	345		- Effects: Lazarus 1.8 cannot open LFMs with a TImageList from Lazarus 2.2. Lazarus 2.0 can open them.
346	346		- Remedy: If you want to open a Lazarus 2.2 project in Lazarus 1.8, you first have to open it in Lazarus 2.0, open all forms containing LFMs with a TImageList and resave them. Then you can open these resaved LFMs in Lazarus 1.8.
347	347
348	348		#### TCalendar: option dsStartMonday of DisplaySettings replaced by Delphi-compatible FirstDayOfWeek property
349	349
350	350		- Old behavior: Changing the start day of a week to Monday works only in QT and QT5 widgetsets. And even there it does not allow for other weekdays like Saturday as needed for the Arabian world. Moveover the option is not compatible with Delphi which uses a separate property FirstDayOfWeek.
351	351		- New behavior: The option dsStartMonday has been removed, use the property FirstDayOfWeek instead. It allows switching to other weekdays as well. The default option, dowDefault, makes the weeks begin with the day defined by the widgetset/OS - which is the old behavior in those cases where dsStartMonday did not work.
352	352		- Reason: Improved Delphi compatibility, more than two weekdays should be allowed as start of the week.
353	353		- Remdy: In most cases dsStartMonday probaby has not been set because it did not work. If it was set, ignore the property when reading (or remove the line dsStartMondy = true from the lfm file), and set FirstDayOfWeek to dowMonday in the Object Inspector.
354	354		- Note 1: The FirstDayOfWeek property is still not supported by all widgetsets. It is respected only for win32, qt and qt5.
355	355		- Note 2: The name of the default option of FirstDayOfWeek, dowDefault, is not exactly Delphi-compliant (dowLocaleDefault) because a "Locale" does not exist in all widgetsets. Since the default value is not stored anyway this incompatibility may be tolerable.
356	356
357	357		#### TRadioGroup's OnEnter and OnExit events
358	358
359	359		- Old behavior: The OnEnter and OnExit events are triggered by TRadioGroup when another item is selected. As a consequence, these events fire twice when the control receives or loses focus. This is against Delphi behavior.
360	360		- New behavior: New events OnItemEnter and OnItemExit were added; they fire when the ItemIndex changes and carry the corresponding radiobutton in the Sender parameter.
361	361		- Reason: No logical behavior; Delphi compatibility.
362	362		- Remedy: Ony applications evaluating these events for the internal selection change are affected. The new events OnItemEnter and OnItemExit should be used instead.
363	363
364	364		#### ShortcutToText / TextToShortcut
365	365
366	366		- Old behaviour:
367	367		- the textual representation of the VK_OEM_PLUS was '+'.
368	368		- the result of TextToShortcut('+') was 187.
369	369		- the result of TextToShortcut('=') was 0.
370	370		- New behaviour:
371	371		- the textual representation of the VK_OEM_PLUS now is '='.
372	372		- the result of TextToShortcut('+') is now 0.
373	373		- the result of TextToShortcut('=') is now 187.
374	374		- Reason: Delphi compatibility.
375	375		- Remedy: change any shortcuts with value '+' to '='
376	376
377	377		#### TTabControl / x,y in mouse-events (move,down,up,drag) and IndexOfTabAt
378	378
379	379		- Old behaviour
380	380		- When the mouse was over the tab, the x/y params to any mouse event where given relative to the embedded PageControl.
381	381
382	382
383	383		For the remaining ClientArea x/y were relative to the TabControl
384	384
385	385		I.e. X/Y over the tabs where: Negative values for tabs on top / 0..20 for tabs on bottom
386	386
387	387		This meant that the same x/y in a TabControl could be received for the mouse over a header (tabs at bottom) and the mouse in the client area. (Y=0 to Y=approx-20 did exist twice)
388	388
389	389		- IndexOfTabAt did expect the x/y as given in the event. ScreenToClient(Mouse.CursorPos) could not be used, as it always returned x/y relative to the TabControl, and never relative to the embedded PageControl
390	390		- New behaviour
391	391		- All X/Y are reported relative to the TabControl. There are no longer any negative values for Y.
392	392		- IndexOfTabAt expects coordinates relative to the TabControl
393	393		- Reason:
394	394		- This fixes ambiguity for X/Y value that could occur twice
395	395		- IndexOfTabAt can now accept the event-X/Y as well as the ScreenToClient(Mouse.CursorPos)
396	396		- Remedy:
397	397		- If you called IndexOfTabAt with the event X/Y =\> all keeps working
398	398		- If you did any amendments to any X/Y (other than calling ClientToScreen), that is if you added/subtracted some constant to "make them work" =\> remove your workaround
399	399		- See also
400	400		- <https://bugs.freepascal.org/view.php?id=38403>
401	401		- Cocoa: <https://bugs.freepascal.org/view.php?id=38553>
402	402
403	403		#### Conversion of '\n' sequences in LCLTaskDialog.TTaskDialog
404	404
405	405		- Old behaviour:
406	406		- '\n' sequence was converted to linefeed in the following fields: Title, Inst, Content, Verify, Info, InfoExpanded, InfoCollapse, Footer.
407	407		- New behaviour:
408	408		- '\n' sequence is no longer converted to linefeed in these fields.
409	409		- Reason: Conversion of '\n' to linefeed mangled strings like
410	410		``` pascal
411	411		'Save "c:\new_folder\new.work"?'
412	412		```
413	413		- Remedy: replace '\n' sequences which should be converted to linefeeds with LineEnding constants, i.e. instead of
414	414
415	415		'Line1\nLine2'
416	416
417		-	~~</syntaxhighlight>~~
418		-
419	417		use
420	418
421	419		``` pascal
422	420		'Line1'+LineEnding+'Line2'
423	421		```
424	422
425	423		- See also <https://bugs.freepascal.org/view.php?id=38676>
426	424
427	425		#### TScrollingWinControl.ScrollInView and successors (e.g. TScrollBox, TForm)
428	426
429	427		- Old behavior: Scrolling of a control in view was possible without ScrollBars visible.
430	428		- New behavior: Scrolling of a control in view is only possible when ScrollBar is visible.
431	429		- Reason: A scrolling feature is only with ScrollBars usefull. Also some controls are painted wrong, when no scrollbar is visible.
432	430		- See also
433	431		- <https://bugs.freepascal.org/view.php?id=38838>
434	432		- <https://forum.lazarus.freepascal.org/index.php/topic,54354>
435	433
436	434		#### TColorDialog.Title
437	435
438	436		- Old behavior: On Windows, the Title of the TColorDialog was ignored and painted by the OS as the localized text "Color".
439	437		- New behavior: Now the Title property of the TColorDialog is used like in other widgetsets. The default title is the unlocalized text "Select color" which can be considered to be inconsistent in localized applications.
440	438		- Reason: An unused property is always confusing to the users.
441	439		- Remedy: Enter the Title manually when an application requires the localized native title, or use the translation utilities to translate the LCL resource strings.
442	440
443	441		#### GTK2 widgetset version requirement
444	442
445	443		- Old behavior: At least GTK2 2.8 was required.
446	444		- New behavior: At least GTK2 2.24 is required.
447	445		- Reason: All supported distribution versions already have GTK2 2.24.
448	446		- Remedy: GTK2 2.22 may still work (untested). Older GTK2 (2.20 and earlier) versions may still work (untested, so completely at your own risk) after reverting commit 0172124a423be.
449	447
450	448		### Components incompatibilities
451	449
452	450		#### TAChart
453	451
454	452		##### Chart.AllowZoom changed
455	453
456	454		The property AllowZoom of TChart is meant to give the user the chance to turn the builtin zooming feature on or off.
457	455
458	456		- Old behavior: AllowZoom operates also on an external toolset.
459	457		- New behavior: AllowZoom is effective only for the built-in toolset.
460	458		- Reason: More consistent handling of properties
461	459		- Remedy: Use the property Enabled of the external zoom tool to switch zooming off, or don't add a zoom tool at all.
462	460
463	461		##### DataPointDrawTool.OnDraw event deprecated
464	462
465	463		The event OnDraw of the data point draw tools (TDataPointCrosshairTool, TDataPointDistanceTool) will be removed and replaced by the new event OnCustomDraw.
466	464
467	465		- Old behavior: OnDraw uses the chart's Drawer for painting the crosshair or distance bars.
468	466		- New behavior: the Drawer to be used is passed as a parameter.
469	467		- Reason: When a chart is painted to an external file the chart's Drawer still refers to the screen; therefore, the datapoint cross hair or distance bars are missing in the external file.
470	468		- Remedy: Copy the old OnDraw event handler code to the new OnCustomDraw handler, but replace "Chart.Drawer" by the "ADrawer" given as a event parameter.
471	469
472	470		##### TChartAxis.OnMarkToText event deprecated
473	471
474	472		The event OnMarkToText of the chart's axes will be removed and replaced by the new event OnGetMarkText.
475	473
476	474		- Old behavior: The old OnMarkToText event does not have a Sender parameter.
477	475		- New behavior: The new OnGetMarkText event has the affected axis as Sender parameter.
478	476		- Reason: When dealing with multiple charts and/or multiple axes, it is currently required to create an individual handler for each axis because it is not possible to determine the axis for which to create axis marks for. This is not required any more with the new event.
479	477		- Remedy: Copy the old OnMarkToText handler code to the new OnGetMarkText handler.
480	478
481	479		##### OpenGL-related units moved to separate packge TAChartOpenGL
482	480
483	481		- Old behavior: OpenGL-related units had been available in the main TAChartLazarusPackage directly. The drawer unit TADrawerOpenGL was not added to the uses list automatically and required a special treatment (see old OpenGL demo project).
484	482		- New behavior: OpenGL-related units are now contained in the new package TAChartOpenGL.
485	483		- Reason: Compilation issues when the system did not contain OpenGL libraries.
486	484		- Remedy: Add package TAChartOpenGL to the requirements of the project. Only needed when project uses the OpenGL drawer.
487	485
488	486		##### Chart colors changed
489	487
490	488		- Old behavior and reason: Some chart elements had hard-coded rgb colors, such as Chart.Title.Font.Color = clBlue, or ChartAxis.TickColor = clBlack. Therefore, these elements could hardly be discerned when the system runs in "dark mode".
491	489		- New behaviour: Such critical colors are system colors now which have a decent appearance in both dark and bright mode
492	490		- Remedy: If the old colors are really needed reset them in the object inspector.
493	491
494	492		#### VirtualTreeViews: Renamed to "laz." prefix
495	493
496	494		VirtualTreeViews is essentially needed by OnlinePackageManager. Having this original package within the Lazarus installation makes is impossible for users to install a different version of this package.
497	495
498	496		- Old behavior: Projects with VirtualTreeViews required the "virtualtreeview_package" and had the unit "virtualtrees" in the uses clause. The registered component classes were named "TVirtualStringTree", "TVirtualDrawTree", "TVTHeaderPopup".
499	497		- New behavior: The package was renamed to "laz.virtualtreeview_package". All file names were changed to have a "laz." prefix, i.e. the uses clause will have to contain "laz.virtualtrees". The registered components are named "TLazVirtualStringTree", "TLazVirtualDrawTree", and "TLazVTHeaderPopup".
500	498		- Reason: Avoid naming conflicts when another version of VirtualTreeViews is installed
501	499		- Remedy: For existing projects requiring the VirtualTreeViews distributed with Lazarus,
502	500		- open the lfm file in an external editor and replace "TVirtualStringTree" by "TLazVirtualStringTree", as well as - if available - "TVirtualDrawTree" by "TLazVirtualDrawTree" and "TVTHeaderPopup" by "TLazVTHeaderPopup".
503	501		- open the project in the IDE, remove package "VirtualTreeView_package" from the project requirements and replace it by "laz.virtualtreeview_package"
504	502		- in the pas file's "uses" clause, replace "virtualtrees" by "laz.virtualtrees"
505	503		- in the pas file replace "TVirtualStringTree" by "TLazVirtualStringTree" (and accordingly for the other VTV components).
506	504
507	505		#### SynEdit
508	506
509	507		SynEdits TextView system has undergone some changes. TextViews (TSynEditStrings) map the physical text (as saved/loaded to/from a file) to what is visible on the screen.
510	508
511	509		This also affects the coordinate system. In addition to [Logical/Physical](https://wiki.lazarus.freepascal.org/SynEdit#Logical.2FPhysical_caret_position) SynEdit now also has ViewedXY. "Viewed" also maps the Y coordinate.
512	510
513	511		##### SynEdit.TextView / TSynEditFoldedView
514	512
515	513		The protected property SynEdit.TextView is no longer of type TSynEditFoldedView. It may hold any other TextView-class instead.
516	514
517	515		- Old behaviour: TSynEditFoldedView was accessible via SynEdit.TextView
518	516		- New behaviour: SynEdit.TextView can be any TextView
519	517		- Remedy: SynEdit.TextViewsManager.SynTextViewByClass\[TSynEditFoldedView\]
520	518
521	519		Class hierarchy
522	520
523	521		- TSynEditFoldedView is now a TSynEditStrings.
524	522
525	523		TSynEditFoldedView.Lines/Count
526	524
527	525		- Old behaviour: Lines/Count referred to visible lines only
528	526		- New behaviour: Lines/Count referred to al lines.
529	527		- Remedy: Use ViewedLines / ViewedCount
530	528
531	529		Mapping
532	530
533	531		- Old behaviour: TextToViewIndex/ViewToTextIndex =\> ViewPos was 1 based
534	532		- New behaviour: TextToViewIndex/ViewToTextIndex =\> ViewPos was 0 based
535	533		- Remedy: Use ToPos() / ToIdx()
536	534
537	535		- Old behaviour: TextPosAddLines with 1 based lines/result
538	536		- New behaviour: AddVisibleOffsetToTextIndex with 0 base lines/result
539	537		- Remedy: Rename and use ToPos() / ToIdx()
540	538
541	539		Callbacks
542	540
543	541		- Old behaviour: AddFoldChangedHandler was reporting changes to folding.
544	542		- New behaviour: AddChangeHandler(senrLineMappingChanged)
545	543
546	544		##### senrTextBufferChanging / senrTextBufferChanged
547	545
548	546		Callbacks on the TextView/TextBuffer were only valid for the current Buffer. If SynEdit shared/unshared the textbuffer, then all handlers needed to be re-registered.
549	547
550	548		This is no longer needed.
551	549
552	550		===== ScreenRowToRow/RowToScreenRow =\> ScreenXYToTextXY/TextXYToScreenXY =====
553	551
554	552		ScreenRowToRow/RowToScreenRow were deprecated, use ScreenXYToTextXY/TextXYToScreenXY
555	553
556	554		The new functions take a point, instead of just a line/row. This reflects the idea that a single text-line can visible occupy several lines. Or mapping can otherwise relay on the x pos, depending on whatever TextViews are used.
557	555
558	556		===== RowColumnToPixels =\> ScreenXYToPixels =====
559	557
560	558		RowColumnToPixels is deprecated, use ScreenXYToPixels
561	559
562	560		##### SynEditExport
563	561
564	562		- Old behaviour: TSynCustomExporter.ExportRange raised an EAbort exception when ALines or Highlighter is unassigned, or when the content of the range to be exported was in fact empty.
565	563		- New behaviour:
566	564		- A verbose exception (ESynExport) is raised when either ALines or Highlighter are unassigned.
567	565		- No exception is raised if the range to be exported is empty, it will simply export nothing in that case.
568	566		- Reason:
569	567		- Raising EAbort if the range to be expoterd is empty doesn't really make sense, at least it should not be forbidden.
570	568		- Not having a Highlighter or not having Lines is a critical error, and as such must raise a verbose exception.
571	569		- Remedy: if your code relied on this behaviour (rasing EAbort), you will have to adjust it.
572	570
573	571		#### T(Float)SpinEditEx.ReadOnly now also disables the use of arrowkeys
574	572
575	573		- Old behaviour: if ReadOnly is True, the value of the control could still be changed using the up or down arrow keys.
576	574		- New behaviour: if ReadOnly is True, the value of the control cannot be changed using the the up or down arrow keys.
577	575		- Reason: internal consistency and consistency with T(Float)SpinEdit.
578	576		- Revision: r64952.
579	577
580	578		#### T(Float)SpinEdit(Ex) default value for MaxValue changed
581	579
582	580		- Old behaviour: the default value of MaxValue was 100
583	581		- New behaviour: the default value for MaxValue is 0. As a consequence the control is no longer "limited" by default.
584	582		- Reason: compatibility with Delphi's TSpinEdit.
585	583		- Remedy: in Object Inspector set MaxValue to 100 (if so desired) and re-save the form.
586	584		- Revision: r64969, r64972
587	585
588	586		==== T(Float)SpinEditEx MaxValue is no longer enforced to be \>= MinValue ====
589	587
590	588		- Old behaviour: if you set MaxValue to a value less than MinValue, MaxValue got the same value as MinValue.
591	589		- New behaviour: MaxValue is allowed to be less than MinValue.
592	590		- Reason: old behaviour cased bugs in loading.
593	591		- Remedy: if your code depended on the old behaviour, you'll have to adjust is.
594	592		- Note: since the control is only "limited" if MaxValue \> MinValue, it should not really make a difference.
595	593		- Revision: r65065.
596	594
597	595		#### TSpinEditExBase: call to abstract method SameValue in descendent classes (FPC 3.2.2 only)
598	596
599	597		- Old behaviour: The component used Math.SameValue to compare two values. FPC 3.2.2, however, sometimes refuses compilation because it cannot determine which one of the many overloads of Math.SameValue should be used.
600	598		- New behaviour: The component has its own method SameValue now. It had to be declared as abstract to keep compilation with FPC 3.2.0 and older. Therefore, all descendants of TSpinEditExBase must override this method.
601	599		- Remedy: If your descendent class of TSpinEditExBase reports a runtime error "abstract method called" you must implement the method SameValue for it, based on the data type specializing the generic data variable. It is needed only for FPC 3.2.2.
602	600		- Note: This issues only affects third-party components descending from TSpinEditExBase.
603	601		- Introduced by revisions <https://gitlab.com/freepascal.org/lazarus/lazarus/-/commit/182cc8b8e6d6a671eb62f7177ff86ee948814de8> and <https://gitlab.com/freepascal.org/lazarus/lazarus/-/commit/7f45938388be4b3ee50b2cd1ed1d04d991f92143>
604	602
605	603		#### TLabel: DoMeasureTextPosition removed, added DoDrawText instead
606	604
607	605		- Old behavior: TCustomLabel had the DoMeasureTextPosition virtual method that allowed to set the X/Y position of the text.
608	606		- New behavior: TCustomLabel now has the DoDrawText virtual method that allows to override the whole text painting and automatic sizing of the label.
609	607		- Reason: It is now possible to override the painting/sizing the label with own text drawing routine, which wasn't easily possible before. Now the TLabel is also Delphi-compatible.
610	608		- Remedy: if your TCustomLabel descendant used to override DoMeasureTextPosition, it needs to override DoDrawText now and handle the whole paint process.
611	609		- Note: This issue only affects third-party components descending from TCustomLabel. See more info: <https://gitlab.com/freepascal.org/lazarus/lazarus/-/issues/39523#note_798080430>
612	610
613	611		### IDE incompatibilities
614	612
615	613		#### LPI&LPS project files: XML structure changed
616	614
617	615		- Old behavior: Child elements had an index suffix.
618	616		- New behavior: Child elements have no suffix.
619	617		- Problems: New LPI files cannot be opened in legacy Lazarus installations.
620	618		- Reason: VCS like the new structure better.
621	619		- Remedy: Save your LPI files in compatibility mode. (Project options -\> Miscellaneous -\> Maximize compatibility of project files). Users of old Lazarus versions can convert the file format by means of the [[fixlp]] utility.
622	620
623	621		#### LPK package files: XML structure changed
624	622
625	623		- Old behavior: Child elements had an index suffix.
626	624		- New behavior: Child elements have no suffix.
627	625		- Problems: New LPK files cannot be opened in legacy Lazarus installations.
628	626		- Reason: VCS like the new structure better.
629	627		- Remedy: Save your LPK files in compatibility mode. (Package options -\> Usage -\> Maximize compatibility of package file). Users of old Lazarus versions can convert the file format by means of the [[fixlp]] utility.
630	628
631	629		### Packages incompatibilities
632	630
633	631		#### ProjectGroups: LPG XML structure changed
634	632
635	633		- Old behavior: The \<Mode?\> elements were not placed within the \<BuildModes\> element. Child elements had an index suffix.
636	634		- New behavior: Child elements have no suffix.
637	635		- Problems: New LPG files cannot be opened in legacy Lazarus installations.
638	636		- Reason: VCS like the new structure better.
639	637		- Remedy: There is no.
640	638
641	639		## Other release notes
642	640
643	641		---
644	642		From the Free Pascal wiki, page "Lazarus 2.2.0 release notes", as it stood on 2024-03-17 after a change by Wp, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).
645	643		Category: Lazarus
646	644		Category: Release Notes

Back to history