path: root/docs/reference/pygtk-gtkentrycompletion.xml

<?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-gtkentrycompletion">
  <refnamediv>
    <refname>gtk.EntryCompletion</refname> <refpurpose>completion
    functionality for <link
    linkend="class-gtkentry"><classname>gtk.Entry</classname></link> (new in
    PyGTK 2.4)</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.EntryCompletion</classname></ooclass>
      <ooclass><classname><link
      linkend="class-gobject">gobject.GObject</link></classname></ooclass>
      <ooclass><classname><link
      linkend="class-gtkcelllayout">gtk.CellLayout</link></classname></ooclass>
      <constructorsynopsis language="python">
	<methodname><link
	linkend="constructor-gtkentrycompletion">gtk.EntryCompletion</link></methodname>
	<methodparam></methodparam> </constructorsynopsis>
      <methodsynopsis language="python">
	<methodname><link linkend="method-gtkentrycompletion--get-entry">get_entry</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link linkend="method-gtkentrycompletion--set-model">set_model</link></methodname>
	<methodparam><parameter role="keyword">model</parameter><initializer>None</initializer></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link linkend="method-gtkentrycompletion--get-model">get_model</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link linkend="method-gtkentrycompletion--set-match-func">set_match_func</link></methodname>
	<methodparam><parameter>func</parameter></methodparam>
	<methodparam><parameter>func_data</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link linkend="method-gtkentrycompletion--set-minimum-key-length">set_minimum_key_length</link></methodname>
	<methodparam><parameter role="keyword">length</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link linkend="method-gtkentrycompletion--get-minimum-key-length">get_minimum_key_length</link></methodname>
	<methodparam></methodparam>  </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link linkend="method-gtkentrycompletion--complete">complete</link></methodname>
	<methodparam></methodparam>  </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link linkend="method-gtkentrycompletion--insert-action-text">insert_action_text</link></methodname>
	<methodparam><parameter role="keyword">index</parameter></methodparam>
	<methodparam><parameter role="keyword">text</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link linkend="method-gtkentrycompletion--insert-action-markup">insert_action_markup</link></methodname>
	<methodparam><parameter role="keyword">index</parameter></methodparam>
	<methodparam><parameter role="keyword">markup</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link linkend="method-gtkentrycompletion--delete-action">delete_action</link></methodname>
	<methodparam><parameter role="keyword">index</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link linkend="method-gtkentrycompletion--insert-prefix">insert_prefix</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
	linkend="method-gtkentrycompletion--set-text-column">set_text_column</link></methodname>
	<methodparam><parameter
	role="keyword">column</parameter></methodparam>
      </methodsynopsis>

<!-- NOT IMPLEMENTED
      <methodsynopsis language="python">
	<methodname><link
	linkend="method-gtkentrycompletion- -get-text-column">get_text_column</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
END NOT IMPLEMENTED -->

      <methodsynopsis language="python">
	<methodname><link
	linkend="method-gtkentrycompletion--set-inline-completion">set_inline_completion</link></methodname>
	<methodparam><parameter
	role="keyword">inline_completion</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
	linkend="method-gtkentrycompletion--get-inline-completion">get_inline_completion</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
	linkend="method-gtkentrycompletion--set-popup-completion">set_popup_completion</link></methodname>
	<methodparam><parameter
	role="keyword">popup_completion</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
	linkend="method-gtkentrycompletion--get-popup-completion">get_popup_completion</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
    </classsynopsis>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-gtkentrycompletion">gtk.EntryCompletion</link> (implements <link linkend="class-gtkcelllayout">gtk.CellLayout</link>)
</synopsis>

  </refsect1>

  <refsect1>
    <title>Properties</title>

    <blockquote role="properties">
      <informaltable pgwide="1" frame="none">
	<tgroup cols="3">
	  <colspec column="1" colwidth="1in"/>
	  <colspec column="2" colwidth="1in"/>
	  <colspec column="3" colwidth="4in"/>
	  <tbody>

	    <row valign="top">
	      <entry>"inline-completion"</entry>
	      <entry>Read-Write</entry>
	      <entry>If <literal>TRUE</literal> the common prefix should be
