[pygtksourceview] Update the docs for gtksourceview2.View class with new API additions.
- From: Gian Mario Tagliaretti <gianmt src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [pygtksourceview] Update the docs for gtksourceview2.View class with new API additions.
- Date: Mon, 17 Aug 2009 21:27:15 +0000 (UTC)
commit 2d9e3fb700cc321c17bbbedf00403b97ba8595e6
Author: Gian Mario Tagliaretti <gianmt gnome org>
Date: Mon Aug 17 23:26:39 2009 +0200
Update the docs for gtksourceview2.View class with new API additions.
docs/reference/gtksourceview2-gtksourceview.xml | 301 ++++++++++++++++++++++-
1 files changed, 300 insertions(+), 1 deletions(-)
---
diff --git a/docs/reference/gtksourceview2-gtksourceview.xml b/docs/reference/gtksourceview2-gtksourceview.xml
index 73fafce..429b05a 100644
--- a/docs/reference/gtksourceview2-gtksourceview.xml
+++ b/docs/reference/gtksourceview2-gtksourceview.xml
@@ -34,6 +34,11 @@
</methodsynopsis>
<methodsynopsis language="python">
+ <methodname><link linkend="method-gtksourceview2--get-gutter">get_gutter</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
+ <methodsynopsis language="python">
<methodname><link linkend="method-gtksourceview2--get-highlight-current-line">get_highlight_current_line</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
@@ -129,24 +134,56 @@
</methodsynopsis>
<methodsynopsis language="python">
- <methodname><link linkend="method-gtksourceview2--set-mark-category-pixbuf">set_mark_category_pixbuf</link></methodname>
+ <methodname><link linkend="method-gtksourceview2--set-mark-category-pixbuf">set_mark_category_icon_from_icon_name</link></methodname>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ <methodparam><parameter role="keyword">name</parameter></methodparam>
+ </methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtksourceview2--set-mark-category-pixbuf">set_mark_category_icon_from_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-pixbuf">set_mark_category_icon_from_stock</link></methodname>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ <methodparam><parameter role="keyword">stock_id</parameter></methodparam>
+ </methodsynopsis>
+
+ <methodsynopsis language="python">
<methodname><link linkend="method-gtksourceview2--set-mark-category-background">set_mark_category_background</link></methodname>
<methodparam><parameter role="keyword">category</parameter></methodparam>
<methodparam><parameter role="keyword">dest</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
+ <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-mark-category-tooltip-func">set_mark_category_tooltip_func</link></methodname>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ <methodparam><parameter role="keyword">func</parameter></methodparam>
+ <methodparam><parameter role="keyword">user_data</parameter></methodparam>
+ </methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtksourceview2--set-mark-category-tooltip-markup-func">set_mark_category_tooltip_markup_func</link></methodname>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ <methodparam><parameter role="keyword">markup_func</parameter></methodparam>
+ <methodparam><parameter role="keyword">user_data</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>
@@ -219,6 +256,11 @@
<entry>Method that can be overridden to implement a custom undo.</entry>
</row>
+ <row valign="top">
+ <entry><methodname>do_line_mark_activated</methodname></entry>
+ <entry>Method that can be overridden to implement a custom line number activation.</entry>
+ </row>
+
</tbody>
</tgroup>
</informaltable>
@@ -340,6 +382,18 @@
</methodsynopsis>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><link linkend="signal-gtksourceview--line-mark-activated">"line-mark-activated"</link></term>
+ <listitem>
+ <methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>sourceview</parameter></methodparam>
+ <methodparam><parameter>iter</parameter></methodparam>
+ <methodparam><parameter>event</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
</variablelist>
</refsect1>
@@ -443,6 +497,30 @@
</para>
</refsect2>
+ <refsect2 id="method-gtksourceview2--get-gutter">
+ <title>gtksourceview2.View.get_gutter</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_gutter</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the <link linkend="class-gtksourcegutter2">gtksourceview2.Gutter</link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>get_gutter</methodname>() method returns the
+ <link linkend="class-gtksourcegutter2">gtksourceview2.Gutter</link> object
+ associated with window_type for view. Only gtk.TEXT_WINDOW_LEFT and gtk.TEXT_WINDOW_RIGHT
+ are supported, respectively corresponding to the left and right gutter. The line numbers
+ and mark category icons are rendered in the gutter corresponding to gtk.TEXT_WINDOW_LEFT.
+ </para>
+ </refsect2>
<refsect2 id="method-gtksourceview2--get-highlight-current-line">
<title>gtksourceview2.View.get_highlight_current_line</title>
@@ -903,6 +981,91 @@
</para>
</refsect2>
+ <refsect2 id="method-gtksourceview2--set-mark-category-icon-from-icon-name">
+ <title>gtksourceview2.View.set_mark_category_icon_from_icon_name</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_mark_category_icon_from_icon_name</methodname>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ <methodparam><parameter role="keyword">name</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">name</parameter> :</term>
+ <listitem><simpara>the themed icon name or <literal>None</literal>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>set_mark_category_icon_from_icon_name</methodname>() method
+ sets the icon to be used for category to the named theme item name.
+ If name is <literal>None</literal>, the icon is unset.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtksourceview2--set-mark-category-icon-from-pixbuf">
+ <title>gtksourceview2.View.set_mark_category_icon_from_pixbuf</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_mark_category_icon_from_pixbuf</methodname>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ <methodparam><parameter role="keyword">pixbuf</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">pixbuf</parameter> :</term>
+ <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_mark_category_icon_from_pixbuf</methodname>() method
+ sets the icon to be used for category to pixbuf. If pixbuf is <literal>None</literal>,
+ the icon is unset.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtksourceview2--set-mark-category-icon-from-stock">
+ <title>gtksourceview2.View.set_mark_category_icon_from_stock</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_mark_category_icon_from_stock</methodname>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ <methodparam><parameter role="keyword">stock</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">simpara</parameter> :</term>
+ <listitem><simpara>the stock id or <literal>None</literal>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>set_mark_category_icon_from_stock</methodname>() method
+ sets the icon to be used for category to the stock item stock_id. If stock_id
+ is <literal>None</literal>, the icon is unset.
+ </para>
+ </refsect2>
+
<refsect2 id="method-gtksourceview2--set-mark-category-pixbuf">
<title>gtksourceview2.View.set_mark_category_pixbuf</title>
@@ -959,6 +1122,91 @@
</para>
</refsect2>
+ <refsect2 id="method-gtksourceview2--set-mark-category-tooltip-func">
+ <title>gtksourceview2.View.set_mark_category_tooltip_func</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_mark_category_tooltip_func</methodname>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ <methodparam><parameter role="keyword">func</parameter></methodparam>
+ <methodparam><parameter role="keyword">user_data</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">func</parameter> :</term>
+ <listitem><simpara>a function or <literal>None</literal>.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">user_data</parameter> :</term>
+ <listitem><simpara>user data which will be passed to func.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>set_mark_category_tooltip_func</methodname>() method
+ sets a func used to set tooltip on marks from the given mark category.
+ If func is <literal>None</literal> and markup_func is <literal>None</literal>
+ then tooltips will not be shown for marks from category. If markup_func is not
+ <literal>None</literal> markup_func is going to be used instead of func.
+ </para>
+
+<programlisting>
+ def markuptooltipfunc(mark, user_data)</programlisting>
+
+ <para>
+ Where mark is the <link linkend="class-gtksourcemark2">gtksourceview2.Mark</link> to use,
+ user_data is the data passed to set_mark_category_tooltip_func().
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtksourceview2--set-mark-category-tooltip-markup_func">
+ <title>gtksourceview2.View.set_mark_category_tooltip_markup_func</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_mark_category_tooltip_markup_func</methodname>
+ <methodparam><parameter role="keyword">category</parameter></methodparam>
+ <methodparam><parameter role="keyword">markup_func</parameter></methodparam>
+ <methodparam><parameter role="keyword">user_data</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">marker</parameter> :</term>
+ <listitem><simpara>a function or <literal>None</literal>.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">user_data</parameter> :</term>
+ <listitem><simpara>user data which will be passed to func.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ See <methodname><link linkend="method-gtksourceview2--set-mark-category-tooltip-func">gtksourceview2.View.set_mark_category_tooltip_func</link></methodname>
+ for more information.
+ </para>
+
+<programlisting>
+ def markuptooltipfunc(mark, user_data)</programlisting>
+
+ <para>
+ Where mark is the <link linkend="class-gtksourcemark2">gtksourceview2.Mark</link> to use,
+ user_data is the data passed to set_mark_category_tooltip_func().
+ </para>
+ </refsect2>
+
<refsect2 id="method-gtksourceview2--set-right-margin-position">
<title>gtksourceview2.View.set_right_margin_position</title>
@@ -1099,6 +1347,57 @@
<refsect1>
<title>Signals</title>
+ <refsect2 id="signal-gtksourceview--line-number-activated">
+ <title>The "line-number-activated" gtksourceview2.View Signal</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>callback</methodname>
+ <methodparam><parameter>sourceview</parameter></methodparam>
+ <methodparam><parameter>iter</parameter></methodparam>
+ <methodparam><parameter>event</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>sourceview</parameter> :</term>
+ <listitem><simpara>the sourceview that received the
+signal</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>iter</parameter> :</term>
+ <listitem><simpara>a
+ <link linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>event</parameter> :</term>
+ <listitem><simpara>the <link linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link>
+ that activated the event.
+ </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>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter> :</term>
+ <listitem><simpara>additional user parameters (if
+any)</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>The "line-number-activated" signal is emitted when a line mark has been activated
+ (for instance when there was a button press in the line marks gutter).
+ You can use iter to determine on which line the activation took place.
+ </para>
+
+ </refsect2>
+
<refsect2 id="signal-gtksourceview--redo">
<title>The "redo" gtksourceview2.View Signal</title>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
