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

This file is indexed.

/usr/share/gtk-doc/html/buzztard-edit/BtMainWindow.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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BtMainWindow</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="BtMainToolbar.html" title="BtMainToolbar">
<link rel="next" href="BtMissingFrameworkElementsDialog.html" title="BtMissingFrameworkElementsDialog">
<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="BtMainToolbar.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="BtMissingFrameworkElementsDialog.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#BtMainWindow.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#BtMainWindow.description" class="shortcut">Description</a>
                   | 
                  <a href="#BtMainWindow.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#BtMainWindow.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#BtMainWindow.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="BtMainWindow"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="BtMainWindow.top_of_page"></a>BtMainWindow</span></h2>
<p>BtMainWindow — root buzztard editor window</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="BtMainWindow.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include "bt-edit.h"

struct              <a class="link" href="BtMainWindow.html#BtMainWindow-struct" title="struct BtMainWindow">BtMainWindow</a>;
<a class="link" href="BtMainWindow.html" title="BtMainWindow"><span class="returnvalue">BtMainWindow</span></a> *      <a class="link" href="BtMainWindow.html#bt-main-window-new" title="bt_main_window_new ()">bt_main_window_new</a>                  (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="BtMainWindow.html#bt-main-window-check-unsaved-song" title="bt_main_window_check_unsaved_song ()">bt_main_window_check_unsaved_song</a>   (<em class="parameter"><code>const <a class="link" href="BtMainWindow.html" title="BtMainWindow"><span class="type">BtMainWindow</span></a> *self</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *headline</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="BtMainWindow.html#bt-main-window-check-quit" title="bt_main_window_check_quit ()">bt_main_window_check_quit</a>           (<em class="parameter"><code>const <a class="link" href="BtMainWindow.html" title="BtMainWindow"><span class="type">BtMainWindow</span></a> *self</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="BtMainWindow.html#bt-main-window-new-song" title="bt_main_window_new_song ()">bt_main_window_new_song</a>             (<em class="parameter"><code>const <a class="link" href="BtMainWindow.html" title="BtMainWindow"><span class="type">BtMainWindow</span></a> *self</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="BtMainWindow.html#bt-main-window-open-song" title="bt_main_window_open_song ()">bt_main_window_open_song</a>            (<em class="parameter"><code>const <a class="link" href="BtMainWindow.html" title="BtMainWindow"><span class="type">BtMainWindow</span></a> *self</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="BtMainWindow.html#bt-main-window-save-song" title="bt_main_window_save_song ()">bt_main_window_save_song</a>            (<em class="parameter"><code>const <a class="link" href="BtMainWindow.html" title="BtMainWindow"><span class="type">BtMainWindow</span></a> *self</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="BtMainWindow.html#bt-main-window-save-song-as" title="bt_main_window_save_song_as ()">bt_main_window_save_song_as</a>         (<em class="parameter"><code>const <a class="link" href="BtMainWindow.html" title="BtMainWindow"><span class="type">BtMainWindow</span></a> *self</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="BtMainWindow.html#bt-dialog-message" title="bt_dialog_message ()">bt_dialog_message</a>                   (<em class="parameter"><code>const <a class="link" href="BtMainWindow.html" title="BtMainWindow"><span class="type">BtMainWindow</span></a> *self</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *headline</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="BtMainWindow.html#bt-dialog-question" title="bt_dialog_question ()">bt_dialog_question</a>                  (<em class="parameter"><code>const <a class="link" href="BtMainWindow.html" title="BtMainWindow"><span class="type">BtMainWindow</span></a> *self</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *headline</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="BtMainWindow.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBin
                                 +----GtkWindow
                                       +----BtMainWindow
</pre>
</div>
<div class="refsect1">
<a name="BtMainWindow.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
BtMainWindow implements
 AtkImplementorIface,  GtkBuildable and  BtChildProxy.</p>
</div>
<div class="refsect1">
<a name="BtMainWindow.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="BtMainWindow.html#BtMainWindow--dialog" title='The "dialog" property'>dialog</a>"                   <span class="type">GtkDialog</span>*            : Read
  "<a class="link" href="BtMainWindow.html#BtMainWindow--pages" title='The "pages" property'>pages</a>"                    <a class="link" href="BtMainPages.html" title="BtMainPages"><span class="type">BtMainPages</span></a>*          : Read
  "<a class="link" href="BtMainWindow.html#BtMainWindow--statusbar" title='The "statusbar" property'>statusbar</a>"                <a class="link" href="BtMainStatusbar.html" title="BtMainStatusbar"><span class="type">BtMainStatusbar</span></a>*      : Read
  "<a class="link" href="BtMainWindow.html#BtMainWindow--toolbar" title='The "toolbar" property'>toolbar</a>"                  <a class="link" href="BtMainToolbar.html" title="BtMainToolbar"><span class="type">BtMainToolbar</span></a>*        : Read
</pre>
</div>
<div class="refsect1">
<a name="BtMainWindow.description"></a><h2>Description</h2>
<p>
The main window class is a container for the <a class="link" href="BtMainMenu.html" title="BtMainMenu"><span class="type">BtMainMenu</span></a>, the <a class="link" href="BtMainToolbar.html" title="BtMainToolbar"><span class="type">BtMainToolbar</span></a>,
the <a class="link" href="BtMainStatusbar.html" title="BtMainStatusbar"><span class="type">BtMainStatusbar</span></a> and the <a class="link" href="BtMainPages.html" title="BtMainPages"><span class="type">BtMainPages</span></a> tabbed notebook.
</p>
</div>
<div class="refsect1">
<a name="BtMainWindow.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="BtMainWindow-struct"></a><h3>struct BtMainWindow</h3>
<pre class="programlisting">struct BtMainWindow;</pre>
<p>
the root window for the editor application
</p>
</div>
<hr>
<div class="refsect2">
<a name="bt-main-window-new"></a><h3>bt_main_window_new ()</h3>
<pre class="programlisting"><a class="link" href="BtMainWindow.html" title="BtMainWindow"><span class="returnvalue">BtMainWindow</span></a> *      bt_main_window_new                  (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Create a new instance
</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 instance</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-main-window-check-unsaved-song"></a><h3>bt_main_window_check_unsaved_song ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            bt_main_window_check_unsaved_song   (<em class="parameter"><code>const <a class="link" href="BtMainWindow.html" title="BtMainWindow"><span class="type">BtMainWindow</span></a> *self</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *headline</code></em>);</pre>
<p>
Checks if the current song is modified and asks for confirmation to continue
(and loose the changes). It only considers the undo/redo stack and not minor
changes such as switching tabs or selecting something.
</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 main window instance</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
<td>the title of the message</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>headline</code></em> :</span></p></td>
<td>the bold headline of the message</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 user has confirmed to continue</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-main-window-check-quit"></a><h3>bt_main_window_check_quit ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            bt_main_window_check_quit           (<em class="parameter"><code>const <a class="link" href="BtMainWindow.html" title="BtMainWindow"><span class="type">BtMainWindow</span></a> *self</code></em>);</pre>
<p>
Displays a dialog box, that asks the user to confirm exiting the application.
</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 main window instance</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 user has confirmed to exit</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-main-window-new-song"></a><h3>bt_main_window_new_song ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                bt_main_window_new_song             (<em class="parameter"><code>const <a class="link" href="BtMainWindow.html" title="BtMainWindow"><span class="type">BtMainWindow</span></a> *self</code></em>);</pre>
<p>
Prepares a new song. Triggers cleaning up the old song and refreshes the ui.
</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 main window instance</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-main-window-open-song"></a><h3>bt_main_window_open_song ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                bt_main_window_open_song            (<em class="parameter"><code>const <a class="link" href="BtMainWindow.html" title="BtMainWindow"><span class="type">BtMainWindow</span></a> *self</code></em>);</pre>
<p>
Opens a dialog box, where the user can choose a song to load.
If the dialog is not canceld, the old song will be freed, the new song will
be loaded and the ui will be refreshed upon success.
</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 main window instance</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-main-window-save-song"></a><h3>bt_main_window_save_song ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                bt_main_window_save_song            (<em class="parameter"><code>const <a class="link" href="BtMainWindow.html" title="BtMainWindow"><span class="type">BtMainWindow</span></a> *self</code></em>);</pre>
<p>
Save the song to disk.
If it is a new song it will ask for a file_name and location.
</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 main window instance</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-main-window-save-song-as"></a><h3>bt_main_window_save_song_as ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                bt_main_window_save_song_as         (<em class="parameter"><code>const <a class="link" href="BtMainWindow.html" title="BtMainWindow"><span class="type">BtMainWindow</span></a> *self</code></em>);</pre>
<p>
Opens a dialog box, where the user can choose a file_name and location to save
the song under.
</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 main window instance</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-dialog-message"></a><h3>bt_dialog_message ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                bt_dialog_message                   (<em class="parameter"><code>const <a class="link" href="BtMainWindow.html" title="BtMainWindow"><span class="type">BtMainWindow</span></a> *self</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *headline</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>);</pre>
<p>
Displays a modal message dialog, that needs to be confirmed with "Okay".
</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 applications main window</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
<td>the title of the message</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>headline</code></em> :</span></p></td>
<td>the bold headline of the message</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>the message itself</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-dialog-question"></a><h3>bt_dialog_question ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            bt_dialog_question                  (<em class="parameter"><code>const <a class="link" href="BtMainWindow.html" title="BtMainWindow"><span class="type">BtMainWindow</span></a> *self</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *headline</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>);</pre>
<p>
Displays a modal question dialog, that needs to be confirmed with "Okay" or aborted with "Cancel".
</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 applications main window</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
<td>the title of the message</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>headline</code></em> :</span></p></td>
<td>the bold headline of the message</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>the message itself</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> for Okay, <code class="literal">FALSE</code> otherwise</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="BtMainWindow.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="BtMainWindow--dialog"></a><h3>The <code class="literal">"dialog"</code> property</h3>
<pre class="programlisting">  "dialog"                   <span class="type">GtkDialog</span>*            : Read</pre>
<p>Get the active dialog.</p>
</div>
<hr>
<div class="refsect2">
<a name="BtMainWindow--pages"></a><h3>The <code class="literal">"pages"</code> property</h3>
<pre class="programlisting">  "pages"                    <a class="link" href="BtMainPages.html" title="BtMainPages"><span class="type">BtMainPages</span></a>*          : Read</pre>
<p>Get the pages widget.</p>
</div>
<hr>
<div class="refsect2">
<a name="BtMainWindow--statusbar"></a><h3>The <code class="literal">"statusbar"</code> property</h3>
<pre class="programlisting">  "statusbar"                <a class="link" href="BtMainStatusbar.html" title="BtMainStatusbar"><span class="type">BtMainStatusbar</span></a>*      : Read</pre>
<p>Get the status bar.</p>
</div>
<hr>
<div class="refsect2">
<a name="BtMainWindow--toolbar"></a><h3>The <code class="literal">"toolbar"</code> property</h3>
<pre class="programlisting">  "toolbar"                  <a class="link" href="BtMainToolbar.html" title="BtMainToolbar"><span class="type">BtMainToolbar</span></a>*        : Read</pre>
<p>Get the toolbar.</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.