inserted automatically. Default value: <literal>FALSE</literal>. Available
in GTK+ 2.6 and above.</entry>
	    </row>

	    <row valign="top">
	      <entry>"minimum-key-length"</entry>
	      <entry>Read-Write</entry>
	      <entry>Minimum length of the search key in order to look up
	      matches.</entry>
	    </row>

	    <row valign="top">
	      <entry>"model"</entry>
	      <entry>Read-Write</entry>
	      <entry>The <link 
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> to 
find matches in.</entry>
	    </row>

	    <row valign="top">
	      <entry>"popup-completion"</entry>
	      <entry>Read-Write</entry>
	      <entry>If <literal>TRUE</literal> the completions should be
shown in a popup window. Default value: <literal>TRUE</literal>. Available
in GTK+ 2.6 and above.</entry>
	    </row>

	    <row valign="top">
	      <entry>"text-column"</entry>
	      <entry>Read-Write</entry>
	      <entry>The column of the model containing the strings. Allowed
values: >= -1. Default value: -1. Available in GTK+ 2.6 and above.</entry>
	    </row>

	  </tbody>
	</tgroup>
      </informaltable>
    </blockquote>

  </refsect1>

  <refsect1>
    <title>Signal Prototypes</title>

    <variablelist>
      <varlistentry>
        <term>"<link linkend="signal-gtkentrycompletion--action-activated">action-activated</link>"</term>
        <listitem>
          <methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>completion</parameter></methodparam>
            <methodparam><parameter>index</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>"<link linkend="signal-gtkentrycompletion--insert-prefix">insert-prefix</link>"</term>
        <listitem>
          <methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>completion</parameter></methodparam>
            <methodparam><parameter>prefix</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>"<link linkend="signal-gtkentrycompletion--match-selected">match-selected</link>"</term>
        <listitem>
          <methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>completion</parameter></methodparam>
            <methodparam><parameter>model</parameter></methodparam>
            <methodparam><parameter>iter</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
    </variablelist>

  </refsect1>

  <refsect1>
    <title>Description</title>

    <note>
      <para>This widget is available in PyGTK 2.4 and above.</para>
    </note>

    <para><link
linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link>
is an auxiliary object to be used in conjunction with <link
linkend="class-gtkentry"><classname>gtk.Entry</classname></link> to provide
completion functionality. It implements the <link
linkend="class-gtkcelllayout"><classname>gtk.CellLayout</classname></link>
interface, to allow the user to add extra cells to the popup display of
completions.</para>

    <para>To add completion functionality to an entry, use the <link
linkend="method-gtkentry--set-completion"><methodname>gtk.Entry.set_completion</methodname>()</link>
method.  In addition to regular completion matches, that will be inserted
into the entry when they are selected, <link
linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link>
also allows "actions" to be displayed in the popup window below any
completions. Their appearance is similar to menuitems, to differentiate them
clearly from completion strings. When an action is selected, the
"action-activated" signal is emitted.</para>

    <para>A <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
(e.g. a <link
linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>)
containing the completion strings is associated with the <link
linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link>
using the <link
linkend="method-gtkentrycompletion--set-model"><methodname>set_model</methodname>()</link>
method. The tree model column containing the completion strings can be set
using the convenience method <link
linkend="method-gtkentrycompletion--set-text-column"><methodname>set_text_column</methodname>()</link>
that also creates a <link
linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link>
and packs it into the entry completion.</para>

    <para>Otherwise, you can create <link
linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
objects and pack them into the <link
linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link>
using the <link
linkend="class-gtkcelllayout"><classname>gtk.CellLayout</classname></link>
methods <link
linkend="method-gtkcelllayout--pack-start"><methodname>gtk.CellLayout.pack_start</methodname>()</link>
or <link
linkend="method-gtkcelllayout--pack-start"><methodname>gtk.CellLayout.pack_start</methodname>()</link>. However,
you will also have to define a match function and set it with the <link
linkend="method-gtkentrycompletion--set-match-func"><methodname>set_match_func</methodname>()</link>
method.</para>

    <para>If you wanted to create a completion list with the strings to
insert and some additional info e.g. an icon or description you could do
something like:</para>

    <programlisting>
  entry = gtk.Entry()
  completion = gtk.EntryCompletion()
  entry.set_completion(completion)
  liststore = gtk.ListStore(gobject.TYPE_STRING, gtk.gdk.Pixbuf)
  completion.set_model(liststore)
  pixbufcell = gtk.CellRendererPixbuf()
  completion.pack_start(pixbufcell)
  completion.add_attribute(pixbufcell, 'pixbuf', 1)
  # create a gtk.CellRendererText and pack it in the completion. Also set the
  # 'text' attribute
  completion.set_text_column(0)
  # load up the liststore with string - pixbuf data - assuming pixbuf created
  liststore.append(['string text', pixbuf])
</programlisting>

    <para>This will create an entry that will display a pixbuf and the text
string during completion.</para>

    <para>Actions are easily managed using the <link
    linkend="method-gtkentrycompletion--insert-action-text"><methodname>insert_action_text</methodname>()</link>,
    <link
    linkend="method-gtkentrycompletion--insert-action-markup"><methodname>insert_action_markup</methodname>()</link>
    and <link
    linkend="method-gtkentrycompletion--delete-action"><methodname>delete_action</methodname>()</link>
    methods.</para>

  </refsect1>

  <refsect1 id="constructor-gtkentrycompletion">
    <title>Constructor</title>

    <programlisting><constructorsynopsis language="python">
	<methodname>gtk.EntryCompletion</methodname>
	<methodparam></methodparam>  </constructorsynopsis></programlisting>
    <variablelist>
      <varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	<listitem><simpara>A newly created <link linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link> object.</simpara></listitem>
      </varlistentry>
    </variablelist>

    <note>
      <para>This constructor is available in PyGTK 2.4 and above.</para>
    </note>

    <para>Creates a new <link
linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link>
object.</para>

  </refsect1>

  <refsect1>
    <title>Methods</title>

  <refsect2 id="method-gtkentrycompletion--get-entry">
    <title>gtk.EntryCompletion.get_entry</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_entry</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>The <link
	  linkend="class-gtkentry"><classname>gtk.Entry</classname></link>
	  that the completion is attached to.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This method is available in PyGTK 2.4 and above.</para>
      </note>

      <para>The <methodname>get_entry</methodname>() method retrieves the
<link linkend="class-gtkentry"><classname>gtk.Entry</classname></link> that
the entry completion is attached to.</para>

    </refsect2>

    <refsect2 id="method-gtkentrycompletion--set-model">
      <title>gtk.EntryCompletion.set_model</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_model</methodname>
	  <methodparam><parameter role="keyword">model</parameter><initializer>None</initializer></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">model</parameter>&nbsp;:</term>
	  <listitem><simpara>The <link
	  linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
	  to use with the entry completion.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This method is available in PyGTK 2.4 and above.</para>
      </note>

      <para>The <methodname>set_model</methodname>() method sets the <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
specified by <parameter>model</parameter> to be used with the entry
completion. A previously set model will be removed before the new model
is set. If <parameter>model</parameter> is <literal>None</literal> or not
specified, the old model will be unset.</para>

      <note>
        <para>In PyGTK 2.4.0 the model could not be <literal>None</literal>
