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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
%gtkdocentities;
]>
<part id="api-breaks">
<title>API Breaks</title>
<chapter id="api-breaks-1-to-2">
<title>Gtef 1 -> Gtef 2</title>
<itemizedlist>
<listitem>
<para>
The <code>GtefBuffer::cursor-moved</code> signal has been renamed to
<code>GtefBuffer::gtef-cursor-moved</code>.
</para>
</listitem>
<listitem>
<para>
The <code>GtefBuffer:title</code> property has been renamed to
<code>GtefBuffer:gtef-title</code>.
</para>
</listitem>
</itemizedlist>
</chapter>
<chapter id="api-breaks-2-to-3-tepl">
<title>Gtef 2 -> Tepl 3</title>
<itemizedlist>
<listitem>
<para>
The library has been renamed to Tepl (Text editor product line). So
the namespace of the code has changed.
</para>
<para>
The new version is Tepl 3 and not Tepl 1, to avoid confusion
with the git tags (the git repository is still the same), since the
repository already contains tags for versions 1 and 2.
</para>
</listitem>
<listitem>
<para>
The <link linkend="TeplTab">TeplTab</link> class has been revamped.
The <link linkend="tepl-tab-new">tepl_tab_new()</link> function
doesn't take a <link linkend="GtkWidget">GtkWidget</link> parameter
anymore, a <link linkend="TeplView">TeplView</link> is created
instead.
</para>
</listitem>
<listitem>
<para>
The <code>TeplBuffer:tepl-title</code> property has been renamed to
<link linkend="TeplBuffer--tepl-full-title">TeplBuffer:tepl-full-title</link>,
and <code>tepl_buffer_get_title()</code> has been renamed to
<link linkend="tepl-buffer-get-full-title">tepl_buffer_get_full_title()</link>.
</para>
</listitem>
</itemizedlist>
</chapter>
<chapter id="api-breaks-2-to-3-amtk">
<title>Gtef 2 -> Amtk 3</title>
<itemizedlist>
<listitem>
<para>
The classes and functions related to actions and menus have been moved
to a new shared library called Amtk (Actions, Menus and Toolbars Kit),
since it was not really related to text editors, it is more general.
But Amtk is still developed inside the Tepl repository.
</para>
</listitem>
<listitem>
<para>
The <link linkend="AmtkFactory">AmtkFactory</link> class has been
added, which replace <code>gtef_action_info_store_create_menu_item()</code>
and removes the <code>GtefActionInfoStore:application</code> property.
</para>
</listitem>
<listitem>
<para>
<code>gtef_action_info_central_store_get_instance()</code> has been
renamed to
<link linkend="amtk-action-info-central-store-get-singleton">amtk_action_info_central_store_get_singleton()</link>.
</para>
</listitem>
<listitem>
<para>
<link linkend="amtk-application-window-connect-menu-to-statusbar">amtk_application_window_connect_menu_to_statusbar()</link>
now takes a <link linkend="GtkMenuShell">GtkMenuShell</link> parameter
instead of <link linkend="AmtkMenuShell">AmtkMenuShell</link>.
</para>
</listitem>
</itemizedlist>
</chapter>
<chapter id="api-breaks-3-to-4-tepl">
<title>Tepl 3 -> Tepl 4</title>
<itemizedlist>
<listitem>
<para>
Tepl 3 depended on GtkSourceView 3, Tepl 4 depends on
GtkSourceView 4. So to be able to use Tepl 4, you need to
port your code to GtkSourceView 4. Note that the GTK dependency
is still GTK 3.
</para>
</listitem>
<listitem>
<para>
The <link linkend="TeplTab-close-request">TeplTab::close-request</link>
signal has now a default object method handler.
</para>
</listitem>
</itemizedlist>
</chapter>
<chapter id="api-breaks-4-to-5-tepl">
<title>Tepl 4 -> Tepl 5</title>
<itemizedlist>
<listitem>
<para>
The <code>TeplEncoding</code> class has been removed, as part of the
beginning of a complete overhaul of the file loading and saving
functionality.
</para>
</listitem>
<listitem>
<para>
Start to rework the <link linkend="TeplFile">TeplFile</link>,
<link linkend="TeplFileLoader">TeplFileLoader</link> and
<link linkend="TeplFileSaver">TeplFileSaver</link> classes. As such,
there are some API breaks in those classes. And as a result, they
currently contain less features as before, unfortunately.
</para>
</listitem>
<listitem>
<para>
The <link linkend="TeplMetadataManager">TeplMetadataManager</link> API
has been re-worked.
</para>
</listitem>
<listitem>
<para>
The <code>TeplFileMetadata</code> class has been replaced by
<link linkend="TeplMetadata">TeplMetadata</link>, the latter no longer
depends on <link linkend="TeplFile">TeplFile</link>.
</para>
</listitem>
<listitem>
<para>
The <code>tepl_file_get_file_metadata()</code> function has been
removed.
</para>
</listitem>
<listitem>
<para>
The <link linkend="tepl-tab-load-file">tepl_tab_load_file()</link>
function no longer loads the file metadata (but it was anyway an
implementation detail).
</para>
</listitem>
<listitem>
<para>
The <code>TeplAbstractFactoryVala</code> class has been removed,
because it's possible to manually manage GObject references in Vala.
</para>
</listitem>
</itemizedlist>
</chapter>
<chapter id="api-breaks-5-to-6-tepl">
<title>Tepl 5 -> Tepl 6</title>
<itemizedlist>
<listitem>
<para>
The <link linkend="tepl-info-bar-set-buttons-orientation">tepl_info_bar_set_buttons_orientation()</link>
now takes a <link linkend="GtkInfoBar">GtkInfoBar</link> parameter,
not a <link linkend="TeplInfoBar">TeplInfoBar</link>.
</para>
</listitem>
<listitem>
<para>
The <code>tepl_info_bar_add_close_button()</code> function has been
renamed to
<link linkend="tepl-info-bar-setup-close-button">tepl_info_bar_setup_close_button()</link>.
</para>
</listitem>
<listitem>
<para>
The <code>tepl_info_bar_add_icon()</code> function has been replaced by
<link linkend="tepl-info-bar-set-icon-from-message-type">tepl_info_bar_set_icon_from_message_type()</link>.
</para>
</listitem>
<listitem>
<para>
A <code>location</code> parameter has been added to the
<link linkend="tepl-info-bar-add-content-widget">tepl_info_bar_add_content_widget()</link>
function.
</para>
</listitem>
</itemizedlist>
</chapter>
<chapter id="api-breaks-during-tepl-6">
<title>API breaks during Tepl 6</title>
<para>
There are also ABI breaks not affecting the API, so just re-compiling the
program is sufficient in that case.
</para>
<para>
Tepl 6.0 to Tepl 6.2:
</para>
<itemizedlist>
<listitem>
<para>
The <code>tepl_utils_override_font()</code> function has been renamed
to <link linkend="tepl-utils-override-font-string">tepl_utils_override_font_string()</link>.
</para>
</listitem>
</itemizedlist>
<para>
Tepl 6.2 to Tepl 6.4:
</para>
<itemizedlist>
<listitem>
<para>
The <code>tepl_statusbar_*()</code> functions have been removed, you
can use
<link linkend="TeplLineColumnIndicator">TeplLineColumnIndicator</link>
instead.
</para>
</listitem>
</itemizedlist>
</chapter>
</part>
|
