[nautilus-python/nautilus-3.0] Updated gtk-docs for 1.0
- From: Adam Plumb <adamplumb src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [nautilus-python/nautilus-3.0] Updated gtk-docs for 1.0
- Date: Sun, 17 Apr 2011 17:57:46 +0000 (UTC)
commit 5b388d06cbfd9a8453ac405b4c5bcaed1555465b
Author: Adam Plumb <adamplumb gmail com>
Date: Sun Apr 17 13:43:46 2011 -0400
Updated gtk-docs for 1.0
docs/reference/nautilus-python-column-provider.xml | 33 ++--
docs/reference/nautilus-python-column.xml | 16 +-
docs/reference/nautilus-python-file-info.xml | 54 +++---
docs/reference/nautilus-python-info-provider.xml | 67 +++---
.../nautilus-python-location-widget-provider.xml | 18 +-
docs/reference/nautilus-python-menu-item.xml | 32 ++--
docs/reference/nautilus-python-menu-provider.xml | 226 ++++++--------------
docs/reference/nautilus-python-menu.xml | 26 ++--
.../reference/nautilus-python-operation-result.xml | 16 +-
.../reference/nautilus-python-overview-example.xml | 65 +++---
.../reference/nautilus-python-overview-methods.xml | 4 +-
docs/reference/nautilus-python-overview.xml | 27 ++-
.../nautilus-python-property-page-provider.xml | 46 +++--
docs/reference/nautilus-python-property-page.xml | 16 +-
14 files changed, 283 insertions(+), 363 deletions(-)
---
diff --git a/docs/reference/nautilus-python-column-provider.xml b/docs/reference/nautilus-python-column-provider.xml
index f22872d..2c34072 100644
--- a/docs/reference/nautilus-python-column-provider.xml
+++ b/docs/reference/nautilus-python-column-provider.xml
@@ -4,8 +4,8 @@
<refentry id="class-nautilus-python-column-provider">
<refnamediv>
- <refname>nautilus.ColumnProvider</refname>
- <refpurpose>nautilus.ColumnProvider Reference</refpurpose>
+ <refname>Nautilus.ColumnProvider</refname>
+ <refpurpose>Nautilus.ColumnProvider Reference</refpurpose>
</refnamediv>
<!-- ******************************* -->
@@ -16,7 +16,7 @@
<title>Synopsis</title>
<classsynopsis language="python">
- <ooclass><classname>nautilus.ColumnProvider</classname></ooclass>
+ <ooclass><classname>Nautilus.ColumnProvider</classname></ooclass>
<methodsynopsis language="python">
<methodname><link linkend="method-nautilus-column-provider--get-columns">get_columns</link></methodname>
@@ -33,32 +33,33 @@
<title>Description</title>
<para>
- If subclassed, Nautilus will request a list of <link linkend="class-nautilus-python-column"><classname>nautilus.Column</classname></link>
+ If subclassed, Nautilus will request a list of <link linkend="class-nautilus-python-column"><classname>Nautilus.Column</classname></link>
objects, which are then displayed when the user is in <literal>List</literal> mode.
- <note>An extension sub-classing <link linkend="class-nautilus-python-column-provider"><classname>nautilus.ColumnProvider</classname></link>
- will almost always want to sub-class <link linkend="class-info-provider"><classname>nautilus.InfoProvider</classname></link>
+ <note>An extension sub-classing <link linkend="class-nautilus-python-column-provider"><classname>Nautilus.ColumnProvider</classname></link>
+ will almost always want to sub-class <link linkend="class-info-provider"><classname>Nautilus.InfoProvider</classname></link>
as well, since that is how an extension provides information for each item in a directory listing.
</note>
</para>
<example>
- <title>nautilus.ColumnProvider Example</title>
+ <title>Nautilus.ColumnProvider Example</title>
<programlisting>
import os
import urllib
-import nautilus
+import gobject
+from gi.repository import Nautilus
-class ColumnExtension(nautilus.ColumnProvider, nautilus.InfoProvider):
+class ColumnExtension(gobject.GObject, Nautilus.ColumnProvider, Nautilus.InfoProvider):
def __init__(self):
pass
def get_columns(self):
- return nautilus.Column("NautilusPython::block_size_column",
- "block_size",
- "Block size",
- "Get the block size"),
+ return Nautilus.Column(name="NautilusPython::block_size_column",
+ attribute="block_size",
+ label="Block size",
+ description="Get the block size"),
def update_file_info(self, file):
if file.get_uri_scheme() != 'file':
@@ -80,7 +81,7 @@ class ColumnExtension(nautilus.ColumnProvider, nautilus.InfoProvider):
<title>Passive Methods</title>
<refsect2 id="method-nautilus-column-provider--get-columns">
- <title>nautilus.ColumnProvider.get_columns</title>
+ <title>Nautilus.ColumnProvider.get_columns</title>
<programlisting><methodsynopsis language="python">
<methodname>get_columns</methodname>
@@ -90,13 +91,13 @@ class ColumnExtension(nautilus.ColumnProvider, nautilus.InfoProvider):
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara>a list of <literal>nautilus.Column</literal></simpara></listitem>
+ <listitem><simpara>a list of <literal>Nautilus.Column</literal></simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_columns</methodname>() method returns a list of
- <link linkend="class-nautilus-python-column"><classname>nautilus.Column</classname></link>.
+ <link linkend="class-nautilus-python-column"><classname>Nautilus.Column</classname></link>.
</para>
</refsect2>
</refsect1>
diff --git a/docs/reference/nautilus-python-column.xml b/docs/reference/nautilus-python-column.xml
index f027fcb..f314a8c 100644
--- a/docs/reference/nautilus-python-column.xml
+++ b/docs/reference/nautilus-python-column.xml
@@ -4,8 +4,8 @@
<refentry id="class-nautilus-python-column">
<refnamediv>
- <refname>nautilus.Column</refname>
- <refpurpose>nautilus.Column Reference</refpurpose>
+ <refname>Nautilus.Column</refname>
+ <refpurpose>Nautilus.Column Reference</refpurpose>
</refnamediv>
<!-- ******************************* -->
@@ -16,11 +16,11 @@
<title>Synopsis</title>
<classsynopsis language="python">
- <ooclass><classname>nautilus.Column</classname></ooclass>
+ <ooclass><classname>Nautilus.Column</classname></ooclass>
<ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
<constructorsynopsis language="python">
- <methodname><link linkend="constructor-nautilus-column">nautilus.Column</link></methodname>
+ <methodname><link linkend="constructor-nautilus-column">Nautilus.Column</link></methodname>
<methodparam><parameter role="keyword">name</parameter></methodparam>
<methodparam><parameter role="keyword">attribute</parameter></methodparam>
<methodparam><parameter role="keyword">label</parameter></methodparam>
@@ -37,7 +37,7 @@
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-nautilus-python-column">nautilus.Column</link>
+ +-- <link linkend="class-nautilus-python-column">Nautilus.Column</link>
</synopsis>
</refsect1>
@@ -50,7 +50,7 @@
<title>Description</title>
<para>
- A list of <link linkend="class-nautilus-python-column"><classname>nautilus.Column</classname></link> objects is returned by <link linkend="class-nautilus-python-column-provider"><classname>nautilus.ColumnProvider</classname></link> extensions.
+ A list of <link linkend="class-nautilus-python-column"><classname>Nautilus.Column</classname></link> objects is returned by <link linkend="class-nautilus-python-column-provider"><classname>Nautilus.ColumnProvider</classname></link> extensions.
</para>
</refsect1>
@@ -122,7 +122,7 @@
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
- <methodname>nautilus.Column</methodname>
+ <methodname>Nautilus.Column</methodname>
<methodparam><parameter role="keyword">name</parameter></methodparam>
<methodparam><parameter role="keyword">attribute</parameter></methodparam>
<methodparam><parameter role="keyword">label</parameter></methodparam>
@@ -149,7 +149,7 @@
</variablelist>
<para>
- Creates a new <link linkend="class-nautilus-python-column"><classname>nautilus.Column</classname></link> object.
+ Creates a new <link linkend="class-nautilus-python-column"><classname>Nautilus.Column</classname></link> object.
</para>
</refsect1>
diff --git a/docs/reference/nautilus-python-file-info.xml b/docs/reference/nautilus-python-file-info.xml
index 32451ae..5233f00 100644
--- a/docs/reference/nautilus-python-file-info.xml
+++ b/docs/reference/nautilus-python-file-info.xml
@@ -4,8 +4,8 @@
<refentry id="class-nautilus-python-file-info">
<refnamediv>
- <refname>nautilus.FileInfo</refname>
- <refpurpose>nautilus.FileInfo Reference</refpurpose>
+ <refname>Nautilus.FileInfo</refname>
+ <refpurpose>Nautilus.FileInfo Reference</refpurpose>
</refnamediv>
<!-- ******************************* -->
@@ -16,7 +16,7 @@
<title>Synopsis</title>
<classsynopsis language="python">
- <ooclass><classname>nautilus.FileInfo</classname></ooclass>
+ <ooclass><classname>Nautilus.FileInfo</classname></ooclass>
<ooclass><classname><link linkend="class-ginterface">gobject.GInterface</link></classname></ooclass>
<methodsynopsis language="python">
@@ -126,7 +126,7 @@
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-ginterface">gobject.GInterface</link>
- +-- <link linkend="class-nautilus-python-file-info">nautilus.FileInfo</link>
+ +-- <link linkend="class-nautilus-python-file-info">Nautilus.FileInfo</link>
</synopsis>
</refsect1>
@@ -139,8 +139,8 @@
<title>Description</title>
<para>
- <link linkend="class-nautilus-python-file-info"><classname>nautilus.FileInfo</classname></link> objects are passed
- to extensions by the <link linkend="class-nautilus-python-info-provider"><classname>nautilus.InfoProvider</classname></link>.
+ <link linkend="class-nautilus-python-file-info"><classname>Nautilus.FileInfo</classname></link> objects are passed
+ to extensions by the <link linkend="class-nautilus-python-info-provider"><classname>Nautilus.InfoProvider</classname></link>.
</para>
</refsect1>
@@ -154,7 +154,7 @@
<title>Public Methods</title>
<refsect2 id="method-nautilus-python-file-info--is-gone">
- <title>nautilus.FileInfo.is_gone</title>
+ <title>Nautilus.FileInfo.is_gone</title>
<programlisting><methodsynopsis language="python">
<methodname>is_gone</methodname>
</methodsynopsis></programlisting>
@@ -167,7 +167,7 @@
</refsect2>
<refsect2 id="method-nautilus-python-file-info--get-file-type">
- <title>nautilus.FileInfo.get_file_type</title>
+ <title>Nautilus.FileInfo.get_file_type</title>
<programlisting><methodsynopsis language="python">
<methodname>get_file_type</methodname>
</methodsynopsis></programlisting>
@@ -180,7 +180,7 @@
</refsect2>
<refsect2 id="method-nautilus-python-file-info--get-location">
- <title>nautilus.FileInfo.get_location</title>
+ <title>Nautilus.FileInfo.get_location</title>
<programlisting><methodsynopsis language="python">
<methodname>get_location</methodname>
</methodsynopsis></programlisting>
@@ -193,7 +193,7 @@
</refsect2>
<refsect2 id="method-nautilus-python-file-info--get-name">
- <title>nautilus.FileInfo.get_name</title>
+ <title>Nautilus.FileInfo.get_name</title>
<programlisting><methodsynopsis language="python">
<methodname>get_name</methodname>
</methodsynopsis></programlisting>
@@ -206,7 +206,7 @@
</refsect2>
<refsect2 id="method-nautilus-python-file-info--get-uri">
- <title>nautilus.FileInfo.get_uri</title>
+ <title>Nautilus.FileInfo.get_uri</title>
<programlisting><methodsynopsis language="python">
<methodname>get_uri</methodname>
</methodsynopsis></programlisting>
@@ -219,7 +219,7 @@
</refsect2>
<refsect2 id="method-nautilus-python-file-info--get-activation-uri">
- <title>nautilus.FileInfo.get_activation_uri</title>
+ <title>Nautilus.FileInfo.get_activation_uri</title>
<programlisting><methodsynopsis language="python">
<methodname>get_activation_uri</methodname>
</methodsynopsis></programlisting>
@@ -232,20 +232,20 @@
</refsect2>
<refsect2 id="method-nautilus-python-file-info--get-parent-info">
- <title>nautilus.FileInfo.get_parent_info</title>
+ <title>Nautilus.FileInfo.get_parent_info</title>
<programlisting><methodsynopsis language="python">
<methodname>get_parent_info</methodname>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara>the <link linkend="class-nautilus-python-file-info"><classname>nautilus.FileInfo</classname></link> object associated with the file's parent</simpara></listitem>
+ <listitem><simpara>the <link linkend="class-nautilus-python-file-info"><classname>Nautilus.FileInfo</classname></link> object associated with the file's parent</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="method-nautilus-python-file-info--get-parent-location">
- <title>nautilus.FileInfo.get_parent_location</title>
+ <title>Nautilus.FileInfo.get_parent_location</title>
<programlisting><methodsynopsis language="python">
<methodname>get_parent_location</methodname>
</methodsynopsis></programlisting>
@@ -258,7 +258,7 @@
</refsect2>
<refsect2 id="method-nautilus-python-file-info--get-parent-uri">
- <title>nautilus.FileInfo.get_parent_uri</title>
+ <title>Nautilus.FileInfo.get_parent_uri</title>
<programlisting><methodsynopsis language="python">
<methodname>get_parent_uri</methodname>
</methodsynopsis></programlisting>
@@ -271,7 +271,7 @@
</refsect2>
<refsect2 id="method-nautilus-python-file-info--get-mount">
- <title>nautilus.FileInfo.get_mount</title>
+ <title>Nautilus.FileInfo.get_mount</title>
<programlisting><methodsynopsis language="python">
<methodname>get_mount</methodname>
</methodsynopsis></programlisting>
@@ -284,7 +284,7 @@
</refsect2>
<refsect2 id="method-nautilus-python-file-info--get-uri-scheme">
- <title>nautilus.FileInfo.get_uri_scheme</title>
+ <title>Nautilus.FileInfo.get_uri_scheme</title>
<programlisting><methodsynopsis language="python">
<methodname>get_uri_scheme</methodname>
</methodsynopsis></programlisting>
@@ -297,7 +297,7 @@
</refsect2>
<refsect2 id="method-nautilus-python-file-info--get-mime-type">
- <title>nautilus.FileInfo.get_mime_type</title>
+ <title>Nautilus.FileInfo.get_mime_type</title>
<programlisting><methodsynopsis language="python">
<methodname>get_mime_type</methodname>
</methodsynopsis></programlisting>
@@ -310,7 +310,7 @@
</refsect2>
<refsect2 id="method-nautilus-python-file-info--is-mime-type">
- <title>nautilus.FileInfo.is_mime_type</title>
+ <title>Nautilus.FileInfo.is_mime_type</title>
<programlisting><methodsynopsis language="python">
<methodname>is_mime_type</methodname>
<methodparam><parameter role="keyword">mimetype</parameter></methodparam>
@@ -328,7 +328,7 @@
</refsect2>
<refsect2 id="method-nautilus-python-file-info--is-directory">
- <title>nautilus.FileInfo.is_directory</title>
+ <title>Nautilus.FileInfo.is_directory</title>
<programlisting><methodsynopsis language="python">
<methodname>is_directory</methodname>
</methodsynopsis></programlisting>
@@ -341,7 +341,7 @@
</refsect2>
<refsect2 id="method-nautilus-python-file-info--can-write">
- <title>nautilus.FileInfo.can_write</title>
+ <title>Nautilus.FileInfo.can_write</title>
<programlisting><methodsynopsis language="python">
<methodname>can_write</methodname>
</methodsynopsis></programlisting>
@@ -354,7 +354,7 @@
</refsect2>
<refsect2 id="method-nautilus-python-file-info--add-emblem">
- <title>nautilus.FileInfo.add_emblem</title>
+ <title>Nautilus.FileInfo.add_emblem</title>
<programlisting><methodsynopsis language="python">
<methodname>add_emblem</methodname>
<methodparam><parameter role="keyword">emblem_name</parameter></methodparam>
@@ -368,7 +368,7 @@
</refsect2>
<refsect2 id="method-nautilus-python-file-info--get-string-attribute">
- <title>nautilus.FileInfo.get_string_attribute</title>
+ <title>Nautilus.FileInfo.get_string_attribute</title>
<programlisting><methodsynopsis language="python">
<methodname>get_string_attribute</methodname>
<methodparam><parameter role="keyword">attribute_name</parameter></methodparam>
@@ -386,7 +386,7 @@
</refsect2>
<refsect2 id="method-nautilus-python-file-info--add-string-attribute">
- <title>nautilus.FileInfo.add_string_attribute</title>
+ <title>Nautilus.FileInfo.add_string_attribute</title>
<programlisting><methodsynopsis language="python">
<methodname>add_string_attribute</methodname>
<methodparam><parameter role="keyword">attribute_name</parameter></methodparam>
@@ -405,12 +405,12 @@
</refsect2>
<refsect2 id="method-nautilus-python-file-info--invalidate-extension-info">
- <title>nautilus.FileInfo.invalidate_extension_info</title>
+ <title>Nautilus.FileInfo.invalidate_extension_info</title>
<programlisting><methodsynopsis language="python">
<methodname>invalidate_extension_info</methodname>
</methodsynopsis></programlisting>
<para>Invalidates the information Nautilus has about this file, which causes it to request new information
- from its <link linkend="class-nautilus-python-info-provider"><classname>nautilus.InfoProvider</classname></link> providers.</para>
+ from its <link linkend="class-nautilus-python-info-provider"><classname>Nautilus.InfoProvider</classname></link> providers.</para>
</refsect2>
</refsect1>
diff --git a/docs/reference/nautilus-python-info-provider.xml b/docs/reference/nautilus-python-info-provider.xml
index f255781..f2eac35 100644
--- a/docs/reference/nautilus-python-info-provider.xml
+++ b/docs/reference/nautilus-python-info-provider.xml
@@ -4,8 +4,8 @@
<refentry id="class-nautilus-python-info-provider">
<refnamediv>
- <refname>nautilus.InfoProvider</refname>
- <refpurpose>nautilus.InfoProvider Reference</refpurpose>
+ <refname>Nautilus.InfoProvider</refname>
+ <refpurpose>Nautilus.InfoProvider Reference</refpurpose>
</refnamediv>
<!-- ******************************* -->
@@ -16,7 +16,7 @@
<title>Synopsis</title>
<classsynopsis language="python">
- <ooclass><classname>nautilus.InfoProvider</classname></ooclass>
+ <ooclass><classname>Nautilus.InfoProvider</classname></ooclass>
<methodsynopsis language="python">
<methodname><link linkend="method-nautilus-python-info-provider--update-file-info">update_file_info</link></methodname>
@@ -38,11 +38,11 @@
</methodsynopsis>
<methodsynopsis language="python">
- <methodname><link linkend="method-nautilus-python-info-provider--update-complete-invoke">update_complete_invoke</link></methodname>
+ <methodname><link linkend="method-nautilus-python-info-provider--update-complete-invoke">Nautilus.info_provider_update_complete_invoke</link></methodname>
<methodparam><parameter role="keyword">provider</parameter></methodparam>
<methodparam><parameter role="keyword">handle</parameter></methodparam>
<methodparam><parameter role="keyword">closure</parameter></methodparam>
- <methodparam><parameter role="keyword">result</parameter><initializer>nautilus.OPERATION_COMPLETE</initializer></methodparam>
+ <methodparam><parameter role="keyword">result</parameter><initializer>Nautilus.OperationResult.COMPLETE</initializer></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
@@ -61,18 +61,21 @@
</para>
<example>
- <title>nautilus.InfoProvider Example</title>
+ <title>Nautilus.InfoProvider Example</title>
<programlisting>
-import os.path
-import nautilus
+import gobject
+from gi.repository import Nautilus
-class SimpleInfoProviderExample(nautilus.InfoProvider):
+class UpdateFileInfoAsync(gobject.GObject, Nautilus.InfoProvider):
def __init__(self):
pass
- def update_file_info(self, file):
- if os.path.splitext(file.get_name())[1] == ".mp3":
- file.add_emblem("multimedia")
+ def update_file_info_full(self, provider, handle, closure, file):
+ gobject.timeout_add_seconds(3, self.update_cb, provider, handle, closure)
+ return Nautilus.OperationResult.IN_PROGRESS
+
+ def update_cb(self, provider, handle, closure):
+ Nautilus.info_provider_update_complete_invoke(closure, provider, handle, Nautilus.OperationResult.FAILED)
</programlisting>
</example>
@@ -86,7 +89,7 @@ class SimpleInfoProviderExample(nautilus.InfoProvider):
<title>Passive Methods</title>
<refsect2 id="method-nautilus-python-info-provider--update-file-info">
- <title>nautilus.InfoProvider.update_file_info</title>
+ <title>Nautilus.InfoProvider.update_file_info</title>
<programlisting><methodsynopsis language="python">
<methodname>update_file_info</methodname>
@@ -96,7 +99,7 @@ class SimpleInfoProviderExample(nautilus.InfoProvider):
<variablelist>
<varlistentry>
<term><parameter role="keyword">file</parameter> :</term>
- <listitem><simpara>a <link linkend="class-nautilus-python-file-info"><classname>nautilus.FileInfo</classname></link> object</simpara></listitem>
+ <listitem><simpara>a <link linkend="class-nautilus-python-file-info"><classname>Nautilus.FileInfo</classname></link> object</simpara></listitem>
</varlistentry>
</variablelist>
@@ -108,7 +111,7 @@ class SimpleInfoProviderExample(nautilus.InfoProvider):
<refsect2 id="method-nautilus-python-info-provider--update-file-info-full">
- <title>nautilus.InfoProvider.update_file_info_full</title>
+ <title>Nautilus.InfoProvider.update_file_info_full</title>
<programlisting><methodsynopsis language="python">
<methodname>update_file_info_full</methodname>
@@ -121,7 +124,7 @@ class SimpleInfoProviderExample(nautilus.InfoProvider):
<variablelist>
<varlistentry>
<term><parameter role="keyword">provider</parameter> :</term>
- <listitem><simpara>the current <link linkend="class-nautilus-python-info-provider"><classname>nautilus.InfoProvider</classname></link> instance</simpara></listitem>
+ <listitem><simpara>the current <link linkend="class-nautilus-python-info-provider"><classname>Nautilus.InfoProvider</classname></link> instance</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">handle</parameter> :</term>
@@ -129,21 +132,21 @@ class SimpleInfoProviderExample(nautilus.InfoProvider):
</varlistentry>
<varlistentry>
<term><parameter role="keyword">closure</parameter> :</term>
- <listitem><simpara>a C Closure that must be passed to <link linkend="method-nautilus-python-info-provider--update-complete-invoke">update_complete_invoke</link> if that method is called</simpara></listitem>
+ <listitem><simpara>a C Closure that must be passed to <link linkend="method-nautilus-python-info-provider--update-complete-invoke">Nautilus.info_provider_update_complete_invoke</link> if that method is called</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">file</parameter> :</term>
- <listitem><simpara>a <link linkend="class-nautilus-python-file-info"><classname>nautilus.FileInfo</classname></link> object</simpara></listitem>
+ <listitem><simpara>a <link linkend="class-nautilus-python-file-info"><classname>Nautilus.FileInfo</classname></link> object</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara>None or a <link linkend="enum-nautilus-python-operation-result"><classname>nautilus.OperationResult</classname></link> enum</simpara></listitem>
+ <listitem><simpara>None or a <link linkend="enum-nautilus-python-operation-result"><classname>Nautilus.OperationResult</classname></link> enum</simpara></listitem>
</varlistentry>
</variablelist>
<para>
This method is called by Nautilus for each file or folder that exists under the
- current directory listing. Originally, <link linkend="class-nautilus-python-info-provider"><classname>nautilus.InfoProvider</classname></link>
+ current directory listing. Originally, <link linkend="class-nautilus-python-info-provider"><classname>Nautilus.InfoProvider</classname></link>
only provided the update_file_info
method, which blocked Nautilus when the method required a lot of computation time. This method was
created to allow an extension to tell Nautilus that it will be spending time on an operation and that
@@ -151,8 +154,8 @@ class SimpleInfoProviderExample(nautilus.InfoProvider):
</para>
<para>
In order to notify Nautilus of your extension's intentions, you must return a
- <link linkend="enum-nautilus-python-operation-result"><classname>nautilus.OperationResult</classname></link> enum.
- Then, when the operation has completed, call the self.update_complete_invoke method, passing the provider,
+ <link linkend="enum-nautilus-python-operation-result"><classname>Nautilus.OperationResult</classname></link> enum.
+ Then, when the operation has completed, call the Nautilus.info_provider_update_complete_invoke method, passing the provider,
handle and closure variables as parameters.
</para>
<para>
@@ -167,7 +170,7 @@ class SimpleInfoProviderExample(nautilus.InfoProvider):
<refsect2 id="method-nautilus-python-info-provider--cancel-update">
- <title>nautilus.InfoProvider.cancel_update</title>
+ <title>Nautilus.InfoProvider.cancel_update</title>
<programlisting><methodsynopsis language="python">
<methodname>cancel_update</methodname>
@@ -178,7 +181,7 @@ class SimpleInfoProviderExample(nautilus.InfoProvider):
<variablelist>
<varlistentry>
<term><parameter role="keyword">provider</parameter> :</term>
- <listitem><simpara>the current <link linkend="class-nautilus-python-info-provider"><classname>nautilus.InfoProvider</classname></link> instance</simpara></listitem>
+ <listitem><simpara>the current <link linkend="class-nautilus-python-info-provider"><classname>Nautilus.InfoProvider</classname></link> instance</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">handle</parameter> :</term>
@@ -202,20 +205,20 @@ class SimpleInfoProviderExample(nautilus.InfoProvider):
<title>Active Methods</title>
<refsect2 id="method-nautilus-python-info-provider--update-complete-invoke">
- <title>nautilus.InfoProvider.update_complete_invoke</title>
+ <title>Nautilus.info_provider_update_complete_invoke</title>
<programlisting><methodsynopsis language="python">
- <methodname>update_complete_invoke</methodname>
+ <methodname>info_provider_update_complete_invoke</methodname>
<methodparam><parameter role="keyword">provider</parameter></methodparam>
<methodparam><parameter role="keyword">handle</parameter></methodparam>
<methodparam><parameter role="keyword">closure</parameter></methodparam>
- <methodparam><parameter role="keyword">result</parameter><initializer>nautilus.OPERATION_COMEPLETE</initializer></methodparam>
+ <methodparam><parameter role="keyword">result</parameter><initializer>Nautilus.OperationResult.COMPLETE</initializer></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">provider</parameter> :</term>
- <listitem><simpara>the current <link linkend="class-nautilus-python-info-provider"><classname>nautilus.InfoProvider</classname></link> instance</simpara></listitem>
+ <listitem><simpara>the current <link linkend="class-nautilus-python-info-provider"><classname>Nautilus.InfoProvider</classname></link> instance</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">handle</parameter> :</term>
@@ -223,18 +226,18 @@ class SimpleInfoProviderExample(nautilus.InfoProvider):
</varlistentry>
<varlistentry>
<term><parameter role="keyword">closure</parameter> :</term>
- <listitem><simpara>a C Closure that must be passed to <link linkend="method-nautilus-python-info-provider--update-complete-invoke">update_complete_invoke</link> if that method is called</simpara></listitem>
+ <listitem><simpara>a C Closure that must be passed to <link linkend="method-nautilus-python-info-provider--update-complete-invoke">Nautilus.info_provider_update_complete_invoke</link> if that method is called</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">result</parameter> :</term>
- <listitem><simpara>an optional parameter. If left out, <link linkend="enum-nautilus-python-operation-result--OPERATION_COMPLETE"><classname>nautilus.OPERATION_COMPLETE</classname></link> is assumed.
- Otherwise, you may pass any any of the <link linkend="enum-nautilus-python-operation-result"><classname>nautilus.OperationResult</classname></link> enums.</simpara></listitem>
+ <listitem><simpara>an optional parameter. If left out, <link linkend="enum-nautilus-python-operation-result--OPERATION_COMPLETE"><classname>Nautilus.OperationResult.COMPLETE</classname></link> is assumed.
+ Otherwise, you may pass any any of the <link linkend="enum-nautilus-python-operation-result"><classname>Nautilus.OperationResult</classname></link> enums.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
An extension must call this method for each update_file_info_full method that
- returns the <link linkend="enum-nautilus-python-operation-result--OPERATION_IN_PROGRESS"><classname>nautilus.OPERATION_IN_PROGRESS</classname></link> enum.
+ returns the <link linkend="enum-nautilus-python-operation-result--OPERATION_IN_PROGRESS"><classname>Nautilus.OperationResult.IN_PROGRESS</classname></link> enum.
The method must be called with the provider, handle, and closure parameters which were passed to the earlier <link linkend="method-nautilus-python-info-provider--update-file-info-full"><function>update_file_info_full</function></link> method.
</para>
<note>
diff --git a/docs/reference/nautilus-python-location-widget-provider.xml b/docs/reference/nautilus-python-location-widget-provider.xml
index 7da0b9e..efccc7a 100644
--- a/docs/reference/nautilus-python-location-widget-provider.xml
+++ b/docs/reference/nautilus-python-location-widget-provider.xml
@@ -4,8 +4,8 @@
<refentry id="class-nautilus-python-location-widget-provider">
<refnamediv>
- <refname>nautilus.LocationWidgetProvider</refname>
- <refpurpose>nautilus.LocationWidgetProvider Reference</refpurpose>
+ <refname>Nautilus.LocationWidgetProvider</refname>
+ <refpurpose>Nautilus.LocationWidgetProvider Reference</refpurpose>
</refnamediv>
<!-- ******************************* -->
@@ -16,7 +16,7 @@
<title>Synopsis</title>
<classsynopsis language="python">
- <ooclass><classname>nautilus.LocationWidgetProvider</classname></ooclass>
+ <ooclass><classname>Nautilus.LocationWidgetProvider</classname></ooclass>
<methodsynopsis language="python">
<methodname><link linkend="method-nautilus-location-widget-provider--get-widget">get_widget</link></methodname>
@@ -38,17 +38,17 @@
</para>
<example>
- <title>nautilus.LocationWidgetProvider Example</title>
+ <title>Nautilus.LocationWidgetProvider Example</title>
<programlisting>
-import nautilus
-import gtk
+import gobject
+from gi.repository import Nautilus, Gtk
-class LocationProviderExample(nautilus.LocationWidgetProvider):
+class LocationProviderExample(gobject.GObject, Nautilus.LocationWidgetProvider):
def __init__(self):
pass
def get_widget(self, uri, window):
- entry = gtk.Entry()
+ entry = Gtk.Entry()
entry.set_text(uri)
entry.show()
return entry
@@ -65,7 +65,7 @@ class LocationProviderExample(nautilus.LocationWidgetProvider):
<title>Passive Methods</title>
<refsect2 id="method-nautilus-location-widget-provider--get-widget">
- <title>nautilus.LocationWidgetProvider.get_widget</title>
+ <title>Nautilus.LocationWidgetProvider.get_widget</title>
<programlisting><methodsynopsis language="python">
<methodname>get_widget</methodname>
diff --git a/docs/reference/nautilus-python-menu-item.xml b/docs/reference/nautilus-python-menu-item.xml
index 6750711..939aed2 100644
--- a/docs/reference/nautilus-python-menu-item.xml
+++ b/docs/reference/nautilus-python-menu-item.xml
@@ -4,8 +4,8 @@
<refentry id="class-nautilus-python-menu-item">
<refnamediv>
- <refname>nautilus.MenuItem</refname>
- <refpurpose>nautilus.MenuItem Reference</refpurpose>
+ <refname>Nautilus.MenuItem</refname>
+ <refpurpose>Nautilus.MenuItem Reference</refpurpose>
</refnamediv>
<!-- ******************************* -->
@@ -16,11 +16,11 @@
<title>Synopsis</title>
<classsynopsis language="python">
- <ooclass><classname>nautilus.MenuItem</classname></ooclass>
+ <ooclass><classname>Nautilus.MenuItem</classname></ooclass>
<ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
<constructorsynopsis language="python">
- <methodname><link linkend="constructor-nautilus-menu-item">nautilus.MenuItem</link></methodname>
+ <methodname><link linkend="constructor-nautilus-menu-item">Nautilus.MenuItem</link></methodname>
<methodparam><parameter role="keyword">name</parameter></methodparam>
<methodparam><parameter role="keyword">label</parameter></methodparam>
<methodparam><parameter role="keyword">tooltip</parameter></methodparam>
@@ -47,7 +47,7 @@
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-nautilus-python-menu-item">nautilus.MenuItem</link>
+ +-- <link linkend="class-nautilus-python-menu-item">Nautilus.MenuItem</link>
</synopsis>
</refsect1>
@@ -60,7 +60,7 @@
<title>Description</title>
<para>
- <link linkend="class-nautilus-python-menu-item"><classname>nautilus.MenuItem</classname></link> objects are appended to lists to create menus and submenus.
+ <link linkend="class-nautilus-python-menu-item"><classname>Nautilus.MenuItem</classname></link> objects are appended to lists to create menus and submenus.
</para>
</refsect1>
@@ -95,7 +95,7 @@
<row valign="top">
<entry>"<link linkend="property-nautilus-python-menu-item--menu">menu</link>"</entry>
- <entry>The <link linkend="class-nautilus-python-menu">nautilus.Menu</link> menu object belonging to this item. May be None.</entry>
+ <entry>The <link linkend="class-nautilus-python-menu">Nautilus.Menu</link> menu object belonging to this item. May be None.</entry>
<entry>Read-Write</entry>
</row>
@@ -161,7 +161,7 @@
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
- <methodname>nautilus.MenuItem</methodname>
+ <methodname>Nautilus.MenuItem</methodname>
<methodparam><parameter role="keyword">name</parameter></methodparam>
<methodparam><parameter role="keyword">label</parameter></methodparam>
<methodparam><parameter role="keyword">tooltip</parameter></methodparam>
@@ -188,7 +188,7 @@
</variablelist>
<para>
- Creates a new <link linkend="class-nautilus-python-menu-item"><classname>nautilus.MenuItem</classname></link> object.
+ Creates a new <link linkend="class-nautilus-python-menu-item"><classname>Nautilus.MenuItem</classname></link> object.
</para>
</refsect1>
@@ -201,18 +201,18 @@
<title>Public Methods</title>
<refsect2 id="method-nautilus-python-menu-item--activate">
- <title>nautilus.MenuItem.activate</title>
+ <title>Nautilus.MenuItem.activate</title>
<programlisting><methodsynopsis language="python">
<methodname>activate</methodname>
</methodsynopsis></programlisting>
<para>
- Generates the "<link linkend="signal-nautilus-python-menu-item--activate">activate</link>" signal for this <link linkend="class-nautilus-python-menu-item"><classname>nautilus.MenuItem</classname></link>.
+ Generates the "<link linkend="signal-nautilus-python-menu-item--activate">activate</link>" signal for this <link linkend="class-nautilus-python-menu-item"><classname>Nautilus.MenuItem</classname></link>.
</para>
</refsect2>
<refsect2 id="method-nautilus-python-menu-item--set_submenu">
- <title>nautilus.MenuItem.set_submenu</title>
+ <title>Nautilus.MenuItem.set_submenu</title>
<programlisting><methodsynopsis language="python">
<methodname>set_submenu</methodname>
<methodparam><parameter role="keyword">menu</parameter></methodparam>
@@ -220,11 +220,11 @@
<variablelist>
<varlistentry>
<term><parameter role="keyword">menu</parameter> :</term>
- <listitem><simpara>a <link linkend="class-nautilus-python-menu"><classname>nautilus.Menu</classname></link></simpara></listitem>
+ <listitem><simpara>a <link linkend="class-nautilus-python-menu"><classname>Nautilus.Menu</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<para>
- Attaches a <link linkend="class-nautilus-python-menu"><classname>nautilus.Menu</classname></link> as the submenu for this <link linkend="class-nautilus-python-menu-item"><classname>nautilus.MenuItem</classname></link>.
+ Attaches a <link linkend="class-nautilus-python-menu"><classname>Nautilus.Menu</classname></link> as the submenu for this <link linkend="class-nautilus-python-menu-item"><classname>Nautilus.MenuItem</classname></link>.
</para>
</refsect2>
</refsect1>
@@ -238,7 +238,7 @@
<title>Signal Details</title>
<refsect2 id="signal-nautilus-python-menu-item--activate">
- <title>The "activate" nautilus.MenuItem Signal</title>
+ <title>The "activate" Nautilus.MenuItem Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
@@ -250,7 +250,7 @@
<variablelist>
<varlistentry>
<term><parameter>item</parameter> :</term>
- <listitem><simpara>the <link linkend="class-nautilus-python-menu-item"><classname>nautilus.MenuItem</classname></link> being activated</simpara></listitem>
+ <listitem><simpara>the <link linkend="class-nautilus-python-menu-item"><classname>Nautilus.MenuItem</classname></link> being activated</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
diff --git a/docs/reference/nautilus-python-menu-provider.xml b/docs/reference/nautilus-python-menu-provider.xml
index 11649b8..1453cb1 100644
--- a/docs/reference/nautilus-python-menu-provider.xml
+++ b/docs/reference/nautilus-python-menu-provider.xml
@@ -4,8 +4,8 @@
<refentry id="class-nautilus-python-menu-provider">
<refnamediv>
- <refname>nautilus.MenuProvider</refname>
- <refpurpose>nautilus.MenuProvider Reference</refpurpose>
+ <refname>Nautilus.MenuProvider</refname>
+ <refpurpose>Nautilus.MenuProvider Reference</refpurpose>
</refnamediv>
<!-- ******************************* -->
@@ -16,7 +16,7 @@
<title>Synopsis</title>
<classsynopsis language="python">
- <ooclass><classname>nautilus.MenuProvider</classname></ooclass>
+ <ooclass><classname>Nautilus.MenuProvider</classname></ooclass>
<methodsynopsis language="python">
<methodname><link linkend="method-nautilus-python-menu-provider--get-file-items">get_file_items</link></methodname>
@@ -45,20 +45,7 @@
</methodsynopsis>
<methodsynopsis language="python">
- <methodname><link linkend="method-nautilus-python-menu-provider--get-toolbar-items">get_toolbar_items</link></methodname>
- <methodparam><parameter role="keyword">window</parameter></methodparam>
- <methodparam><parameter role="keyword">folder</parameter></methodparam>
- </methodsynopsis>
-
- <methodsynopsis language="python">
- <methodname><link linkend="method-nautilus-python-menu-provider--get-toolbar-items-full">get_toolbar_items_full</link></methodname>
- <methodparam><parameter role="keyword">provider</parameter></methodparam>
- <methodparam><parameter role="keyword">window</parameter></methodparam>
- <methodparam><parameter role="keyword">folder</parameter></methodparam>
- </methodsynopsis>
-
- <methodsynopsis language="python">
- <methodname><link linkend="method-nautilus-python-menu-provider--emit-items-updated-signal">emit_items_updated_signal</link></methodname>
+ <methodname><link linkend="method-nautilus-python-menu-provider--emit-items-updated-signal">Nautilus.menu_provider_emit_items_updated_signal</link></methodname>
<methodparam><parameter role="keyword">provider</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
@@ -72,61 +59,57 @@
<title>Description</title>
<para>
- If subclassed, Nautilus will request a list of <link linkend="class-nautilus-python-menu-item"><classname>nautilus.MenuItem</classname></link> objects,
+ If subclassed, Nautilus will request a list of <link linkend="class-nautilus-python-menu-item"><classname>Nautilus.MenuItem</classname></link> objects,
which are then attached to various menus. Nautilus expects at least one of
- the following methods to be defined (or their *_full variants): get_file_items,
- get_background_items, or get_toolbar_items.
+ the following methods to be defined (or their *_full variants): get_file_items or
+ get_background_items.</para>
+
+ <para>The get_toolbar_items methods were removed in nautilus-python 1.0 because they were removed from Nautilus 3. Technically, you should still be
+ able to call those methods with nautilus-python 1.0 if you are running Nautilus 2.x with annotations.
</para>
<example>
- <title>nautilus.MenuProvider Example</title>
+ <title>Nautilus.MenuProvider Example</title>
<programlisting>
-import os
-import urllib
-
-import gtk
-import nautilus
-import gconf
-
-TERMINAL_KEY = '/desktop/gnome/applications/terminal/exec'
+import gobject
+from gi.repository import Nautilus
-class OpenTerminalExtension(nautilus.MenuProvider):
+class ExampleMenuProvider(gobject.GObject, Nautilus.MenuProvider):
def __init__(self):
- self.client = gconf.client_get_default()
-
- def _open_terminal(self, file):
- filename = urllib.unquote(file.get_uri()[7:])
- terminal = self.client.get_string(TERMINAL_KEY)
-
- os.chdir(filename)
- os.system('%s &' % terminal)
+ pass
- def menu_activate_cb(self, menu, file):
- self._open_terminal(file)
-
- def menu_background_activate_cb(self, menu, file):
- self._open_terminal(file)
-
def get_file_items(self, window, files):
- if len(files) != 1:
- return
-
- file = files[0]
- if not file.is_directory() or file.get_uri_scheme() != 'file':
- return
-
- item = nautilus.MenuItem('NautilusPython::openterminal_file_item',
- 'Open Terminal' ,
- 'Open Terminal In %s' % file.get_name())
- item.connect('activate', self.menu_activate_cb, file)
- return item,
+ top_menuitem = Nautilus.MenuItem(name='ExampleMenuProvider::Foo',
+ label='Foo',
+ tip='',
+ icon='')
+
+ submenu = Nautilus.Menu()
+ top_menuitem.set_submenu(submenu)
+
+ sub_menuitem = Nautilus.MenuItem(name='ExampleMenuProvider::Bar',
+ label='Bar',
+ tip='',
+ icon='')
+ submenu.append_item(sub_menuitem)
+
+ return top_menuitem,
def get_background_items(self, window, file):
- item = nautilus.MenuItem('NautilusPython::openterminal_item',
- 'Open Terminal Here',
- 'Open Terminal In This Directory')
- item.connect('activate', self.menu_background_activate_cb, file)
- return item,
+ submenu = Nautilus.Menu()
+ submenu.append_item(Nautilus.MenuItem(name='ExampleMenuProvider::Bar2',
+ label='Bar2',
+ tip='',
+ icon=''))
+
+ menuitem = Nautilus.MenuItem(name='ExampleMenuProvider::Foo2',
+ label='Foo2',
+ tip='',
+ icon='')
+ menuitem.set_submenu(submenu)
+
+ return menuitem,
+
</programlisting>
</example>
@@ -159,7 +142,7 @@ class OpenTerminalExtension(nautilus.MenuProvider):
<title>Passive Methods</title>
<refsect2 id="method-nautilus-python-menu-provider--get-file-items">
- <title>nautilus.MenuProvider.get_file_items</title>
+ <title>Nautilus.MenuProvider.get_file_items</title>
<programlisting><methodsynopsis language="python">
<methodname>get_file_items</methodname>
@@ -174,22 +157,22 @@ class OpenTerminalExtension(nautilus.MenuProvider):
</varlistentry>
<varlistentry>
<term><parameter role="keyword">menu</parameter> :</term>
- <listitem><simpara>a list of <link linkend="class-nautilus-python-file-info"><classname>nautilus.FileInfo</classname></link> objects.</simpara></listitem>
+ <listitem><simpara>a list of <link linkend="class-nautilus-python-file-info"><classname>Nautilus.FileInfo</classname></link> objects.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara>a list of <link linkend="class-nautilus-python-menu-item"><classname>nautilus.MenuItem</classname></link> objects</simpara></listitem>
+ <listitem><simpara>a list of <link linkend="class-nautilus-python-menu-item"><classname>Nautilus.MenuItem</classname></link> objects</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_file_items</methodname>() method returns a list of
- <link linkend="class-nautilus-python-menu-item"><classname>nautilus.MenuItem</classname></link> objects.
+ <link linkend="class-nautilus-python-menu-item"><classname>Nautilus.MenuItem</classname></link> objects.
</para>
</refsect2>
<refsect2 id="method-nautilus-python-menu-provider--get-file-items-full">
- <title>nautilus.MenuProvider.get_file_items_full</title>
+ <title>Nautilus.MenuProvider.get_file_items_full</title>
<programlisting><methodsynopsis language="python">
<methodname>get_file_items_full</methodname>
@@ -201,7 +184,7 @@ class OpenTerminalExtension(nautilus.MenuProvider):
<variablelist>
<varlistentry>
<term><parameter role="keyword">provider</parameter> :</term>
- <listitem><simpara>the current <link linkend="class-nautilus-python-menu-provider"><classname>nautilus.MenuProvider</classname></link> instance</simpara></listitem>
+ <listitem><simpara>the current <link linkend="class-nautilus-python-menu-provider"><classname>Nautilus.MenuProvider</classname></link> instance</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">window</parameter> :</term>
@@ -209,21 +192,21 @@ class OpenTerminalExtension(nautilus.MenuProvider):
</varlistentry>
<varlistentry>
<term><parameter role="keyword">files</parameter> :</term>
- <listitem><simpara>a list of <link linkend="class-nautilus-python-file-info"><classname>nautilus.FileInfo</classname></link> objects.</simpara></listitem>
+ <listitem><simpara>a list of <link linkend="class-nautilus-python-file-info"><classname>Nautilus.FileInfo</classname></link> objects.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara>a list of <link linkend="class-nautilus-python-menu-item"><classname>nautilus.MenuItem</classname></link> objects</simpara></listitem>
+ <listitem><simpara>a list of <link linkend="class-nautilus-python-menu-item"><classname>Nautilus.MenuItem</classname></link> objects</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_file_items_full</methodname>() method returns a list of
- <link linkend="class-nautilus-python-menu-item"><classname>nautilus.MenuItem</classname> objects</link>.
+ <link linkend="class-nautilus-python-menu-item"><classname>Nautilus.MenuItem</classname> objects</link>.
</para>
<para>
This method was created in order to allow extension writers to call the
- <link linkend="method-nautilus-menu-provider--emit_items_updated_signal">nautilus.MenuProvider.emit_items_updated_signal</link>, which must
+ <link linkend="method-nautilus-menu-provider--emit_items_updated_signal">Nautilus.menu_provider_emit_items_updated_signal</link>, which must
be passed the current provider instance.
</para>
<note>
@@ -233,7 +216,7 @@ class OpenTerminalExtension(nautilus.MenuProvider):
<refsect2 id="method-nautilus-python-menu-provider--get-background-items">
- <title>nautilus.MenuProvider.get_background_items</title>
+ <title>Nautilus.MenuProvider.get_background_items</title>
<programlisting><methodsynopsis language="python">
<methodname>get_background_items</methodname>
@@ -248,22 +231,22 @@ class OpenTerminalExtension(nautilus.MenuProvider):
</varlistentry>
<varlistentry>
<term><parameter role="keyword">folder</parameter> :</term>
- <listitem><simpara>the current folder, as a <link linkend="class-nautilus-python-file-info"><classname>nautilus.FileInfo</classname></link> object.</simpara></listitem>
+ <listitem><simpara>the current folder, as a <link linkend="class-nautilus-python-file-info"><classname>Nautilus.FileInfo</classname></link> object.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara>a list of <link linkend="class-nautilus-python-menu-item"><classname>nautilus.MenuItem</classname></link> objects</simpara></listitem>
+ <listitem><simpara>a list of <link linkend="class-nautilus-python-menu-item"><classname>Nautilus.MenuItem</classname></link> objects</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_background_items</methodname>() method returns a list of
- <link linkend="class-nautilus-python-menu-item"><classname>nautilus.MenuItem</classname> objects</link>.
+ <link linkend="class-nautilus-python-menu-item"><classname>Nautilus.MenuItem</classname> objects</link>.
</para>
</refsect2>
<refsect2 id="method-nautilus-python-menu-provider--get-background-items-full">
- <title>nautilus.MenuProvider.get_background_items_full</title>
+ <title>Nautilus.MenuProvider.get_background_items_full</title>
<programlisting><methodsynopsis language="python">
<methodname>get_background_items_full</methodname>
@@ -275,7 +258,7 @@ class OpenTerminalExtension(nautilus.MenuProvider):
<variablelist>
<varlistentry>
<term><parameter role="keyword">provider</parameter> :</term>
- <listitem><simpara>the current <link linkend="class-nautilus-python-menu-provider"><classname>nautilus.MenuProvider</classname></link> instance</simpara></listitem>
+ <listitem><simpara>the current <link linkend="class-nautilus-python-menu-provider"><classname>Nautilus.MenuProvider</classname></link> instance</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">window</parameter> :</term>
@@ -283,21 +266,21 @@ class OpenTerminalExtension(nautilus.MenuProvider):
</varlistentry>
<varlistentry>
<term><parameter role="keyword">folder</parameter> :</term>
- <listitem><simpara>the current folder, as a <link linkend="class-nautilus-python-file-info"><classname>nautilus.FileInfo</classname></link> object.</simpara></listitem>
+ <listitem><simpara>the current folder, as a <link linkend="class-nautilus-python-file-info"><classname>Nautilus.FileInfo</classname></link> object.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara>a list of <link linkend="class-nautilus-python-menu-item"><classname>nautilus.MenuItem</classname></link> objects</simpara></listitem>
+ <listitem><simpara>a list of <link linkend="class-nautilus-python-menu-item"><classname>Nautilus.MenuItem</classname></link> objects</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_background_items_full</methodname>() method returns a list of
- <link linkend="class-nautilus-python-menu-item"><classname>nautilus.MenuItem</classname> objects</link>.
+ <link linkend="class-nautilus-python-menu-item"><classname>Nautilus.MenuItem</classname> objects</link>.
</para>
<para>
This method was created in order to allow extension writers to call the
- <link linkend="method-nautilus-menu-provider--emit_items_updated_signal">nautilus.MenuProvider.emit_items_updated_signal</link>, which must
+ <link linkend="method-nautilus-menu-provider--emit_items_updated_signal">Nautilus.menu_provider_emit_items_updated_signal</link>, which must
be passed the current provider instance.
</para>
<note>
@@ -305,96 +288,23 @@ class OpenTerminalExtension(nautilus.MenuProvider):
</note>
</refsect2>
-
- <refsect2 id="method-nautilus-python-menu-provider--get-toolbar-items">
- <title>nautilus.MenuProvider.get_toolbar_items</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_toolbar_items</methodname>
- <methodparam><parameter role="keyword">window</parameter></methodparam>
- <methodparam><parameter role="keyword">folder</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter> :</term>
- <listitem><simpara>the current <link linkend="class-gtkwindow"><classname>gtk.Window</classname></link> instance</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">folder</parameter> :</term>
- <listitem><simpara>the current folder, as a <link linkend="class-nautilus-python-file-info"><classname>nautilus.FileInfo</classname></link> object.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara>a list of <link linkend="class-nautilus-python-menu-item"><classname>nautilus.MenuItem</classname></link> objects</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>
- The <methodname>get_toolbar_items</methodname>() method returns a list of
- <link linkend="class-nautilus-python-menu-item"><classname>nautilus.MenuItem</classname> objects</link>.
- </para>
- </refsect2>
-
- <refsect2 id="method-nautilus-python-menu-provider--get-toolbar-items-full">
- <title>nautilus.MenuProvider.get_toolbar_items_full</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_toolbar_items_full</methodname>
- <methodparam><parameter role="keyword">provider</parameter></methodparam>
- <methodparam><parameter role="keyword">window</parameter></methodparam>
- <methodparam><parameter role="keyword">folder</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">provider</parameter> :</term>
- <listitem><simpara>the current <link linkend="class-nautilus-python-menu-provider"><classname>nautilus.MenuProvider</classname></link> instance</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">window</parameter> :</term>
- <listitem><simpara>the current <link linkend="class-gtkwindow"><classname>gtk.Window</classname></link> instance</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">folder</parameter> :</term>
- <listitem><simpara>the current folder, as a <link linkend="class-nautilus-python-file-info"><classname>nautilus.FileInfo</classname></link> object.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara>a list of <link linkend="class-nautilus-python-menu-item"><classname>nautilus.MenuItem</classname></link> objects</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>
- The <methodname>get_toolbar_items_full</methodname>() method returns a list of
- <link linkend="class-nautilus-python-menu-item"><classname>nautilus.MenuItem</classname> objects</link>.
- </para>
- <para>
- This method was created in order to allow extension writers to call the
- <link linkend="method-nautilus-menu-provider--emit_items_updated_signal">nautilus.MenuProvider.emit_items_updated_signal</link>, which must
- be passed the current provider instance.
- </para>
- <note>
- This method was introduced in nautilus-python 0.7.0.
- </note>
- </refsect2>
</refsect1>
<refsect1>
<title>Active Methods</title>
<refsect2 id="method-nautilus-python-menu-provider--emit-items-updated-signal">
- <title>nautilus.MenuProvider.emit_items_updated_signal</title>
+ <title>Nautilus.menu_provider_emit_items_updated_signal</title>
<programlisting><methodsynopsis language="python">
- <methodname>emit_items_updated_signal</methodname>
+ <methodname>menu_provider_emit_items_updated_signal</methodname>
<methodparam><parameter role="keyword">provider</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">provider</parameter> :</term>
- <listitem><simpara>the current <link linkend="class-nautilus-python-menu-provider"><classname>nautilus.MenuProvider</classname></link> instance</simpara></listitem>
+ <listitem><simpara>the current <link linkend="class-nautilus-python-menu-provider"><classname>Nautilus.MenuProvider</classname></link> instance</simpara></listitem>
</varlistentry>
</variablelist>
@@ -417,7 +327,7 @@ class OpenTerminalExtension(nautilus.MenuProvider):
<title>Signal Details</title>
<refsect2 id="signal-nautilus-python-menu-provider--items-updated">
- <title>The "items-updated" nautilus.MenuProvider Signal</title>
+ <title>The "items-updated" Nautilus.MenuProvider Signal</title>
<para>
Emits the "<link linkend="signal-nautilus-python-menu-provider--items-updated">items-updated</link>" signal.
diff --git a/docs/reference/nautilus-python-menu.xml b/docs/reference/nautilus-python-menu.xml
index fcb89a3..ce0e8f4 100644
--- a/docs/reference/nautilus-python-menu.xml
+++ b/docs/reference/nautilus-python-menu.xml
@@ -4,8 +4,8 @@
<refentry id="class-nautilus-python-menu">
<refnamediv>
- <refname>nautilus.Menu</refname>
- <refpurpose>nautilus.Menu Reference</refpurpose>
+ <refname>Nautilus.Menu</refname>
+ <refpurpose>Nautilus.Menu Reference</refpurpose>
</refnamediv>
<!-- ******************************* -->
@@ -16,11 +16,11 @@
<title>Synopsis</title>
<classsynopsis language="python">
- <ooclass><classname>nautilus.Menu</classname></ooclass>
+ <ooclass><classname>Nautilus.Menu</classname></ooclass>
<ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
<constructorsynopsis language="python">
- <methodname><link linkend="constructor-nautilus-menu">nautilus.Menu</link></methodname>
+ <methodname><link linkend="constructor-nautilus-menu">Nautilus.Menu</link></methodname>
</constructorsynopsis>
<methodsynopsis language="python">
@@ -43,7 +43,7 @@
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-nautilus-python-menu">nautilus.Menu</link>
+ +-- <link linkend="class-nautilus-python-menu">Nautilus.Menu</link>
</synopsis>
</refsect1>
@@ -56,7 +56,7 @@
<title>Description</title>
<para>
- A nautilus.Menu object allows an extension to create sub-menus.
+ A Nautilus.Menu object allows an extension to create sub-menus.
</para>
</refsect1>
@@ -71,11 +71,11 @@
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
- <methodname>nautilus.Menu</methodname>
+ <methodname>Nautilus.Menu</methodname>
</constructorsynopsis></programlisting>
<para>
- Creates a new <link linkend="class-nautilus-python-menu"><classname>nautilus.Menu</classname></link> object.
+ Creates a new <link linkend="class-nautilus-python-menu"><classname>Nautilus.Menu</classname></link> object.
</para>
</refsect1>
@@ -89,7 +89,7 @@
<title>Public Methods</title>
<refsect2 id="method-nautilus-python-menu--append_item">
- <title>nautilus.Menu.append_item</title>
+ <title>Nautilus.Menu.append_item</title>
<programlisting><methodsynopsis language="python">
<methodname>append_item</methodname>
<methodparam><parameter role="keyword">item</parameter></methodparam>
@@ -97,22 +97,22 @@
<variablelist>
<varlistentry>
<term><parameter role="keyword">item</parameter> :</term>
- <listitem><simpara>a <link linkend="class-nautilus-python-menu-item"><classname>nautilus.MenuItem</classname></link></simpara></listitem>
+ <listitem><simpara>a <link linkend="class-nautilus-python-menu-item"><classname>Nautilus.MenuItem</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<para>
- Append a <link linkend="class-nautilus-python-menu-item"><classname>nautilus.MenuItem</classname></link> to a <link linkend="class-nautilus-python-menu"><classname>nautilus.Menu</classname></link>.
+ Append a <link linkend="class-nautilus-python-menu-item"><classname>Nautilus.MenuItem</classname></link> to a <link linkend="class-nautilus-python-menu"><classname>Nautilus.Menu</classname></link>.
</para>
</refsect2>
<refsect2 id="method-nautilus-python-menu--get_items">
- <title>nautilus.Menu.get_items</title>
+ <title>Nautilus.Menu.get_items</title>
<programlisting><methodsynopsis language="python">
<methodname>get_items</methodname>
</methodsynopsis></programlisting>
<para>
- Returns a list of <link linkend="class-nautilus-python-menu-item"><classname>nautilus.MenuItem</classname></link> objects attached to the <link linkend="class-nautilus-python-menu"><classname>nautilus.Menu</classname></link>.
+ Returns a list of <link linkend="class-nautilus-python-menu-item"><classname>Nautilus.MenuItem</classname></link> objects attached to the <link linkend="class-nautilus-python-menu"><classname>Nautilus.Menu</classname></link>.
</para>
</refsect2>
</refsect1>
diff --git a/docs/reference/nautilus-python-operation-result.xml b/docs/reference/nautilus-python-operation-result.xml
index f1e1fe2..994747d 100644
--- a/docs/reference/nautilus-python-operation-result.xml
+++ b/docs/reference/nautilus-python-operation-result.xml
@@ -4,8 +4,8 @@
<refentry id="enum-nautilus-python-operation-result">
<refnamediv>
- <refname>nautilus.OperationResult</refname>
- <refpurpose>nautilus.OperationResult Reference</refpurpose>
+ <refname>Nautilus.OperationResult</refname>
+ <refpurpose>Nautilus.OperationResult Reference</refpurpose>
</refnamediv>
@@ -18,8 +18,8 @@
<title>Description</title>
<para>
- The <link linkend="enum-nautilus-python-operation-result"><classname>nautilus.OperationResult</classname></link> constants are
- used by the <link linkend="class-nautilus-python-info-provider"><classname>nautilus.InfoProvider</classname></link> provider to
+ The <link linkend="enum-nautilus-python-operation-result"><classname>Nautilus.OperationResult</classname></link> constants are
+ used by the <link linkend="class-nautilus-python-info-provider"><classname>Nautilus.InfoProvider</classname></link> provider to
notify Nautilus what the extension intends to do when Nautilus calls the extension's <link linkend="method-nautilus-python-info-provider--update-file-info-full">update_file_info_full</link>
method. The possible values are as follows:
</para>
@@ -27,20 +27,20 @@
<variablelist>
<varlistentry>
- <term><literal>nautilus.OPERATION_COMPLETE</literal></term>
+ <term><literal>Nautilus.OperationResult.COMPLETE</literal></term>
<listitem>
<simpara>The operation is complete and Nautilus can move on to the next <link linkend="method-nautilus-python-info-provider--update-file-info-full">update_file_info_full</link> call.</simpara>
</listitem>
</varlistentry>
<varlistentry>
- <term><literal>nautilus.OPERATION_IN_PROGRESS</literal></term>
+ <term><literal>Nautilus.OperationResult.IN_PROGRESS</literal></term>
<listitem>
- <simpara>The operation is in progress and running asynchronously and Nautilus should wait until the <link linkend="method-nautilus-python-info-provider--update-complete-invoke">update_complete_invoke</link> method
+ <simpara>The operation is in progress and running asynchronously and Nautilus should wait until the <link linkend="method-nautilus-python-info-provider--update-complete-invoke">Nautilus.info_provider_update_complete_invoke</link> method
is called before moving on to the next <link linkend="method-nautilus-python-info-provider--update-file-info-full">update_file_info_full</link> call.</simpara>
</listitem>
</varlistentry>
<varlistentry>
- <term><literal>nautilus.OPERATION_FAILED</literal></term>
+ <term><literal>Nautilus.OperationResult.FAILED</literal></term>
<listitem>
<simpara>The operation has failed.</simpara>
</listitem>
diff --git a/docs/reference/nautilus-python-overview-example.xml b/docs/reference/nautilus-python-overview-example.xml
index 98b3933..b49429f 100644
--- a/docs/reference/nautilus-python-overview-example.xml
+++ b/docs/reference/nautilus-python-overview-example.xml
@@ -11,49 +11,44 @@
<example>
<title>A Simple Extension</title>
<programlisting>
-import nautilus
-
-class SimpleMenuExtension(nautilus.MenuProvider):
-def __init__(self):
- pass
-
-def menu_activate_cb(self, menu, file):
- print "menu_activate_cb",file
-
-def get_file_items(self, window, files):
- if len(files) != 1:
- return
-
- file = files[0]
-
- item = nautilus.MenuItem(
- "SimpleMenuExtension::Show_File_Name",
- "Showing %s" % file.get_name(),
- "Showing %s" % file.get_name()
- )
- item.connect('activate', self.menu_activate_cb, file)
-
- return [item]</programlisting>
+import gobject
+from gi.repository import Nautilus
+
+class SimpleMenuExtension(gobject.GObject, Nautilus.MenuProvider):
+ def __init__(self):
+ pass
+
+ def menu_activate_cb(self, menu, file):
+ print "menu_activate_cb",file
+
+ def get_file_items(self, window, files):
+ if len(files) != 1:
+ return
+
+ file = files[0]
+
+ item = Nautilus.MenuItem(
+ name="SimpleMenuExtension::Show_File_Name",
+ label="Showing %s" % file.get_name(),
+ tip="Showing %s" % file.get_name()
+ )
+ item.connect('activate', self.menu_activate_cb, file)
+
+ return [item]</programlisting>
</example>
- <para>Save this file as TestExtension.py in the ~/.nautilus/python-extensions folder.
- You may need to create this folder. To run, open the terminal and type:</para>
-
- <informalexample>
- <programlisting>
-$ nautilus -q
-$ nautilus --no-desktop</programlisting>
- </informalexample>
+ <para>Save this file as TestExtension.py in the ~/.local/share/nautilus-python/extensions folder.
+ You may need to create this folder. To run, simply restart Nautilus.</para>
- <para>Once Nautilus starts, right-click on a file and you should see a new menu item,
+ <para>Once Nautilus restarts, right-click on a file and you should see a new menu item,
"Showing #filename#". It is as simple as that!</para>
<para>As mentioned above, in order to
- get loaded by Nautilus, a python extension must import the nautilus module,
- create a class derived from a nautilus *Provider, then create the methods that
+ get loaded by Nautilus, a python extension must import the Nautilus module from gi.repository,
+ create a class derived from a nautilus *Provider and a gobject.GObject, and create the methods that
will be called by Nautilus when it requests information from its providers.
In this case, when someone right-clicks on a file, Nautilus will ask all of its
MenuProviders for additional menu items to show the user. When folders or files are clicked,
- the get_file_items method is called and a list of nautilus.MenuItems is expected.</para>
+ the get_file_items method is called and a list of Nautilus.MenuItems is expected.</para>
</chapter>
diff --git a/docs/reference/nautilus-python-overview-methods.xml b/docs/reference/nautilus-python-overview-methods.xml
index e669c61..c56aa82 100644
--- a/docs/reference/nautilus-python-overview-methods.xml
+++ b/docs/reference/nautilus-python-overview-methods.xml
@@ -10,8 +10,8 @@
<para>Because nautilus-python is an interface to a Nautilus' extension interface rather than a true library, it is
rather quirky in how it works. One example of this is that several providers have additional public methods
that an extension actively calls, rather than the extension defining and the method in their class that is called by
- Nautilus. You can see this with the <link linkend="method-nautilus-python-menu-provider--emit-items-updated-signal">nautilus.MenuProvider.emit_items_updated_signal</link>
- and <link linkend="method-nautilus-python-info-provider--update-complete-invoke">nautilus.InfoProvider.update_complete_invoke</link> methods, which
+ Nautilus. You can see this with the <link linkend="method-nautilus--menu-provider-emit-items-updated-signal">Nautilus.menu_provider_emit_items_updated_signal</link>
+ and <link linkend="method-nautilus--info-provider-update-complete-invoke">Nautilus.info_provider_update_complete_invoke</link> methods, which
the extension actively calls, passing the provider instance as a parameter.
</para>
diff --git a/docs/reference/nautilus-python-overview.xml b/docs/reference/nautilus-python-overview.xml
index 40a2978..5f83fc4 100644
--- a/docs/reference/nautilus-python-overview.xml
+++ b/docs/reference/nautilus-python-overview.xml
@@ -6,9 +6,9 @@
<title>Overview</title>
- <para>Writing a Nautilus-Python extension is a fairly straight-forward process.
- One simply imports the nautilus module and creates a class which is derived from a number
- of the nautilus module's classes. When an extension derives a class, it becomes a "provider",
+ <para>Writing a Nautilus-Python extension is a fairly straight-forward process.
+ One simply imports the Nautilus module from the gobject introspection repository and creates a class which is derived from a gobject.GObject and
+ one of the Nautilus module's classes. When an extension derives a class, it becomes a "provider",
telling Nautilus to ask it for information. There are several types of providers
available for extensions to use: there is MenuProvider, LocationWidgetProvider,
ColumnProvider, PropertyPageProvider, and InfoProvider, all of which will be explained
@@ -16,20 +16,25 @@
<para>Here are the basic steps:</para>
- <para>1. A script is written and installed to the standard python extensions install path</para>
- <para>2. Nautilus is (re)started and loads the Nautilus-Python C extension, which in turn loads all python extensions</para>
- <para>3. Any python script in the standard python extensions install path that imports the nautilus module and derives
- the main class from a nautilus module class will be loaded</para>
+ <para>1. A script is written and installed to the standard nautilus-python extension install path</para>
+ <para>2. Nautilus is (re)started and loads the nautilus-python C extension, which in turn loads all python extensions it can find</para>
+ <para>3. Any python script in the standard nautilus-python extension install path that imports the Nautilus module from the gobject introspection repository and derives
+ the main class from a Nautilus module class will be loaded</para>
<note>
<title>A note about the standard python extensions install path</title>
-<para>The install path for individual users is ~/.nautilus/python-extensions. </para>
-<para>The system-wide install path is $PREFIX/lib/nautilus/extensions-2.0/python. However, some 64 bit distributions,
-such as Fedora, put Nautilus-Python extensions in $PREFIX/lib64/nautilus/extensions-2.0/python. </para>
-<para>As of nautilus-python 0.7.0, nautilus-python looks in ~/.local/share/nautilus-python/extensions
+<para>As of nautilus-python 0.7.0 (and continued in 1.0+), nautilus-python looks in ~/.local/share/nautilus-python/extensions
for local extensions and $PREFIX/share/nautilus-python/extensions for global extensions.</para>
</note>
+
+ <note>
+<title>A note about compatibility issues for nautilus-python 1.0</title>
+ <para>1. We no longer support the "import nautilus" command that previous versions used. This is because
+ nautilus-python now directly uses Nautilus's annotations, which must be imported by the "from gi.repository import Nautilus" command.</para>
+ <para>2. The extension class must now derive itself from a gobject.GObject in addition to the standard Nautilus classes.</para>
+ <para>3. For now, some Nautilus class constructors require passing named arguments instead of a standard argument list. This requirement may go away at some point.</para>
+ </note>
<xi:include href="nautilus-python-overview-example.xml"/>
<xi:include href="nautilus-python-overview-methods.xml"/>
diff --git a/docs/reference/nautilus-python-property-page-provider.xml b/docs/reference/nautilus-python-property-page-provider.xml
index ded08f8..1b5e79c 100644
--- a/docs/reference/nautilus-python-property-page-provider.xml
+++ b/docs/reference/nautilus-python-property-page-provider.xml
@@ -4,8 +4,8 @@
<refentry id="class-nautilus-python-property-page-provider">
<refnamediv>
- <refname>nautilus.PropertyPageProvider</refname>
- <refpurpose>nautilus.PropertyPageProvider Reference</refpurpose>
+ <refname>Nautilus.PropertyPageProvider</refname>
+ <refpurpose>Nautilus.PropertyPageProvider Reference</refpurpose>
</refnamediv>
<!-- ******************************* -->
@@ -16,7 +16,7 @@
<title>Synopsis</title>
<classsynopsis language="python">
- <ooclass><classname>nautilus.PropertyPageProvider</classname></ooclass>
+ <ooclass><classname>Nautilus.PropertyPageProvider</classname></ooclass>
<methodsynopsis language="python">
<methodname><link linkend="method-nautilus-property-page-provider--get-pages">get_pages</link></methodname>
@@ -38,15 +38,15 @@
</para>
<example>
- <title>nautilus.PropertyPageProvider Example</title>
+ <title>Nautilus.PropertyPageProvider Example</title>
<programlisting>
import hashlib
import urllib
-import gtk
-import nautilus
+import gobject
+from gi.repository import Nautilus, Gtk
-class MD5SumPropertyPage(nautilus.PropertyPageProvider):
+class MD5SumPropertyPage(gobject.GObject, Nautilus.PropertyPageProvider):
def __init__(self):
pass
@@ -63,25 +63,31 @@ class MD5SumPropertyPage(nautilus.PropertyPageProvider):
filename = urllib.unquote(file.get_uri()[7:])
- self.property_label = gtk.Label('MD5Sum')
+ self.property_label = Gtk.Label('MD5Sum')
self.property_label.show()
- self.hbox = gtk.HBox(0, False)
+ self.hbox = Gtk.HBox(homogeneous=False, spacing=0)
self.hbox.show()
- label = gtk.Label('MD5Sum:')
+ label = Gtk.Label('MD5Sum:')
label.show()
- self.hbox.pack_start(label)
+ self.hbox.pack_start(label, False, False, 0)
- self.value_label = gtk.Label()
- self.hbox.pack_start(self.value_label)
+ self.value_label = Gtk.Label()
+ self.hbox.pack_start(self.value_label, False, False, 0)
- md5sum = hashlib.md5(filename).hexdigest()
- self.value_label.set_text(md5sum)
+ md5sum = hashlib.md5()
+ with open(filename,'rb') as f:
+ for chunk in iter(lambda: f.read(8192), ''):
+ md5sum.update(chunk)
+ f.close()
+
+ self.value_label.set_text(md5sum.hexdigest())
self.value_label.show()
- return nautilus.PropertyPage("NautilusPython::md5_sum",
- self.property_label, self.hbox),
+ return Nautilus.PropertyPage(name="NautilusPython::md5_sum",
+ label=self.property_label,
+ page=self.hbox),
</programlisting>
</example>
@@ -95,7 +101,7 @@ class MD5SumPropertyPage(nautilus.PropertyPageProvider):
<title>Passive Methods</title>
<refsect2 id="method-nautilus-property-page-provider--get-pages">
- <title>nautilus.PropertyPageProvider.get_pages</title>
+ <title>Nautilus.PropertyPageProvider.get_pages</title>
<programlisting><methodsynopsis language="python">
<methodname>get_pages</methodname>
@@ -105,11 +111,11 @@ class MD5SumPropertyPage(nautilus.PropertyPageProvider):
<variablelist>
<varlistentry>
<term><parameter role="keyword">files</parameter> :</term>
- <listitem><simpara>a list of <link linkend="class-nautilus-python-file-info"><classname>nautilus.FileInfo</classname></link> objects.</simpara></listitem>
+ <listitem><simpara>a list of <link linkend="class-nautilus-python-file-info"><classname>Nautilus.FileInfo</classname></link> objects.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara>a list of <link linkend="class-nautilus-python-property-page"><classname>nautilus.PropertyPage</classname></link> objects</simpara></listitem>
+ <listitem><simpara>a list of <link linkend="class-nautilus-python-property-page"><classname>Nautilus.PropertyPage</classname></link> objects</simpara></listitem>
</varlistentry>
</variablelist>
diff --git a/docs/reference/nautilus-python-property-page.xml b/docs/reference/nautilus-python-property-page.xml
index 41fba5c..0216956 100644
--- a/docs/reference/nautilus-python-property-page.xml
+++ b/docs/reference/nautilus-python-property-page.xml
@@ -4,8 +4,8 @@
<refentry id="class-nautilus-python-property-page">
<refnamediv>
- <refname>nautilus.PropertyPage</refname>
- <refpurpose>nautilus.PropertyPage Reference</refpurpose>
+ <refname>Nautilus.PropertyPage</refname>
+ <refpurpose>Nautilus.PropertyPage Reference</refpurpose>
</refnamediv>
<!-- ******************************* -->
@@ -16,11 +16,11 @@
<title>Synopsis</title>
<classsynopsis language="python">
- <ooclass><classname>nautilus.PropertyPage</classname></ooclass>
+ <ooclass><classname>Nautilus.PropertyPage</classname></ooclass>
<ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
<constructorsynopsis language="python">
- <methodname><link linkend="constructor-nautilus-property-page">nautilus.PropertyPage</link></methodname>
+ <methodname><link linkend="constructor-nautilus-property-page">Nautilus.PropertyPage</link></methodname>
<methodparam><parameter role="keyword">name</parameter></methodparam>
<methodparam><parameter role="keyword">label</parameter></methodparam>
<methodparam><parameter role="keyword">page</parameter></methodparam>
@@ -36,7 +36,7 @@
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-nautilus-python-property-page">nautilus.PropertyPage</link>
+ +-- <link linkend="class-nautilus-python-property-page">Nautilus.PropertyPage</link>
</synopsis>
</refsect1>
@@ -49,7 +49,7 @@
<title>Description</title>
<para>
- A <link linkend="class-nautilus-python-property-page"><classname>nautilus.PropertyPage</classname></link> object is returned by <link linkend="class-nautilus-python-property-page-provider"><classname>nautilus.PropertyPageProvider</classname></link> extensions.
+ A <link linkend="class-nautilus-python-property-page"><classname>Nautilus.PropertyPage</classname></link> object is returned by <link linkend="class-nautilus-python-property-page-provider"><classname>Nautilus.PropertyPageProvider</classname></link> extensions.
</para>
</refsect1>
@@ -103,7 +103,7 @@
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
- <methodname>nautilus.PropertyPage</methodname>
+ <methodname>Nautilus.PropertyPage</methodname>
<methodparam><parameter role="keyword">name</parameter></methodparam>
<methodparam><parameter role="keyword">label</parameter></methodparam>
<methodparam><parameter role="keyword">page</parameter></methodparam>
@@ -125,7 +125,7 @@
</variablelist>
<para>
- Creates a new <link linkend="class-nautilus-python-property-page"><classname>nautilus.PropertyPage</classname></link> object.
+ Creates a new <link linkend="class-nautilus-python-property-page"><classname>Nautilus.PropertyPage</classname></link> object.
</para>
</refsect1>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
