~ubuntu-branches/ubuntu/wily/nautilus-python/wily

<?xml version="1.0" standalone="no"?>

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"

    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

 

<refentry id="class-nautilus-python-column-provider">

  <refnamediv>

    <refname>Nautilus.ColumnProvider</refname>

    <refpurpose>Nautilus.ColumnProvider Reference</refpurpose>

  </refnamediv>

 

<!-- ******************************* -->

<!-- BEGIN OF SYNOPSIS -->

<!-- ******************************* -->

 

  <refsect1>

    <title>Synopsis</title>

 

    <classsynopsis language="python">

      <ooclass><classname>Nautilus.ColumnProvider</classname></ooclass>

 

      <methodsynopsis language="python">

        <methodname><link linkend="method-nautilus-column-provider--get-columns">get_columns</link></methodname>

          <methodparam></methodparam>

      </methodsynopsis>

    </classsynopsis>

  </refsect1>

 

<!-- ********************************** -->

<!-- BEGIN OF DESCRIPTION -->

<!-- ********************************** -->

 

  <refsect1 id="description-column-provider">

    <title>Description</title>

 

      <para>

        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> 

        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>

    <programlisting>

import os

import urllib

 

import gobject

from gi.repository import Nautilus

 

class ColumnExtension(gobject.GObject, Nautilus.ColumnProvider, Nautilus.InfoProvider):

    def __init__(self):

        pass

    

    def get_columns(self):

        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':

            return

        

        filename = urllib.unquote(file.get_uri()[7:])

        

        file.add_string_attribute('block_size', str(os.stat(filename).st_blksize))

    </programlisting>

</example>

        

  </refsect1>

 

<!-- ****************************** -->

<!-- BEGIN OF METHODS -->

<!-- ****************************** -->

 

  <refsect1>

        <title>Passive Methods</title>

 

        <refsect2 id="method-nautilus-column-provider--get-columns">

          <title>Nautilus.ColumnProvider.get_columns</title>

 

          <programlisting><methodsynopsis language="python">

            <methodname>get_columns</methodname>

              <methodparam></methodparam>

          </methodsynopsis></programlisting>

 

          <variablelist>

            <varlistentry>

              <term><emphasis>Returns</emphasis>&nbsp;:</term>

              <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>.

          </para>

        </refsect2>

    </refsect1>

 

</refentry>