pygtksourceview r66 - in trunk: . docs docs/reference
- From: gianmt svn gnome org
- To: svn-commits-list gnome org
- Subject: pygtksourceview r66 - in trunk: . docs docs/reference
- Date: Sun, 6 Jan 2008 17:02:36 +0000 (GMT)
Author: gianmt
Date: Sun Jan 6 17:02:36 2008
New Revision: 66
URL: http://svn.gnome.org/viewvc/pygtksourceview?rev=66&view=rev
Log:
update docs with new mark API
Added:
trunk/docs/reference/gtksourceview2-gtksourcemark.xml
Removed:
trunk/docs/reference/gtksourceview2-gtksourcemarker.xml
Modified:
trunk/ChangeLog
trunk/docs/Makefile.am
trunk/docs/reference/gtksourceview2-gtksourcebuffer.xml
trunk/docs/reference/gtksourceview2-gtksourceview.xml
trunk/docs/reference/gtksourceview2-ref.xml
trunk/gtksourceview2.defs
Modified: trunk/ChangeLog
==============================================================================
--- trunk/ChangeLog (original)
+++ trunk/ChangeLog Sun Jan 6 17:02:36 2008
@@ -1,5 +1,18 @@
2008-01-05 Gian Mario Tagliaretti <gianmt gnome org>
+ * gtksourceview2.defs: Fix null-ok in parameters.
+
+ * docs/reference/gtksourceview2-gtksourcemarker.xml: remove old docs.
+
+ * docs/reference/gtksourceview2-gtksourcemark.xml: add new mark docs.
+
+ * docs/Makefile.am:
+ * docs/reference/gtksourceview2-gtksourcebuffer.xml:
+ * docs/reference/gtksourceview2-gtksourceview.xml:
+ * docs/reference/gtksourceview2-ref.xml: New mark API documented.
+
+2008-01-05 Gian Mario Tagliaretti <gianmt gnome org>
+
* gtksourceview2.defs:
* gtksourceview2.override: add the new GtkSourceMark stuff.
Modified: trunk/docs/Makefile.am
==============================================================================
--- trunk/docs/Makefile.am (original)
+++ trunk/docs/Makefile.am Sun Jan 6 17:02:36 2008
@@ -12,6 +12,7 @@
reference/gtksourceview2-gtksourcebuffer.xml \
reference/gtksourceview2-gtksourcelanguage.xml \
reference/gtksourceview2-gtksourcelanguagesmanager.xml \
+ reference/gtksourceview2-gtksourcemark.xml \
reference/gtksourceview2-gtksourcestyle.xml \
reference/gtksourceview2-gtksourcestylescheme.xml \
reference/gtksourceview2-gtksourcestyleschememanager.xml
@@ -24,6 +25,7 @@
html/class-gtksourcebuffer2.html \
html/class-gtksourcelanguage2.html \
html/class-gtksourcelanguagemanager2.html \
+ html/class-gtksourcemark2.html \
html/class-gtksourcestyle2.html \
html/class-gtksourcestylescheme2.html \
html/class-gtksourcestyleschememanager2.html \
Modified: trunk/docs/reference/gtksourceview2-gtksourcebuffer.xml
==============================================================================
--- trunk/docs/reference/gtksourceview2-gtksourcebuffer.xml (original)
+++ trunk/docs/reference/gtksourceview2-gtksourcebuffer.xml Sun Jan 6 17:02:36 2008
@@ -24,6 +24,12 @@
</constructorsynopsis>
<methodsynopsis language="python">
+ <methodname><link linkend="method-gtksourcebuffer2--backward-iter-to-mark">backward_iter_to_mark</link></methodname>
+ <methodparam><parameter role="keyword">iter</parameter></methodparam>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ </methodsynopsis>
+
+ <methodsynopsis language="python">
<methodname><link linkend="method-gtksourcebuffer2--begin-not-undoable-action">begin_not_undoable_action</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
@@ -38,18 +44,13 @@
<methodparam></methodparam>
</methodsynopsis>
- <!-- NOT YET IMPLEMENTED <methodsynopsis language="python">
- <methodname><link linkend="method-gtksourcebuffer2- -create-marker">create_marker</link></methodname>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtksourcebuffer2--create-mark">create_mark</link></methodname>
<methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
<methodparam><parameter role="keyword">where</parameter></methodparam>
</methodsynopsis>
-
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtksourcebuffer2- -delete-marker">delete_marker</link></methodname>
- <methodparam><parameter role="keyword">marker</parameter></methodparam>
- </methodsynopsis> END NON YET IMPLEMENTED -->
-
+
<methodsynopsis language="python">
<methodname><link linkend="method-gtksourcebuffer2--end-not-undoable-action">end_not_undoable_action</link></methodname>
<methodparam></methodparam>
@@ -61,11 +62,12 @@
<methodparam><parameter role="keyword">end</parameter></methodparam>
</methodsynopsis>
- <!-- NOT YET IMPLEMENTED <methodsynopsis language="python">
- <methodname><link linkend="method-gtksourcebuffer2- -get-first-marker">get_first_marker</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis> END NON YET IMPLEMENTED -->
-
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtksourcebuffer2--forward-iter-to-mark">forward_iter_to_mark</link></methodname>
+ <methodparam><parameter role="keyword">iter</parameter></methodparam>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ </methodsynopsis>
+
<methodsynopsis language="python">
<methodname><link linkend="method-gtksourcebuffer2--get-highlight-matching-brackets">get_highlight_matching_brackets</link></methodname>
<methodparam></methodparam>
@@ -75,63 +77,45 @@
<methodname><link linkend="method-gtksourcebuffer2--get-highlight-syntax">get_highlight_syntax</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
-
- <!-- NOT YET IMPLEMENTED <methodsynopsis language="python">
- <methodname><link linkend="method-gtksourcebuffer2- -get-iter-at-marker">get_iter_at_marker</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis> END NON YET IMPLEMENTED -->
-
+
<methodsynopsis language="python">
<methodname><link linkend="method-gtksourcebuffer2--get-language">get_language</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
-
- <!-- NOT YET IMPLEMENTED <methodsynopsis language="python">
- <methodname><link linkend="method-gtksourcebuffer2- -get-last-marker">get_last_marker</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-
+
<methodsynopsis language="python">
- <methodname><link linkend="method-gtksourcebuffer2- -get-marker">get_marker</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
+ <methodname><link linkend="method-gtksourcebuffer2--get-marks-at-iter">get_marks_at_iter</link></methodname>
+ <methodparam><parameter role="keyword">iter</parameter></methodparam>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
- <methodname><link linkend="method-gtksourcebuffer2- -get-markers-in-region">get_marker_in_region</link></methodname>
- <methodparam><parameter role="keyword">start</parameter></methodparam>
- <methodparam><parameter role="keyword">end</parameter></methodparam>
- </methodsynopsis> END NON YET IMPLEMENTED -->
+ <methodname><link linkend="method-gtksourcebuffer2--get-marks-at-line">get_marks_at_line</link></methodname>
+ <methodparam><parameter role="keyword">line</parameter></methodparam>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ </methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtksourcebuffer2--get-max-undo-levels">get_max_undo_levels</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
-
- <!-- NOT YET IMPLEMENTED <methodsynopsis language="python">
- <methodname><link linkend="method-gtksourcebuffer2- -get-next-marker">get_next_marker</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtksourcebuffer2- -get-prev-marker">get_prev_marker</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis> END NON YET IMPLEMENTED -->
-
+
<methodsynopsis language="python">
<methodname><link linkend="method-gtksourcebuffer2--get-style-scheme">get_style_scheme</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
-
- <!-- NOT YET IMPLEMENTED <methodsynopsis language="python">
- <methodname><link linkend="method-gtksourcebuffer2- -move-marker">move_marker</link></methodname>
- <methodparam><parameter role="keyword">marker</parameter></methodparam>
- <methodparam><parameter role="keyword">where</parameter></methodparam>
- </methodsynopsis> END NON YET IMPLEMENTED -->
-
+
<methodsynopsis language="python">
<methodname><link linkend="method-gtksourcebuffer2--redo">redo</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtksourcebuffer2--remove-marks">remove_marks</link></methodname>
+ <methodparam><parameter role="keyword">start</parameter></methodparam>
+ <methodparam><parameter role="keyword">end</parameter></methodparam>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ </methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtksourcebuffer2--set-highlight-matching-brackets">set_highlight_matching_brackets</link></methodname>
@@ -255,8 +239,8 @@
</listitem>
</varlistentry>
- <!-- NOT YET IMPLEMENTED <varlistentry>
- <term><link linkend="signal-gtksourcebuffer2- -marker-updated">"marker-updated"</link></term>
+ <varlistentry>
+ <term><link linkend="signal-gtksourcebuffer2--source-mark-updated">"source-mark-updated"</link></term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>sourceview</parameter></methodparam>
@@ -265,7 +249,7 @@
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
- </varlistentry> END NON YET IMPLEMENTED -->
+ </varlistentry>
</variablelist>
</refsect1>
@@ -339,7 +323,37 @@
<refsect1>
<title>Methods</title>
- <refsect2 id="method-gtksourcebuffer2--begin-not-undoable-action">
+ <refsect2 id="method-gtksourcebuffer2--backward-iter-to-mark">
+ <title>gtksourceview2.Buffer.backward_iter_to_mark</title>
+ <programlisting><methodsynopsis language="python">
+ <methodname>backward_iter_to_mark</methodname>
+ <methodparam><parameter role="keyword">iter</parameter></methodparam>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">iter</parameter> :</term>
+ <listitem><simpara>a <link linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">category</parameter> :</term>
+ <listitem><simpara>category to search for or <literal>None</literal>.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>whether iter moved.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>backward_iter_to_mark</methodname>() method moves iter to the
+ position of the previous <link linkend="class-gtksourcemark2"><classname>gtksourceview2.Mark</classname></link>
+ of the given category. Returns <literal>True</literal> if iter was moved.
+ If category is <literal>None</literal>, the previous source mark can be of any category.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtksourcebuffer2--begin-not-undoable-action">
<title>gtksourceview2.Buffer.begin_not_undoable_action</title>
<programlisting><methodsynopsis language="python">
<methodname>begin_not_undoable_action</methodname>
@@ -392,78 +406,60 @@
</para>
</refsect2>
- <!-- NOT YET IMPLEMENTED <refsect2 id="method-gtksourcebuffer2- -create-marker">
+ <refsect2 id="method-gtksourcebuffer2--create-mark">
<title>gtksourceview2.Buffer.create_marker</title>
<programlisting><methodsynopsis language="python">
<methodname>create_marker</methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- <methodparam><parameter role="keyword">where</parameter></methodparam>
+ <methodparam><parameter role="keyword">name</parameter></methodparam>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ <methodparam><parameter role="keyword">where</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter> :</term>
- <listitem><simpara> the name of the marker, or <literal>None</literal>.</simpara></listitem></varlistentry>
- <varlistentry><term><parameter role="keyword">type</parameter> :</term>
- <listitem><simpara> a string defining the marker type, or <literal>None</literal>.</simpara></listitem></varlistentry>
- <varlistentry><term><parameter role="keyword">where</parameter> :</term>
- <listitem><simpara> location to place the marker.</simpara></listitem></varlistentry>
- <varlistentry><term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara> a new
- <link linkend="class-gtksourcemarker2"><classname>gtksourceview2.Marker</classname></link>
- </simpara></listitem></varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">name</parameter> :</term>
+ <listitem><simpara>the name of the mark, or <literal>None</literal>.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">category</parameter> :</term>
+ <listitem><simpara>a string defining the mark category.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">where</parameter> :</term>
+ <listitem><simpara>location to place the mark.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara> a new
+ <link linkend="class-gtksourcemark2"><classname>gtksourceview2.Mark</classname></link>
+ </simpara></listitem>
+ </varlistentry>
</variablelist>
<para>
- The <methodname>create_marker</methodname>() method creates a marker in the
- <methodname><link linkend="constructor-gtksourcebuffer2">gtksourceview2.Buffer</link></methodname> of type
- <parameter>type</parameter>. A marker is semantically very similar to a
- <classname><link linkend="class-gtktextmark">gtk.TextMark</link></classname>, except it has a type which is used by the
- <classname><link linkend="class-gtksourceview2">gtksourceview2.View</link></classname> displaying the buffer to show
- a pixmap on the left margin, at the line the marker is in. Because of this, a marker is generally associated to a line
- and not a character position. Markers are also accessible through a position or range in the buffer.
- </para>
- <para>
- Markers are implemented using <classname><link linkend="class-gtktextmark">gtk.TextMark</link></classname>, so all
- characteristics and restrictions to marks apply to markers too. These includes life cycle issues
- and "mark-set" and "mark-deleted" signal emissions.
+ The <methodname>create_mark</methodname>() method creates a mark in the
+ <methodname><link linkend="constructor-gtksourcebuffer2">gtksourceview2.Buffer</link></methodname> of category
+ <parameter>category</parameter>. A mark is semantically very similar to a
+ <classname><link linkend="class-gtktextmark">gtk.TextMark</link></classname>, but organised into categories.
</para>
<para>
- Like a <classname><link linkend="class-gtktextmark">gtk.TextMark</link></classname>, a
- <link linkend="class-gtksourcemarker2"><classname>gtksourceview2.Marker</classname></link>
- can be anonymous if the passed <parameter>name</parameter> is <literal>None</literal>.
- Also, the buffer owns the markers so you shouldn't unreference it.
+ Like a <classname><link linkend="class-gtktextmark">gtk.TextMark</link></classname>, a
+ <link linkend="class-gtksourcemark2"><classname>gtksourceview2.Mark</classname></link>
+ can be anonymous if the passed name is <literal>None</literal>.
</para>
<para>
- Markers 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.
+ Like a <classname><link linkend="class-gtktextmark">gtk.TextMark</link></classname>, a
+ <link linkend="class-gtksourcemarker2"><classname>gtksourceview2.Marker</classname></link>
+ can be anonymous if the passed <parameter>name</parameter> is <literal>None</literal>.
+ Also, the buffer owns the markers so you shouldn't unreference it.
</para>
<para>
- Typical uses for a marker are bookmarks, breakpoints, current executing instruction indication in a source file, etc..
+ 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.
</para>
- </refsect2>
-
- <refsect2 id="method-gtksourcebuffer2- -delete-marker">
- <title>gtksourceview2.Buffer.delete_marker</title>
- <programlisting><methodsynopsis language="python">
- <methodname>delete_marker</methodname>
- <methodparam><parameter role="keyword">marker</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">marker</parameter> :</term>
- <listitem><simpara> a <link linkend="class-gtksourcemarker2"><classname>gtksourceview2.Marker</classname></link>.</simpara></listitem></varlistentry>
- <varlistentry><term><parameter role="keyword">where</parameter> :</term>
- <listitem><simpara> the new location for the marker.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
<para>
- Deletes <parameter>marker</parameter> from the source buffer. The same conditions as for
- <classname><link linkend="class-gtktextmark">gtk.TextMark</link></classname>
- apply here. The marker is no longer accessible from the buffer, but if you held a reference to it, it will not be destroyed.
+ Typical uses for marks are bookmarks, breakpoints, current executing instruction indication in a source file, etc..
</para>
- </refsect2> END NON YET IMPLEMENTED -->
+ </refsect2>
<refsect2 id="method-gtksourcebuffer2--end-not-undoable-action">
<title>gtksourceview2.Buffer.end_not_undoable_action</title>
@@ -499,25 +495,36 @@
and highlight the given area synchronously.
</para>
</refsect2>
-
- <!-- NOT YET IMPLEMENTED <refsect2 id="method-gtksourcebuffer2- -get-first-marker">
- <title>gtksourceview2.Buffer.get_first_marker</title>
+
+ <refsect2 id="method-gtksourcebuffer2--forward-iter-to-mark">
+ <title>gtksourceview2.Buffer.forward_iter_to_mark</title>
<programlisting><methodsynopsis language="python">
- <methodname>get_first_marker</methodname>
- <methodparam></methodparam></methodsynopsis></programlisting>
+ <methodname>forward_iter_to_mark</methodname>
+ <methodparam><parameter role="keyword">iter</parameter></methodparam>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ </methodsynopsis></programlisting>
<variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara> a reference to the first
- <link linkend="class-gtksourcemarker2"><classname>gtksourceview2.Marker</classname></link>,
- or <literal>None</literal> if there are no markers in the buffer.
- </simpara></listitem>
- </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">iter</parameter> :</term>
+ <listitem><simpara>a <link linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">category</parameter> :</term>
+ <listitem><simpara>category to search for or <literal>None</literal>.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>whether iter moved.</simpara></listitem>
+ </varlistentry>
</variablelist>
+
<para>
- Returns the first (nearest to the top of the buffer) marker in buffer.
+ The <methodname>forward_iter_to_mark</methodname>() method moves iter to the
+ position of the next <link linkend="class-gtksourcemark2"><classname>gtksourceview2.Mark</classname></link>
+ of the given category. Returns <literal>True</literal> if iter was moved.
+ If category is <literal>None</literal>, the previous source mark can be of any category.
</para>
- </refsect2> END NON YET IMPLEMENTED -->
+ </refsect2>
<refsect2 id="method-gtksourcebuffer2--get-highlight-matching-brackets">
<title>gtksourceview2.Buffer.get_highlight_matching_brackets</title>
@@ -559,28 +566,6 @@
</para>
</refsect2>
- <!-- NOT YET IMPLEMENTED <refsect2 id="method-gtksourcebuffer2- -get-iter-at-marker">
- <title>gtksourceview2.Buffer.get_iter_at_marker</title>
- <programlisting><methodsynopsis language="python">
- <methodname>get_iter_at_marker</methodname>
- <methodparam><parameter role="keyword">iter</parameter></methodparam>
- <methodparam><parameter role="keyword">marker</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry><term><parameter role="keyword">iter</parameter> :</term>
- <listitem><simpara> a <classname><link linkend="class-gtktextiter">gtk.TextIter</link></classname> to initialize.
- </simpara></listitem></varlistentry>
- <varlistentry><term><parameter role="keyword">marker</parameter> :</term>
- <listitem><simpara> a <link linkend="class-gtksourcemarker2"><classname>gtksourceview2.Marker</classname></link> of buffer.
- </simpara></listitem></varlistentry>
- </variablelist>
-
- <para>
- The <methodname>get_iter_at_marker</methodname>() method initializes
- <parameter>iter</parameter> at the location of <parameter>marker</parameter>.
- </para>
- </refsect2> END NON YET IMPLEMENTED -->
-
<refsect2 id="method-gtksourcebuffer2--get-language">
<title>gtksourceview2.Buffer.get_language</title>
<programlisting><methodsynopsis language="python">
@@ -602,72 +587,58 @@
<methodname><link linkend="method-gtksourcebuffer2--set-language">gtksourceview2.Buffer.set_language</link></methodname>().
</para>
</refsect2>
-
- <!-- NOT YET IMPLEMENTED <refsect2 id="method-gtksourcebuffer2- -get-last-marker">
- <title>gtksourceview2.Buffer.get_last_marker</title>
- <programlisting><methodsynopsis language="python">
- <methodname>get_last_marker</methodname>
- <methodparam></methodparam></methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara> a reference to the last
- <link linkend="class-gtksourcemarker2"><classname>gtksourceview2.Marker</classname></link>,
- or <literal>None</literal> if there are no markers in the buffer.
- </simpara></listitem>
- </varlistentry>
- </variablelist>
- <para>
- The <methodname>get_last_marker</methodname>() method returns the last
- (nearest to the bottom of the buffer) marker in buffer.
- </para>
- </refsect2>
-
- <refsect2 id="method-gtksourcebuffer2- -get-marker">
- <title>gtksourceview2.Buffer.get_marker</title>
+
+ <refsect2 id="method-gtksourcebuffer2--get-marks-at-iter">
+ <title>gtksourceview2.Buffer.get_marks_at_iter</title>
<programlisting><methodsynopsis language="python">
- <methodname>get_marker</methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
+ <methodname>get_marks_at_iter</methodname>
+ <methodparam><parameter role="keyword">iter</parameter></methodparam>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter> :</term>
- <listitem><simpara> name of the <link linkend="class-gtksourcemarker2"><classname>gtksourceview2.Marker</classname></link>
- to retreive.</simpara></listitem></varlistentry>
+ <varlistentry><term><parameter role="keyword">iter</parameter> :</term>
+ <listitem><simpara>a <link linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>.</simpara></listitem>
+ </varlistentry>
+ <varlistentry><term><parameter role="keyword">category</parameter> :</term>
+ <listitem><simpara>category to search for or <literal>None</literal></simpara></listitem>
+ </varlistentry>
+ <varlistentry><term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara> a list of <link linkend="class-gtksourcemark2"><classname>gtksourceview2.Mark</classname></link>.</simpara></listitem>
+ </varlistentry>
</variablelist>
<para>
- The <methodname>get_marker</methodname>() method Looks up the
- <link linkend="class-gtksourcemarker2"><classname>gtksourceview2.Marker</classname></link>
- named <parameter role="keyword">name</parameter> in <parameter role="keyword">buffer</parameter>, returning
- <literal>None</literal> if it doesn't exists.
+ The <methodname>get_marks_at_iter</methodname>() method returns the list of marks
+ of the given category at iter. If category is <literal>None</literal>
+ it returns all marks at iter.
</para>
</refsect2>
-
- <refsect2 id="method-gtksourcebuffer2- -get-markers-in-region">
- <title>gtksourceview2.Buffer.get_markers_in_region</title>
+
+ <refsect2 id="method-gtksourcebuffer2--get-marks-at-line">
+ <title>gtksourceview2.Buffer.get_marks_at_line</title>
<programlisting><methodsynopsis language="python">
- <methodname>get_markers_in_region</methodname>
- <methodparam><parameter role="keyword">begin</parameter></methodparam>
- <methodparam><parameter role="keyword">end</parameter></methodparam>
+ <methodname>get_marks_at_line</methodname>
+ <methodparam><parameter role="keyword">iter</parameter></methodparam>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
- <varlistentry><term><parameter role="keyword">begin</parameter> :</term>
- <listitem><simpara> beginning of the range.</simpara></listitem></varlistentry>
- <varlistentry><term><parameter role="keyword">end</parameter> :</term>
- <listitem><simpara> end of the range.</simpara></listitem></varlistentry>
- <varlistentry><term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara> a list of the <link linkend="class-gtksourcemarker2"><classname>gtksourceview2.Marker</classname></link>
- in the range.</simpara></listitem></varlistentry>
+ <varlistentry><term><parameter role="keyword">iter</parameter> :</term>
+ <listitem><simpara>a <link linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>.</simpara></listitem>
+ </varlistentry>
+ <varlistentry><term><parameter role="keyword">category</parameter> :</term>
+ <listitem><simpara>category to search for or <literal>None</literal></simpara></listitem>
+ </varlistentry>
+ <varlistentry><term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara> a list of <link linkend="class-gtksourcemark2"><classname>gtksourceview2.Mark</classname></link>.</simpara></listitem>
+ </varlistentry>
</variablelist>
<para>
- The <methodname>get_markers_in_region</methodname>() method returns an ordered (by position)
- list of <link linkend="class-gtksourcemarker2"><classname>gtksourceview2.Marker</classname></link>
- objects inside the region delimited by the <classname><link linkend="class-gtktextiter">gtk.TextIter</link></classname>
- <parameter>begin</parameter> and <parameter>end</parameter>. The iters may be in any order.
+ The <methodname>get_marks_at_line</methodname>() method returns the list of marks
+ of the given category at line. If category is <literal>None</literal>
+ it returns all marks at line.
</para>
- </refsect2> END NON YET IMPLEMENTED -->
+ </refsect2>
<refsect2 id="method-gtksourcebuffer2--get-max-undo-levels">
<title>gtksourceview2.Buffer.get_max_undo_levels</title>
@@ -688,52 +659,6 @@
</para>
</refsect2>
- <!-- NOT YET IMPLEMENTED <refsect2 id="method-gtksourcebuffer2- -get-next-marker">
- <title>gtksourceview2.Buffer.get_next_marker</title>
- <programlisting><methodsynopsis language="python">
- <methodname>get_next_marker</methodname>
- <methodparam><parameter role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry><term><parameter role="keyword">iter</parameter> :</term>
- <listitem><simpara> the location to start searching from.</simpara></listitem></varlistentry>
- <varlistentry><term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara> the <link linkend="class-gtksourcemarker2"><classname>gtksourceview2.Marker</classname></link>
- nearest to the right of <parameter>iter</parameter>, or <literal>None</literal> if there are no more markers after
- <parameter>iter</parameter>.</simpara></listitem></varlistentry>
- </variablelist>
-
- <para>
- The <methodname>get_next_marker</methodname>() method returns the nearest marker to the
- right of <parameter>iter</parameter>. 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 <methodname><link linkend="method-gtksourcemarker2- -next">gtksourcemarker2.Marker.next</link></methodname>().
- </para>
- </refsect2>
-
- <refsect2 id="method-gtksourcebuffer2- -get-prev-marker">
- <title>gtksourceview2.Buffer.get_prev_marker</title>
- <programlisting><methodsynopsis language="python">
- <methodname>get_prev_marker</methodname>
- <methodparam><parameter role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry><term><parameter role="keyword">iter</parameter> :</term>
- <listitem><simpara> the location to start searching from.</simpara></listitem></varlistentry>
- <varlistentry><term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara> the <link linkend="class-gtksourcemarker2"><classname>gtksourceview2.Marker</classname></link>
- nearest to the left of <parameter>iter</parameter>, or <literal>None</literal> if there are no more markers before
- <parameter>iter</parameter>.</simpara></listitem></varlistentry>
- </variablelist>
-
- <para>
- The <methodname>get_prev_marker</methodname>() method returns the nearest marker
- to the left of <parameter>iter</parameter>. 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 <methodname><link linkend="method-gtksourcemarker2- -prev">gtksourcemarker2.Marker.prev</link></methodname>().
- </para>
- </refsect2> END NON YET IMPLEMENTED -->
-
<refsect2 id="method-gtksourcebuffer2--get-style-scheme">
<title>gtksourceview2.Buffer.get_style_scheme</title>
<programlisting><methodsynopsis language="python">
@@ -756,28 +681,6 @@
You can get the others using <methodname><link linkend="method-gtksourcemarker2--next">gtksourceview2.Marker.next</link></methodname>().
</para>
</refsect2>
-
- <!-- NOT YET IMPLEMENTED <refsect2 id="method-gtksourcebuffer2- -move-marker">
- <title>gtksourceview2.Buffer.move_marker</title>
- <programlisting><methodsynopsis language="python">
- <methodname>move_marker</methodname>
- <methodparam><parameter role="keyword">marker</parameter></methodparam>
- <methodparam><parameter role="keyword">where</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">marker</parameter> :</term>
- <listitem><simpara> a <link linkend="class-gtksourcemarker2"><classname>gtksourceview2.Marker</classname></link>.</simpara></listitem></varlistentry>
- <varlistentry><term><parameter role="keyword">where</parameter> :</term>
- <listitem><simpara> the new location for the marker.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>
- The <methodname>move_marker</methodname>() method moves <parameter>marker</parameter>
- to the new location <parameter>where</parameter>.
- </para>
- </refsect2> END NON YET IMPLEMENTED -->
<refsect2 id="method-gtksourcebuffer2--redo">
<title>gtksourceview2.Buffer.redo</title>
@@ -790,6 +693,36 @@
</para>
</refsect2>
+ <refsect2 id="method-gtksourcebuffer2--remove-marks">
+ <title>gtksourceview2.Buffer.remove_marks</title>
+ <programlisting><methodsynopsis language="python">
+ <methodname>remove_marks</methodname>
+ <methodparam><parameter role="keyword">start</parameter></methodparam>
+ <methodparam><parameter role="keyword">end</parameter></methodparam>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">start</parameter> :</term>
+ <listitem><simpara>a <link linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">end</parameter> :</term>
+ <listitem><simpara>a <link linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">category</parameter> :</term>
+ <listitem><simpara>category to search for or <literal>None</literal>.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>remove_marks</methodname>() method remove all marks of category
+ between start and end from the buffer. If category is <literal>None</literal>,
+ all marks in the range will be removed.
+ </para>
+ </refsect2>
+
<refsect2 id="method-gtksourcebuffer2--set-highlight-matching-brackets">
<title>gtksourceview2.Buffer.set_highlight_matching_brackets</title>
<programlisting><methodsynopsis language="python">
@@ -983,7 +916,7 @@
</refsect2>
- <!-- NOT YET IMPLEMENTED <refsect2 id="signal-gtksourcebuffer2- -marker-updated">
+ <refsect2 id="signal-gtksourcebuffer2-source--mark-updated">
<title>The "marker-updated" gtksourceview2.Buffer Signal</title>
<programlisting><methodsynopsis language="python">
@@ -1001,13 +934,13 @@
</varlistentry>
<varlistentry>
<term><parameter>arg1</parameter> :</term>
- <listitem><simpara>the <classname><link linkend="class-gtktextiter">gtk.TextIter</link></classname>
+ <listitem><simpara>the <classname><link linkend="class-gtktextmark">gtk.TextMark</link></classname>
at the location where the change occurred.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified with the
- <link linkend="method-gobject- -connect"><methodname>connect</methodname>()</link> method</simpara></listitem>
+ <link linkend="method-gobject--connect"><methodname>connect</methodname>()</link> method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
@@ -1016,9 +949,8 @@
</variablelist>
<para>
- The "marker-updated" signal is emitted whenever a marker of <parameter>sourcebuffer</parameter> has changed and
- needs to be redisplayed by the view. A change in a marker's type or location can trigger this signal.
+ The "source-mark-updated" signal is emitted whenever a mark is added to, moved or removed from the buffer.
</para>
- </refsect2> END NON YET IMPLEMENTED -->
+ </refsect2>
</refsect1>
</refentry>
Added: trunk/docs/reference/gtksourceview2-gtksourcemark.xml
==============================================================================
--- (empty file)
+++ trunk/docs/reference/gtksourceview2-gtksourcemark.xml Sun Jan 6 17:02:36 2008
@@ -0,0 +1,240 @@
+<?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-gtksourcemark2">
+ <refnamediv>
+ <refname>gtksourceview2.Mark</refname>
+ <refpurpose>Mark object for <link linkend="class-gtksourceview">gtksourceview.SourceView</link></refpurpose>
+ </refnamediv>
+
+<!-- ******************************* -->
+<!-- BEGIN OF GTKSOURCEMARK SYNOPSIS -->
+<!-- ******************************* -->
+
+<refsect1>
+ <title>Synopsis</title>
+
+ <classsynopsis language="python">
+ <ooclass><classname>gtksourceview2.Mark</classname></ooclass>
+ <ooclass><classname><link linkend="class-gtktextmark">gtk.TextMark</link></classname></ooclass>
+
+ <constructorsynopsis language="python">
+ <methodname><link linkend="constructor-gtksourcemark2">gtksourceview2.Mark</link></methodname>
+ <methodparam><parameter role="keyword">name</parameter></methodparam>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ </constructorsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtksourcemark2--get-category">get_category</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtksourcemark2--next">next</link></methodname>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ </methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtksourcemark2--prev">prev</link></methodname>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ </methodsynopsis>
+ </classsynopsis>
+</refsect1>
+
+<!-- ******************************* -->
+<!-- BEGIN OF GTKSOURCEMARK ANCESTRY -->
+<!-- ******************************* -->
+
+<refsect1>
+ <title>Ancestry</title>
+
+<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+ +-- <link linkend="class-gtktextmark">gtk.TextMark</link>
+ +-- <link linkend="class-gtksourcemark2">gtksourceview2.Mark</link>
+</synopsis>
+</refsect1>
+
+<!-- ********************************* -->
+<!-- BEGIN OF GTKSOURCEMARK PROPERTIES -->
+<!-- ********************************* -->
+
+ <refsect1>
+ <title>Properties</title>
+
+ <blockquote role="properties">
+ <informaltable pgwide="1" frame="none">
+ <tgroup cols="3">
+ <colspec column="1" colwidth="1in"/>
+ <colspec column="2" colwidth="1in"/>
+ <colspec column="3" colwidth="4in"/>
+ <tbody>
+
+ <row valign="top">
+ <entry>"category"</entry>
+ <entry>Read-Write-Construct Only</entry>
+ <entry>The category of the
+ <link linkend="class-gtksourcemark2"><classname>gtksourceview2.Mark</classname></link>,
+ classified the mark and control what pixbuf is used and with which priority it is drawn.
+ Default value: <literal>None</literal></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </blockquote>
+
+ </refsect1>
+
+<!-- ********************************** -->
+<!-- BEGIN OF GTKSOURCEMARK DESCRIPTION -->
+<!-- ********************************** -->
+
+<refsect1 id="description-gtktextmarker">
+ <title>Description</title>
+
+ <para>
+ A <link linkend="class-gtksourcemark2"><classname>gtksourceview2.Mark</classname></link>
+ preserves a position in the text where you want to display additional info. It is based on
+ <link linkend="class-gtktextmark"><classname>gtk.TextMark</classname></link> and thus is still
+ valid after the text has changed though it may change it's position.
+ </para>
+ <para>
+ <link linkend="class-gtksourcemark2"><classname>gtksourceview2.Mark</classname></link> are organised
+ in categories which you have to set when you create the mark. Each category can have a pixbuf and a
+ priority associated using
+ <methodname><link linkend="method-gtksourceview2--set-mark_category-pixbuf">gtksourceview2.View.set_mark_category_pixbuf</link></methodname>()
+ and <methodname><link linkend="method-gtksourceview2--set-mark_category-pixbuf">gtksourceview2.View.set_mark_category_priority</link></methodname>().
+ The pixbuf will be displayed in the margin at the line where the mark residents if the "show-line-marks"
+ property is set to <literal>True</literal>. If there are multiple marks in the same line,
+ the pixbufs will be drawn on top of each other. The mark with the highest priority will be drawn on top.
+ </para>
+</refsect1>
+
+<!-- ********************************** -->
+<!-- BEGIN OF GTKSOURCEMARK CONSTRUCTOR -->
+<!-- ********************************** -->
+
+ <refsect1 id="constructor-gtksourcemark2">
+ <title>Constructor</title>
+
+ <programlisting><constructorsynopsis language="python">
+ <methodname>gtksourceview2.Mark</methodname>
+ <methodparam><parameter role="keyword">name</parameter></methodparam>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ </constructorsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">name</parameter> :</term>
+ <listitem><simpara>name of the <link linkend="class-gtksourcemark2"><classname>gtksourceview2.Mark</classname></link>,can be
+ <literal>None</literal> when not using a name.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">category</parameter> :</term>
+ <listitem><simpara>used to classify marks according to common characteristics
+ (e.g. all the marks representing a bookmark could belong to the "bookmark" category,
+ or all the marks representing a compilation error could belong to "error"
+ category).</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a new <link linkend="class-gtksourcemark2"><classname>gtksourceview2.Mark</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Creates a new <link linkend="class-gtksourcemark2"><classname>gtksourceview2.Mark</classname></link>.
+ Add it to a buffer using
+ <methodname><link linkend="method-gtktextbuffer--add-mark">gtk.TextBuffer.add_mark</link></methodname>().
+ If name is <literal>None</literal>, the mark is anonymous; otherwise, the mark can be retrieved by name using
+ <methodname><link linkend="method-gtktextbuffer--get-mark">gtk.TextBuffer.get_mark</link></methodname>().
+ Normally marks are created using the utility function
+ <methodname><link linkend="method-gtksourcebuffer2--create-mark">gtksourceview2.Buffer.create_mark</link></methodname>().
+ </para>
+
+ </refsect1>
+
+<!-- ****************************** -->
+<!-- BEGIN OF GTKSOURCEMARK METHODS -->
+<!-- ****************************** -->
+
+<refsect1>
+ <title>Methods</title>
+
+ <refsect2 id="method-gtksourcemark2--get-category">
+ <title>gtksourceview2.Mark.get_category</title>
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_category</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the category.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>get_category</methodname>() method returns the category of
+ <link linkend="class-gtksourcemark2"><classname>gtksourceview2.Mark</classname></link>.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtksourcemark2--next">
+ <title>gtksourceview2.Mark.next</title>
+ <programlisting><methodsynopsis language="python">
+ <methodname>next</methodname>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">category</parameter> :</term>
+ <listitem><simpara>a string specifying the mark category or <literal>None</literal>.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the next <link linkend="class-gtksourcemark2"><classname>gtksourceview2.Mark</classname></link>
+ or <literal>None</literal>.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>next</methodname>() method returns the next
+ <link linkend="class-gtksourcemark2"><classname>gtksourceview2.Mark</classname></link>
+ in the buffer or <literal>None</literal> if the mark was not added to a buffer.
+ If there is no next mark, <literal>None</literal> will be returned.
+ If category is <literal>None</literal>, looks for marks of any category.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtksourcemark2--prev">
+ <title>gtksourceview2.Mark.prev</title>
+ <programlisting><methodsynopsis language="python">
+ <methodname>prev</methodname>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">category</parameter> :</term>
+ <listitem><simpara>a string specifying the mark category or <literal>None</literal>.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the previous <link linkend="class-gtksourcemark2"><classname>gtksourceview2.Mark</classname></link>
+ or <literal>None</literal>.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>prev</methodname>() method returns the previous
+ <link linkend="class-gtksourcemark2"><classname>gtksourceview2.Mark</classname></link>
+ in the buffer or <literal>None</literal> if the mark was not added to a buffer.
+ If there is no next mark, <literal>None</literal> will be returned.
+ If category is <literal>None</literal>, looks for marks of any category.
+ </para>
+ </refsect2>
+
+</refsect1>
+</refentry>
Modified: trunk/docs/reference/gtksourceview2-gtksourceview.xml
==============================================================================
--- trunk/docs/reference/gtksourceview2-gtksourceview.xml (original)
+++ trunk/docs/reference/gtksourceview2-gtksourceview.xml Sun Jan 6 17:02:36 2008
@@ -49,8 +49,13 @@
</methodsynopsis>
<methodsynopsis language="python">
- <methodname><link linkend="method-gtksourceview2--get-marker-pixbuf">get_marker_pixbuf</link></methodname>
- <methodparam></methodparam>
+ <methodname><link linkend="method-gtksourceview2--get-mark-category-pixbuf">get_mark_category_pixbuf</link></methodname>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ </methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtksourceview2--get-mark-category-priority">get_mark_category_priority</link></methodname>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
@@ -59,7 +64,7 @@
</methodsynopsis>
<methodsynopsis language="python">
- <methodname><link linkend="method-gtksourceview2--get-show-line-markers">get_show_line_markers</link></methodname>
+ <methodname><link linkend="method-gtksourceview2--get-show-line-marks">get_show_line_marks</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
@@ -109,18 +114,24 @@
</methodsynopsis>
<methodsynopsis language="python">
- <methodname><link linkend="method-gtksourceview2--set-marker-pixbuf">set_marker_pixbuf</link></methodname>
- <methodparam><parameter role="keyword">marker_type</parameter></methodparam>
+ <methodname><link linkend="method-gtksourceview2--set-mark-category-pixbuf">set_mark_category_pixbuf</link></methodname>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
<methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
+ <methodname><link linkend="method-gtksourceview2--set-mark-category-priority">set_mark_category_priority</link></methodname>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ <methodparam><parameter role="keyword">priority</parameter></methodparam>
+ </methodsynopsis>
+
+ <methodsynopsis language="python">
<methodname><link linkend="method-gtksourceview2--set-right-margin-position">set_right_margin_position</link></methodname>
<methodparam><parameter role="keyword">pos</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
- <methodname><link linkend="method-gtksourceview2--set-show-line-markers">set_show_line_markers</link></methodname>
+ <methodname><link linkend="method-gtksourceview2--set-show-line-marks">set_show_line_marks</link></methodname>
<methodparam><parameter role="keyword">show</parameter></methodparam>
</methodsynopsis>
@@ -215,9 +226,9 @@
</row>
<row valign="top">
- <entry>"show-line-markers"</entry>
+ <entry>"show-line-marks"</entry>
<entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the display line marker pixbufs will be shown. Default value: False.</entry>
+ <entry>If <literal>True</literal>, the display line marks pixbufs will be shown. Default value: False.</entry>
</row>
<row valign="top">
@@ -450,18 +461,18 @@
</para>
</refsect2>
- <refsect2 id="method-gtksourceview2--get-marker-pixbuf">
- <title>gtksourceview2.View.get_marker_pixbuf</title>
+ <refsect2 id="method-gtksourceview2--get-mark-category-pixbuf">
+ <title>gtksourceview2.View.get_mark_category_pixbuf</title>
<programlisting><methodsynopsis language="python">
- <methodname>get_marker_pixbuf</methodname>
- <methodparam><parameter role="keyword">marker_type</parameter></methodparam>
+ <methodname>get_mark_category_pixbuf</methodname>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
- <term><parameter role="keyword">marker_type</parameter> :</term>
- <listitem><simpara>a marker type.</simpara></listitem>
+ <term><parameter role="keyword">category</parameter> :</term>
+ <listitem><simpara>a marker category.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
@@ -471,8 +482,34 @@
</variablelist>
<para>
- The <methodname>get_marker_pixbuf</methodname>() method gets the pixbuf which
- is associated with the given marker_type.
+ The <methodname>get_marker_category_pixbuf</methodname>() method gets the pixbuf which
+ is associated with the given category.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtksourceview2--get-mark-category-priority">
+ <title>gtksourceview2.View.get_mark_category_priority</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_mark_category_priority</methodname>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">category</parameter> :</term>
+ <listitem><simpara>a marker category.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a <link linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
+ if found, or <literal>None</literal> if not found.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>get_mark_category_priority</methodname>() method gets
+ the priority which is associated with the given category.
</para>
</refsect2>
@@ -497,25 +534,25 @@
</para>
</refsect2>
- <refsect2 id="method-gtksourceview2--get-show-line-markers">
- <title>gtksourceview2.View.get_show_line_markers</title>
+ <refsect2 id="method-gtksourceview2--get-show-line-marks">
+ <title>gtksourceview2.View.get_show_line_marks</title>
<programlisting><methodsynopsis language="python">
- <methodname>get_show_line_markers</methodname>
+ <methodname>get_show_line_marks</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara><literal>True</literal> if the line markers are displayed.
+ <listitem><simpara><literal>True</literal> if the line marks are displayed.
<literal>False</literal> otherwise.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
- The <methodname>get_show_line_markers</methodname>() method returns
- whether line markers are displayed beside the text.
+ The <methodname>get_show_line_marks</methodname>() method returns
+ whether line marks are displayed beside the text.
</para>
</refsect2>
@@ -715,30 +752,59 @@
</para>
</refsect2>
- <refsect2 id="method-gtksourceview2--set-marker-pixbuf">
- <title>gtksourceview2.View.set_marker_pixbuf</title>
+ <refsect2 id="method-gtksourceview2--set-mark-category-pixbuf">
+ <title>gtksourceview2.View.set_mark_category_pixbuf</title>
<programlisting><methodsynopsis language="python">
- <methodname>set_marker_pixbuf</methodname>
- <methodparam><parameter role="keyword">marker_type</parameter></methodparam>
+ <methodname>set_mark_category_pixbuf</methodname>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
<methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
- <term><parameter role="keyword">marker_type</parameter> :</term>
- <listitem><simpara>a marker type.</simpara></listitem>
+ <term><parameter role="keyword">category</parameter> :</term>
+ <listitem><simpara>a marker category.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">pixbuf</parameter> :</term>
- <listitem><simpara>a <link linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>.</simpara></listitem>
+ <listitem><simpara>a <link linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
+ or <literal>None</literal>.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
- The <methodname>set_marker_pixbuf</methodname>() method
+ The <methodname>set_mark_category_priority</methodname>() method
associates a given <parameter>pixbuf</parameter> with a given
- <parameter>marker_type</parameter>.
+ <parameter>category</parameter>. If pixbuf is <literal>None</literal>,
+ the pixbuf is unset.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtksourceview2--set-mark-category-priority">
+ <title>gtksourceview2.View.set_mark_category_priority</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_mark_category_priority</methodname>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ <methodparam><parameter role="keyword">priority</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">category</parameter> :</term>
+ <listitem><simpara>a marker category.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">priority</parameter> :</term>
+ <listitem><simpara>the priority for the category.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>set_mark_category_priority</methodname>() method
+ Set the priority for the given mark category. When there are multiple marks
+ on the same line, marks of categories with higher priorities will be drawn on top.
</para>
</refsect2>
@@ -763,25 +829,25 @@
</para>
</refsect2>
- <refsect2 id="method-gtksourceview2--set-show-line-markers">
- <title>gtksourceview2.View.set_show_line_markers</title>
+ <refsect2 id="method-gtksourceview2--set-show-line-marks">
+ <title>gtksourceview2.View.set_show_line_marks</title>
<programlisting><methodsynopsis language="python">
- <methodname>set_show_line_markers</methodname>
+ <methodname>set_show_line_marks</methodname>
<methodparam><parameter role="keyword">show</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">show</parameter> :</term>
- <listitem><simpara>if <literal>True</literal> line markers will be
+ <listitem><simpara>if <literal>True</literal> line marks will be
displayed beside the text.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
- The <methodname>set_show_line_markers</methodname>() method sets
- whether line markers should be displayed.
+ The <methodname>set_show_line_marks</methodname>() method sets
+ whether line marks should be displayed.
</para>
</refsect2>
Modified: trunk/docs/reference/gtksourceview2-ref.xml
==============================================================================
--- trunk/docs/reference/gtksourceview2-ref.xml (original)
+++ trunk/docs/reference/gtksourceview2-ref.xml Sun Jan 6 17:02:36 2008
@@ -30,7 +30,7 @@
<xi:include href="gtksourceview2-gtksourcebuffer.xml"/>
<xi:include href="gtksourceview2-gtksourcelanguage.xml"/>
<xi:include href="gtksourceview2-gtksourcelanguagesmanager.xml"/>
- <!-- HOLD <xi:include href="gtksourceview2-gtksourcemarker.xml"/> -->
+ <xi:include href="gtksourceview2-gtksourcemark.xml"/>
<xi:include href="gtksourceview2-gtksourcestyle.xml"/>
<xi:include href="gtksourceview2-gtksourcestylescheme.xml"/>
<xi:include href="gtksourceview2-gtksourcestyleschememanager.xml"/>
Modified: trunk/gtksourceview2.defs
==============================================================================
--- trunk/gtksourceview2.defs (original)
+++ trunk/gtksourceview2.defs Sun Jan 6 17:02:36 2008
@@ -210,7 +210,7 @@
(c-name "gtk_source_buffer_create_mark")
(return-type "GtkSourceMark*")
(parameters
- '("const-gchar*" "name")
+ '("const-gchar*" "name" (null-ok))
'("const-gchar*" "category")
'("const-GtkTextIter*" "where")
)
@@ -222,7 +222,7 @@
(return-type "gboolean")
(parameters
'("GtkTextIter*" "iter")
- '("const-gchar*" "category")
+ '("const-gchar*" "category" (null-ok))
)
)
@@ -232,7 +232,7 @@
(return-type "gboolean")
(parameters
'("GtkTextIter*" "iter")
- '("const-gchar*" "category")
+ '("const-gchar*" "category" (null-ok))
)
)
@@ -242,7 +242,7 @@
(return-type "GSList*")
(parameters
'("GtkTextIter*" "iter")
- '("const-gchar*" "category")
+ '("const-gchar*" "category" (null-ok))
)
)
@@ -252,7 +252,7 @@
(return-type "GSList*")
(parameters
'("gint" "line")
- '("const-gchar*" "category")
+ '("const-gchar*" "category" (null-ok))
)
)
@@ -263,7 +263,7 @@
(parameters
'("GtkTextIter*" "start")
'("GtkTextIter*" "end")
- '("const-gchar*" "category")
+ '("const-gchar*" "category" (null-ok))
)
)
@@ -711,7 +711,7 @@
(return-type "none")
(parameters
'("const-gchar*" "category")
- '("GdkPixbuf*" "pixbuf")
+ '("GdkPixbuf*" "pixbuf" (null-ok))
)
)
@@ -767,7 +767,7 @@
(is-constructor-of "GtkSourceMark")
(return-type "GtkSourceMark*")
(parameters
- '("const-gchar*" "name")
+ '("const-gchar*" "name" (null-ok))
'("const-gchar*" "category")
)
)
@@ -783,7 +783,7 @@
(c-name "gtk_source_mark_next")
(return-type "GtkSourceMark*")
(parameters
- '("const-gchar*" "category")
+ '("const-gchar*" "category" (null-ok))
)
)
@@ -792,6 +792,6 @@
(c-name "gtk_source_mark_prev")
(return-type "GtkSourceMark*")
(parameters
- '("const-gchar*" "category")
+ '("const-gchar*" "category" (null-ok))
)
)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
