1
<?xml version="1.0" standalone="no"?>
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
5
<refentry id="class-nautilus-python-column-provider">
7
<refname>Nautilus.ColumnProvider</refname>
8
<refpurpose>Nautilus.ColumnProvider Reference</refpurpose>
11
<!-- ******************************* -->
12
<!-- BEGIN OF SYNOPSIS -->
13
<!-- ******************************* -->
16
<title>Synopsis</title>
18
<classsynopsis language="python">
19
<ooclass><classname>Nautilus.ColumnProvider</classname></ooclass>
21
<methodsynopsis language="python">
22
<methodname><link linkend="method-nautilus-column-provider--get-columns">get_columns</link></methodname>
23
<methodparam></methodparam>
28
<!-- ********************************** -->
29
<!-- BEGIN OF DESCRIPTION -->
30
<!-- ********************************** -->
32
<refsect1 id="description-column-provider">
33
<title>Description</title>
36
If subclassed, Nautilus will request a list of <link linkend="class-nautilus-python-column"><classname>Nautilus.Column</classname></link>
37
objects, which are then displayed when the user is in <literal>List</literal> mode.
39
<note>An extension sub-classing <link linkend="class-nautilus-python-column-provider"><classname>Nautilus.ColumnProvider</classname></link>
40
will almost always want to sub-class <link linkend="class-info-provider"><classname>Nautilus.InfoProvider</classname></link>
41
as well, since that is how an extension provides information for each item in a directory listing.
46
<title>Nautilus.ColumnProvider Example</title>
52
from gi.repository import Nautilus
54
class ColumnExtension(gobject.GObject, Nautilus.ColumnProvider, Nautilus.InfoProvider):
58
def get_columns(self):
59
return Nautilus.Column(name="NautilusPython::block_size_column",
60
attribute="block_size",
62
description="Get the block size"),
64
def update_file_info(self, file):
65
if file.get_uri_scheme() != 'file':
68
filename = urllib.unquote(file.get_uri()[7:])
70
file.add_string_attribute('block_size', str(os.stat(filename).st_blksize))
76
<!-- ****************************** -->
77
<!-- BEGIN OF METHODS -->
78
<!-- ****************************** -->
81
<title>Passive Methods</title>
83
<refsect2 id="method-nautilus-column-provider--get-columns">
84
<title>Nautilus.ColumnProvider.get_columns</title>
86
<programlisting><methodsynopsis language="python">
87
<methodname>get_columns</methodname>
88
<methodparam></methodparam>
89
</methodsynopsis></programlisting>
93
<term><emphasis>Returns</emphasis> :</term>
94
<listitem><simpara>a list of <literal>Nautilus.Column</literal></simpara></listitem>
99
The <methodname>get_columns</methodname>() method returns a list of
100
<link linkend="class-nautilus-python-column"><classname>Nautilus.Column</classname></link>.