← Back to branch summary

~ubuntu-branches/ubuntu/precise/gtksourceview2/precise-proposed

« back to all changes in this revision

Viewing changes to docs/reference/html/GtkSourceMark.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-06-21 15:16:53 UTC
  • mfrom: (1.1.42 upstream) (38.1.1 lucid-proposed)
  • Revision ID: james.westby@ubuntu.com-20100621151653-h2zosk5vatjbwf5v
Tags: 2.10.4-0ubuntu1
https://launchpad.net/bugs/586819
* New upstream version:
  - Misc bugfixes
  - Updated translations
  - gtk-doc comments should be spellchecked (lp: #586819)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/GtkSourceMark.html
8
8
<link rel="up" href="rn01.html" title="API reference">
9
9
<link rel="prev" href="GtkSourceGutter.html" title="GtkSourceGutter">
10
10
<link rel="next" href="GtkSourceView.html" title="GtkSourceView">
11
 
<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
45
45
#include &lt;gtksourceview/gtksourcemark.h&gt;
46
46
 
47
47
                    <a class="link" href="GtkSourceMark.html#GtkSourceMark-struct" title="GtkSourceMark">GtkSourceMark</a>;
48
 
<a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="returnvalue">GtkSourceMark</span></a> *     <a class="link" href="GtkSourceMark.html#gtk-source-mark-new" title="gtk_source_mark_new ()">gtk_source_mark_new</a>                 (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
49
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *category</code></em>);
50
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="GtkSourceMark.html#gtk-source-mark-get-category" title="gtk_source_mark_get_category ()">gtk_source_mark_get_category</a>        (<em class="parameter"><code><a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> *mark</code></em>);
 
48
<a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="returnvalue">GtkSourceMark</span></a> *     <a class="link" href="GtkSourceMark.html#gtk-source-mark-new" title="gtk_source_mark_new ()">gtk_source_mark_new</a>                 (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
 
49
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *category</code></em>);
 
50
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="GtkSourceMark.html#gtk-source-mark-get-category" title="gtk_source_mark_get_category ()">gtk_source_mark_get_category</a>        (<em class="parameter"><code><a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> *mark</code></em>);
51
51
<a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="returnvalue">GtkSourceMark</span></a> *     <a class="link" href="GtkSourceMark.html#gtk-source-mark-next" title="gtk_source_mark_next ()">gtk_source_mark_next</a>                (<em class="parameter"><code><a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> *mark</code></em>,
52
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *category</code></em>);
 
52
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *category</code></em>);
53
53
<a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="returnvalue">GtkSourceMark</span></a> *     <a class="link" href="GtkSourceMark.html#gtk-source-mark-prev" title="gtk_source_mark_prev ()">gtk_source_mark_prev</a>                (<em class="parameter"><code><a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> *mark</code></em>,
54
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *category</code></em>);
 
54
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *category</code></em>);
55
55
</pre>
56
56
</div>
57
57
<div class="refsect1" title="Object Hierarchy">
58
58
<a name="GtkSourceMark.object-hierarchy"></a><h2>Object Hierarchy</h2>
59
59
<pre class="synopsis">
60
 
  GObject
61
 
   +----GtkTextMark
 
60
  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
61
   +----<a href="/usr/share/gtk-doc/html/gtk/GtkTextMark.html">GtkTextMark</a>
62
62
         +----GtkSourceMark
63
63
</pre>
64
64
</div>
65
65
<div class="refsect1" title="Properties">
66
66
<a name="GtkSourceMark.properties"></a><h2>Properties</h2>
67
67
<pre class="synopsis">
68
 
  "<a class="link" href="GtkSourceMark.html#GtkSourceMark--category" title='The "category" property'>category</a>"                 <span class="type">gchar</span>*                : Read / Write / Construct Only
 
68
  "<a class="link" href="GtkSourceMark.html#GtkSourceMark--category" title='The "category" property'>category</a>"                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
69
69
</pre>
70
70
</div>
71
71
<div class="refsect1" title="Description">
72
72
<a name="GtkSourceMark.description"></a><h2>Description</h2>
73
73
<p>
74
74
A <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> marks a position in the text where you want to display
75
 
additional info. It is based on <span class="type">GtkTextMark</span> and thus is still valid after
 
75
additional info. It is based on <a href="/usr/share/gtk-doc/html/gtk/GtkTextMark.html"><span class="type">GtkTextMark</span></a> and thus is still valid after
76
76
the text has changed though its position may change.
77
77
</p>
78
78
<p>
95
95
<hr>
96
96
<div class="refsect2" title="gtk_source_mark_new ()">
97
97
<a name="gtk-source-mark-new"></a><h3>gtk_source_mark_new ()</h3>
98
 
<pre class="programlisting"><a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="returnvalue">GtkSourceMark</span></a> *     gtk_source_mark_new                 (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
99
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *category</code></em>);</pre>
 
98
<pre class="programlisting"><a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="returnvalue">GtkSourceMark</span></a> *     gtk_source_mark_new                 (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
 
99
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *category</code></em>);</pre>
100
100
<p>
101
 
Creates a text mark. Add it to a buffer using <code class="function">gtk_text_buffer_add_mark()</code>. 
 