and did not default to <literal>None</literal>.</para>
      </note>

    </refsect2>

    <refsect2 id="method-gtkentrycompletion--get-model">
      <title>gtk.EntryCompletion.get_model</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_model</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>The current <link
	  linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>,
	  or <literal>None</literal> if not set.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This method is available in PyGTK 2.4 and above.</para>
      </note>

      <para>The <methodname>get_model</methodname>() method returns the
<link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
that the entry completion is using as data source. Returns
<literal>None</literal> if the model is unset.</para>

    </refsect2>

    <refsect2 id="method-gtkentrycompletion--set-match-func">
      <title>gtk.EntryCompletion.set_match_func</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_match_func</methodname>
	  <methodparam><parameter>func</parameter></methodparam>
	  <methodparam><parameter>func_data</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter>func</parameter>&nbsp;:</term>
	  <listitem><simpara>A function to be used.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>func_data</parameter>&nbsp;:</term>
	  <listitem><simpara>The user data for <parameter>func</parameter>.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This method is available in PyGTK 2.4 and above.</para>
      </note>

      <para>The <methodname>set_match_func</methodname>() method sets the
match function specified by <parameter>func</parameter>. The match function
is used by the entry completion to determine if a row of the associated tree
model should be in the completion list.</para>

      <para>The signature of the match function is:</para>

      <programlisting>
  def match_func(completion, key_string, iter, func_data):
</programlisting>

      <para>where <parameter>completion</parameter> is the <link
linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link>
that the match function is invoked on, <parameter>key_string</parameter> is
the current contents of the <link
linkend="class-gtkentry"><classname>gtk.Entry</classname></link> to be
matched, <parameter>iter</parameter> is a <link
linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
pointing at a row in the <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
associated with completion and <parameter>func_data</parameter> is the data
specified when the <link
linkend="method-gtkentrycompletion--set-match-func"><methodname>set_match_func</methodname>()</link>
method was called. The match function should return <literal>TRUE</literal>
if the completion string should be displayed; otherwise,
<literal>FALSE</literal>.</para>

      <para>A simple example match function is:</para>

      <programlisting>
  # Assumes that the func_data is set to the number of the text column in the
  # model.
  def match_func(completion, key, iter, column):
    model = completion.get_model()
    text = model.get_value(iter, column)
    if text.startswith(key):
      return True
    return False
</programlisting>

      <para>You must use the <link
linkend="method-gtkentrycompletion--set-match-func"><methodname>set_match_func</methodname>()</link>
method to display completions if you don't use the <link
linkend="method-gtkentrycompletion--set-text-column"><methodname>set_text_column</methodname>()</link>
method.</para>

    </refsect2>

    <refsect2 id="method-gtkentrycompletion--set-minimum-key-length">
      <title>gtk.EntryCompletion.set_minimum_key_length</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_minimum_key_length</methodname>
	  <methodparam><parameter role="keyword">length</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">length</parameter>&nbsp;:</term>
	  <listitem><simpara>The minimum length of the key string in order
	  to start completing.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This method is available in PyGTK 2.4 and above.</para>
      </note>

      <para>The <methodname>set_minimum_key_length</methodname>() method
sets the minimum length of the search key to the value specified by
<parameter>length</parameter>. This means that the key string (contents of
the <link linkend="class-gtkentry"><classname>gtk.Entry</classname></link>)
must be at least <parameter>length</parameter> characters before a
completion list will be displayed. This is useful for long lists, where
completing using a small key will take too much time and will likely return
too large a dataset.</para>

    </refsect2>

    <refsect2 id="method-gtkentrycompletion--get-minimum-key-length">
      <title>gtk.EntryCompletion.get_minimum_key_length</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_minimum_key_length</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>The currently used minimum key
	  length.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This method is available in PyGTK 2.4 and above.</para>
      </note>

      <para>The <methodname>get_minimum_key_length</methodname>() method
