/usr/share/gtk-doc/html/pygtksourceview2/class-gtksourcebuffer2.html is in python-gtksourceview2 2.10.1-3.
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 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtksourceview2.Buffer</title><link rel="stylesheet" type="text/css" href="style.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="PyGtksourceview2 Reference Manual"><link rel="up" href="index.html" title="PyGtksourceview2 Reference Manual"><link rel="prev" href="class-gtksourceview2.html" title="gtksourceview2.View"><link rel="next" href="class-gtksourcegutter2.html" title="gtksourceview2.Gutter"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtksourceview2.Buffer</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtksourceview2.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="class-gtksourcegutter2.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="class-gtksourcebuffer2"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtksourceview2.Buffer</h2><p>gtksourceview2.Buffer — Text buffer object for <a class="link" href="class-gtksourceview2.html" title="gtksourceview2.View">gtksourceview2.View</a></p></div><div class="refsect1"><a name="idm1191"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtksourceview2.Buffer</span></span>(<span class="ooclass"><span class="classname">gtk.TextBuffer</span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#constructor-gtksourcebuffer2" title="Constructor">gtksourceview2.Buffer</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>buffer</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--backward-iter-to-source-mark" title="gtksourceview2.Buffer.backward_iter_to_source_mark">backward_iter_to_source_mark</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>iter</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>category</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--begin-not-undoable-action" title="gtksourceview2.Buffer.begin_not_undoable_action">begin_not_undoable_action</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--can-redo" title="gtksourceview2.Buffer.can_redo">can_redo</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--can-undo" title="gtksourceview2.Buffer.can_undo">can_undo</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--create-source-mark" title="gtksourceview2.Buffer.create_source_mark">create_source_mark</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>category</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>where</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--end-not-undoable-action" title="gtksourceview2.Buffer.end_not_undoable_action">end_not_undoable_action</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--ensure-highlight" title="gtksourceview2.Buffer.ensure_highlight">ensure_highlight</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>start</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>end</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--forward-iter-to-source-mark" title="gtksourceview2.Buffer.forward_iter_to_source_mark">forward_iter_to_source_mark</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>iter</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>category</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--get-highlight-matching-brackets" title="gtksourceview2.Buffer.get_highlight_matching_brackets">get_highlight_matching_brackets</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--get-highlight-syntax" title="gtksourceview2.Buffer.get_highlight_syntax">get_highlight_syntax</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--get-language" title="gtksourceview2.Buffer.get_language">get_language</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--get-source-marks-at-iter" title="gtksourceview2.Buffer.get_source_marks_at_iter">get_source_marks_at_iter</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>iter</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>category</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--get-source-marks-at-line" title="gtksourceview2.Buffer.get_source_marks_at_line">get_source_marks_at_line</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>line</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>category</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--get-max-undo-levels" title="gtksourceview2.Buffer.get_max_undo_levels">get_max_undo_levels</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--get-style-scheme" title="gtksourceview2.Buffer.get_style_scheme">get_style_scheme</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--redo" title="gtksourceview2.Buffer.redo">redo</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--remove-source-marks" title="gtksourceview2.Buffer.remove_source_marks">remove_source_marks</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>start</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>end</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>category</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--set-highlight-matching-brackets" title="gtksourceview2.Buffer.set_highlight_matching_brackets">set_highlight_matching_brackets</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>highlight</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--set-highlight-syntax" title="gtksourceview2.Buffer.set_highlight_syntax">set_highlight_syntax</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>highlight</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--set-language" title="gtksourceview2.Buffer.set_language">set_language</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>language</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--set-max-undo-levels" title="gtksourceview2.Buffer.set_max_undo_levels">set_max_undo_levels</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>max_undo_levels</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--set-style-scheme" title="gtksourceview2.Buffer.set_style_scheme">set_style_scheme</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>scheme</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--undo" title="gtksourceview2.Buffer.undo">undo</a></span>()</code><br></pre></td></tr></table><pre class="programlisting">
<span class="bold"><strong>Functions</strong></span>
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#function-gtksourcebuffer2--iter-backward-search" title="gtksourceview2.iter_backward_search">gtksourceview2.iter_backward_search</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>iter</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>str</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>limit</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcebuffer2.html#function-gtksourcebuffer2--iter-forward-search" title="gtksourceview2.iter_forward_search">gtksourceview2.iter_forward_search</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>iter</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>str</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>limit</code></strong></span></span>)</code></pre></div><div class="refsect1"><a name="idm1355"></a><h2>Ancestry</h2><pre class="synopsis">+-- <a
href="../pygobject/class-gobject.html"
>gobject.GObject</a>
+-- gtk.TextBuffer
+-- <a class="link" href="class-gtksourcebuffer2.html" title="gtksourceview2.Buffer">gtksourceview2.Buffer</a>
</pre></div><div class="refsect1"><a name="idm1361"></a><h2>Properties</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table class="informaltable" width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="4in"></colgroup><tbody><tr valign="top"><td valign="top">"can-redo"</td><td valign="top">Read</td><td valign="top">Whether Redo operation is possible. Default value: False.</td></tr><tr valign="top"><td valign="top">"can-undo"</td><td valign="top">Read</td><td valign="top">Whether Undo operation is possible. Default value: False.</td></tr><tr valign="top"><td valign="top">"highlight-matching-brackets"</td><td valign="top">Read-Write</td><td valign="top">Whether to highlight matching brackets in the buffer. Default value: True.</td></tr><tr valign="top"><td valign="top">"highlight-syntax"</td><td valign="top">Read-Write</td><td valign="top">Whether to highlight syntax in the buffer. Default value: True.</td></tr><tr valign="top"><td valign="top">"language"</td><td valign="top">Read-Write</td><td valign="top">Language object to get highlighting patterns from.</td></tr><tr valign="top"><td valign="top">"max-undo-levels"</td><td valign="top">Read-Write</td><td valign="top">Number of undo levels for the buffer. -1 means no limit. Allowed values: >= -1 Default value: 1000.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1"><a name="idm1394"></a><h2>Signal Prototypes</h2><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><a class="link" href="class-gtksourcebuffer2.html#signal-gtksourcebuffer2--highlight-updated" title='The "highlight-updated" gtksourceview2.Buffer Signal'>"highlight-updated"</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>sourceview</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>arg1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>arg2</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"source-mark-updated"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>sourceview</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>arg1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1"><a name="description-gtksourcebuffer2"></a><h2>Description</h2><p>
The <a class="link" href="class-gtksourcebuffer2.html" title="gtksourceview2.Buffer"><code class="classname">gtksourceview2.Buffer</code></a>
is the model for <a class="link" href="class-gtksourceview2.html" title="gtksourceview2.View"><code class="classname">gtksourceview.View</code></a>
widgets. It extends the <code class="classname">gtk.TextBuffer</code>
object by adding features necessary to display and edit source code: syntax highlighting, bracket matching and markers.
It also implements support for undo/redo operations.
</p><p>
To create a <a class="link" href="class-gtksourcebuffer2.html" title="gtksourceview2.Buffer"><code class="classname">gtksourceview2.Buffer</code></a>
use the <a class="link" href="class-gtksourcebuffer2.html#constructor-gtksourcebuffer2" title="Constructor">constructor</a>.
</p><p>
By default highlighting is enabled, but you can disable it with
<a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--set-highlight-syntax" title="gtksourceview2.Buffer.set_highlight_syntax"><code class="methodname">set_highlight_syntax</code>()</a>.
</p></div><div class="refsect1"><a name="constructor-gtksourcebuffer2"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtksourceview2.Buffer</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>table</code></strong></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>language</code></strong></span><span class="initializer">=None</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>table</code></strong> :</span></p></td><td>a <code class="classname">gtk.TextTagTable</code>
or <code class="literal">None</code></td></tr><tr><td><p><span class="term"><strong class="parameter"><code>language</code></strong> :</span></p></td><td>a <a class="link" href="class-gtksourcelanguage2.html" title="gtksourceview2.Language"><code class="classname">gtksourceview2.Language</code></a>
or <code class="literal">None</code></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-gtksourcebuffer2.html" title="gtksourceview2.Buffer"><code class="classname">gtksourceview2.Buffer</code></a>.
</td></tr></tbody></table><p>
Creates a new <a class="link" href="class-gtksourcebuffer2.html" title="gtksourceview2.Buffer"><code class="classname">gtksourceview2.Buffer</code></a> object.
</p></div><div class="refsect1"><a name="idm1481"></a><h2>Methods</h2><div class="refsect2"><a name="method-gtksourcebuffer2--backward-iter-to-source-mark"></a><h3>gtksourceview2.Buffer.backward_iter_to_source_mark</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">backward_iter_to_source_mark</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>iter</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>category</code></strong></span><span class="initializer">=None</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>iter</code></strong> :</span></p></td><td>a <code class="classname">gtk.TextIter</code></td></tr><tr><td><p><span class="term"><strong class="parameter"><code>category</code></strong> :</span></p></td><td>category to search for or <code class="literal">None</code>.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>whether iter moved.</td></tr></tbody></table><p>
The <code class="methodname">backward_iter_to_source_mark</code>() method moves iter to the
position of the previous <a class="link" href="class-gtksourcemark2.html" title="gtksourceview2.Mark"><code class="classname">gtksourceview2.Mark</code></a>
of the given category. Returns <code class="literal">True</code> if iter was moved.
If category is <code class="literal">None</code>, the previous source mark can be of any category.
</p></div><div class="refsect2"><a name="method-gtksourcebuffer2--begin-not-undoable-action"></a><h3>gtksourceview2.Buffer.begin_not_undoable_action</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">begin_not_undoable_action</span>(<span class="methodparam"></span>)</code></pre><p>
The <code class="methodname">begin_not_undoable_action</code>() marks the beginning of a not undoable action on the buffer,
disabling the undo manager. Typically you would call this function before initially setting the contents of the buffer
(e.g. when loading a file in a text editor).
</p><p>
You may nest <code class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--begin-not-undoable-action" title="gtksourceview2.Buffer.begin_not_undoable_action">begin_not_undoable_action</a></code>() /
<code class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--end-not-undoable-action" title="gtksourceview2.Buffer.end_not_undoable_action">end_not_undoable_action</a></code>() blocks.
</p></div><div class="refsect2"><a name="method-gtksourcebuffer2--can-redo"></a><h3>gtksourceview2.Buffer.can_redo</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">can_redo</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> <code class="literal">True</code> if a redo is possible.</td></tr></tbody></table><p>
The <code class="methodname">can_redo</code>() method Determines whether a source buffer can redo the last action
(i.e. if the last operation was an undo).
</p></div><div class="refsect2"><a name="method-gtksourcebuffer2--can-undo"></a><h3>gtksourceview2.Buffer.can_undo</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">can_undo</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> <code class="literal">True</code> if it's possible to undo the last action.</td></tr></tbody></table><p>
The <code class="methodname">can_undo</code>() method determines whether a source buffer can undo the last action.
</p></div><div class="refsect2"><a name="method-gtksourcebuffer2--create-source-mark"></a><h3>gtksourceview2.Buffer.create_source_mark</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">create_source_mark</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>category</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>where</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>name</code></strong> :</span></p></td><td>the name of the mark, or <code class="literal">None</code>.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>category</code></strong> :</span></p></td><td>a string defining the mark category.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>where</code></strong> :</span></p></td><td>location to place the mark.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> a new
<a class="link" href="class-gtksourcemark2.html" title="gtksourceview2.Mark"><code class="classname">gtksourceview2.Mark</code></a>
</td></tr></tbody></table><p>
The <code class="methodname">create_source_mark</code>() method creates a mark in the
<code class="methodname"><a class="link" href="class-gtksourcebuffer2.html#constructor-gtksourcebuffer2" title="Constructor">gtksourceview2.Buffer</a></code> of category
<em class="parameter"><code>category</code></em>. A mark is semantically very similar to a
<code class="classname">gtk.TextMark</code>, but organised into categories.
</p><p>
Like a <code class="classname">gtk.TextMark</code>, a
<a class="link" href="class-gtksourcemark2.html" title="gtksourceview2.Mark"><code class="classname">gtksourceview2.Mark</code></a>
can be anonymous if the passed name is <code class="literal">None</code>.
</p><p>
Like a <code class="classname">gtk.TextMark</code>, a
<code class="classname">gtksourceview2.Marker</code>
can be anonymous if the passed <em class="parameter"><code>name</code></em> is <code class="literal">None</code>.
Also, the buffer owns the markers so you shouldn't unreference it.
</p><p>
Marks always have left gravity and are moved to the beginning of the line when the user deletes the line they were in.
Also, if the user deletes a region of text which contained lines with markers, those are deleted.
</p><p>
Typical uses for marks are bookmarks, breakpoints, current executing instruction indication in a source file, etc..
</p></div><div class="refsect2"><a name="method-gtksourcebuffer2--end-not-undoable-action"></a><h3>gtksourceview2.Buffer.end_not_undoable_action</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">end_not_undoable_action</span>(<span class="methodparam"></span>)</code></pre><p>
The <code class="methodname">end_not_undoable_action</code>() method marks the end of a not undoable action on the buffer.
When the last not undoable block is closed through the call to this function, the list of undo actions is cleared
and the undo manager is re-enabled.
</p></div><div class="refsect2"><a name="method-gtksourcebuffer2--ensure-highlight"></a><h3>gtksourceview2.Buffer.ensure_highlight</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">ensure_highlight</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>start</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>end</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>start</code></strong> :</span></p></td><td>start of the area to highlight.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>end</code></strong> :</span></p></td><td>end of the area to highlight.</td></tr></tbody></table><p>
The <code class="methodname">ensure_highlight</code>() method forces buffer to analyze
and highlight the given area synchronously.
</p></div><div class="refsect2"><a name="method-gtksourcebuffer2--forward-iter-to-source-mark"></a><h3>gtksourceview2.Buffer.forward_iter_to_source_mark</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">forward_iter_to_source_mark</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>iter</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>category</code></strong></span><span class="initializer">=None</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>iter</code></strong> :</span></p></td><td>a <code class="classname">gtk.TextIter</code></td></tr><tr><td><p><span class="term"><strong class="parameter"><code>category</code></strong> :</span></p></td><td>category to search for or <code class="literal">None</code>.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>whether iter moved.</td></tr></tbody></table><p>
The <code class="methodname">forward_iter_to_source_mark</code>() method moves iter to the
position of the next <a class="link" href="class-gtksourcemark2.html" title="gtksourceview2.Mark"><code class="classname">gtksourceview2.Mark</code></a>
of the given category. Returns <code class="literal">True</code> if iter was moved.
If category is <code class="literal">None</code>, the previous source mark can be of any category.
</p></div><div class="refsect2"><a name="method-gtksourcebuffer2--get-highlight-matching-brackets"></a><h3>gtksourceview2.Buffer.get_highlight_matching_brackets</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_highlight_matching_brackets</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the matching brackets highlight is active,
<code class="literal">False</code> otherwise.</td></tr></tbody></table><p>
The <code class="methodname">get_highlight_matching_brackets</code>() method determines whether
bracket match highlighting is activated for the source buffer.
</p></div><div class="refsect2"><a name="method-gtksourcebuffer2--get-highlight-syntax"></a><h3>gtksourceview2.Buffer.get_highlight_syntax</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_highlight_syntax</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the source highlighting is activated in the buffer,
<code class="literal">False</code> otherwise.</td></tr></tbody></table><p>
The <code class="methodname">get_highlight_syntax</code>() method determines whether
syntax highlighting is activated in the source buffer.
</p></div><div class="refsect2"><a name="method-gtksourcebuffer2--get-language"></a><h3>gtksourceview2.Buffer.get_language</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_language</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> the
<a class="link" href="class-gtksourcelanguage2.html" title="gtksourceview2.Language"><code class="classname">gtksourceview2.Language</code></a>
set by <code class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--set-language" title="gtksourceview2.Buffer.set_language">set_language</a></code>.
</td></tr></tbody></table><p>
The <code class="methodname">get_language</code>() method returns the
<a class="link" href="class-gtksourcelanguage2.html" title="gtksourceview2.Language"><code class="classname">gtksourceview2.Language</code></a>
associated with the buffer, see
<code class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--set-language" title="gtksourceview2.Buffer.set_language">gtksourceview2.Buffer.set_language</a></code>().
</p></div><div class="refsect2"><a name="method-gtksourcebuffer2--get-source-marks-at-iter"></a><h3>gtksourceview2.Buffer.get_source_marks_at_iter</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_source_marks_at_iter</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>iter</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>category</code></strong></span><span class="initializer">=None</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>iter</code></strong> :</span></p></td><td>a <code class="classname">gtk.TextIter</code>.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>category</code></strong> :</span></p></td><td>category to search for or <code class="literal">None</code></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> a list of <a class="link" href="class-gtksourcemark2.html" title="gtksourceview2.Mark"><code class="classname">gtksourceview2.Mark</code></a>.</td></tr></tbody></table><p>
The <code class="methodname">get_source_marks_at_iter</code>() method returns the list of marks
of the given category at iter. If category is <code class="literal">None</code>
it returns all marks at iter.
</p></div><div class="refsect2"><a name="method-gtksourcebuffer2--get-source-marks-at-line"></a><h3>gtksourceview2.Buffer.get_source_marks_at_line</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_source_marks_at_line</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>iter</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>category</code></strong></span><span class="initializer">=None</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>iter</code></strong> :</span></p></td><td>a <code class="classname">gtk.TextIter</code>.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>category</code></strong> :</span></p></td><td>category to search for or <code class="literal">None</code></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> a list of <a class="link" href="class-gtksourcemark2.html" title="gtksourceview2.Mark"><code class="classname">gtksourceview2.Mark</code></a>.</td></tr></tbody></table><p>
The <code class="methodname">get_source_marks_at_line</code>() method returns the list of marks
of the given category at line. If category is <code class="literal">None</code>
it returns all marks at line.
</p></div><div class="refsect2"><a name="method-gtksourcebuffer2--get-max-undo-levels"></a><h3>gtksourceview2.Buffer.get_max_undo_levels</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_max_undo_levels</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the maximum number of possible undo levels or -1 if no limit is set.</td></tr></tbody></table><p>
The <code class="methodname">get_max_undo_levels</code>() method determines the number
of undo levels the buffer will track for buffer edits.
</p></div><div class="refsect2"><a name="method-gtksourcebuffer2--get-style-scheme"></a><h3>gtksourceview2.Buffer.get_style_scheme</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_style_scheme</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the <code class="classname">gtksourceview2.StyleScheme</code>
set by <code class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--set-style-scheme" title="gtksourceview2.Buffer.set_style_scheme">gtksourceview2.Buffer.set_style_scheme</a></code>(),
or <code class="literal">None</code>.</td></tr></tbody></table><p>
The <code class="methodname">get_style_scheme</code>() method returns the nearest marker to
the right of <em class="parameter"><code>iter</code></em>. If there are multiple markers at the same position,
this function will always return the first one (from the internal linked list), even if starting the search exactly at its location.
You can get the others using <code class="methodname">gtksourceview2.Marker.next</code>().
</p></div><div class="refsect2"><a name="method-gtksourcebuffer2--redo"></a><h3>gtksourceview2.Buffer.redo</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">redo</span>(<span class="methodparam"></span>)</code></pre><p>
The <code class="methodname">redo</code>() method redoes the last undo operation. Use
<code class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--can-redo" title="gtksourceview2.Buffer.can_redo">gtksourceview2.Buffer.can_redo</a></code>
to check whether a call to this function will have any effect.
</p></div><div class="refsect2"><a name="method-gtksourcebuffer2--remove-source-marks"></a><h3>gtksourceview2.Buffer.remove_source_marks</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">remove_source_marks</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>start</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>end</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>category</code></strong></span><span class="initializer">=None</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>start</code></strong> :</span></p></td><td>a <code class="classname">gtk.TextIter</code></td></tr><tr><td><p><span class="term"><strong class="parameter"><code>end</code></strong> :</span></p></td><td>a <code class="classname">gtk.TextIter</code></td></tr><tr><td><p><span class="term"><strong class="parameter"><code>category</code></strong> :</span></p></td><td>category to search for or <code class="literal">None</code>.</td></tr></tbody></table><p>
The <code class="methodname">remove_source_marks</code>() method remove all marks of category
between start and end from the buffer. If category is <code class="literal">None</code>,
all marks in the range will be removed.
</p></div><div class="refsect2"><a name="method-gtksourcebuffer2--set-highlight-matching-brackets"></a><h3>gtksourceview2.Buffer.set_highlight_matching_brackets</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_highlight_matching_brackets</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>highlight</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>highlight</code></strong> :</span></p></td><td><code class="literal">True</code> if you want matching brackets highlighted.</td></tr></tbody></table><p>
The <code class="methodname">set_highlight_matching_brackets</code>() method Controls the bracket
match highlighting function in the buffer. If activated, when you position your
ursor over a bracket character (a parenthesis, a square bracket, etc.) the matching
opening or closing bracket character will be highlighted.
</p></div><div class="refsect2"><a name="method-gtksourcebuffer2--set-highlight-syntax"></a><h3>gtksourceview2.Buffer.set_highlight_syntax</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_highlight_syntax</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>highlight</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>highlight</code></strong> :</span></p></td><td><code class="literal">True</code> to enable syntax highlighting,
<code class="literal">False</code> to disable it.</td></tr></tbody></table><p>
The <code class="methodname">set_highlight_syntax</code>() method controls whether syntax
is highlighted in the buffer. If highlight is <code class="literal">True</code>, the text
will be highlighted according to the syntax patterns specified in the language set
with <code class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--can-redo" title="gtksourceview2.Buffer.can_redo">gtksourceview2.Buffer.set_language</a></code>().
If highlight is <code class="literal">False</code>, syntax highlighting is disabled and all
the GtkTextTag objects that have been added by the syntax highlighting
engine are removed from the buffer.
</p></div><div class="refsect2"><a name="method-gtksourcebuffer2--set-language"></a><h3>gtksourceview2.Buffer.set_language</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_language</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>language</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>language</code></strong> :</span></p></td><td>A <a class="link" href="class-gtksourcelanguage2.html" title="gtksourceview2.Language"><code class="classname">gtksourceview2.Language</code></a>
or <code class="literal">None</code>.</td></tr></tbody></table><p>
The <code class="methodname">set_language</code>() method associate a
<a class="link" href="class-gtksourcelanguage2.html" title="gtksourceview2.Language"><code class="classname">gtksourceview2.Language</code></a>
with the source buffer. If language is not-<code class="literal">None</code> and syntax highlighting is
enabled (see <code class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--set-highlight-syntax" title="gtksourceview2.Buffer.set_highlight_syntax">gtksourceview2.Buffer.set_highlight_syntax</a></code>()),
the syntax patterns defined in language will be used to highlight the text contained in the buffer.
If language is <code class="literal">None</code>, the text contained in the buffer is not highlighted.
</p></div><div class="refsect2"><a name="method-gtksourcebuffer2--set-max-undo-levels"></a><h3>gtksourceview2.Buffer.set_max_undo_levels</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_max_undo_levels</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>max_undo_levels</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>max_undo_levels</code></strong> :</span></p></td><td>the desired maximum number of undo levels.</td></tr></tbody></table><p>
The <code class="methodname">set_max_undo_levels</code>() method sets the number of undo levels for user actions
the buffer will track. If the number of user actions exceeds the limit set by this function, older actions will be discarded.
</p><p>
If max_undo_levels is -1, no limit is set.
</p><p>
A new action is started whenever the function
<code class="methodname">gtk.TextBuffer.begin_user_action</code>
is called. In general, this happens whenever the user presses any key which modifies the buffer, but the undo manager
will try to merge similar consecutive actions, such as multiple character insertions into one action.
But, inserting a newline does start a new action.
</p></div><div class="refsect2"><a name="method-gtksourcebuffer2--set-style-scheme"></a><h3>gtksourceview2.Buffer.set_style_scheme</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_style_scheme</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>scheme</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>scheme</code></strong> :</span></p></td><td>a style scheme.</td></tr></tbody></table><p>
The <code class="methodname">set_style_scheme</code>() method sets the style scheme used by the buffer.
</p></div><div class="refsect2"><a name="method-gtksourcebuffer2--undo"></a><h3>gtksourceview2.Buffer.undo</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">undo</span>(<span class="methodparam"></span>)</code></pre><p>
The <code class="methodname">undo</code>() Undoes the last user action which modified the buffer. Use
<code class="methodname"><a class="link" href="class-gtksourcebuffer2.html#method-gtksourcebuffer2--can-undo" title="gtksourceview2.Buffer.can_undo">gtksourceview2.Buffer.can_undo</a></code>
to check whether a call to this function will have any effect.
</p><p>
Actions are defined as groups of operations between a call to
<code class="methodname">gtk.TextBuffer.begin_user_action</code>() and
<code class="methodname">gtk.TextBuffer.end_user_action</code>(),
or sequences of similar edits (inserts or deletes) on the same line.
</p></div></div><div class="refsect1"><a name="idm1997"></a><h2>Signals</h2><div class="refsect2"><a name="signal-gtksourcebuffer2--highlight-updated"></a><h3>The "highlight-updated" gtksourceview2.Buffer Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>sourcebuffer</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>start</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>end</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>sourcebuffer</code></em> :</span></p></td><td>the sourcebuffer that received the signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>start</code></em> :</span></p></td><td>the <code class="classname">gtk.TextIter</code>
at the start of the updated region.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>end</code></em> :</span></p></td><td>the <code class="classname">gtk.TextIter</code>
at the end of the updated region.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified with the
<a
href="../pygobject/class-gobject.html#method-gobject--connect"
><code class="methodname">connect</code>()</a> method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if any)</td></tr></tbody></table><p>
The "highlight-updated" signal is emitted whenever the syntax highlighting information has been updated,
so that views can request a redraw if the region changed is visible. Usually only view widgets displaying
this buffer will be interested in this signal.
</p></div><div class="refsect2"><a name="signal-gtksourcebuffer2-source--mark-updated"></a><h3>The "marker-updated" gtksourceview2.Buffer Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>sourcebuffer</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>arg1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>sourcebuffer</code></em> :</span></p></td><td>the sourcebuffer that received the signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td><td>the <code class="classname">gtk.TextMark</code>
at the location where the change occurred.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified with the
<a
href="../pygobject/class-gobject.html#method-gobject--connect"
><code class="methodname">connect</code>()</a> method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if any)</td></tr></tbody></table><p>
The "source-mark-updated" signal is emitted whenever a mark is added to, moved or removed from the buffer.
</p></div></div><div class="refsect1"><a name="idm2086"></a><h2>Functions</h2><div class="refsect2"><a name="function-gtksourcebuffer2--iter-backward-search"></a><h3>gtksourceview2.iter_backward_search</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtksourceview2.iter_backward_search</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>iter</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>str</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>limit</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>iter</em></span> :</span></p></td><td>
a <code class="classname">gtk.TextIter</code> where the search begins.
</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>str</em></span> :</span></p></td><td>
search string.
</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>flags</em></span> :</span></p></td><td>
bitmask of flags affecting the search.
</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>limit</em></span> :</span></p></td><td>
location of last possible match_start, or <code class="literal">None</code> for start of buffer.
</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>
start of match and end of match
</td></tr></tbody></table><p>
The <code class="methodname">iter_backward_search</code>() function is the same as the
<code class="methodname"><a class="link" href="class-gtksourcebuffer2.html#function-gtksourcebuffer2--iter-forward-search" title="gtksourceview2.iter_forward_search">gtksourceview2.iter_forward_search</a></code>()
function, except searches backward.
</p></div><div class="refsect2"><a name="function-gtksourcebuffer2--iter-forward-search"></a><h3>gtksourceview2.iter_forward_search</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtksourceview2.iter_forward_search</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>iter</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>str</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>limit</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>iter</em></span> :</span></p></td><td>
a <code class="classname">gtk.TextIter</code> where the search begins.
</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>str</em></span> :</span></p></td><td>
search string.
</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>flags</em></span> :</span></p></td><td>
bitmask of flags affecting the search.
</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>limit</em></span> :</span></p></td><td>
bound for the search, or <code class="literal">None</code> for the end of the buffer.
</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>
start of match and end of match
</td></tr></tbody></table><p>
The <code class="methodname">iter_forward_search</code>() function searches forward for <em class="parameter"><code>str</code></em>
and returns a tuple containing <code class="classname">gtk.TextIter</code>
objects that point at the start and end locations of the match.
The search will not continue past limit. Note that a search is a linear or O(n) operation,
so you may wish to use limit to avoid locking up your UI on large buffers.
</p><p>
If the gtksourceview2.SOURCE_SEARCH_VISIBLE_ONLY flag is present, the match may have invisible text
interspersed in str. i.e. str will be a possibly-noncontiguous subsequence of the matched range.
similarly, if you specify gtksourceview2.SOURCE_SEARCH_TEXT_ONLY, the match may have pixbufs or
child widgets mixed inside the matched range. If these flags are not given, the match must be exact;
the special 0xFFFC character in str will match embedded pixbufs or child widgets. If you specify the
gtksourceview2.SOURCE_SEARCH_CASE_INSENSITIVE flag, the text will be matched regardless of what case it is in.
</p><p>
Same as <code class="methodname">gtk.TextIter.forward_search</code>(),
but supports case insensitive searching.
</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gtksourceview2.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="class-gtksourcegutter2.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtksourceview2.View </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtksourceview2.Gutter</td></tr></table></div></body></html>
|