101
Creates a text mark. Add it to a buffer using <a href="/usr/share/gtk-doc/html/gtk/GtkTextBuffer.html#gtk-text-buffer-add-mark"><code class="function">gtk_text_buffer_add_mark()</code></a>. 
102
102
If name is NULL, the mark is anonymous; otherwise, the mark can be retrieved
103
 
by name using <code class="function">gtk_text_buffer_get_mark()</code>.
 
103
by name using <a href="/usr/share/gtk-doc/html/gtk/GtkTextBuffer.html#gtk-text-buffer-get-mark"><code class="function">gtk_text_buffer_get_mark()</code></a>.
104
104
Normally marks are created using the utility function 
105
105
<code class="function">gtk_source_buffer_create_mark()</code>.
106
106
</p>
122
122
</tr>
123
123
<tr>
124
124
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
125
 
<td> a new <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> that can be added using <code class="function">gtk_text_buffer_add_mark()</code>
 
125
<td> a new <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> that can be added using <a href="/usr/share/gtk-doc/html/gtk/GtkTextBuffer.html#gtk-text-buffer-add-mark"><code class="function">gtk_text_buffer_add_mark()</code></a>
126
126
 
127
127
</td>
128
128
</tr>
133
133
<hr>
134
134
<div class="refsect2" title="gtk_source_mark_get_category ()">
135
135
<a name="gtk-source-mark-get-category"></a><h3>gtk_source_mark_get_category ()</h3>
136
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       gtk_source_mark_get_category        (<em class="parameter"><code><a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> *mark</code></em>);</pre>
 
136
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gtk_source_mark_get_category        (<em class="parameter"><code><a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> *mark</code></em>);</pre>
137
137
<p>
138
138
Returns the mark category
139
139
</p>
159
159
<div class="refsect2" title="gtk_source_mark_next ()">
160
160
<a name="gtk-source-mark-next"></a><h3>gtk_source_mark_next ()</h3>
161
161
<pre class="programlisting"><a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="returnvalue">GtkSourceMark</span></a> *     gtk_source_mark_next                (<em class="parameter"><code><a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> *mark</code></em>,
162
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *category</code></em>);</pre>
 
162
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *category</code></em>);</pre>
163
163
<p>
164
 
Returns the next <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> in the buffer or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if the mark
165
 
was not added to a buffer. If there is no next mark, <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> will be returned.
 
164
Returns the next <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> in the buffer or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the mark
 
165
was not added to a buffer. If there is no next mark, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> will be returned.
166
166
</p>
167
167
<p>
168
 
If <em class="parameter"><code>category</code></em> is <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, looks for marks of any category
 
168
If <em class="parameter"><code>category</code></em> is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, looks for marks of any category
169
169
</p>
170
170
<div class="variablelist"><table border="0">
171
171
<col align="left" valign="top">
177
177
</tr>
178
178
<tr>
179
179
<td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td>
180
 
<td>a string specifying the mark category or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
180
<td>a string specifying the mark category or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
181
181
</td>
182
182
</tr>
183
183
<tr>
184
184
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
185
 
<td> the next <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
185
<td> the next <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
186
186
 
187
187
</td>
188
188
</tr>
194
194
<div class="refsect2" title="gtk_source_mark_prev ()">
195
195
<a name="gtk-source-mark-prev"></a><h3>gtk_source_mark_prev ()</h3>
196
196
<pre class="programlisting"><a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="returnvalue">GtkSourceMark</span></a> *     gtk_source_mark_prev                (<em class="parameter"><code><a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> *mark</code></em>,
197
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *category</code></em>);</pre>
 
197
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *category</code></em>);</pre>
198
198
<p>
199
 
Returns the previous <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> in the buffer or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if the mark
200
 
was not added to a buffer. If there is no previous mark, <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned.
 
199
Returns the previous <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> in the buffer or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the mark
 
200
was not added to a buffer. If there is no previous mark, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned.
201
201
</p>
202
202
<p>
203
 
If <em class="parameter"><code>category</code></em> is <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, looks for marks of any category
 
203
If <em class="parameter"><code>category</code></em> is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, looks for marks of any category
204
204
</p>
205
205
<div class="variablelist"><table border="0">
206
206
<col align="left" valign="top">
212
212
</tr>
213
213
<tr>
214
214
<td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td>
215
 
<td>a string specifying the mark category or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
215
<td>a string specifying the mark category or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
216
216
</td>
217
217
</tr>
218
218
<tr>
219
219
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
220
 
<td> the previous <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
220
<td> the previous <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
221
221
 
222
222
</td>
223
223
</tr>
230
230
<a name="GtkSourceMark.property-details"></a><h2>Property Details</h2>
231
231
<div class="refsect2" title='The "category" property'>
232
232
<a name="GtkSourceMark--category"></a><h3>The <code class="literal">"category"</code> property</h3>
233
 
<pre class="programlisting">  "category"                 <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
 
233
<pre class="programlisting">  "category"                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
234
234
<p>
235
235
The category of the <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a>, classifies the mark and controls
236
236
which pixbuf is used and with which priority it is drawn.
245
245
</div>
246
246
<div class="footer">
247
247
<hr>
248
 
          Generated by GTK-Doc V1.15.1</div>
 
248
          Generated by GTK-Doc V1.14</div>
249
249
</body>
250
250
</html>
 
 
b'\\ No newline at end of file'