diff options
Diffstat (limited to 'docs/reference/pygtk-gtkiconview.xml')
| -rw-r--r-- | docs/reference/pygtk-gtkiconview.xml | 2408 |
1 files changed, 0 insertions, 2408 deletions
diff --git a/docs/reference/pygtk-gtkiconview.xml b/docs/reference/pygtk-gtkiconview.xml deleted file mode 100644 index 63e9d8be..00000000 --- a/docs/reference/pygtk-gtkiconview.xml +++ /dev/null @@ -1,2408 +0,0 @@ -<?xml version="1.0" standalone="no"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> - -<refentry id="class-gtkiconview"> - <refnamediv> - <refname>gtk.IconView</refname> - <refpurpose>a widget which displays a list of icons in a grid (new in -PyGTK 2.6)</refpurpose> - </refnamediv> - - <refsect1> - <title>Synopsis</title> - -<classsynopsis language="python"> - <ooclass><classname>gtk.IconView</classname></ooclass> - <ooclass><classname><link linkend="class-gtkcontainer">gtk.Container</link></classname></ooclass> - <ooclass><classname><link linkend="class-gtkcelllayout">gtk.CellLayout</link></classname></ooclass> -<constructorsynopsis language="python"> - <methodname><link linkend="constructor-gtkiconview">gtk.IconView</link></methodname> - <methodparam><parameter role="keyword">model</parameter><initializer>None</initializer></methodparam> - </constructorsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--set-model">set_model</link></methodname> - <methodparam><parameter role="keyword">model</parameter><initializer>None</initializer></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--get-model">get_model</link></methodname> - <methodparam></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--set-text-column">set_text_column</link></methodname> - <methodparam><parameter role="keyword">column</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--get-text-column">get_text_column</link></methodname> - <methodparam></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--set-markup-column">set_markup_column</link></methodname> - <methodparam><parameter role="keyword">column</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--get-markup-column">get_markup_column</link></methodname> - <methodparam></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--set-pixbuf-column">set_pixbuf_column</link></methodname> - <methodparam><parameter role="keyword">column</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--get-pixbuf-column">get_pixbuf_column</link></methodname> - <methodparam></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--get-path-at-pos">get_path_at_pos</link></methodname> - <methodparam><parameter role="keyword">x</parameter></methodparam> - <methodparam><parameter role="keyword">y</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--get-item-at-pos">get_item_at_pos</link></methodname> - <methodparam><parameter role="keyword">x</parameter></methodparam> - <methodparam><parameter role="keyword">y</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--set-cursor">set_cursor</link></methodname> - <methodparam><parameter role="keyword">path</parameter></methodparam> - <methodparam><parameter role="keyword">cell</parameter><initializer>None</initializer></methodparam> - <methodparam><parameter role="keyword">start_editing</parameter><initializer>False</initializer></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--get-cursor">get_cursor</link></methodname> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--selected-foreach">selected_foreach</link></methodname> - <methodparam><parameter role="keyword">func</parameter></methodparam> - <methodparam><parameter role="keyword">data</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--set-selection-mode">set_selection_mode</link></methodname> - <methodparam><parameter role="keyword">mode</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--get-selection-mode">get_selection_mode</link></methodname> - <methodparam></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--set-orientation">set_orientation</link></methodname> - <methodparam><parameter role="keyword">orientation</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--get-orientation">get_orientation</link></methodname> - <methodparam></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--set-columns">set_columns</link></methodname> - <methodparam><parameter role="keyword">columns</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--get-columns">get_columns</link></methodname> - <methodparam></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--set-columns">set_item_width</link></methodname> - <methodparam><parameter role="keyword">item_width</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--get-columns">get_item_width</link></methodname> - <methodparam></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--set-columns">set_spacing</link></methodname> - <methodparam><parameter role="keyword">spacing</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--get-columns">get_spacing</link></methodname> - <methodparam></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--set-columns">set_row_spacing</link></methodname> - <methodparam><parameter role="keyword">row_spacing</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--get-columns">get_row_spacing</link></methodname> - <methodparam></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--set-columns">set_column_spacing</link></methodname> - <methodparam><parameter role="keyword">column_spacing</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--get-columns">get_column_spacing</link></methodname> - <methodparam></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--set-columns">set_margin</link></methodname> - <methodparam><parameter role="keyword">margin</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--get-columns">get_margin</link></methodname> - <methodparam></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--select-path">select_path</link></methodname> - <methodparam><parameter role="keyword">path</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--unselect-path">unselect_path</link></methodname> - <methodparam><parameter role="keyword">path</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--path-is-selected">path_is_selected</link></methodname> - <methodparam><parameter role="keyword">path</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--get-selected-items">get_selected_items</link></methodname> - <methodparam></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--select-all">select_all</link></methodname> - <methodparam></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--unselect-all">unselect_all</link></methodname> - <methodparam></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--item-activated">item_activated</link></methodname> - <methodparam><parameter role="keyword">path</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--scroll-to-path">scroll_to_path</link></methodname> - <methodparam><parameter role="keyword">path</parameter></methodparam> - <methodparam><parameter role="keyword">use_align</parameter></methodparam> - <methodparam><parameter role="keyword">row_align</parameter></methodparam> - <methodparam><parameter role="keyword">col_align</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--get-visible-range">get_visible_range</link></methodname> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--enable-model-drag-source">enable_model_drag_source</link></methodname> - <methodparam><parameter role="keyword">start_button_mask</parameter></methodparam> - <methodparam><parameter role="keyword">targets</parameter></methodparam> - <methodparam><parameter role="keyword">actons</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--enable-model-drag-dest">enable_model_drag_dest</link></methodname> - <methodparam><parameter role="keyword">targets</parameter></methodparam> - <methodparam><parameter role="keyword">actions</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--unset-model-drag-source">unset_model_drag_source</link></methodname> - <methodparam></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--unset-model-drag-dest">unset_model_drag_dest</link></methodname> - <methodparam><parameter role="keyword"></parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--set-reorderable">set_reorderable</link></methodname> - <methodparam><parameter role="keyword">reorderable</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--get-reorderable">get_reorderable</link></methodname> - <methodparam></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--set-drag-dest-item">set_drag_dest_item</link></methodname> - <methodparam><parameter role="keyword">path</parameter></methodparam> - <methodparam><parameter role="keyword">pos</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--get-drag-dest-item">get_drag_dest_item</link></methodname> - <methodparam></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--get-dest-item-at-pos">get_dest_item_at_pos</link></methodname> - <methodparam><parameter role="keyword">drag_x</parameter></methodparam> - <methodparam><parameter role="keyword">drag_y</parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkiconview--create-drag-icon">create_drag_icon</link></methodname> - <methodparam><parameter role="keyword">path</parameter></methodparam> - </methodsynopsis> -</classsynopsis> - -</refsect1> - - <refsect1> - <title>Ancestry</title> - -<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link> - +-- <link linkend="class-gtkobject">gtk.Object</link> - +-- <link linkend="class-gtkwidget">gtk.Widget</link> - +-- <link linkend="class-gtkcontainer">gtk.Container</link> - +-- <link linkend="class-gtkiconview">gtk.IconView</link> (implements <link linkend="class-gtkcelllayout">gtk.CellLayout</link>)</synopsis> - - </refsect1> - - <refsect1 id="properties-gtkiconview"> - <title>gtk.IconView Properties</title> - - <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> - <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para> - <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para> - - <blockquote role="properties"> - <informaltable pgwide="1" frame="none"> - <tgroup cols="3"> - <colspec column="1" colwidth="1in"/> - <colspec column="2" colwidth="1in"/> - <colspec column="3" colwidth="4in"/> - <tbody> - - <row valign="top"> - <entry>"column-spacing"</entry> - <entry>Read-Write</entry> - - <entry>The space (in pixels) inserted between grid -columns. Allowed values: >= 0. Default value: 6. -Available in GTK+ 2.6 and above.</entry> - </row> - - <row valign="top"> - <entry>"columns"</entry> - <entry>Read-Write</entry> - - <entry>The number of columns in a row. If it is -1, the number -of columns will be chosen automatically to fill the available width. -Allowed values: >= -1. Default value: -1. -Available in GTK+ 2.6 and above.</entry> - </row> - - <row valign="top"> - <entry>"item-width"</entry> - <entry>Read-Write</entry> - - <entry>The width used for each item. If it is -1 the width the -largest item is used. Allowed values: >= -1. Default value: -1. -Available in GTK+ 2.6 and above.</entry> - </row> - - <row valign="top"> - <entry>"margin"</entry> - <entry>Read-Write</entry> - - <entry>The space (in pixels) inserted at the edges of the -icon view. Allowed values: >= 0. Default value: 6. -Available in GTK+ 2.6 and above.</entry> - </row> - - <row valign="top"> - <entry>"markup-column"</entry> - <entry>Read-Write</entry> - - <entry>The number of the model column containing markup -information to be displayed. If this property and the "text-column" property -are both set to column numbers, this overrides the text column. If both are -set to -1, no text is displayed. Allowed values: >= -1. Default value: -1. -Available in GTK+ 2.6 and above.</entry> - </row> - - <row valign="top"> - <entry>"model"</entry> - <entry>Read-Write</entry> - <entry>The <link -linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> -for the icon view. Available in GTK+ 2.6 and above.</entry> - </row> - - <row valign="top"> - <entry>"orientation"</entry> - <entry>Read-Write</entry> - <entry>How the text and icon of each item are positioned -relative to each other. Default value: -<literal>gtk.ORIENTATION_VERTICAL</literal>. Available in GTK+ 2.6 and -above.</entry> - </row> - - <row valign="top"> - <entry>"pixbuf-column"</entry> - <entry>Read-Write</entry> - - <entry>The number of the model column containing the pixbufs -that are displayed. Setting this property to -1 turns off the display of -pixbufs. Allowed values: >= -1. Default value: -1. Available in GTK+ 2.6 and -above.</entry> - </row> - - <row valign="top"> - <entry>"reorderable"</entry> - <entry>Read-Write</entry> - - <entry>If <literal>True</literal> the icon view is reorderable. -Default value: <literal>False</literal>. -Available in GTK+ 2.8 and above.</entry> - </row> - - <row valign="top"> - <entry>"row-spacing"</entry> - <entry>Read-Write</entry> - - <entry>The space (in pixels) inserted between grid rows. -Allowed values: >= 0. Default value: 6. -Available in GTK+ 2.6 and above.</entry> - </row> - - <row valign="top"> - <entry>"selection-mode"</entry> - <entry>Read-Write</entry> - - <entry>The selection mode of the icon view. If the mode is -<literal>gtk.SELECTION_MULTIPLE</literal>, rubberband selection is enabled, -for the other modes, only keyboard selection is possible. Default value: -<literal>gtk.SELECTION_SINGLE</literal>. Available in GTK+ 2.6 and -above.</entry> - </row> - - <row valign="top"> - <entry>"spacing"</entry> - <entry>Read-Write</entry> - - <entry>The space (in pixels) inserted between cells of an item. -Allowed values: >= 0. Default value: 0. -Available in GTK+ 2.6 and above.</entry> - </row> - - <row valign="top"> - <entry>"text-column"</entry> - <entry>Read-Write</entry> - - <entry>The number of the model column containing the text that -is displayed. If this property and the "markup-column" property are both set -to -1, no text is displayed. Allowed values: >= -1. Default value: --1. Available in GTK+ 2.6 and above.</entry> - </row> - - </tbody> - </tgroup> - </informaltable> - </blockquote> - - </refsect1> - - <refsect1 id="style-properties-gtkiconview"> - <title>gtk.IconView Style Properties</title> - - <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> - - <blockquote role="properties"> - <informaltable pgwide="1" frame="none"> - <tgroup cols="3"> - <colspec column="1" colwidth="1in"/> - <colspec column="2" colwidth="1in"/> - <colspec column="3" colwidth="4in"/> - <tbody> - - <row valign="top"> - <entry>"selection-box-alpha"</entry> - <entry>Read</entry> - - <entry>The opacity of the selection box. Default value: -64. Available in GTK+ 2.6 and above.</entry> - </row> - - <row valign="top"> - <entry>"selection-box-color"</entry> - <entry>Read</entry> - - <entry>The color of the selection box. Available in GTK+ 2.6 -and above.</entry> - </row> - - </tbody> - </tgroup> - </informaltable> - </blockquote> - - </refsect1> - - <refsect1 id="signal-prototypes-gtkiconview"> - <title>gtk.IconView Signal Prototypes</title> - - <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> - <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para> - <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para> - <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para> - - <variablelist> - <varlistentry> - <term>"<link linkend="signal-gtkiconview--activate-cursor-item">activate-cursor-item</link>"</term> - <listitem> - <methodsynopsis language="python"><methodname>callback</methodname> - <methodparam><parameter>iconview</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis> - </listitem> - </varlistentry> - <varlistentry> - <term>"<link linkend="signal-gtkiconview--item-activated">item-activated</link>"</term> - <listitem> - <methodsynopsis language="python"><methodname>callback</methodname> - <methodparam><parameter>iconview</parameter></methodparam> - <methodparam><parameter>path</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis> - </listitem> - </varlistentry> - <varlistentry> - <term>"<link linkend="signal-gtkiconview--move-cursor">move-cursor</link>"</term> - <listitem> - <methodsynopsis language="python"><methodname>callback</methodname> - <methodparam><parameter>iconview</parameter></methodparam> - <methodparam><parameter>step</parameter></methodparam> - <methodparam><parameter>number</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis> - </listitem> - </varlistentry> - <varlistentry> - <term>"<link linkend="signal-gtkiconview--select-all">select-all</link>"</term> - <listitem> - <methodsynopsis language="python"><methodname>callback</methodname> - <methodparam><parameter>iconview</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis> - </listitem> - </varlistentry> - <varlistentry> - <term>"<link linkend="signal-gtkiconview--select-cursor-item">select-cursor-item</link>"</term> - <listitem> - <methodsynopsis language="python"><methodname>callback</methodname> - <methodparam><parameter>iconview</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis> - </listitem> - </varlistentry> - <varlistentry> - <term>"<link linkend="signal-gtkiconview--selection-changed">selection-changed</link>"</term> - <listitem> - <methodsynopsis language="python"><methodname>callback</methodname> - <methodparam><parameter>iconview</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis> - </listitem> - </varlistentry> - <varlistentry> - <term>"<link linkend="signal-gtkiconview--set-scroll-adjustments">set-scroll-adjustments</link>"</term> - <listitem> - <methodsynopsis language="python"><methodname>callback</methodname> - <methodparam><parameter>iconview</parameter></methodparam> - <methodparam><parameter>hadj</parameter></methodparam> - <methodparam><parameter>vadj</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis> - </listitem> - </varlistentry> - <varlistentry> - <term>"<link linkend="signal-gtkiconview--toggle-cursor-item">toggle-cursor-item</link>"</term> - <listitem> - <methodsynopsis language="python"><methodname>callback</methodname> - <methodparam><parameter>iconview</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis> - </listitem> - </varlistentry> - <varlistentry> - <term>"<link linkend="signal-gtkiconview--unselect-all">unselect-all</link>"</term> - <listitem> - <methodsynopsis language="python"><methodname>callback</methodname> - <methodparam><parameter>iconview</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis> - </listitem> - </varlistentry> - </variablelist> - - </refsect1> - - <refsect1> - <title>Description</title> - - <note> - <para>This widget is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <link -linkend="class-gtkiconview"><classname>gtk.IconView</classname></link> -widget provides an alternative view of a <link -linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link> -model. It displays the model as a grid of icons with labels. Like <link -linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>, you -can select one or multiple items (depending on the selection mode, see the -<link -linkend="method-gtkiconview--set-selection-mode"><methodname>set_selection_mode</methodname>()</link> -method for more information). In addition to selection with the arrow keys, -<link linkend="class-gtkiconview"><classname>gtk.IconView</classname></link> -supports rubberband selection, which is controlled by dragging the -pointer.</para> - - </refsect1> - - <refsect1 id="constructor-gtkiconview"> - <title>Constructor</title> - - <programlisting><constructorsynopsis language="python"> - <methodname>gtk.IconView</methodname> - <methodparam><parameter - role="keyword">model</parameter><initializer>None</initializer></methodparam> - </constructorsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">model</parameter> :</term> - <listitem><simpara>A <link -linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>, or -<literal>None</literal></simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link -linkend="class-gtkiconview"><classname>gtk.IconView</classname></link> -widget.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This constructor is available in PyGTK 2.6 and above.</para> - </note> - - <para>Creates a new <link -linkend="class-gtkiconview"><classname>gtk.IconView</classname></link> -widget. If <parameter>model</parameter> is specified and not -<literal>None</literal> it should specify a <link -linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> to -be used as the model.</para> - - </refsect1> - - <refsect1> - <title>Methods</title> - - <refsect2 id="method-gtkiconview--set-model"> - <title>gtk.IconView.set_model</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_model</methodname> - <methodparam><parameter - role="keyword">model</parameter><initializer>None</initializer></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">model</parameter> :</term> - <listitem><simpara>a <link -linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> -or <literal>None</literal></simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>set_model</methodname>() method sets the "model" -property to the <link -linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> -specified by <parameter>model</parameter>. If <parameter>model</parameter> -is <literal>None</literal> the old model will be unset.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--get-model"> - <title>gtk.IconView.get_model</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_model</methodname> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>The <link -linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> -used by the cell view or <literal>None</literal>.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>get_model</methodname>() method returns the -value of the "model" property which contains the <link -linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> -used by the cell view. If no model is being used this method returns -<literal>None</literal>.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--set-text-column"> - <title>gtk.IconView.set_text_column</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_text_column</methodname> - <methodparam><parameter - role="keyword">column</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">column</parameter> :</term> - <listitem><simpara>The index of a column in the -model or -1 to unset the column</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>set_text_column</methodname>() method sets the -"text-column" property to the value of <parameter>column</parameter> which -should be the index of a column in the model containing strings to be used -for text. If <parameter>column</parameter> is -1 the text column is -unset.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--get-text-column"> - <title>gtk.IconView.get_text_column</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_text_column</methodname> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>The index of a model's column or -1 if -unset.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>get_text_column</methodname>() method returns -the value of the "text-column" property which contains the index of the -column in the model that provides strings to be used for text. If the -"text-column" property contains -1 then no column is used for text.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--set-markup-column"> - <title>gtk.IconView.set_markup_column</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_markup_column</methodname> - <methodparam><parameter - role="keyword">column</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">column</parameter> :</term> - <listitem><simpara>The index of a column in the model or -1.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>set_markup_column</methodname>() method sets the -"markup-column" property to the value specified by -<parameter>column</parameter>. The "markup-column" property indicates the -index of a column in the model to be used for markup information. If -<parameter>column</parameter> is -1 the markup column will be unset. If the -markup column is set, it overrides the text column set by the <link -linkend="method-gtkiconview--set-text-column"><methodname>set_text_column</methodname>()</link> -method.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--get-markup-column"> - <title>gtk.IconView.get_markup_column</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_markup_column</methodname> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the index of the model column containing markup -or -1.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>get_markup_column</methodname> method returns -the value of the "markup-column" property which contains the index of the -column in the model that contains the Pango markup for text. if the -"markup-column" property is -1, the markup column is unset.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--set-pixbuf-column"> - <title>gtk.IconView.set_pixbuf_column</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_pixbuf_column</methodname> - <methodparam><parameter - role="keyword">column</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">column</parameter> :</term> - <listitem><simpara>the index of a model column or --1</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>set_pixbuf_column</methodname>() method sets the -"pixbuf-column" property to the value of <parameter>column</parameter>. If -column >= 0 the icon view <link -linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> -objects will be retrieved from the specified column. If -<parameter>column</parameter> is -1 then no pixbufs will be used,</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--get-pixbuf-column"> - <title>gtk.IconView.get_pixbuf_column</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_pixbuf_column</methodname> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>The index of a column in the model or --1</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>get_pixbuf_column</methodname>() returns the -value of the "pixbuf-column" property which contains the index of the model -column use to to retrieve <link -linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> -objects to display. If the "pixbuf-column" property is -1 no pixbufs will be -retrieved.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--get-path-at-pos"> - <title>gtk.IconView.get_path_at_pos</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_path_at_pos</methodname> - <methodparam><parameter - role="keyword">x</parameter></methodparam> - <methodparam><parameter - role="keyword">y</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">x</parameter> :</term> - <listitem><simpara>the x coordinate</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">y</parameter> :</term> - <listitem><simpara>the y coordinate</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the path at the specified point or -<literal>None</literal>.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>get_path_at_pos</methodname>() method returns -the model path of the icon located at the coordinates specified by -(<parameter>x</parameter>, <parameter>y</parameter>). This method returns -<literal>None</literal> if there is no icon at the specified -location.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--get-item-at-pos"> - <title>gtk.IconView.get_item_at_pos</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_item_at_pos</methodname> - <methodparam><parameter - role="keyword">x</parameter></methodparam> - <methodparam><parameter - role="keyword">y</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">x</parameter> :</term> - <listitem><simpara>the x coordinate</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">y</parameter> :</term> - <listitem><simpara>the y coordinate</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a 2-tuple comtaining the path and the cell -renderer at the specified point or <literal>None</literal> if the is no item -at the position.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.8 and above.</para> - </note> - - <para>The <methodname>get_item_at_pos</methodname>() method returns a -2-tuple containing the model path and cell renderer of the icon located at -the coordinates specified by (<parameter>x</parameter>, -<parameter>y</parameter>). This method returns <literal>None</literal> if -there is no item at the specified location.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--set-cursor"> - <title>gtk.IconView.set_cursor</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_cursor</methodname> - <methodparam><parameter - role="keyword">path</parameter></methodparam> - <methodparam><parameter - role="keyword">cell</parameter><initializer>None</initializer></methodparam> - <methodparam><parameter - role="keyword">start_editing</parameter><initializer>False</initializer></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">path</parameter> :</term> - <listitem><simpara>a tree path</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">cell</parameter> :</term> - <listitem><simpara>a <link -linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link> -or <literal>None</literal></simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">start_editing</parameter> :</term> - <listitem><simpara>if <literal>True</literal> the specified cell -should start being edited</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.8 and above.</para> - </note> - - <para>The <methodname>set_cursor</methodname>() method sets the -current keyboard focus to be at the location specified by -<parameter>path</parameter>, and selects it. This is useful when you want to -focus the user's attention on a particular item. If -<parameter>cell</parameter> is not <literal>None</literal>, then focus is -given to the specified cell. Additionally, if -<parameter>start_editing</parameter> is <literal>True</literal>, then -editing should be started in the specified cell.</para> - - <para>This method is often followed by <link - linkend="method-gtkwidget--grab-focus"><methodname>gtk.Widget.grab_focus</methodname>()</link> - in order to give keyboard focus to the icon view. Please note that editing - can only happen when the icon view is realized.</para> - - <note> - <para>In PyGTK 2.8 <parameter>cell</parameter> and - <parameter>start_editing</parameter> must be specified. Also - <parameter>cell</parameter> cannot be <literal>None</literal>.</para> - </note> - - </refsect2> - - <refsect2 id="method-gtkiconview--get-cursor"> - <title>gtk.IconView.get_cursor</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_cursor</methodname> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a 2-tuple containing the current cursor path -and cell renderer or <literal>None</literal> if the cursor isn't -set.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.8 and above.</para> - </note> - - <para>The <methodname>get_cursor</methodname>() method returns a -2-tuple containing the model path and <link -linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link> -at the current cursor location. This method returns <literal>None</literal> -if the cursor is not set. If no cell renderer has focus then -<literal>None</literal> will be returned for the cell renderer value.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--selected-foreach"> - <title>gtk.IconView.selected_foreach</title> - - <programlisting><methodsynopsis language="python"> - <methodname>selected_foreach</methodname> - <methodparam><parameter - role="keyword">func</parameter></methodparam> - <methodparam><parameter - role="keyword">data</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">func</parameter> :</term> - <listitem><simpara>a callback function or -method.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">data</parameter> :</term> - <listitem><simpara>User data to pass to -<parameter>func</parameter>.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>selected_foreach</methodname>() method calls the -callback function or method specified by <parameter>func</parameter> for -each selected icon. The signature of <parameter>func</parameter> is:</para> - - <programlisting> - def func(<parameter>iconview</parameter>, <parameter>path</parameter>, <parameter>user_data</parameter>): -</programlisting> - - <para>where <parameter>iconview</parameter> is the <link -linkend="class-gtkiconview"><classname>gtk.IconView</classname></link>, -<parameter>path</parameter> is the tree path of the icon row and -<parameter>user_data</parameter> is data.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--set-selection-mode"> - <title>gtk.IconView.set_selection_mode</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_selection_mode</methodname> - <methodparam><parameter - role="keyword">mode</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">mode</parameter> :</term> - <listitem><simpara>The selection mode.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>set_selection_mode</methodname>() method sets -the "selection-mode" property to the value of -<parameter>mode</parameter>. <parameter>mode</parameter> should be one of -the <xref linkend="gtk-selection-mode-constants" -endterm="gtk-selection-mode-constants-title"></xref>.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--get-selection-mode"> - <title>gtk.IconView.get_selection_mode</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_selection_mode</methodname> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the selection mode.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>get_selection_mode</methodname>() method returns -the value of the "selection-mode" property which contains one of the <xref -linkend="gtk-selection-mode-constants" -endterm="gtk-selection-mode-constants-title"></xref>.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--set-orientation"> - <title>gtk.IconView.set_orientation</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_orientation</methodname> - <methodparam><parameter - role="keyword">orientation</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">orientation</parameter> :</term> - <listitem><simpara>the relative position of the icon and -text.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>set_orientation</methodname>() method sets the -"orientation" property to the value of -<parameter>orientation</parameter>. <parameter>orientation</parameter> -should contain one of the <xref linkend="gtk-orientation-constants" -endterm="gtk-orientation-constants-title"></xref>. The "orientation" -property indicates the relative positioning of the icon and text.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--get-orientation"> - <title>gtk.IconView.get_orientation</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_orientation</methodname> - <methodparam><parameter - role="keyword"></parameter></methodparam> - <methodparam><parameter - role="keyword"></parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the relative position of the icon and -text.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>get_orientation</methodname>() method returns -the value of the "orientation" property that indicates the relative position -between the icon and text. See the <link -linkend="method-gtkiconview--set-orientation"><methodname>set_orientation</methodname>()</link> -method for more information.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--set-columns"> - <title>gtk.IconView.set_columns</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_columns</methodname> - <methodparam><parameter - role="keyword">columns</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">columns</parameter> :</term> - <listitem><simpara>the number of columns in a row.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>set_columns</methodname>() method sets the -"columns" property to the value of -<parameter>columns</parameter>. <parameter>columns</parameter> should -contain the number of columns to be displayed in each row or -1 to fit as -many columns as possible per row.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--get-columns"> - <title>gtk.IconView.get_columns</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_columns</methodname> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the number of columns per row or --1.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>get_columns</methodname>() method returns the -value of the "columns" property that indicates the number of columns per -row. See the <link -linkend="method-gtkiconview--set-columns"><methodname>set_columns</methodname>()</link> -method for more information.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--set-item-width"> - <title>gtk.IconView.set_item_width</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_item_width</methodname> - <methodparam><parameter - role="keyword">item_width</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">item_width</parameter> :</term> - <listitem><simpara>The space used to display an item or -1 to use -the width of the largest item.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>set_item_width</methodname>() method sets the -"item-width" property to the value of -<parameter>item_width</parameter>. <parameter>item_width</parameter> should -contain the maximum space (in pixels) to use to display an item in the icon -view or -1 to use the width of the largest item.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--get-item-width"> - <title>gtk.IconView.get_item_width</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_item_width</methodname> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the space available for displaying an -item or -1.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>get_item_width</methodname>() method returns the -value of the "item-width" property that contains the space available for -displaying an item. See the <link -linkend="method-gtkiconview--set-item-width"><methodname>set_item_width</methodname>()</link> -method for more information.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--set-spacing"> - <title>gtk.IconView.set_spacing</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_spacing</methodname> - <methodparam><parameter - role="keyword">spacing</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">spacing</parameter> :</term> - <listitem><simpara>The space between the cells of an item in the -icon view</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>set_spacing</methodname>() method sets the -"spacing" property to the value of -<parameter>spacing</parameter>. <parameter>spacing</parameter> should -contain the space in pixels that is inserted between the cells of an item in -the icon view.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--get-spacing"> - <title>gtk.IconView.get_spacing</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_spacing</methodname> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the space in pixels that is inserted between -cells in the icon view.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>get_spacing</methodname>() method returns the -value of the "spacing" property that contains the space in pixels that is -inserted between the cells of an item in the icon view. See the <link -linkend="method-gtkiconview--set-spacing"><methodname>set_spacing</methodname>()</link> -method for more information.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--set-row-spacing"> - <title>gtk.IconView.set_row_spacing</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_row_spacing</methodname> - <methodparam><parameter - role="keyword">row_spacing</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">row_spacing</parameter> :</term> - <listitem><simpara>the space between rows in the icon -view.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>set_row_spacing</methodname>() method sets the -"row-spacing" property to the value of -<parameter>row_spacing</parameter>. <parameter>row_spacing</parameter> -should contain the space in pixels to be inserted between rows in the icon -view..</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--get-row-spacing"> - <title>gtk.IconView.get_row_spacing</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_row_spacing</methodname> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the space between rows in the icon -view.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>get_row_spacing</methodname>() method returns -the value of the "row-spacing" property that contains the space in pixels -inserted between the rows in the icon view. See the <link -linkend="method-gtkiconview--set-row-spacing"><methodname>set_row_spacing</methodname>()</link> -method for more information.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--set-column-spacing"> - <title>gtk.IconView.set_column_spacing</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_column_spacing</methodname> - <methodparam><parameter - role="keyword">column_spacing</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">column_spacing</parameter> :</term> - <listitem><simpara>The space inserted between columns in the icon -view</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>set_column_spacing</methodname>() method sets -the "column-spacing" property to the value of -<parameter>column_spacing</parameter>. <parameter>column_spacing</parameter> -should contain the space in pixels to be inserted between columns in the -icon view.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--get-column-spacing"> - <title>gtk.IconView.get_column_spacing</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_column_spacing</methodname> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the space between columns in the icon -view.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>get_column_spacing</methodname>() method returns -the value of the "column-spacing" property that contains the space in pixels -between the columns in the icon view. See the <link -linkend="method-gtkiconview--set-column-spacing"><methodname>set_column_spacing</methodname>()</link> -method for more information.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--set-margin"> - <title>gtk.IconView.set_margin</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_margin</methodname> - <methodparam><parameter - role="keyword">margin</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">margin</parameter> :</term> - <listitem><simpara>the space inserted at the edges of the icon -view.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>set_margin</methodname>() method sets the -"margin" property to the value of -<parameter>margin</parameter>. <parameter>margin</parameter> should contain -the space in pixels to be inserted at the edges of the icon view.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--get-margin"> - <title>gtk.IconView.get_margin</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_margin</methodname> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the space inserted at the edges of the icon -view.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>get_margin</methodname>() method returns the -value of the "margin" property that continas the space in pixels inserted at -the edges of the icon view. See the <link -linkend="method-gtkiconview--set-margin"><methodname>set_margin</methodname>()</link> -method for more information.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--select-path"> - <title>gtk.IconView.select_path</title> - - <programlisting><methodsynopsis language="python"> - <methodname>select_path</methodname> - <methodparam><parameter - role="keyword">path</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">path</parameter> :</term> - <listitem><simpara>a path indicating the icon to be -selected</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>select_path</methodname> method selects the icon -with the tree path specified by <parameter>path</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--unselect-path"> - <title>gtk.IconView.unselect_path</title> - - <programlisting><methodsynopsis language="python"> - <methodname>unselect_path</methodname> - <methodparam><parameter - role="keyword">path</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">path</parameter> :</term> - <listitem><simpara>a path indicating the icon to be -unselected</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para> The <methodname>unselect_path</methodname> method unselects the -icon with the tree path specified by <parameter>path</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--path-is-selected"> - <title>gtk.IconView.path_is_selected</title> - - <programlisting><methodsynopsis language="python"> - <methodname>path_is_selected</methodname> - <methodparam><parameter - role="keyword">path</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">path</parameter> :</term> - <listitem><simpara>a path of an icon.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara><literal>True</literal> if -<parameter>path</parameter> is selected.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>path_is_selected</methodname>() method returns -<literal>True</literal> if the icon with the tree path specified by -<parameter>path</parameter> is selected.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--get-selected-items"> - <title>gtk.IconView.get_selected_items</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_selected_items</methodname> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a list of the paths of the selected -icons.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>get_selected_items</methodname>() method returns -a list of the paths of the selected icons.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--select-all"> - <title>gtk.IconView.select_all</title> - - <programlisting><methodsynopsis language="python"> - <methodname>select_all</methodname> - </methodsynopsis></programlisting> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>select_all</methodname>() method selects all the -icons if the selection mode is set to -<literal>gtk.SELECTION_MULTIPLE</literal>.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--unselect-all"> - <title>gtk.IconView.unselect_all</title> - - <programlisting><methodsynopsis language="python"> - <methodname>unselect_all</methodname> - </methodsynopsis></programlisting> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>unselect_all</methodname>() method unselects all -the icons.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--item-activated"> - <title>gtk.IconView.item_activated</title> - - <programlisting><methodsynopsis language="python"> - <methodname>item_activated</methodname> - <methodparam><parameter - role="keyword">path</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">path</parameter> :</term> - <listitem><simpara>a tree path pointing to an icon -row.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>item_activated</methodname>() method activates -the icon pointed to by the path specified by -<parameter>path</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--scroll-to-path"> - <title>gtk.IconView.scroll_to_path</title> - - <programlisting><methodsynopsis language="python"> - <methodname>scroll_to_path</methodname> - <methodparam><parameter - role="keyword">path</parameter></methodparam> - <methodparam><parameter - role="keyword">use_align</parameter></methodparam> - <methodparam><parameter - role="keyword">row_align</parameter></methodparam> - <methodparam><parameter - role="keyword">col_align</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">path</parameter> :</term> - <listitem><simpara>the path of the item to move -to.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">use_align</parameter> :</term> - <listitem><simpara>if <literal>True</literal> use the alignment -arguments</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">row_align</parameter> :</term> - <listitem><simpara>the vertical alignment of the item specified by -<parameter>path</parameter>.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">col_align</parameter> :</term> - <listitem><simpara>The horizontal alignment of the item specified -by <parameter>path</parameter>.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.8 and above.</para> - </note> - - <para>The <methodname>scroll_to_path</methodname>() method moves the - alignments of the icon view to the position specified by - <parameter>path</parameter>. <parameter>row_align</parameter> determines - where the row is placed, and <parameter>col_align</parameter> determines - where column is placed. Both are expected to be between 0.0 and 1.0. 0.0 - means left/top alignment, 1.0 means right/bottom alignment, 0.5 means - center.</para> - - <para>If <parameter>use_align</parameter> is <literal>False</literal>, - then the alignment arguments are ignored, and the icon view does the - minimum amount of work to scroll the item onto the screen. This means that - the item will be scrolled to the edge closest to its current position. If - the item is currently visible on the screen, nothing is done.</para> - - <para>This method only works if the model is set, and - <parameter>path</parameter> is a valid row on the model. If the model - changes before the icon view is realized, the centered path will be - modified to reflect this change.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--get-visible-range"> - <title>gtk.IconView.get_visible_range</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_visible_range</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a 2-tuple containing the start and end paths of -the visible region or <literal>None</literal>.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.8 and above.</para> - </note> - - <para>The <methodname>get_visible_range</methodname>() method returns -a 2-tuple containing the start and end paths for the visible region in the -iconview. If no valid paths are available this method returns -<literal>None</literal>.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--enable-model-drag-source"> - <title>gtk.IconView.enable_model_drag_source</title> - - <programlisting><methodsynopsis language="python"> - <methodname>enable_model_drag_source</methodname> - <methodparam><parameter - role="keyword">start_button_mask</parameter></methodparam> - <methodparam><parameter - role="keyword">targets</parameter></methodparam> - <methodparam><parameter - role="keyword">actions</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">start_button_mask</parameter> :</term> - <listitem><simpara>the mask of buttons allowed to start drag</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">targets</parameter> :</term> - <listitem><simpara>a sequence of 3-tuples containing target -information that the drag will support</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">actions</parameter> :</term> - <listitem><simpara>the combination of possible <xref - linkend="gdk-drag-action-constants" - endterm="gdk-drag-action-constants-title"></xref> for a drag - from the iconview</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.8 and above.</para> - </note> - - <para>The <methodname>enable_model_drag_source</methodname>() method - enables the iconview to be used as a drag source for automatic - DND. <parameter>start_button_mask</parameter> specifies a combination of - the <xref linkend="gdk-modifier-constants" - endterm="gdk-modifier-constants-title"></xref> that can start the - drag. <parameter>targets</parameter> is a sequence (tuple or list) of - 3-tuples each containing target information: a string representing the drag - type, target flags (a combination of <literal>gtk.TARGET_SAME_APP</literal> - and <literal>gtk.TARGET_SAME_WIDGET</literal> or neither) and an - application assigned integer ID used for identification - purposes. <parameter>actions</parameter> is a combination of the <xref - linkend="gdk-drag-action-constants" - endterm="gdk-drag-action-constants-title"></xref> supported by the - iconview.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--enable-model-drag-dest"> - <title>gtk.IconView.enable_model_drag_dest</title> - - <programlisting><methodsynopsis language="python"> - <methodname>enable_model_drag_dest</methodname> - <methodparam><parameter - role="keyword">targets</parameter></methodparam> - <methodparam><parameter - role="keyword">actions</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">targets</parameter> :</term> - <listitem><simpara>a sequence of 3-tuples containing target -information that the iconview will support for a drag drop</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">actions</parameter> :</term> - <listitem><simpara>the combination of possible <xref - linkend="gdk-drag-action-constants" - endterm="gdk-drag-action-constants-title"></xref> for a drag - drop onto to the iconview</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.8 and above.</para> - </note> - - <para>The <methodname>enable_model_drag_dest</methodname>() method -enables the iconview to be a destination for a drag -drop. <parameter>targets</parameter> is a sequence (tuple or list) of -3-tuples each containing target information: a string representing the drag -type, target flags (a combination of <literal>gtk.TARGET_SAME_APP</literal> -and <literal>gtk.TARGET_SAME_WIDGET</literal> or neither) and an application -assigned integer ID used for identification -purposes. <parameter>actions</parameter> is a combination of the <xref -linkend="gdk-drag-action-constants" -endterm="gdk-drag-action-constants-title"></xref> supported by the -iconview.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--unset-model-drag-source"> - <title>gtk.IconView.unset_model_drag_source</title> - - <programlisting><methodsynopsis language="python"> - <methodname>unset_model_drag_source</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <note> - <para>This method is available in PyGTK 2.8 and above.</para> - </note> - - <para>The <methodname>unset_model_drag_source</methodname>() method - undoes the effect of the <link - linkend="method-gtkiconview--enable-model-drag-source"><methodname>enable_model_drag_source</methodname>()</link> - method.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--unset-model-drag-dest"> - <title>gtk.IconView.unset_model_drag_dest</title> - - <programlisting><methodsynopsis language="python"> - <methodname>unset_model_drag_dest</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <note> - <para>This method is available in PyGTK 2.8 and above.</para> - </note> - - <para>The <methodname>unset_model_drag_dest</methodname>() method - undoes the effect of the <link - linkend="method-gtkiconview--enable-model-drag-dest"><methodname>enable_model_drag_dest</methodname>()</link> - method.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--set-reorderable"> - <title>gtk.IconView.set_reorderable</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_reorderable</methodname> - <methodparam><parameter - role="keyword">reorderable</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">reorderable</parameter> :</term> - <listitem><simpara>if <literal>True</literal> the items are -reorderable.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.8 and above.</para> - </note> - - <para>The <methodname>set_reorderable</methodname>() method sets the -"reorderable" property to the value of -<parameter>reorderable</parameter>. If <parameter>reorderable</parameter> is -<literal>True</literal> the user can reorder the model by dragging and -dropping rows. The developer can listen to these changes by connecting to -the model's "row_inserted" and "row_deleted" signals.</para> - - <para>This method does not give you any degree of control over the - order -- any reordering is allowed. If more control is needed, you should - probably handle drag and drop manually.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--get-reorderable"> - <title>gtk.IconView.get_reorderable</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_reorderable</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara><literal>True</literal> if the iconview list -can be reordered.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.8 and above.</para> - </note> - - <para>The <methodname>get_reorderable</methodname>() method returns -the value of the "reorderable" property. If "reorderable" is -<literal>True</literal> the user can reorder iconview using -drag-and-drop.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--set-drag-dest-item"> - <title>gtk.IconView.set_drag_dest_item</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_drag_dest_item</methodname> - <methodparam><parameter - role="keyword">path</parameter></methodparam> - <methodparam><parameter - role="keyword">pos</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">path</parameter> :</term> - <listitem><simpara>the path of the item to highlight, or -<literal>None</literal> .</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">pos</parameter> :</term> - <listitem><simpara>specifies where to drop, relative to the -item</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.8 and above.</para> - </note> - - <para>The <methodname>set_drag_dest_item</methodname>() method -highlights for feedback the item specified by -<parameter>path</parameter>. <literal>pos</literal> is one of the <xref -linkend="gtk-iconview-drop-position-constants" -endterm="gtk-iconview-drop-position-constants-title"></xref> that specifies -where the drop is to take place relative to the receiving item.</para> - -<para>In PyGTK 2.10 and above, <parameter>path</parameter> may be -<literal>None</literal>.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--get-drag-dest-item"> - <title>gtk.IconView.get_drag_dest_item</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_drag_dest_item</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a 2-tuple containing the path of the highlighted -item and one of the <xref -linkend="gtk-iconview-drop-position-constants" -endterm="gtk-iconview-drop-position-constants-title"></xref> specifying the -relative drop location or <literal>None</literal>.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.8 and above.</para> - </note> - - <para>The <methodname>get_drag_dest_item</methodname>() method returns -a 2-tuple containing the path of the highlighted item and one of the <xref -linkend="gtk-iconview-drop-position-constants" -endterm="gtk-iconview-drop-position-constants-title"></xref> specifying the -drop location relative to the receiving item. If there is no highlighted -item, this method returns <literal>None</literal>.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--get-dest-item-at-pos"> - <title>gtk.IconView.get_dest_item_at_pos</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_dest_item_at_pos</methodname> - <methodparam><parameter - role="keyword">drag_x</parameter></methodparam> - <methodparam><parameter - role="keyword">drag_y</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">drag_x</parameter> :</term> - <listitem><simpara>the X position</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">drag_y</parameter> :</term> - <listitem><simpara>the Y position</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a 2-tuple containing the path of the highlighted -item and a relative drop location.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.8 and above.</para> - </note> - - <para>The <methodname>get_dest_item_at_pos</methodname>() method -returns a 2-tuple containing the path of the highlighted item at the -location specified by <parameter>drag_x</parameter> and -<parameter>drag_y</parameter> and the drop location relative to the -receiving item. If there is no highlighted item, this method returns -<literal>None</literal>.</para> - - </refsect2> - - <refsect2 id="method-gtkiconview--create-drag-icon"> - <title>gtk.IconView.create_drag_icon</title> - - <programlisting><methodsynopsis language="python"> - <methodname>create_drag_icon</methodname> - <methodparam><parameter - role="keyword">path</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">path</parameter> :</term> - <listitem><simpara>a path</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a <link -linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> of the -drag icon.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.8 and above.</para> - </note> - - <para>The <methodname>create_drag_icon</methodname>() method returns a -<link linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> -representation of the item at the location specified by -<parameter>path</parameter>. The return image can be used for a drag -icon.</para> - - </refsect2> - - </refsect1> - - <refsect1> - <title>Signals</title> - - <refsect2 id="signal-gtkiconview--activate-cursor-item"> - <title>The "activate-cursor-item" gtk.IconView Signal</title> - - <programlisting><methodsynopsis language="python"> - <methodname>callback</methodname> - <methodparam><parameter>iconview</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter>iconview</parameter> :</term> - <listitem><simpara>the widget that received the -signal</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>user_param1</parameter> :</term> - <listitem><simpara>the first user parameter (if any) specified -with the <link -linkend="method-gobject--connect"><methodname>connect</methodname>()</link> -method</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>...</parameter> :</term> - <listitem><simpara>additional user parameters (if -any)</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara><literal>True</literal> if the signal -was handled.</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The "activate-cursor-item" signal is emitted when an icon is -selected and the <keycap>Enter</keycap> key is pressed.</para> - - </refsect2> - - <refsect2 id="signal-gtkiconview--item-activated"> - <title>The "item-activated" gtk.IconView Signal</title> - - <programlisting><methodsynopsis language="python"> - <methodname>callback</methodname> - <methodparam><parameter>iconview</parameter></methodparam> - <methodparam><parameter>path</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter>iconview</parameter> :</term> - <listitem><simpara>the widget that received the -signal</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>path</parameter> :</term> - <listitem><simpara>the path to the activated icon -item.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>user_param1</parameter> :</term> - <listitem><simpara>the first user parameter (if any) specified -with the <link -linkend="method-gobject--connect"><methodname>connect</methodname>()</link> -method</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>...</parameter> :</term> - <listitem><simpara>additional user parameters (if -any)</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The "item-activated" signal is emitted when an icon item is -activated by the user double clicking an icon item, pressing the -<keycap>Enter</keycap> key when an icon item is selected or via a call to -the <link -linkend="method-gtkiconview--item-activated"><methodname>item_activated</methodname>()</link> -method.</para> - - </refsect2> - - <refsect2 id="signal-gtkiconview--move-cursor"> - <title>The "move-cursor" gtk.IconView Signal</title> - - <programlisting><methodsynopsis language="python"> - <methodname>callback</methodname> - <methodparam><parameter>iconview</parameter></methodparam> - <methodparam><parameter>step</parameter></methodparam> - <methodparam><parameter>number</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter>iconview</parameter> :</term> - <listitem><simpara>the widget that received the -signal</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>step</parameter> :</term> - <listitem><simpara>the step size to move the cursor</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>number</parameter> :</term> - <listitem><simpara>the number of steps to move</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>user_param1</parameter> :</term> - <listitem><simpara>the first user parameter (if any) specified -with the <link -linkend="method-gobject--connect"><methodname>connect</methodname>()</link> -method</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>...</parameter> :</term> - <listitem><simpara>additional user parameters (if -any)</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara><literal>True</literal> if the signal -was handled.</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The "move-cursor" signal is emitted when the cursor is moved -using the keyboard keys: <keycap>Up</keycap>, <keycap>Down</keycap>, -<keycombo><keycap>Control</keycap><keycap>p</keycap> </keycombo>, -<keycombo><keycap>Control</keycap><keycap>n</keycap> </keycombo>, -<keycap>Home</keycap>, <keycap>End</keycap>, <keycap>Page_Up</keycap>, -<keycap>Page_Down</keycap>, <keycap>Right</keycap>, <keycap>Left</keycap> -with various <keycap>Shift</keycap> and <keycap>Control</keycap> -combinations. <parameter>step</parameter> will be one of the <xref -linkend="gtk-movement-step-constants" -endterm="gtk-movement-step-constants-title"></xref>.</para> - - </refsect2> - - <refsect2 id="signal-gtkiconview--select-all"> - <title>The "select-all" gtk.IconView Signal</title> - - <programlisting><methodsynopsis language="python"> - <methodname>callback</methodname> - <methodparam><parameter>iconview</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter>iconview</parameter> :</term> - <listitem><simpara>the widget that received the -signal</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>user_param1</parameter> :</term> - <listitem><simpara>the first user parameter (if any) specified -with the <link -linkend="method-gobject--connect"><methodname>connect</methodname>()</link> -method</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>...</parameter> :</term> - <listitem><simpara>additional user parameters (if -any)</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The "select-all" signal is emitted when all icon items are -selected by pressing <keycombo><keycap>Control</keycap><keycap>a</keycap> -</keycombo>.</para> - - </refsect2> - - <refsect2 id="signal-gtkiconview--select-cursor-item"> - <title>The "select-cursor-item" gtk.IconView Signal</title> - - <programlisting><methodsynopsis language="python"> - <methodname>callback</methodname> - <methodparam><parameter>iconview</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter>iconview</parameter> :</term> - <listitem><simpara>the widget that received the -signal</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>user_param1</parameter> :</term> - <listitem><simpara>the first user parameter (if any) specified -with the <link -linkend="method-gobject--connect"><methodname>connect</methodname>()</link> -method</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>...</parameter> :</term> - <listitem><simpara>additional user parameters (if -any)</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The "select-cursor-item" signal is emitted when the icon item -at the cursor is selected by the user pressing the <keycap>Space</keycap> -key.</para> - - </refsect2> - - <refsect2 id="signal-gtkiconview--selection-changed"> - <title>The "selection-changed" gtk.IconView Signal</title> - - <programlisting><methodsynopsis language="python"> - <methodname>callback</methodname> - <methodparam><parameter>iconview</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter>iconview</parameter> :</term> - <listitem><simpara>the widget that received the -signal</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>user_param1</parameter> :</term> - <listitem><simpara>the first user parameter (if any) specified -with the <link -linkend="method-gobject--connect"><methodname>connect</methodname>()</link> -method</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>...</parameter> :</term> - <listitem><simpara>additional user parameters (if -any)</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The "selection-changed" signal is emitted when the selection is -changed either by user action or program method calls.</para> - - </refsect2> - - <refsect2 id="signal-gtkiconview--set-scroll-adjustments"> - <title>The "set-scroll-adjustments" gtk.IconView Signal</title> - - <programlisting><methodsynopsis language="python"> - <methodname>callback</methodname> - <methodparam><parameter>iconview</parameter></methodparam> - <methodparam><parameter>hadj</parameter></methodparam> - <methodparam><parameter>vadj</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter>iconview</parameter> :</term> - <listitem><simpara>the widget that received the -signal</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>hadj</parameter> :</term> - <listitem><simpara>the new horizontal <link -linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link></simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>vadj</parameter> :</term> - <listitem><simpara>the new vertical <link -linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link></simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>user_param1</parameter> :</term> - <listitem><simpara>the first user parameter (if any) specified -with the <link -linkend="method-gobject--connect"><methodname>connect</methodname>()</link> -method</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>...</parameter> :</term> - <listitem><simpara>additional user parameters (if -any)</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The "set-scroll-adjustments" signal is emitted when the new -horizontal and veritcal scroll <link -linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link> -objects are set.</para> - - </refsect2> - - <refsect2 id="signal-gtkiconview--toggle-cursor-item"> - <title>The "toggle-cursor-item" gtk.IconView Signal</title> - - <programlisting><methodsynopsis language="python"> - <methodname>callback</methodname> - <methodparam><parameter>iconview</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter>iconview</parameter> :</term> - <listitem><simpara>the widget that received the -signal</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>user_param1</parameter> :</term> - <listitem><simpara>the first user parameter (if any) specified -with the <link -linkend="method-gobject--connect"><methodname>connect</methodname>()</link> -method</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>...</parameter> :</term> - <listitem><simpara>additional user parameters (if -any)</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The "toggle-cursor-item" signal is emitted when the user presses -<keycombo><keycap>Control</keycap><keycap>Space</keycap> </keycombo>.</para> - - </refsect2> - - <refsect2 id="signal-gtkiconview--unselect-all"> - <title>The "unselect-all" gtk.IconView Signal</title> - - <programlisting><methodsynopsis language="python"> - <methodname>callback</methodname> - <methodparam><parameter>iconview</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter>iconview</parameter> :</term> - <listitem><simpara>the widget that received the -signal</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>user_param1</parameter> :</term> - <listitem><simpara>the first user parameter (if any) specified -with the <link -linkend="method-gobject--connect"><methodname>connect</methodname>()</link> -method</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>...</parameter> :</term> - <listitem><simpara>additional user parameters (if -any)</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The "unselect-all" signal is emitted when the user presses -<keycombo><keycap>Control</keycap><keycap>Shift</keycap><keycap>a</keycap> -</keycombo>.</para> - - </refsect2> - - </refsect1> - -</refentry> |