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
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gtksourcemarker">
<refnamediv>
<refname>gtksourceview.SourceMarker</refname>
<refpurpose>Marker object for <link linkend="class-gtksourceview">gtksourceview.SourceView</link></refpurpose>
</refnamediv>
<!-- ********************************* -->
<!-- BEGIN OF GTKSOURCEMARKER SYNOPSIS -->
<!-- ********************************* -->
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtksourceview.SourceMarker</classname></ooclass>
<ooclass><classname><link linkend="class-gtktextmark">gtk.TextMark</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-gtksourcemarker">gtksourceview.SourceMarker</link></methodname>
<methodparam><parameter role="keyword"></parameter></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtksourcemarker--set-marker-type">set_marker_type</link></methodname>
<methodparam>type</methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtksourcemarker--get-marker-type">get_marker_type</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtksourcemarker--get-line">get_line</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtksourcemarker--get-name">get_name</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtksourcemarker--get-buffer">get_buffer</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtksourcemarker--next">next</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtksourcemarker--prev">prev</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<!-- ********************************* -->
<!-- BEGIN OF GTKSOURCEMARKER ANCESTRY -->
<!-- ********************************* -->
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gtksourcemarker">gtksourceview.SourceMarker</link>
</synopsis>
</refsect1>
<!-- ************************************ -->
<!-- BEGIN OF GTKSOURCEMARKER DESCRIPTION -->
<!-- ************************************ -->
<refsect1 id="description-gtktextmarker">
<title>Description</title>
<para>
</para>
</refsect1>
<!-- ************************************ -->
<!-- BEGIN OF GTKSOURCEMARKER CONSTRUCTOR -->
<!-- ************************************ -->
<refsect1 id="constructor-gtksourcemarker">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtksourceview.SourceMarker</methodname>
<methodparam><parameter role="keyword"></parameter></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new <link linkend="class-gtksourcemarker"><classname>gtksourceview.SourceMarker</classname></link>.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
Creates a new <link linkend="class-gtksourcemarker"><classname>gtksourceview.SourceMarker</classname></link> object.
</para>
</refsect1>
<!-- ******************************** -->
<!-- BEGIN OF GTKSOURCEMARKER METHODS -->
<!-- ******************************** -->
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtksourcemarker--set-marker-type">
<title>gtksourceview.SourceMarker.set_marker_type</title>
<programlisting><methodsynopsis language="python">
<methodname>set_marker_type</methodname>
<methodparam><parameter role="keyword">type</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">type</parameter> :</term>
<listitem><simpara> the type of marker.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>set_marker_type</methodname>() method sets the type of marker to the value of <parameter>type</parameter>.
</para>
</refsect2>
<refsect2 id="method-gtksourcemarker--get-marker-type">
<title>gtksourceview.SourceMarker.get_marker_type</title>
<programlisting><methodsynopsis language="python">
<methodname>get_marker_type</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara> the marker type.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_marker_type</methodname>() method gets the marker type of this <parameter>marker</parameter>.
</para>
</refsect2>
<refsect2 id="method-gtksourcemarker--get-line">
<title>gtksourceview.SourceMarker.get_line</title>
<programlisting><methodsynopsis language="python">
<methodname>get_line</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara> the line number.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_line</methodname>() method gets the line number of this <parameter>marker</parameter>.
</para>
</refsect2>
<refsect2 id="method-gtksourcemarker--get-name">
<title>gtksourceview.SourceMarker.get_name</title>
<programlisting><methodsynopsis language="python">
<methodname>get_name</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara> the name.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_name</methodname>() method gets the name of this <parameter>marker</parameter>.
</para>
</refsect2>
<refsect2 id="method-gtksourcemarker--get-buffer">
<title>gtksourceview.SourceMarker.get_buffer</title>
<programlisting><methodsynopsis language="python">
<methodname>get_buffer</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara> the <link linkend="class-gtksourcebuffer"><classname>gtksourceview.SourceBuffer</classname></link>.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_buffer</methodname>() method gets the buffer associated with this <parameter>marker</parameter>.
</para>
</refsect2>
<refsect2 id="method-gtksourcemarker--next">
<title>gtksourceview.SourceMarker.next</title>
<programlisting><methodsynopsis language="python">
<methodname>next</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara> a <link linkend="class-gtksourcemarker"><classname>gtksourceview.SourceMarker</classname></link>.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>next</methodname>() method gets the next marker after <parameter>marker</parameter>.
</para>
</refsect2>
<refsect2 id="method-gtksourcemarker--prev">
<title>gtksourceview.SourceMarker.prev</title>
<programlisting><methodsynopsis language="python">
<methodname>prev</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara> a <link linkend="class-gtksourcemarker"><classname>gtksourceview.SourceMarker</classname></link>.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>prev</methodname>() method gets the previous marker before <parameter>marker</parameter>.
</para>
</refsect2>
</refsect1>
</refentry>
|