returns the minimum key length set for the entry completion. See the
<link
linkend="method-gtkentrycompletion--set-minimum-key-length"><methodname>set_minimum_key_length</methodname>()</link>
method for more information.</para>

    </refsect2>

    <refsect2 id="method-gtkentrycompletion--complete">
      <title>gtk.EntryCompletion.complete</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>complete</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>

      <note>
	<para>This method is available in PyGTK 2.4 and above.</para>
      </note>

      <para>The <methodname>complete</methodname>() method requests a
completion operation, i.e. a refiltering of the current list
with completions, using the current key. The completion list view will be
updated accordingly.</para>

    </refsect2>

    <refsect2 id="method-gtkentrycompletion--insert-action-text">
      <title>gtk.EntryCompletion.insert_action_text</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>insert_action_text</methodname>
	  <methodparam><parameter role="keyword">index</parameter></methodparam>
	  <methodparam><parameter role="keyword">text</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">index</parameter>&nbsp;:</term>
	  <listitem><simpara>The index in the action list where the item
	  should be inserted.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">text</parameter>&nbsp;:</term>
	  <listitem><simpara>The text of the item to
	  insert.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This method is available in PyGTK 2.4 and above.</para>
      </note>

      <para>The <methodname>insert_action_text</methodname>() method inserts
an action in the action item list of the entry completion at the position
specified by <parameter>index</parameter> with the text specified by
<parameter>text</parameter>. If you want the action item to have markup, use
the <link
linkend="method-gtkentrycompletion--insert-action-markup"><methodname>gtk.EntryCompletion.insert_action_markup()</methodname></link>
method.</para>

    </refsect2>

    <refsect2 id="method-gtkentrycompletion--insert-action-markup">
      <title>gtk.EntryCompletion.insert_action_markup</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>insert_action_markup</methodname>
	  <methodparam><parameter role="keyword">index</parameter></methodparam>
	  <methodparam><parameter role="keyword">markup</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">index</parameter>&nbsp;:</term>
	  <listitem><simpara>The index in the action list where the item
	  should be inserted.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">markup</parameter>&nbsp;:</term>
	  <listitem><simpara>The Pango markup of the item to
	  insert.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This method is available in PyGTK 2.4 and above.</para>
      </note>

      <para>The <methodname>insert_action_markup</methodname>() method
inserts an action item in the action item list of the entry completion at
the position specified by <parameter>index</parameter> with the Pango markup
specified by <parameter>markup</parameter>.</para>

    </refsect2>

    <refsect2 id="method-gtkentrycompletion--delete-action">
      <title>gtk.EntryCompletion.delete_action</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>delete_action</methodname>
	  <methodparam><parameter role="keyword">index</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">index</parameter>&nbsp;:</term>
	  <listitem><simpara>The index of the item to
	  delete.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This method is available in PyGTK 2.4 and above.</para>
      </note>

      <para>The <methodname>delete_action</methodname>() method deletes the
action item at the position in the action item list specified by
<parameter>index</parameter>.</para>

    </refsect2>

    <refsect2 id="method-gtkentrycompletion--insert-prefix">
      <title>gtk.EntryCompletion.insert_prefix</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>insert_prefix</methodname>
	</methodsynopsis></programlisting>

      <note>
	<para>This method is available in PyGTK 2.6 and above.</para>
      </note>

      <para>The <methodname>insert_prefix</methodname>() method requests a
prefix insertion.</para>

    </refsect2>

    <refsect2 id="method-gtkentrycompletion--set-text-column">
      <title>gtk.EntryCompletion.set_text_column</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_text_column</methodname>
	  <methodparam><parameter role="keyword">column</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">column</parameter>&nbsp;:</term>
	  <listitem><simpara>The column in the model to get strings
	  from.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This method is available in PyGTK 2.4 and above.</para>
      </note>

      <para>The <methodname>set_text_column</methodname>() method is a
