~ubuntu-branches/ubuntu/natty/pygtk/natty-proposed
» Revision
60
: docs/html/class-gtkentrycompletion.html
« back to all changes in this revision
Viewing changes to docs/html/class-gtkentrycompletion.html
- browse files at revision 60
- compare with another revision
- download diff
- download tarball
- view history from revision 60
- Committer: Bazaar Package Importer
- Author(s): Sebastien Bacher
- Date: 2010-01-07 11:08:47 UTC
- mfrom: (1.2.8 upstream)
- Revision ID: james.westby@ubuntu.com-20100107110847-f5av7e1ttudh7ra6
Tags: 2.17.0-0ubuntu1
New upstream version
- files added:
- gtk/gdk-2.18.defs
- files modified:
- ChangeLog
added
removed
docs/html/class-gtkentrycompletion.html
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.EntryCompletion</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkentry.html" title="gtk.Entry"><link rel="next" href="class-gtkeventbox.html" title="gtk.EventBox"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.EntryCompletion</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkentry.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkeventbox.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkentrycompletion"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.EntryCompletion</h2><p>gtk.EntryCompletion — completion
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.EntryCompletion</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.1"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkentry.html" title="gtk.Entry"><link rel="next" href="class-gtkeventbox.html" title="gtk.EventBox"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.EntryCompletion</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkentry.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkeventbox.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.EntryCompletion"><a name="class-gtkentrycompletion"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.EntryCompletion</h2><p>gtk.EntryCompletion — completion
2
2
functionality for <a class="link" href="class-gtkentry.html" title="gtk.Entry"><code class="classname">gtk.Entry</code></a> (new in
3
PyGTK 2.4)</p></div><div class="refsect1" lang="en"><a name="id3484461"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.EntryCompletion</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>, <span class="ooclass"><span class="classname"><a class="link" href="class-gtkcelllayout.html" title="gtk.CellLayout">gtk.CellLayout</a></span></span>):
4
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#constructor-gtkentrycompletion" title="Constructor">gtk.EntryCompletion</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--get-entry" title="gtk.EntryCompletion.get_entry">get_entry</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-model" title="gtk.EntryCompletion.set_model">set_model</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>model</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--get-model" title="gtk.EntryCompletion.get_model">get_model</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-match-func" title="gtk.EntryCompletion.set_match_func">set_match_func</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>func</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>func_data</code></em></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-minimum-key-length" title="gtk.EntryCompletion.set_minimum_key_length">set_minimum_key_length</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>length</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--get-minimum-key-length" title="gtk.EntryCompletion.get_minimum_key_length">get_minimum_key_length</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--complete" title="gtk.EntryCompletion.complete">complete</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--insert-action-text" title="gtk.EntryCompletion.insert_action_text">insert_action_text</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>index</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>text</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--insert-action-markup" title="gtk.EntryCompletion.insert_action_markup">insert_action_markup</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>index</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>markup</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--delete-action" title="gtk.EntryCompletion.delete_action">delete_action</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>index</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--insert-prefix" title="gtk.EntryCompletion.insert_prefix">insert_prefix</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-text-column" title="gtk.EntryCompletion.set_text_column">set_text_column</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>column</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--get-text-column" title="gtk.EntryCompletion.get_text_column">get_text_column</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-inline-completion" title="gtk.EntryCompletion.set_inline_completion">set_inline_completion</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>inline_completion</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--get-inline-completion" title="gtk.EntryCompletion.get_inline_completion">get_inline_completion</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-inline-completion" title="gtk.EntryCompletion.set_inline_completion">set_inline_selection</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>inline_selection</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--get-inline-completion" title="gtk.EntryCompletion.get_inline_completion">get_inline_selection</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-popup-completion" title="gtk.EntryCompletion.set_popup_completion">set_popup_completion</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>popup_completion</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--get-popup-completion" title="gtk.EntryCompletion.get_popup_completion">get_popup_completion</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-popup-set-width" title="gtk.EntryCompletion.set_popup_set_width">set_popup_set_width</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>popup_set_width</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--get-popup-set-width" title="gtk.EntryCompletion.get_popup_set_width">get_popup_set_width</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-popup-single-match" title="gtk.EntryCompletion.set_popup_single_match">set_popup_single_match</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>popup_single_match</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--get-popup-single-match" title="gtk.EntryCompletion.get_popup_completion">get_popup_single_match</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3485121"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
3
PyGTK 2.4)</p></div><div class="refsect1" title="Synopsis"><a name="id3794229"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.EntryCompletion</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>, <span class="ooclass"><span class="classname"><a class="link" href="class-gtkcelllayout.html" title="gtk.CellLayout">gtk.CellLayout</a></span></span>):
4
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#constructor-gtkentrycompletion" title="Constructor">gtk.EntryCompletion</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--get-entry" title="gtk.EntryCompletion.get_entry">get_entry</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-model" title="gtk.EntryCompletion.set_model">set_model</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>model</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--get-model" title="gtk.EntryCompletion.get_model">get_model</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-match-func" title="gtk.EntryCompletion.set_match_func">set_match_func</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>func</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>func_data</code></em></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-minimum-key-length" title="gtk.EntryCompletion.set_minimum_key_length">set_minimum_key_length</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>length</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--get-minimum-key-length" title="gtk.EntryCompletion.get_minimum_key_length">get_minimum_key_length</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--complete" title="gtk.EntryCompletion.complete">complete</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--insert-action-text" title="gtk.EntryCompletion.insert_action_text">insert_action_text</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>index</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>text</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--insert-action-markup" title="gtk.EntryCompletion.insert_action_markup">insert_action_markup</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>index</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>markup</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--delete-action" title="gtk.EntryCompletion.delete_action">delete_action</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>index</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--insert-prefix" title="gtk.EntryCompletion.insert_prefix">insert_prefix</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-text-column" title="gtk.EntryCompletion.set_text_column">set_text_column</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>column</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--get-text-column" title="gtk.EntryCompletion.get_text_column">get_text_column</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-inline-completion" title="gtk.EntryCompletion.set_inline_completion">set_inline_completion</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>inline_completion</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--get-inline-completion" title="gtk.EntryCompletion.get_inline_completion">get_inline_completion</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-inline-completion" title="gtk.EntryCompletion.set_inline_completion">set_inline_selection</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>inline_selection</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--get-inline-completion" title="gtk.EntryCompletion.get_inline_completion">get_inline_selection</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-popup-completion" title="gtk.EntryCompletion.set_popup_completion">set_popup_completion</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>popup_completion</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--get-popup-completion" title="gtk.EntryCompletion.get_popup_completion">get_popup_completion</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-popup-set-width" title="gtk.EntryCompletion.set_popup_set_width">set_popup_set_width</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>popup_set_width</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--get-popup-set-width" title="gtk.EntryCompletion.get_popup_set_width">get_popup_set_width</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-popup-single-match" title="gtk.EntryCompletion.set_popup_single_match">set_popup_single_match</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>popup_single_match</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--get-popup-single-match" title="gtk.EntryCompletion.get_popup_completion">get_popup_single_match</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id3794888"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
5
5
+-- <a class="link" href="class-gtkentrycompletion.html" title="gtk.EntryCompletion">gtk.EntryCompletion</a>
6
</pre></div><div class="refsect1" lang="en"><a name="id3485147"></a><h2>Implemented Interfaces</h2><p>
6
</pre></div><div class="refsect1" title="Implemented Interfaces"><a name="id3794914"></a><h2>Implemented Interfaces</h2><p>
7
7
<a class="link" href="class-gtkentrycompletion.html" title="gtk.EntryCompletion"><code class="classname">gtk.EntryCompletion</code></a>
8
8
implements
9
9
<a class="link" href="class-gtkbuildable.html" title="gtk.Buildable"><code class="classname">gtk.Buildable</code></a>
10
10
<a class="link" href="class-gtkcelllayout.html" title="gtk.CellLayout"><code class="classname">gtk.CellLayout</code></a>
11
</p></div><div class="refsect1" lang="en"><a name="properties-gtkentrycompletion"></a><h2>gtk.EntryCompletion Properties</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"inline-completion"</td><td valign="top">Read-Write</td><td valign="top">If <code class="literal">True</code> the common prefix should be
11
</p></div><div class="refsect1" title="gtk.EntryCompletion Properties"><a name="properties-gtkentrycompletion"></a><h2>gtk.EntryCompletion Properties</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="4in"></colgroup><tbody><tr valign="top"><td valign="top">"inline-completion"</td><td valign="top">Read-Write</td><td valign="top">If <code class="literal">True</code> the common prefix should be
12
12
inserted automatically. Default value:
13
13
<code class="literal">False</code>. Available in GTK+ 2.6 and
14
14
above.</td></tr><tr valign="top"><td valign="top">"inline-selection"</td><td valign="top">Read-Write</td><td valign="top">Determines whether the possible completions on the popup will appear
26
26
<code class="literal">True</code>. Available in GTK+ 2.8 and
27
27
above.</td></tr><tr valign="top"><td valign="top">"text-column"</td><td valign="top">Read-Write</td><td valign="top">The column of the model containing the strings. Allowed
28
28
values: >= -1. Default value: -1. Available in GTK+ 2.6 and
29
above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtkentrycompletion"></a><h2>gtk.EntryCompletion Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkentrycompletion.html#signal-gtkentrycompletion--action-activated" title='The "action-activated" gtk.EntryCompletion Signal'>action-activated</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>completion</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>index</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkentrycompletion.html#signal-gtkentrycompletion--cursor-on-match" title='The "cursor-on-match" gtk.EntryCompletion Signal'>cursor_on_match</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>completion</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>model</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>iter</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkentrycompletion.html#signal-gtkentrycompletion--insert-prefix" title='The "insert-prefix" gtk.EntryCompletion Signal'>insert-prefix</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>completion</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>prefix</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkentrycompletion.html#signal-gtkentrycompletion--match-selected" title='The "match-selected" gtk.EntryCompletion Signal'>match-selected</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>completion</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>model</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>iter</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3485793"></a><h2>Description</h2><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This widget is available in PyGTK 2.4 and above.</p></div><p><a class="link" href="class-gtkentrycompletion.html" title="gtk.EntryCompletion"><code class="classname">gtk.EntryCompletion</code></a>
29
above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.EntryCompletion Signal Prototypes"><a name="signal-prototypes-gtkentrycompletion"></a><h2>gtk.EntryCompletion Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkentrycompletion.html#signal-gtkentrycompletion--action-activated" title='The "action-activated" gtk.EntryCompletion Signal'>action-activated</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>completion</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>index</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkentrycompletion.html#signal-gtkentrycompletion--cursor-on-match" title='The "cursor-on-match" gtk.EntryCompletion Signal'>cursor_on_match</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>completion</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>model</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>iter</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkentrycompletion.html#signal-gtkentrycompletion--insert-prefix" title='The "insert-prefix" gtk.EntryCompletion Signal'>insert-prefix</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>completion</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>prefix</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkentrycompletion.html#signal-gtkentrycompletion--match-selected" title='The "match-selected" gtk.EntryCompletion Signal'>match-selected</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>completion</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>model</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>iter</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" title="Description"><a name="id3795560"></a><h2>Description</h2><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This widget is available in PyGTK 2.4 and above.</p></div><p><a class="link" href="class-gtkentrycompletion.html" title="gtk.EntryCompletion"><code class="classname">gtk.EntryCompletion</code></a>
30
30
is an auxiliary object to be used in conjunction with <a class="link" href="class-gtkentry.html" title="gtk.Entry"><code class="classname">gtk.Entry</code></a> to
31
31
provide completion functionality. It implements the <a class="link" href="class-gtkcelllayout.html" title="gtk.CellLayout"><code class="classname">gtk.CellLayout</code></a>
32
32
interface, to allow the user to add extra cells to the popup display of
69
69
string during completion.</p><p>Actions are easily managed using the <a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--insert-action-text" title="gtk.EntryCompletion.insert_action_text"><code class="methodname">insert_action_text</code>()</a>,
70
70
<a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--insert-action-markup" title="gtk.EntryCompletion.insert_action_markup"><code class="methodname">insert_action_markup</code>()</a>
71
71
and <a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--delete-action" title="gtk.EntryCompletion.delete_action"><code class="methodname">delete_action</code>()</a>
72
methods.</p></div><div class="refsect1" lang="en"><a name="constructor-gtkentrycompletion"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.EntryCompletion</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>A newly created <a class="link" href="class-gtkentrycompletion.html" title="gtk.EntryCompletion"><code class="classname">gtk.EntryCompletion</code></a> object.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This constructor is available in PyGTK 2.4 and above.</p></div><p>Creates a new <a class="link" href="class-gtkentrycompletion.html" title="gtk.EntryCompletion"><code class="classname">gtk.EntryCompletion</code></a>
73
object.</p></div><div class="refsect1" lang="en"><a name="id3486112"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--get-entry"></a><h3>gtk.EntryCompletion.get_entry</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_entry</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>The <a class="link" href="class-gtkentry.html" title="gtk.Entry"><code class="classname">gtk.Entry</code></a>
74
that the completion is attached to.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_entry</code>() method retrieves the
72
methods.</p></div><div class="refsect1" title="Constructor"><a name="constructor-gtkentrycompletion"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.EntryCompletion</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>A newly created <a class="link" href="class-gtkentrycompletion.html" title="gtk.EntryCompletion"><code class="classname">gtk.EntryCompletion</code></a> object.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This constructor is available in PyGTK 2.4 and above.</p></div><p>Creates a new <a class="link" href="class-gtkentrycompletion.html" title="gtk.EntryCompletion"><code class="classname">gtk.EntryCompletion</code></a>
73
object.</p></div><div class="refsect1" title="Methods"><a name="id3795879"></a><h2>Methods</h2><div class="refsect2" title="gtk.EntryCompletion.get_entry"><a name="method-gtkentrycompletion--get-entry"></a><h3>gtk.EntryCompletion.get_entry</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_entry</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>The <a class="link" href="class-gtkentry.html" title="gtk.Entry"><code class="classname">gtk.Entry</code></a>
74
that the completion is attached to.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_entry</code>() method retrieves the
75
75
<a class="link" href="class-gtkentry.html" title="gtk.Entry"><code class="classname">gtk.Entry</code></a> that
76
the entry completion is attached to.</p></div><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--set-model"></a><h3>gtk.EntryCompletion.set_model</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_model</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>model</code></strong></span><span class="initializer">=None</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>model</code></strong> :</span></p></td><td>The <a class="link" href="class-gtktreemodel.html" title="gtk.TreeModel"><code class="classname">gtk.TreeModel</code></a>
77
to use with the entry completion.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_model</code>() method sets the <a class="link" href="class-gtktreemodel.html" title="gtk.TreeModel"><code class="classname">gtk.TreeModel</code></a>
76
the entry completion is attached to.</p></div><div class="refsect2" title="gtk.EntryCompletion.set_model"><a name="method-gtkentrycompletion--set-model"></a><h3>gtk.EntryCompletion.set_model</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_model</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>model</code></strong></span><span class="initializer">=None</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>model</code></strong> :</span></p></td><td>The <a class="link" href="class-gtktreemodel.html" title="gtk.TreeModel"><code class="classname">gtk.TreeModel</code></a>
77
to use with the entry completion.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_model</code>() method sets the <a class="link" href="class-gtktreemodel.html" title="gtk.TreeModel"><code class="classname">gtk.TreeModel</code></a>
78
78
specified by <em class="parameter"><code>model</code></em> to be used with the entry
79
79
completion. A previously set model will be removed before the new model
80
80
is set. If <em class="parameter"><code>model</code></em> is <code class="literal">None</code> or not
81
specified, the old model will be unset.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>In PyGTK 2.4.0 the model could not be <code class="literal">None</code>
82
and did not default to <code class="literal">None</code>.</p></div></div><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--get-model"></a><h3>gtk.EntryCompletion.get_model</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_model</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>The current <a class="link" href="class-gtktreemodel.html" title="gtk.TreeModel"><code class="classname">gtk.TreeModel</code></a>,
83
or <code class="literal">None</code> if not set.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_model</code>() method returns the
81
specified, the old model will be unset.</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>In PyGTK 2.4.0 the model could not be <code class="literal">None</code>
82
and did not default to <code class="literal">None</code>.</p></div></div><div class="refsect2" title="gtk.EntryCompletion.get_model"><a name="method-gtkentrycompletion--get-model"></a><h3>gtk.EntryCompletion.get_model</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_model</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>The current <a class="link" href="class-gtktreemodel.html" title="gtk.TreeModel"><code class="classname">gtk.TreeModel</code></a>,
83
or <code class="literal">None</code> if not set.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_model</code>() method returns the
84
84
<a class="link" href="class-gtktreemodel.html" title="gtk.TreeModel"><code class="classname">gtk.TreeModel</code></a>
85
85
that the entry completion is using as data source. Returns
86
<code class="literal">None</code> if the model is unset.</p></div><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--set-match-func"></a><h3>gtk.EntryCompletion.set_match_func</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_match_func</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>func</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>func_data</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td><td>A function to be used.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>func_data</code></em> :</span></p></td><td>The user data for <em class="parameter"><code>func</code></em>.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_match_func</code>() method sets the
86
<code class="literal">None</code> if the model is unset.</p></div><div class="refsect2" title="gtk.EntryCompletion.set_match_func"><a name="method-gtkentrycompletion--set-match-func"></a><h3>gtk.EntryCompletion.set_match_func</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_match_func</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>func</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>func_data</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td><td>A function to be used.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>func_data</code></em> :</span></p></td><td>The user data for <em class="parameter"><code>func</code></em>.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_match_func</code>() method sets the
87
87
match function specified by <em class="parameter"><code>func</code></em>. The match function
88
88
is used by the entry completion to determine if a row of the associated tree
89
89
model should be in the completion list.</p><p>The signature of the match function is:</p><pre class="programlisting">
108
108
return False
109
109
</pre><p>You must use the <a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-match-func" title="gtk.EntryCompletion.set_match_func"><code class="methodname">set_match_func</code>()</a>
110
110
method to display completions if you don't use the <a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-text-column" title="gtk.EntryCompletion.set_text_column"><code class="methodname">set_text_column</code>()</a>
111
method.</p></div><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--set-minimum-key-length"></a><h3>gtk.EntryCompletion.set_minimum_key_length</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_minimum_key_length</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>length</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>length</code></strong> :</span></p></td><td>The minimum length of the key string in order
112
to start completing.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_minimum_key_length</code>() method
111
method.</p></div><div class="refsect2" title="gtk.EntryCompletion.set_minimum_key_length"><a name="method-gtkentrycompletion--set-minimum-key-length"></a><h3>gtk.EntryCompletion.set_minimum_key_length</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_minimum_key_length</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>length</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>length</code></strong> :</span></p></td><td>The minimum length of the key string in order
112
to start completing.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_minimum_key_length</code>() method
113
113
sets the minimum length of the search key to the value specified by
114
114
<em class="parameter"><code>length</code></em>. This means that the key string (contents of
115
115
the <a class="link" href="class-gtkentry.html" title="gtk.Entry"><code class="classname">gtk.Entry</code></a>)
116
116
must be at least <em class="parameter"><code>length</code></em> characters before a
117
117
completion list will be displayed. This is useful for long lists, where
118
118
completing using a small key will take too much time and will likely return
119
too large a dataset.</p></div><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--get-minimum-key-length"></a><h3>gtk.EntryCompletion.get_minimum_key_length</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_minimum_key_length</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>The currently used minimum key
120
length.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_minimum_key_length</code>() method
119
too large a dataset.</p></div><div class="refsect2" title="gtk.EntryCompletion.get_minimum_key_length"><a name="method-gtkentrycompletion--get-minimum-key-length"></a><h3>gtk.EntryCompletion.get_minimum_key_length</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_minimum_key_length</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>The currently used minimum key
120
length.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_minimum_key_length</code>() method
121
121
returns the minimum key length set for the entry completion. See the
122
122
<a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-minimum-key-length" title="gtk.EntryCompletion.set_minimum_key_length"><code class="methodname">set_minimum_key_length</code>()</a>
123
method for more information.</p></div><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--complete"></a><h3>gtk.EntryCompletion.complete</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">complete</span>(<span class="methodparam"></span>)</code></pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">complete</code>() method requests a
123
method for more information.</p></div><div class="refsect2" title="gtk.EntryCompletion.complete"><a name="method-gtkentrycompletion--complete"></a><h3>gtk.EntryCompletion.complete</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">complete</span>(<span class="methodparam"></span>)</code></pre><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">complete</code>() method requests a
124
124
completion operation, i.e. a refiltering of the current list
125
125
with completions, using the current key. The completion list view will be
126
updated accordingly.</p></div><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--insert-action-text"></a><h3>gtk.EntryCompletion.insert_action_text</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">insert_action_text</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>index</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>text</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>index</code></strong> :</span></p></td><td>The index in the action list where the item
126
updated accordingly.</p></div><div class="refsect2" title="gtk.EntryCompletion.insert_action_text"><a name="method-gtkentrycompletion--insert-action-text"></a><h3>gtk.EntryCompletion.insert_action_text</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">insert_action_text</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>index</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>text</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>index</code></strong> :</span></p></td><td>The index in the action list where the item
127
127
should be inserted.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>text</code></strong> :</span></p></td><td>The text of the item to
128
insert.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">insert_action_text</code>() method inserts
128
insert.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">insert_action_text</code>() method inserts
129
129
an action in the action item list of the entry completion at the position
130
130
specified by <em class="parameter"><code>index</code></em> with the text specified by
131
131
<em class="parameter"><code>text</code></em>. If you want the action item to have markup, use
132
132
the <a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--insert-action-markup" title="gtk.EntryCompletion.insert_action_markup"><code class="methodname">gtk.EntryCompletion.insert_action_markup()</code></a>
133
method.</p></div><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--insert-action-markup"></a><h3>gtk.EntryCompletion.insert_action_markup</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">insert_action_markup</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>index</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>markup</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>index</code></strong> :</span></p></td><td>The index in the action list where the item
133
method.</p></div><div class="refsect2" title="gtk.EntryCompletion.insert_action_markup"><a name="method-gtkentrycompletion--insert-action-markup"></a><h3>gtk.EntryCompletion.insert_action_markup</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">insert_action_markup</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>index</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>markup</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>index</code></strong> :</span></p></td><td>The index in the action list where the item
134
134
should be inserted.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>markup</code></strong> :</span></p></td><td>The Pango markup of the item to
135
insert.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">insert_action_markup</code>() method
135
insert.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">insert_action_markup</code>() method
136
136
inserts an action item in the action item list of the entry completion at
137
137
the position specified by <em class="parameter"><code>index</code></em> with the Pango markup
138
specified by <em class="parameter"><code>markup</code></em>.</p></div><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--delete-action"></a><h3>gtk.EntryCompletion.delete_action</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">delete_action</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>index</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>index</code></strong> :</span></p></td><td>The index of the item to
139
delete.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">delete_action</code>() method deletes the
138
specified by <em class="parameter"><code>markup</code></em>.</p></div><div class="refsect2" title="gtk.EntryCompletion.delete_action"><a name="method-gtkentrycompletion--delete-action"></a><h3>gtk.EntryCompletion.delete_action</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">delete_action</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>index</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>index</code></strong> :</span></p></td><td>The index of the item to
139
delete.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">delete_action</code>() method deletes the
140
140
action item at the position in the action item list specified by
141
<em class="parameter"><code>index</code></em>.</p></div><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--insert-prefix"></a><h3>gtk.EntryCompletion.insert_prefix</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">insert_prefix</span>()</code></pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <code class="methodname">insert_prefix</code>() method requests a
142
prefix insertion.</p></div><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--set-text-column"></a><h3>gtk.EntryCompletion.set_text_column</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_text_column</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>column</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>column</code></strong> :</span></p></td><td>The column in the model to get strings
143
from.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_text_column</code>() method is a
141
<em class="parameter"><code>index</code></em>.</p></div><div class="refsect2" title="gtk.EntryCompletion.insert_prefix"><a name="method-gtkentrycompletion--insert-prefix"></a><h3>gtk.EntryCompletion.insert_prefix</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">insert_prefix</span>()</code></pre><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <code class="methodname">insert_prefix</code>() method requests a
142
prefix insertion.</p></div><div class="refsect2" title="gtk.EntryCompletion.set_text_column"><a name="method-gtkentrycompletion--set-text-column"></a><h3>gtk.EntryCompletion.set_text_column</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_text_column</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>column</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>column</code></strong> :</span></p></td><td>The column in the model to get strings
143
from.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_text_column</code>() method is a
144
144
convenience method for setting up the most common completion scenario: a
145
145
completion list with just strings. This method creates and adds a <a class="link" href="class-gtkcellrenderertext.html" title="gtk.CellRendererText"><code class="classname">gtk.CellRendererText</code></a>
146
146
using the column specified by <em class="parameter"><code>column</code></em> as the source
148
148
install a <a class="link" href="class-gtkcellrenderertext.html" title="gtk.CellRendererText"><code class="classname">gtk.CellRendererText</code></a>
149
149
in the entry completion and set a match function using the <a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-match-func" title="gtk.EntryCompletion.set_match_func"><code class="methodname">set_match_func</code>()</a>
150
150
method to display the completion strings. In GTK+ 2.6 the "text-column"
151
property is set to the value of <em class="parameter"><code>column</code></em>.</p></div><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--get-text-column"></a><h3>gtk.EntryCompletion.get_text_column</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_text_column</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>The column containing the text
152
strings.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.8 and above.</p></div><p>The <code class="methodname">get_text_column</code>() method returns
151
property is set to the value of <em class="parameter"><code>column</code></em>.</p></div><div class="refsect2" title="gtk.EntryCompletion.get_text_column"><a name="method-gtkentrycompletion--get-text-column"></a><h3>gtk.EntryCompletion.get_text_column</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_text_column</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>The column containing the text
152
strings.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.8 and above.</p></div><p>The <code class="methodname">get_text_column</code>() method returns
153
153
the value of the "text-column" property. The "text-column" property contains
154
154
the index of the column in the completion model to get strings from. See the
155
155
<a class="link" href="class-gtkentrycompletion.html#method-gtkentrycompletion--set-text-column" title="gtk.EntryCompletion.set_text_column"><code class="methodname">set_text_column</code>()</a>
156
method for more information.</p></div><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--set-inline-completion"></a><h3>gtk.EntryCompletion.set_inline_completion</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_inline_completion</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>inline_completion</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>inline_completion</code></strong> :</span></p></td><td>if <code class="literal">True</code> do inline
157
completion</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <code class="methodname">set_inline_completion</code>() method sets
156
method for more information.</p></div><div class="refsect2" title="gtk.EntryCompletion.set_inline_completion"><a name="method-gtkentrycompletion--set-inline-completion"></a><h3>gtk.EntryCompletion.set_inline_completion</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_inline_completion</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>inline_completion</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>inline_completion</code></strong> :</span></p></td><td>if <code class="literal">True</code> do inline
157
completion</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <code class="methodname">set_inline_completion</code>() method sets
158
158
the "inline-completion" property to the value of
159
159
<em class="parameter"><code>inline_completion</code></em>. If
160
160
<em class="parameter"><code>inline_completion</code></em> is <code class="literal">True</code>, the
161
161
common prefix of the possible completions should be automatically inserted
162
in the entry.</p></div><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--get-inline-completion"></a><h3>gtk.EntryCompletion.get_inline_completion</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_inline_completion</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if automatic inline
163
completion is enabled.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <code class="methodname">get_inline_completion</code>() method
162
in the entry.</p></div><div class="refsect2" title="gtk.EntryCompletion.get_inline_completion"><a name="method-gtkentrycompletion--get-inline-completion"></a><h3>gtk.EntryCompletion.get_inline_completion</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_inline_completion</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if automatic inline
163
completion is enabled.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <code class="methodname">get_inline_completion</code>() method
164
164
returns the value of the "inline-completion" property. If the value of the
165
165
"inline-completion" property is <code class="literal">True</code> the common prefix of
166
possible completions is automatically inserted in the entry.</p></div><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--set-inline-selection"></a><h3>gtk.EntryCompletion.set_inline_selection</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_inline_selection</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>inline_selection</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>inline_selection</code></strong> :</span></p></td><td>if <code class="literal">True</code> do inline
167
selection</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.12 and above.</p></div><p>The <code class="methodname">set_inline_selection</code>() method Sets whether
168
it is possible to cycle through the possible completions inside the entry.</p></div><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--get-inline-selection"></a><h3>gtk.EntryCompletion.get_inline_selection</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_inline_selection</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if automatic inline
169
selection is enabled.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.12 and above.</p></div><p>The <code class="methodname">get_inline_selection</code>() method returns
170
<code class="literal">True</code> if inline-selection mode is turned on.</p></div><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--set-popup-completion"></a><h3>gtk.EntryCompletion.set_popup_completion</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_popup_completion</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>popup_completion</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>popup_completion</code></strong> :</span></p></td><td>If <code class="literal">True</code> do popup
171
completion.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <code class="methodname">set_popup_completion</code>() method sets
166
possible completions is automatically inserted in the entry.</p></div><div class="refsect2" title="gtk.EntryCompletion.set_inline_selection"><a name="method-gtkentrycompletion--set-inline-selection"></a><h3>gtk.EntryCompletion.set_inline_selection</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_inline_selection</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>inline_selection</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>inline_selection</code></strong> :</span></p></td><td>if <code class="literal">True</code> do inline
167
selection</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.12 and above.</p></div><p>The <code class="methodname">set_inline_selection</code>() method Sets whether
168
it is possible to cycle through the possible completions inside the entry.</p></div><div class="refsect2" title="gtk.EntryCompletion.get_inline_selection"><a name="method-gtkentrycompletion--get-inline-selection"></a><h3>gtk.EntryCompletion.get_inline_selection</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_inline_selection</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if automatic inline
169
selection is enabled.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.12 and above.</p></div><p>The <code class="methodname">get_inline_selection</code>() method returns
170
<code class="literal">True</code> if inline-selection mode is turned on.</p></div><div class="refsect2" title="gtk.EntryCompletion.set_popup_completion"><a name="method-gtkentrycompletion--set-popup-completion"></a><h3>gtk.EntryCompletion.set_popup_completion</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_popup_completion</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>popup_completion</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>popup_completion</code></strong> :</span></p></td><td>If <code class="literal">True</code> do popup
171
completion.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <code class="methodname">set_popup_completion</code>() method sets
172
172
the "popup-completion" property to the value of
173
173
<em class="parameter"><code>popup_completion</code></em>. If
174
174
<em class="parameter"><code>popup_completion</code></em> is <code class="literal">True</code> the
175
completions should be presented in a popup window.</p></div><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--get-popup-completion"></a><h3>gtk.EntryCompletion.get_popup_completion</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_popup_completion</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if completions should
176
be displayed in a popup.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <code class="methodname">get_popup_completion</code>() method
175
completions should be presented in a popup window.</p></div><div class="refsect2" title="gtk.EntryCompletion.get_popup_completion"><a name="method-gtkentrycompletion--get-popup-completion"></a><h3>gtk.EntryCompletion.get_popup_completion</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_popup_completion</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if completions should
176
be displayed in a popup.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <code class="methodname">get_popup_completion</code>() method
177
177
returns the value of the "popup-completion" property. If the value of
178
178
"popup-completion" property is <code class="literal">True</code> the completions
179
should be presented in a popup window.</p></div><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--set-popup-set-width"></a><h3>gtk.EntryCompletion.set_popup_set_width</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_popup_set_width</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>popup_set_width</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>popup_set_width</code></strong> :</span></p></td><td>If <code class="literal">True</code> the completions
179
should be presented in a popup window.</p></div><div class="refsect2" title="gtk.EntryCompletion.set_popup_set_width"><a name="method-gtkentrycompletion--set-popup-set-width"></a><h3>gtk.EntryCompletion.set_popup_set_width</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_popup_set_width</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>popup_set_width</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>popup_set_width</code></strong> :</span></p></td><td>If <code class="literal">True</code> the completions
180
180
popup window will be resized to the width of the
181
completion.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.8 and above.</p></div><p>The <code class="methodname">set_popup_set_width</code>() method sets
181
completion.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.8 and above.</p></div><p>The <code class="methodname">set_popup_set_width</code>() method sets
182
182
the "popup-set-width" property to the value of
183
183
<em class="parameter"><code>popup_set_width</code></em>. If
184
184
<em class="parameter"><code>popup_set_width</code></em> is <code class="literal">True</code> the
185
completions popup window will be resized to the width of the completion.</p></div><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--get-popup-set-width"></a><h3>gtk.EntryCompletion.get_popup_set_width</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_popup_set_width</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the completions popup
186
window will be resized to the width of the completion.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.8 and above.</p></div><p>The <code class="methodname">get_popup_set_width</code>() method
185
completions popup window will be resized to the width of the completion.</p></div><div class="refsect2" title="gtk.EntryCompletion.get_popup_set_width"><a name="method-gtkentrycompletion--get-popup-set-width"></a><h3>gtk.EntryCompletion.get_popup_set_width</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_popup_set_width</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the completions popup
186
window will be resized to the width of the completion.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.8 and above.</p></div><p>The <code class="methodname">get_popup_set_width</code>() method
187
187
returns the value of the "popup-set-width" property. If the value of
188
188
"popup-set-width" property is <code class="literal">True</code> the completions popup
189
window will be resized to the width of the completion.</p></div><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--set-popup-single-match"></a><h3>gtk.EntryCompletion.set_popup_single_match</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_popup_single_match</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>popup_single_match</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>popup_single_match</code></strong> :</span></p></td><td>If <code class="literal">True</code> the completions popup
190
window will appear even for a single match.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.8 and above.</p></div><p>The <code class="methodname">set_popup_single_match</code>() method
189
window will be resized to the width of the completion.</p></div><div class="refsect2" title="gtk.EntryCompletion.set_popup_single_match"><a name="method-gtkentrycompletion--set-popup-single-match"></a><h3>gtk.EntryCompletion.set_popup_single_match</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_popup_single_match</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>popup_single_match</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>popup_single_match</code></strong> :</span></p></td><td>If <code class="literal">True</code> the completions popup
190
window will appear even for a single match.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.8 and above.</p></div><p>The <code class="methodname">set_popup_single_match</code>() method
191
191
sets the "popup-single-match" property to the value of
192
192
<em class="parameter"><code>popup_single_match</code></em>. If
193
193
<em class="parameter"><code>popup_single_match</code></em> is <code class="literal">True</code> the
194
completions popup window will appear even for a single match.</p></div><div class="refsect2" lang="en"><a name="method-gtkentrycompletion--get-popup-single-match"></a><h3>gtk.EntryCompletion.get_popup_completion</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_popup_single_match</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the completions popup
195
window should appear even for a single match.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.8 and above.</p></div><p>The <code class="methodname">get_popup_single_match</code>() method
194
completions popup window will appear even for a single match.</p></div><div class="refsect2" title="gtk.EntryCompletion.get_popup_completion"><a name="method-gtkentrycompletion--get-popup-single-match"></a><h3>gtk.EntryCompletion.get_popup_completion</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_popup_single_match</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the completions popup
195
window should appear even for a single match.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.8 and above.</p></div><p>The <code class="methodname">get_popup_single_match</code>() method
196
196
returns the value of the "popup-single-match" property. If the value of
197
197
"popup-single-match" property is <code class="literal">True</code> the completions
198
popup window should appear even for a single match.</p></div></div><div class="refsect1" lang="en"><a name="id3488429"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkentrycompletion--action-activated"></a><h3>The "action-activated" gtk.EntryCompletion Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>completion</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>index</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td><td>the entry completion that received the
198
popup window should appear even for a single match.</p></div></div><div class="refsect1" title="Signals"><a name="id3798196"></a><h2>Signals</h2><div class="refsect2" title='The "action-activated" gtk.EntryCompletion Signal'><a name="signal-gtkentrycompletion--action-activated"></a><h3>The "action-activated" gtk.EntryCompletion Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>completion</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>index</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td><td>the entry completion that received the
199
199
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td><td>the index of the action item that was
200
200
activated.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
201
201
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
202
202
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
203
any)</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This signal is available in GTK+ 2.4 and above.</p></div><p>The "action-activated" signal is emitted when an action item is
204
selected from the popup action list.</p></div><div class="refsect2" lang="en"><a name="signal-gtkentrycompletion--cursor-on-match"></a><h3>The "cursor-on-match" gtk.EntryCompletion Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>completion</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>model</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>iter</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td><td>the entry completion that received the
203
any)</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This signal is available in GTK+ 2.4 and above.</p></div><p>The "action-activated" signal is emitted when an action item is
204
selected from the popup action list.</p></div><div class="refsect2" title='The "cursor-on-match" gtk.EntryCompletion Signal'><a name="signal-gtkentrycompletion--cursor-on-match"></a><h3>The "cursor-on-match" gtk.EntryCompletion Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>completion</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>model</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>iter</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td><td>the entry completion that received the
205
205
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td><td>The <a class="link" href="class-gtktreemodel.html" title="gtk.TreeModel"><code class="classname">gtk.TreeModel</code></a>
206
206
containing the matches.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td><td>A <a class="link" href="class-gtktreeiter.html" title="gtk.TreeIter"><code class="classname">gtk.TreeIter</code></a>
207
207
positioned at the selected match.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
208
208
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
209
209
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
210
any)</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This signal is available in GTK+ 2.12 and above.</p></div><p>The "cursor-on-match" signal gets emitted when a match from the cursor
210
any)</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This signal is available in GTK+ 2.12 and above.</p></div><p>The "cursor-on-match" signal gets emitted when a match from the cursor
211
211
is on a match of the list.The default behaviour is to replace the contents
212
of the entry with the contents of the text column in the row pointed to by iter.</p></div><div class="refsect2" lang="en"><a name="signal-gtkentrycompletion--insert-prefix"></a><h3>The "insert-prefix" gtk.EntryCompletion Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>completion</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>prefix</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td><td>the entry completion that received the
212
of the entry with the contents of the text column in the row pointed to by iter.</p></div><div class="refsect2" title='The "insert-prefix" gtk.EntryCompletion Signal'><a name="signal-gtkentrycompletion--insert-prefix"></a><h3>The "insert-prefix" gtk.EntryCompletion Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>completion</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>prefix</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td><td>the entry completion that received the
213
213
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>prefix</code></em> :</span></p></td><td> the common prefix of all possible
214
214
completions</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
215
215
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
216
216
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
217
any)</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This signal is available in GTK+ 2.6 and above.</p></div><p>The "insert-prefix" signal is emitted when the inline
217
any)</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This signal is available in GTK+ 2.6 and above.</p></div><p>The "insert-prefix" signal is emitted when the inline
218
218
auto-completion is triggered. The default behavior is to make the entry
219
219
display the whole prefix and select the newly inserted part.</p><p>Applications may connect to this signal in order to insert only
220
220
a smaller part of the prefix into the entry - e.g. the entry used in the
221
221
<a class="link" href="class-gtkfilechooser.html" title="gtk.FileChooser"><code class="classname">gtk.FileChooser</code></a>
222
inserts only the part of the prefix up to the next '/'.</p></div><div class="refsect2" lang="en"><a name="signal-gtkentrycompletion--match-selected"></a><h3>The "match-selected" gtk.EntryCompletion Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>completion</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>model</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>iter</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td><td>the entry completion that received the
222
inserts only the part of the prefix up to the next '/'.</p></div><div class="refsect2" title='The "match-selected" gtk.EntryCompletion Signal'><a name="signal-gtkentrycompletion--match-selected"></a><h3>The "match-selected" gtk.EntryCompletion Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>completion</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>model</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>iter</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td><td>the entry completion that received the
223
223
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td><td>the <a class="link" href="class-gtktreemodel.html" title="gtk.TreeModel"><code class="classname">gtk.TreeModel</code></a>
224
224
that <em class="parameter"><code>iter</code></em> points into.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td><td>a <a class="link" href="class-gtktreeiter.html" title="gtk.TreeIter"><code class="classname">gtk.TreeIter</code></a>
225
225
pointing at the selection completion string row in
226
226
<em class="parameter"><code>model</code></em>.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
227
227
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
228
228
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
229
any)</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This signal is available in GTK+ 2.4 and above.</p></div><p>The "match-selected" signal is emitted when a completion string
229
any)</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This signal is available in GTK+ 2.4 and above.</p></div><p>The "match-selected" signal is emitted when a completion string
230
230
was selected from the completion list. <em class="parameter"><code>iter</code></em> points at
231
231
the row in <em class="parameter"><code>model</code></em> that contains the completion
232
232
string.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gtkentry.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-gtkeventbox.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.Entry </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.EventBox</td></tr></table></div></body></html>
Loggerhead is a web-based interface for Breezy
Version: 2.0.1