Debian Codegraph @

docs/reference/api-breaks.xml

raw
1 <?xml version="1.0"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
3 "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
4 [
5 <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
6 <!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
7 %gtkdocentities;
8 ]>
9
10 <part id="api-breaks">
11 <title>API Breaks</title>
12
13 <chapter id="api-breaks-1-to-2">
14 <title>Gtef 1 -> Gtef 2</title>
15
16 <itemizedlist>
17 <listitem>
18 <para>
19 The <code>GtefBuffer::cursor-moved</code> signal has been renamed to
20 <code>GtefBuffer::gtef-cursor-moved</code>.
21 </para>
22 </listitem>
23 <listitem>
24 <para>
25 The <code>GtefBuffer:title</code> property has been renamed to
26 <code>GtefBuffer:gtef-title</code>.
27 </para>
28 </listitem>
29 </itemizedlist>
30 </chapter>
31
32 <chapter id="api-breaks-2-to-3-tepl">
33 <title>Gtef 2 -> Tepl 3</title>
34
35 <itemizedlist>
36 <listitem>
37 <para>
38 The library has been renamed to Tepl (Text editor product line). So
39 the namespace of the code has changed.
40 </para>
41 <para>
42 The new version is Tepl&nbsp;3 and not Tepl&nbsp;1, to avoid confusion
43 with the git tags (the git repository is still the same), since the
44 repository already contains tags for versions 1 and 2.
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 The <link linkend="TeplTab">TeplTab</link> class has been revamped.
50 The <link linkend="tepl-tab-new">tepl_tab_new()</link> function
51 doesn't take a <link linkend="GtkWidget">GtkWidget</link> parameter
52 anymore, a <link linkend="TeplView">TeplView</link> is created
53 instead.
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 The <code>TeplBuffer:tepl-title</code> property has been renamed to
59 <link linkend="TeplBuffer--tepl-full-title">TeplBuffer:tepl-full-title</link>,
60 and <code>tepl_buffer_get_title()</code> has been renamed to
61 <link linkend="tepl-buffer-get-full-title">tepl_buffer_get_full_title()</link>.
62 </para>
63 </listitem>
64 </itemizedlist>
65 </chapter>
66
67 <chapter id="api-breaks-2-to-3-amtk">
68 <title>Gtef 2 -> Amtk 3</title>
69
70 <itemizedlist>
71 <listitem>
72 <para>
73 The classes and functions related to actions and menus have been moved
74 to a new shared library called Amtk (Actions, Menus and Toolbars Kit),
75 since it was not really related to text editors, it is more general.
76 But Amtk is still developed inside the Tepl repository.
77 </para>
78 </listitem>
79 <listitem>
80 <para>
81 The <link linkend="AmtkFactory">AmtkFactory</link> class has been
82 added, which replace <code>gtef_action_info_store_create_menu_item()</code>
83 and removes the <code>GtefActionInfoStore:application</code> property.
84 </para>
85 </listitem>
86 <listitem>
87 <para>
88 <code>gtef_action_info_central_store_get_instance()</code> has been
89 renamed to
90 <link linkend="amtk-action-info-central-store-get-singleton">amtk_action_info_central_store_get_singleton()</link>.
91 </para>
92 </listitem>
93 <listitem>
94 <para>
95 <link linkend="amtk-application-window-connect-menu-to-statusbar">amtk_application_window_connect_menu_to_statusbar()</link>
96 now takes a <link linkend="GtkMenuShell">GtkMenuShell</link> parameter
97 instead of <link linkend="AmtkMenuShell">AmtkMenuShell</link>.
98 </para>
99 </listitem>
100 </itemizedlist>
101 </chapter>
102
103 <chapter id="api-breaks-3-to-4-tepl">
104 <title>Tepl 3 -> Tepl 4</title>
105
106 <itemizedlist>
107 <listitem>
108 <para>
109 Tepl&nbsp;3 depended on GtkSourceView&nbsp;3, Tepl&nbsp;4 depends on
110 GtkSourceView&nbsp;4. So to be able to use Tepl&nbsp;4, you need to
111 port your code to GtkSourceView&nbsp;4. Note that the GTK dependency
112 is still GTK&nbsp;3.
113 </para>
114 </listitem>
115 <listitem>
116 <para>
117 The <link linkend="TeplTab-close-request">TeplTab::close-request</link>
118 signal has now a default object method handler.
119 </para>
120 </listitem>
121 </itemizedlist>
122 </chapter>
123
124 <chapter id="api-breaks-4-to-5-tepl">
125 <title>Tepl 4 -> Tepl 5</title>
126
127 <itemizedlist>
128 <listitem>
129 <para>
130 The <code>TeplEncoding</code> class has been removed, as part of the
131 beginning of a complete overhaul of the file loading and saving
132 functionality.
133 </para>
134 </listitem>
135 <listitem>
136 <para>
137 Start to rework the <link linkend="TeplFile">TeplFile</link>,
138 <link linkend="TeplFileLoader">TeplFileLoader</link> and
139 <link linkend="TeplFileSaver">TeplFileSaver</link> classes. As such,
140 there are some API breaks in those classes. And as a result, they
141 currently contain less features as before, unfortunately.
142 </para>
143 </listitem>
144 <listitem>
145 <para>
146 The <link linkend="TeplMetadataManager">TeplMetadataManager</link> API
147 has been re-worked.
148 </para>
149 </listitem>
150 <listitem>
151 <para>
152 The <code>TeplFileMetadata</code> class has been replaced by
153 <link linkend="TeplMetadata">TeplMetadata</link>, the latter no longer
154 depends on <link linkend="TeplFile">TeplFile</link>.
155 </para>
156 </listitem>
157 <listitem>
158 <para>
159 The <code>tepl_file_get_file_metadata()</code> function has been
160 removed.
161 </para>
162 </listitem>
163 <listitem>
164 <para>
165 The <link linkend="tepl-tab-load-file">tepl_tab_load_file()</link>
166 function no longer loads the file metadata (but it was anyway an
167 implementation detail).
168 </para>
169 </listitem>
170 <listitem>
171 <para>
172 The <code>TeplAbstractFactoryVala</code> class has been removed,
173 because it's possible to manually manage GObject references in Vala.
174 </para>
175 </listitem>
176 </itemizedlist>
177 </chapter>
178
179 <chapter id="api-breaks-5-to-6-tepl">
180 <title>Tepl 5 -> Tepl 6</title>
181
182 <itemizedlist>
183 <listitem>
184 <para>
185 The <link linkend="tepl-info-bar-set-buttons-orientation">tepl_info_bar_set_buttons_orientation()</link>
186 now takes a <link linkend="GtkInfoBar">GtkInfoBar</link> parameter,
187 not a <link linkend="TeplInfoBar">TeplInfoBar</link>.
188 </para>
189 </listitem>
190 <listitem>
191 <para>
192 The <code>tepl_info_bar_add_close_button()</code> function has been
193 renamed to
194 <link linkend="tepl-info-bar-setup-close-button">tepl_info_bar_setup_close_button()</link>.
195 </para>
196 </listitem>
197 <listitem>
198 <para>
199 The <code>tepl_info_bar_add_icon()</code> function has been replaced by
200 <link linkend="tepl-info-bar-set-icon-from-message-type">tepl_info_bar_set_icon_from_message_type()</link>.
201 </para>
202 </listitem>
203 <listitem>
204 <para>
205 A <code>location</code> parameter has been added to the
206 <link linkend="tepl-info-bar-add-content-widget">tepl_info_bar_add_content_widget()</link>
207 function.
208 </para>
209 </listitem>
210 </itemizedlist>
211 </chapter>
212
213 <chapter id="api-breaks-during-tepl-6">
214 <title>API breaks during Tepl 6</title>
215
216 <para>
217 There are also ABI breaks not affecting the API, so just re-compiling the
218 program is sufficient in that case.
219 </para>
220
221 <para>
222 Tepl 6.0 to Tepl 6.2:
223 </para>
224 <itemizedlist>
225 <listitem>
226 <para>
227 The <code>tepl_utils_override_font()</code> function has been renamed
228 to <link linkend="tepl-utils-override-font-string">tepl_utils_override_font_string()</link>.
229 </para>
230 </listitem>
231 </itemizedlist>
232
233 <para>
234 Tepl 6.2 to Tepl 6.4:
235 </para>
236 <itemizedlist>
237 <listitem>
238 <para>
239 The <code>tepl_statusbar_*()</code> functions have been removed, you
240 can use
241 <link linkend="TeplLineColumnIndicator">TeplLineColumnIndicator</link>
242 instead.
243 </para>
244 </listitem>
245 </itemizedlist>
246
247 <para>
248 Tepl 6.4 to Tepl 6.6:
249 </para>
250 <itemizedlist>
251 <listitem>
252 <para>
253 Tepl now depends on libgedit-gtksourceview instead of GtkSourceView.
254 </para>
255 </listitem>
256 <listitem>
257 <para>
258 The <code>TeplWidgetListItem</code> and
259 <code>TeplWidgetListCategory</code> classes have been removed.
260 </para>
261 </listitem>
262 </itemizedlist>
263
264 <para>
265 Tepl 6.6 to Tepl 6.8:
266 </para>
267 <itemizedlist>
268 <listitem>
269 <para>
270 The <code>TeplPanel</code> class has been renamed to
271 <link linkend="TeplPanel1">TeplPanel1</link>.
272 </para>
273 </listitem>
274 <listitem>
275 <para>
276 The <code>TeplStack</code>, <code>TeplStackItem</code> and
277 <code>TeplStackSwitcherMenu</code> classes have been removed. They are
278 superseded by <link linkend="TeplPanel">TeplPanel</link> (and related
279 classes and interfaces).
280 </para>
281 </listitem>
282 <listitem>
283 <para>
284 The <code>TeplStatusbar</code> class has been removed, and is replaced
285 by <link linkend="tepl-utils-setup-statusbar">tepl_utils_setup_statusbar()</link>.
286 </para>
287 </listitem>
288 </itemizedlist>
289
290 <para>
291 Tepl 6.8 to libgedit-tepl 6.10:
292 </para>
293 <itemizedlist>
294 <listitem>
295 <para>
296 Tepl has been renamed to libgedit-tepl. The new pkg-config name is:
297 <code>libgedit-tepl-6</code>
298 </para>
299 </listitem>
300 <listitem>
301 <para>
302 <link linkend="TeplFile">TeplFile</link> now uses
303 <link linkend="GflsUnsavedDocumentTitles">GflsUnsavedDocumentTitles</link>.
304 This affects the
305 <link linkend="TeplFile--short-name">TeplFile:short-name</link>
306 property. Also, <code>tepl_file_set_untitled_file_callback()</code>
307 and <code>TeplUntitledFileCallback</code> have been removed.
308 </para>
309 </listitem>
310 </itemizedlist>
311
312 <para>
313 libgedit-tepl 6.10 to 6.11:
314 </para>
315 <itemizedlist>
316 <listitem>
317 <para>
318 The <code>TeplSettingsSimpleThemeVariant</code> enum,
319 <code>tepl_settings_handle_simple_theme_variant()</code> and
320 <code>tepl_prefs_create_simple_theme_variant_combo_box()</code> have
321 been removed. You can use instead the more complete
322 <link linkend="TeplSettingsThemeVariant">TeplSettingsThemeVariant</link>
323 enum and the functions that use it.
324 </para>
325 </listitem>
326 <listitem>
327 <para>
328 <code>tepl_buffer_provide_style_scheme_id_gsetting()</code> has been
329 removed. Use <link linkend="TeplSettings">TeplSettings</link> instead
330 to provide two GSettings keys instead of one.
331 </para>
332 <para>
333 The <code>TeplBuffer:tepl-style-scheme-id</code> property,
334 <code>tepl_buffer_get_style_scheme_id()</code> and
335 <code>tepl_buffer_set_style_scheme_id()</code> have been removed.
336 You can use
337 <link linkend="tepl-buffer-connect-style-scheme-settings">tepl_buffer_connect_style_scheme_settings()</link>
338 instead.
339 </para>
340 </listitem>
341 <listitem>
342 <para>
343 <code>tepl_prefs_create_color_scheme_component()</code> and the
344 <code>TeplStyleSchemeChooserWidget</code> class have been removed.
345 They are replaced by
346 <link linkend="TeplStyleSchemeChooserSimple">TeplStyleSchemeChooserSimple</link> and
347 <link linkend="TeplStyleSchemeChooserFull">TeplStyleSchemeChooserFull</link>.
348 </para>
349 </listitem>
350 <listitem>
351 <para>
352 <link linkend="TeplTabLabel">TeplTabLabel</link> now inherits from
353 <code>GtkBox</code> instead of <code>GtkGrid</code>.
354 </para>
355 </listitem>
356 <listitem>
357 <para>
358 <link linkend="TeplPanelItem">TeplPanelItem</link> is now a GObject
359 class instead of an interface.
360 </para>
361 </listitem>
362 <listitem>
363 <para>
364 The API of <link linkend="tepl-panel-add">tepl_panel_add()</link> and
365 its vfunc have changed.
366 </para>
367 </listitem>
368 <listitem>
369 <para>
370 The API of
371 <link linkend="TeplPanelSwitcherMenu">TeplPanelSwitcherMenu</link>
372 has changed.
373 </para>
374 </listitem>
375 <listitem>
376 <para>
377 The <code>TeplPanelSwitcherNotebook</code> class has been removed, you
378 can use <link linkend="TeplPanelNotebook">TeplPanelNotebook</link>
379 instead.
380 </para>
381 </listitem>
382 <listitem>
383 <para>
384 The <code>TeplPanelContainer</code> class has been removed, you can
385 use <link linkend="TeplPanelSimple">TeplPanelSimple</link> instead.
386 </para>
387 </listitem>
388 </itemizedlist>
389
390 <para>
391 libgedit-tepl 6.11 to 6.12:
392 </para>
393 <itemizedlist>
394 <listitem>
395 <para>
396 The <code>tepl_prefs_create_display_grid_checkbutton()</code> function
397 has been removed.
398 </para>
399 </listitem>
400 </itemizedlist>
401
402 <para>
403 libgedit-tepl 6.12 to 6.13:
404 </para>
405 <itemizedlist>
406 <listitem>
407 <para>
408 The <code>tepl_abstract_factory_fill_prefs_dialog()</code> function
409 and its vfunc have been replaced by
410 <link linkend="tepl-abstract-factory-create-prefs-dialog">tepl_abstract_factory_create_prefs_dialog()</link>.
411 </para>
412 </listitem>
413 <listitem>
414 <para>
415 The <code>TeplEncoding</code> interface and the
416 <code>TeplEncodingIconv</code> class have been removed.
417 </para>
418 </listitem>
419 </itemizedlist>
420 </chapter>
421 </part>