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
|
<?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'">
]>
<part id="api-breaks">
<title>API Breaks</title>
<para>
gedit is a quite old piece of software (created in 1998, at the beginnings
of the GNOME project), and as every software, the code evolves during its
lifetime. So there are sometimes API breaks for gedit plugins, there are no
API stability guarantees.
</para>
<para>
When it is possible, instead of directly removing an API, that API is first
marked as deprecated, and then removed for the next API break. See the
<link linkend="api-index-deprecated">index of deprecated symbols</link>.
</para>
<refsect1>
<title>43 -> 44</title>
<itemizedlist>
<listitem>
<para>
When an URI is added to the
<link linkend="GtkRecentManager">GtkRecentManager</link>,
the <code>groups</code> field of
<link linkend="GtkRecentData">GtkRecentData</link>
is no longer set. You can rely on the application name instead.
</para>
</listitem>
<listitem>
<para>
The <code>gedit_document_get_language()</code> function has been
removed, use
<link linkend="gtk-source-buffer-get-language">gtk_source_buffer_get_language()</link>
instead.
</para>
</listitem>
<listitem>
<para>
The <code>gedit_document_get_short_name_for_display()</code> function has been
removed, use
<link linkend="tepl-file-get-short-name">tepl_file_get_short_name()</link>
instead.
</para>
</listitem>
<listitem>
<para>
The <code>gedit_document_is_untitled()</code> function has been
removed, use
<link linkend="tepl-file-get-location">tepl_file_get_location()</link>
instead.
</para>
</listitem>
<listitem>
<para>
The <code>gedit_statusbar_set_overwrite()</code>
and <code>gedit_statusbar_clear_overwrite()</code>
functions have been removed.
</para>
</listitem>
</itemizedlist>
</refsect1>
<refsect1>
<title>3.38 -> 40</title>
<itemizedlist>
<listitem>
<para>
All previously deprecated APIs have been removed.
</para>
</listitem>
<listitem>
<para>
The <code>GeditProgressInfoBar</code> class has been removed, you can
use <link linkend="TeplProgressInfoBar">TeplProgressInfoBar</link>
instead.
</para>
</listitem>
<listitem>
<para>
<link linkend="GeditDocument">GeditDocument</link> is now a subclass
of <link linkend="TeplBuffer">TeplBuffer</link>.
</para>
</listitem>
<listitem>
<para>
The <code>GeditDocument::cursor-moved</code> signal has been removed.
You can use the <link linkend="TeplBuffer">TeplBuffer</link> API
instead.
</para>
</listitem>
<listitem>
<para>
The <code>gedit_document_get_uri_for_display()</code> function has
been removed from the public API.
</para>
</listitem>
<listitem>
<para>
The <code>GeditDocument:shortname</code> property has been removed.
You can use the <link linkend="TeplFile">TeplFile</link> API instead.
</para>
</listitem>
<listitem>
<para>
The <code>gedit_document_is_untouched()</code> function has been
removed. You can use the <link linkend="TeplBuffer">TeplBuffer</link>
API instead.
</para>
</listitem>
<listitem>
<para>
The <code>gedit_view_set_font()</code> function has been removed.
</para>
</listitem>
<listitem>
<para>
<code>DEBUG_METADATA</code> has been removed.
</para>
</listitem>
</itemizedlist>
</refsect1>
<refsect1>
<title>3.36.0 -> 3.37.1</title>
<itemizedlist>
<listitem>
<para>
All previously deprecated APIs have been removed.
</para>
</listitem>
<listitem>
<para>
The lockdown support has been removed (for the
org.gnome.desktop.lockdown GSettings). So the
<code>gedit_app_get_lockdown()</code> function has been removed.
</para>
</listitem>
<listitem>
<para>
The <code>GBOOLEAN_TO_POINTER()</code> and
<code>GPOINTER_TO_BOOLEAN()</code> macros have been removed from
<code>gedit-utils.h</code>.
</para>
</listitem>
<listitem>
<para>
The <code>gedit_utils_get_current_workspace()</code>,
<code>gedit_utils_get_window_workspace()</code> and
<code>gedit_utils_get_current_viewport()</code> functions have been
removed because workspaces information is not available on Wayland.
</para>
</listitem>
</itemizedlist>
</refsect1>
<refsect1>
<title>3.34.0 -> 3.35.2</title>
<itemizedlist>
<listitem>
<para>
All previously deprecated APIs have been removed.
</para>
</listitem>
<listitem>
<para>
The <code>GeditDocument:use-gvfs-metadata</code> property has been
removed. But there was anyway a warning for not using that property in
a gedit plugin.
</para>
</listitem>
<listitem>
<para>
For <link linkend="gedit-document-get-metadata">gedit_document_get_metadata()</link>
and <link linkend="gedit-document-set-metadata">gedit_document_set_metadata()</link>,
the key names should now have the prefix <code>"gedit-"</code> with
possibly an additional namespace for the plugin name, for example
<code>"gedit-spell-foobar"</code>. So the key names are now the same
regardless of the operating system, and the key names should no longer
start with <code>"metadata::"</code>.
</para>
</listitem>
</itemizedlist>
</refsect1>
<refsect1>
<title>For previous gedit versions</title>
<para>
See the
<ulink url="https://wiki.gnome.org/Apps/Gedit/Attic/Old_API_Changes">Old API Changes wiki page</ulink>.
</para>
</refsect1>
</part>
|
