summaryrefslogtreecommitdiff
path: root/docs/reference/pygtk-gtktoolbutton.xml
diff options
context:
space:
mode:
authorJohn Finlay <finlay@src.gnome.org>2005-09-07 04:41:45 +0000
committerJohn Finlay <finlay@src.gnome.org>2005-09-07 04:41:45 +0000
commitc72efdb6be8bc62a8b05a02c29771812b9c04528 (patch)
tree5bc6eaae7fc40d664507babd131f61dc131a3fc4 /docs/reference/pygtk-gtktoolbutton.xml
parent843f2446ce187c510ca920aedb00b9fbd9a70e47 (diff)
downloadpygtk-c72efdb6be8bc62a8b05a02c29771812b9c04528.tar.gz
Change date and version number.
* pygtk2-ref.xml: Change date and version number. * pygtk-pangolayoutiter.xml (free): * pygtk-gdkevent.xml (free): * pygtk-gtktreerowreference.xml (free): * pygtk-gtktreeiter.xml (free): * pygtk-gtkrequisition.xml (free): * pygtk-gtkiconsource.xml (free): * pygtk-gtkborder.xml (free): * pygtk-gtkiconinfo.xml (free): Add deprecation warning. * pygtk-gdkwindow.xml (set_urgency_hint): Add. * pygtk-gtkwindow.xml (set_urgency_hint, get_urgency_hint): Add. (present_with_time): Add. * pygtk-gtktreeview.xml (get_visible_range): Add. * pygtk-gtktreeviewcolumn.xml (queue_resize): Add. * pygtk-gtktreerowreference.xml (get_icon_name): Add. * pygtk-gtktoolbutton.xml (set_icon_name, get_icon_name): Add. * pygtk-gtkiconsource.xml (set_icon_name, get_icon_name): Add. * pygtk-gtktextiter.xml (forward_visible_cursor_position) (backward_visible_cursor_position, forward_visible_cursor_positions) (backward_visible_cursor_positions, forward_visible_line) (backward_visible_line, forward_visible_lines, backward_visible_lines): Add. * pygtk-gtk-stock-items.xml: Add STOCK_FULLSCREEN, STOCK_LEAVE_FULLSCREEN and STOCK_INFO. Fix XMl so RTL icons display correctly. * pygtk-gtksizegroup.xml (set_ignore_hidden, get_ignore_hidden): Add. * pygtk-gtkscrolledwindow.xml (get_hscrollbar, get_vscrollbar): Add. * pygtk-gtkmenushell.xml (set_take_focus, get_take_focus): Add. * pygtk-gtkmenubar.xml (set_pack_direction, get_pack_direction) (set_child_pack_direction, get_child_pack_direction): Add. * pygtk-gtkimage.xml (clear): Add. * pygtk-gtkiconview.xml (create_drag_icon, enable_model_drag_dest) (enable_model_drag_source, get_cursor, get_dest_item_at_pos) (get_drag_dest_item, get_item_at_pos, get_reorderable) (get_visible_range, scroll_to_path, set_cursor, set_drag_dest_item) (set_reorderable, unset_model_drag_dest, unset_model_drag_source): Add. * pygtk-gtk-constants.xml (IconView Drop Position Constants) (Pack Direction Constants): Add. * pygtk-gtkfilechooser.xml (get_do_overwrite, set_do_overwrite) ("do-confirm-overwrite", confirm-overwrite): Add. * pygtk-gtkentrycompletion.xml (set_popup_set_width) (get_popup_set_width, set_popup_single_match, get_popup_single_match): Add. * pygtk-gtkaboutdialog.xml (get_wrap_license, set_wrap_license): Add. * pygtk-gtktextview.xml (get_iter_at_position): * pygtk-gtk-stock-items.xml: Add STOCK_DISCONNECT. * pygtk-gtkprogressbar.xml (set_ellipsize, get_ellipsize): Add. * pygtk-gtkfilefilter.xml (add_pixbuf_formats): Add. * pygtk-gtkwidget.xml (drag_source_add_image_targets) (drag_source_add_uri_targets): Add. * pygtk-gtkclipboard.xml (request_image, wait_for_image, set_image) (wait_is_image_available): Add. * pygtk-gtkdialog.xml (gtk.alternative_dialog_button_order) (get_response_for_widget): Add description. * pygtk-gtkbutton.xml (get_image, set_image): Add descriptions. * pygtk-gtkaction.xml (get_accel_path): Add description.
Diffstat (limited to 'docs/reference/pygtk-gtktoolbutton.xml')
-rw-r--r--docs/reference/pygtk-gtktoolbutton.xml93
1 files changed, 85 insertions, 8 deletions
diff --git a/docs/reference/pygtk-gtktoolbutton.xml b/docs/reference/pygtk-gtktoolbutton.xml
index d0dd38bc..a105238c 100644
--- a/docs/reference/pygtk-gtktoolbutton.xml
+++ b/docs/reference/pygtk-gtktoolbutton.xml
@@ -48,6 +48,14 @@
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolbutton--set-icon-name">set_icon_name</link></methodname>
+ <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolbutton--get-icon-name">get_icon_name</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
<methodname><link linkend="method-gtktoolbutton--set-icon-widget">set_icon_widget</link></methodname>
<methodparam><parameter role="keyword">icon_widget</parameter></methodparam>
</methodsynopsis>
@@ -93,29 +101,41 @@
<tbody>
<row valign="top">
+ <entry>"icon-name"</entry>
+ <entry>Read-Write</entry>
+ <entry>The themed icon name to display in the item. This
+property only has an effect if not overridden by "label", "icon-widget" or
+"stock-id" properties. Default value: <literal>None</literal>.
+Available in GTK+ 2.8 and above.</entry>
+ </row>
+
+ <row valign="top">
<entry>"icon-widget"</entry>
<entry>Read-Write</entry>
- <entry>The icon widget to display in the item.</entry>
+ <entry>The icon widget to display in the item.
+Default value: <literal>None</literal>.</entry>
</row>
<row valign="top">
<entry>"label"</entry>
<entry>Read-Write</entry>
- <entry>The text to show in the item.</entry>
+ <entry>The text to show in the item.
+Default value: <literal>None</literal>.</entry>
</row>
<row valign="top">
<entry>"label-widget"</entry>
<entry>Read-Write</entry>
<entry>The widget to use as the item label instead of
-"label".</entry>
+"label". Default value: <literal>None</literal>.</entry>
</row>
<row valign="top">
<entry>"stock-id"</entry>
<entry>Read-Write</entry>
<entry>The stock icon displayed on the item if "label" and
-"label-widget" are None.</entry>
+"label-widget" are <literal>None</literal>.
+Default value: <literal>None</literal>.</entry>
</row>
<row valign="top">
@@ -123,7 +143,8 @@
<entry>Read-Write</entry>
<entry>If <literal>TRUE</literal>, an underline in the "label"
property indicates that the next character should be used for the mnemonic
-accelerator key in the overflow menu.</entry>
+accelerator key in the overflow menu.
+Default value: <literal>FALSE</literal>.</entry>
</row>
</tbody>
@@ -413,9 +434,10 @@ method for more information.</para>
</note>
<para>The <methodname>set_stock_id</methodname>() method sets the
-"stock_id" property to the value of <parameter>stock_id</parameter>. The
-stock item specified by stock_id is used to determine the icon and label if
-not overridden by the "label" and "icon_widget" properties. See the <link
+"stock-id" property to the value of <parameter>stock_id</parameter>. The
+stock item specified by <parameter>stock_id</parameter> is used to determine
+the icon and label if not overridden by the "label" and "icon-widget"
+properties. See the <link
linkend="constructor-gtktoolbutton2">gtk.ToolButton</link>() constructor for
more information.</para>
@@ -447,6 +469,61 @@ more information.</para>
</refsect2>
+ <refsect2 id="method-gtktoolbutton--set-icon-name">
+ <title>gtk.ToolButton.set_icon_name</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_icon_name</methodname>
+ <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">icon_name</parameter>&nbsp;:</term>
+ <listitem><simpara>a name of a themed icon, 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>set_icon_name</methodname>() method sets the
+"icon-name" property to the value of <parameter>icon_name</parameter>. The
+themed icon name specified by <parameter>icon_name</parameter> is used to
+determine the icon for the toolbutton if not overridden by the "label",
+"stock-id" and "icon-widget" properties. See the <link
+linkend="constructor-gtktoolbutton2">gtk.ToolButton</link>() constructor for
+more information.</para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtktoolbutton--get-icon-name">
+ <title>gtk.ToolButton.get_icon_name</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_icon_name</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis>&nbsp;:</term>
+ <listitem><simpara>the name of the stock item.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.8 and above.</para>
+ </note>
+
+ <para>The <methodname>get_icon_name</methodname>() method returns the
+value of the "icon_name" property that contains the name of a themed icon or
+<literal>None</literal>. See the <link
+linkend="constructor-gtktoolbutton2">gtk.ToolButton</link>() constructor for
+more information.</para>
+
+ </refsect2>
+
<refsect2 id="method-gtktoolbutton--set-icon-widget">
<title>gtk.ToolButton.set_icon_widget</title>