convenience method for setting up the most common completion scenario: a
completion list with just strings. This method creates and adds a <link
linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link>
using the column specified by <parameter>column</parameter> as the source
for completion strings. If you don't use this method you will have to
install a <link
linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link>
in the entry completion and set a match function using the <link
linkend="method-gtkentrycompletion--set-match-func"><methodname>set_match_func</methodname>()</link>
method to display the completion strings. In GTK+ 2.6 the "text-column"
property is set to the value of <parameter>column</parameter>.</para>

    </refsect2>

<!-- NOT IMPLEMENTED
    <refsect2 id="method-gtkentrycompletion- -get-text-column">
      <title>gtk.EntryCompletion.get_text_column</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_text_column</methodname>
	  <methodparam></methodparam>
        </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>The column containing the text
strings.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This method is available in PyGTK 2.6 and above.</para>
      </note>

      <para>The <methodname>get_text_column</methodname>() method returns
the value of the "text-column" property. The "text-column" property contains
the index of the column in the completion model to get strings from. See the
<link
linkend="method-gtkentrycompletion- -set-text-column"><methodname>set_text_column</methodname>()</link>
method for more information.</para>

    </refsect2>
END NOT IMPLEMENTED -->

    <refsect2 id="method-gtkentrycompletion--set-inline-completion">
      <title>gtk.EntryCompletion.set_inline_completion</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_inline_completion</methodname>
	  <methodparam><parameter role="keyword">inline_completion</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">inline_completion</parameter>&nbsp;:</term>
	  <listitem><simpara>if <literal>TRUE</literal> do inline
completion</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This method is available in PyGTK 2.6 and above.</para>
      </note>

      <para>The <methodname>set_inline_completion</methodname>() method sets
the "inline-completion" property to the value of
<parameter>inline_completion</parameter>. If
<parameter>inline_completion</parameter> is <literal>TRUE</literal>, the
common prefix of the possible completions should be automatically inserted
in the entry.</para>

    </refsect2>

    <refsect2 id="method-gtkentrycompletion--get-inline-completion">
      <title>gtk.EntryCompletion.get_inline_completion</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_inline_completion</methodname>
	  <methodparam></methodparam>
        </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara><literal>TRUE</literal> if automatic inline
completion is enabled.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This method is available in PyGTK 2.6 and above.</para>
      </note>

      <para>The <methodname>get_inline_completion</methodname>() method
returns the value of the "inline-completion" property. If the value of the
"inline-completion" property is <literal>TRUE</literal> the common prefix of
possible completions is automatically inserted in the entry.</para>

    </refsect2>

    <refsect2 id="method-gtkentrycompletion--set-popup-completion">
      <title>gtk.EntryCompletion.set_popup_completion</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_popup_completion</methodname>
	  <methodparam><parameter role="keyword">popup_completion</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">popup_completion</parameter>&nbsp;:</term>
	  <listitem><simpara>If <literal>TRUE</literal> do popup
completion.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This method is available in PyGTK 2.6 and above.</para>
      </note>

      <para>The <methodname>set_popup_completion</methodname>() method sets
the "popup-completion" property to the value of
<parameter>popup_completion</parameter>. If
<parameter>popup_completion</parameter> is <literal>TRUE</literal> the
completions should be presented in a popup window.</para>

    </refsect2>

    <refsect2 id="method-gtkentrycompletion--get-popup-completion">
      <title>gtk.EntryCompletion.get_popup_completion</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_popup_completion</methodname>
	  <methodparam></methodparam>
        </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara><literal>TRUE</literal> if completions should
be displayed in a popup.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This method is available in PyGTK 2.6 and above.</para>
      </note>

      <para>The <methodname>get_popup_completion</methodname>() method
