libbuzztard-dev 0.6.0-1.1 / usr / share / gtk-doc / html / buzztard-edit / BtChangeLog.html

This file is indexed.

/usr/share/gtk-doc/html/buzztard-edit/BtChangeLog.html is in libbuzztard-dev 0.6.0-1.1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BtChangeLog</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Buzztard Bt-Edit Reference Manual">
<link rel="up" href="ch01.html" title="Main Class Reference">
<link rel="prev" href="BtAboutDialog.html" title="BtAboutDialog">
<link rel="next" href="buzztard-edit-BtChangeLogger.html" title="BtChangeLogger">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="BtAboutDialog.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Buzztard Bt-Edit Reference Manual</th>
<td><a accesskey="n" href="buzztard-edit-BtChangeLogger.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#BtChangeLog.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#BtChangeLog.description" class="shortcut">Description</a>
                   | 
                  <a href="#BtChangeLog.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#BtChangeLog.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="BtChangeLog"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="BtChangeLog.top_of_page"></a>BtChangeLog</span></h2>
<p>BtChangeLog — class for the editor action journaling</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="BtChangeLog.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include "bt-edit.h"

struct              <a class="link" href="BtChangeLog.html#BtChangeLog-struct" title="struct BtChangeLog">BtChangeLog</a>;
<a class="link" href="BtChangeLog.html" title="BtChangeLog"><span class="returnvalue">BtChangeLog</span></a> *       <a class="link" href="BtChangeLog.html#bt-change-log-new" title="bt_change_log_new ()">bt_change_log_new</a>                   (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="BtChangeLog.html#bt-change-log-is-active" title="bt_change_log_is_active ()">bt_change_log_is_active</a>             (<em class="parameter"><code><a class="link" href="BtChangeLog.html" title="BtChangeLog"><span class="type">BtChangeLog</span></a> *self</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="BtChangeLog.html#bt-change-log-add" title="bt_change_log_add ()">bt_change_log_add</a>                   (<em class="parameter"><code><a class="link" href="BtChangeLog.html" title="BtChangeLog"><span class="type">BtChangeLog</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">BtChangeLogger</span> *owner</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> *undo_data</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> *redo_data</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="BtChangeLog.html#bt-change-log-redo" title="bt_change_log_redo ()">bt_change_log_redo</a>                  (<em class="parameter"><code><a class="link" href="BtChangeLog.html" title="BtChangeLog"><span class="type">BtChangeLog</span></a> *self</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="BtChangeLog.html#bt-change-log-undo" title="bt_change_log_undo ()">bt_change_log_undo</a>                  (<em class="parameter"><code><a class="link" href="BtChangeLog.html" title="BtChangeLog"><span class="type">BtChangeLog</span></a> *self</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="BtChangeLog.html#bt-change-log-start-group" title="bt_change_log_start_group ()">bt_change_log_start_group</a>           (<em class="parameter"><code><a class="link" href="BtChangeLog.html" title="BtChangeLog"><span class="type">BtChangeLog</span></a> *self</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="BtChangeLog.html#bt-change-log-end-group" title="bt_change_log_end_group ()">bt_change_log_end_group</a>             (<em class="parameter"><code><a class="link" href="BtChangeLog.html" title="BtChangeLog"><span class="type">BtChangeLog</span></a> *self</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="BtChangeLog.html#bt-change-log-recover" title="bt_change_log_recover ()">bt_change_log_recover</a>               (<em class="parameter"><code><a class="link" href="BtChangeLog.html" title="BtChangeLog"><span class="type">BtChangeLog</span></a> *self</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *log_name</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="BtChangeLog.html#bt-change-log-register" title="bt_change_log_register ()">bt_change_log_register</a>              (<em class="parameter"><code><a class="link" href="BtChangeLog.html" title="BtChangeLog"><span class="type">BtChangeLog</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">BtChangeLogger</span> *logger</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="BtChangeLog.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----BtChangeLog
</pre>
</div>
<div class="refsect1">
<a name="BtChangeLog.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="BtChangeLog.html#BtChangeLog--can-redo" title='The "can-redo" property'>can-redo</a>"                 <span class="type">gboolean</span>              : Read
  "<a class="link" href="BtChangeLog.html#BtChangeLog--can-undo" title='The "can-undo" property'>can-undo</a>"                 <span class="type">gboolean</span>              : Read
  "<a class="link" href="BtChangeLog.html#BtChangeLog--crash-logs" title='The "crash-logs" property'>crash-logs</a>"               <span class="type">gpointer</span>              : Read
</pre>
</div>
<div class="refsect1">
<a name="BtChangeLog.description"></a><h2>Description</h2>
<p>
Tracks edits actions since last save. Provides undo/redo. Supports grouping
of edits into single undo/redo items (see <a class="link" href="BtChangeLog.html#bt-change-log-start-group" title="bt_change_log_start_group ()"><code class="function">bt_change_log_start_group()</code></a>).
</p>
<p>
Edit actions are logged to disk for crash recovery. Groups are logged
atomically, when they are closed (to have a recoverable log).
</p>
<p>
Logs are reset when saving a song. The log is removed when a song is closed.
</p>
<p>
<a class="link" href="BtEditApplication.html" title="BtEditApplication"><span class="type">BtEditApplication</span></a> checks for left-over logs at startup and uses
<span class="type">BtCrashRecoverDialog</span> to offer a list of recoverable songs to the user.
</p>
</div>
<div class="refsect1">
<a name="BtChangeLog.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="BtChangeLog-struct"></a><h3>struct BtChangeLog</h3>
<pre class="programlisting">struct BtChangeLog;</pre>
<p>
Editor action journal.
</p>
</div>
<hr>
<div class="refsect2">
<a name="bt-change-log-new"></a><h3>bt_change_log_new ()</h3>
<pre class="programlisting"><a class="link" href="BtChangeLog.html" title="BtChangeLog"><span class="returnvalue">BtChangeLog</span></a> *       bt_change_log_new                   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Create a new instance on first call and return a reference later on.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new signleton instance</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-change-log-is-active"></a><h3>bt_change_log_is_active ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            bt_change_log_is_active             (<em class="parameter"><code><a class="link" href="BtChangeLog.html" title="BtChangeLog"><span class="type">BtChangeLog</span></a> *self</code></em>);</pre>
<p>
Checks if the changelog journalling is active. Should be checked before
adding entries to avoid logging when e.g. loading a song.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the changelog</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the log is active</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-change-log-add"></a><h3>bt_change_log_add ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                bt_change_log_add                   (<em class="parameter"><code><a class="link" href="BtChangeLog.html" title="BtChangeLog"><span class="type">BtChangeLog</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">BtChangeLogger</span> *owner</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> *undo_data</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> *redo_data</code></em>);</pre>
<p>
Add a new change to the change log. Changes are passed as serialized strings.
The change-log takes ownership of  <em class="parameter"><code>undo_data</code></em> and <em class="parameter"><code>redo_data</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the change log</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>owner</code></em> :</span></p></td>
<td>the owner of the change</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>undo_data</code></em> :</span></p></td>
<td>how to undo the change</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>redo_data</code></em> :</span></p></td>
<td>how to redo the change</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-change-log-redo"></a><h3>bt_change_log_redo ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                bt_change_log_redo                  (<em class="parameter"><code><a class="link" href="BtChangeLog.html" title="BtChangeLog"><span class="type">BtChangeLog</span></a> *self</code></em>);</pre>
<p>
Redo the last action.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the change log</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-change-log-undo"></a><h3>bt_change_log_undo ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                bt_change_log_undo                  (<em class="parameter"><code><a class="link" href="BtChangeLog.html" title="BtChangeLog"><span class="type">BtChangeLog</span></a> *self</code></em>);</pre>
<p>
Undo the last action.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the change log</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-change-log-start-group"></a><h3>bt_change_log_start_group ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                bt_change_log_start_group           (<em class="parameter"><code><a class="link" href="BtChangeLog.html" title="BtChangeLog"><span class="type">BtChangeLog</span></a> *self</code></em>);</pre>
<p>
Open a new group. All further <a class="link" href="BtChangeLog.html#bt-change-log-add" title="bt_change_log_add ()"><code class="function">bt_change_log_add()</code></a> calls will add to the
active group. The group needs to be closed using <a class="link" href="BtChangeLog.html#bt-change-log-end-group" title="bt_change_log_end_group ()"><code class="function">bt_change_log_end_group()</code></a>.
Groups can be nested.
</p>
<p>
A top-level group is undone or redone with a single <a class="link" href="BtChangeLog.html#bt-change-log-undo" title="bt_change_log_undo ()"><code class="function">bt_change_log_undo()</code></a> or
<a class="link" href="BtChangeLog.html#bt-change-log-redo" title="bt_change_log_redo ()"><code class="function">bt_change_log_redo()</code></a> call.
</p>
<p>
One would start and finish such a group in the first signal handler that
triggered the change.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the change log</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-change-log-end-group"></a><h3>bt_change_log_end_group ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                bt_change_log_end_group             (<em class="parameter"><code><a class="link" href="BtChangeLog.html" title="BtChangeLog"><span class="type">BtChangeLog</span></a> *self</code></em>);</pre>
<p>
Closed the last group opened with <a class="link" href="BtChangeLog.html#bt-change-log-start-group" title="bt_change_log_start_group ()"><code class="function">bt_change_log_start_group()</code></a>. Usually one
a group would be closed in the same local scope where it was opened.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the change log</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-change-log-recover"></a><h3>bt_change_log_recover ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            bt_change_log_recover               (<em class="parameter"><code><a class="link" href="BtChangeLog.html" title="BtChangeLog"><span class="type">BtChangeLog</span></a> *self</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *log_name</code></em>);</pre>
<p>
Recover the given song.
</p>
<p>
Return: <code class="literal">TRUE</code> for successful recovery.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the changelog</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>log_name</code></em> :</span></p></td>
<td>the log file to replay</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-change-log-register"></a><h3>bt_change_log_register ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                bt_change_log_register              (<em class="parameter"><code><a class="link" href="BtChangeLog.html" title="BtChangeLog"><span class="type">BtChangeLog</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">BtChangeLogger</span> *logger</code></em>);</pre>
<p>
Register a change-logger for use in change log replay.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the change log</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>logger</code></em> :</span></p></td>
<td>a change logger</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="BtChangeLog.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="BtChangeLog--can-redo"></a><h3>The <code class="literal">"can-redo"</code> property</h3>
<pre class="programlisting">  "can-redo"                 <span class="type">gboolean</span>              : Read</pre>
<p>Where there are action to redo.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="BtChangeLog--can-undo"></a><h3>The <code class="literal">"can-undo"</code> property</h3>
<pre class="programlisting">  "can-undo"                 <span class="type">gboolean</span>              : Read</pre>
<p>Where there are action to undo.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="BtChangeLog--crash-logs"></a><h3>The <code class="literal">"crash-logs"</code> property</h3>
<pre class="programlisting">  "crash-logs"               <span class="type">gpointer</span>              : Read</pre>
<p>A list of found crash logs.</p>
</div>
</div>
<div class="refsect1">
<a name="BtChangeLog.see-also"></a><h2>See Also</h2>
<span class="type">BtCrashRecoverDialog</span>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.