returns the value of the "popup-completion" property. If the value of
"popup-completion" property is <literal>TRUE</literal> the completions
should be presented in a popup window.</para>

    </refsect2>

  </refsect1>

  <refsect1>
    <title>Signals</title>

    <refsect2 id="signal-gtkentrycompletion--action-activated">
      <title>The "action-activated" gtk.EntryCompletion Signal</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>callback</methodname>
	  <methodparam><parameter>completion</parameter></methodparam>
	  <methodparam><parameter>index</parameter></methodparam>
	  <methodparam><parameter>user_param1</parameter></methodparam>
	  <methodparam><parameter>...</parameter></methodparam>
	</methodsynopsis></programlisting>

      <variablelist>
	<varlistentry>
	  <term><parameter>completion</parameter>&nbsp;:</term>
	  <listitem><simpara>the entry completion that received the
signal</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>index</parameter>&nbsp;:</term>
	  <listitem><simpara>the index of the action item that was
	  activated.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>user_param1</parameter>&nbsp;:</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>&nbsp;:</term>
	  <listitem><simpara>additional user parameters (if
any)</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
        <para>This signal is available in GTK+ 2.4 and above.</para>
      </note>

      <para>The "action-activated" signal is emitted when an action item is
selected from the popup action list.</para>

    </refsect2>

    <refsect2 id="signal-gtkentrycompletion--insert-prefix">
      <title>The "insert-prefix" gtk.EntryCompletion Signal</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>callback</methodname>
	  <methodparam><parameter>completion</parameter></methodparam>
	  <methodparam><parameter>prefix</parameter></methodparam>
	  <methodparam><parameter>user_param1</parameter></methodparam>
	  <methodparam><parameter>...</parameter></methodparam>
	</methodsynopsis></programlisting>

      <variablelist>
	<varlistentry>
	  <term><parameter>completion</parameter>&nbsp;:</term>
	  <listitem><simpara>the entry completion that received the
signal</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>prefix</parameter>&nbsp;:</term>
	  <listitem><simpara> the common prefix of all possible
completions</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>user_param1</parameter>&nbsp;:</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>&nbsp;:</term>
	  <listitem><simpara>additional user parameters (if
any)</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
        <para>This signal is available in GTK+ 2.6 and above.</para>
      </note>

      <para>The "insert-prefix" signal is emitted when the inline
auto-completion is triggered. The default behavior is to make the entry
display the whole prefix and select the newly inserted part.</para>

      <para>Applications may connect to this signal in order to insert only
a smaller part of the prefix into the entry - e.g. the entry used in the
<link
linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>
inserts only the part of the prefix up to the next '/'.</para>

    </refsect2>

    <refsect2 id="signal-gtkentrycompletion--match-selected">
      <title>The "match-selected" gtk.EntryCompletion Signal</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>callback</methodname>
	  <methodparam><parameter>completion</parameter></methodparam>
	  <methodparam><parameter>model</parameter></methodparam>
	  <methodparam><parameter>iter</parameter></methodparam>
	  <methodparam><parameter>user_param1</parameter></methodparam>
	  <methodparam><parameter>...</parameter></methodparam>
	</methodsynopsis></programlisting>

      <variablelist>
	<varlistentry>
	  <term><parameter>completion</parameter>&nbsp;:</term>
	  <listitem><simpara>the entry completion that received the
signal</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>model</parameter>&nbsp;:</term>
	  <listitem><simpara>the <link
	  linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
	  that <parameter>iter</parameter> points into.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>iter</parameter>&nbsp;:</term>
	  <listitem><simpara>a <link
	  linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
	  pointing at the selection completion string row in
	  <parameter>model</parameter>.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>user_param1</parameter>&nbsp;:</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>&nbsp;:</term>
	  <listitem><simpara>additional user parameters (if
any)</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
        <para>This signal is available in GTK+ 2.4 and above.</para>
      </note>

      <para>The "match-selected" signal is emitted when a completion string
was selected from the completion list. <parameter>iter</parameter> points at
the row in <parameter>model</parameter> that contains the completion
string.</para>

    </refsect2>

  </refsect1>

</refentry>