Permalink
Browse files

Cross-reference stock items section

  • Loading branch information...
1 parent d289343 commit acc8362f3e8fab43c3a004908cca3e82269c1e35 @sebp sebp committed Oct 14, 2011
Showing with 18 additions and 13 deletions.
  1. +1 −1 source/button_widgets.txt
  2. +1 −1 source/cellrenderers.txt
  3. +5 −4 source/dialogs.txt
  4. +2 −1 source/entry.txt
  5. +7 −6 source/menus.txt
  6. +2 −0 source/stock.txt
@@ -22,7 +22,7 @@ Button Objects
:class:`Gtk.Label` child containing the given text.
If *stock* is not ``None``, creates a new button containing the image and
- text from a stock item.
+ text from a :ref:`stock item <stock-items>`.
If *use_underline* is set to ``True``, an underline in the text
indicates the next character should be used for the mnemonic accelerator key.
@@ -105,7 +105,7 @@ CellRendererPixbuf
A :class:`Gtk.CellRendererPixbuf` can be used to render an image in a cell. It
allows to render either a given :class:`Gdk.Pixbuf` (set via the "pixbuf"
-property) or a stock icon (set via the "stock-id" property).
+property) or a :ref:`stock item <stock-items>` (set via the "stock-id" property).
CellRendererPixbuf Objects
^^^^^^^^^^^^^^^^^^^^^^^^^^
View
@@ -66,9 +66,9 @@ Dialog Objects
.. method:: add_button(button_text, response_id)
Adds a button with the given text (or a stock button, if *button_text*
- is a stock ID) and sets things up so that clicking the button will emit
- the "response" signal with the given *response_id*. The button is appended
- to the end of the dialog's action area.
+ is a :ref:`stock item <stock-items>`) and sets things up so that clicking
+ the button will emit the "response" signal with the given *response_id*.
+ The button is appended to the end of the dialog's action area.
*response_id* can be any positive integer or one of the predefined
:class:`Gtk.ResponseType` values:
@@ -92,7 +92,8 @@ Dialog Objects
Adds several buttons to this dialog using the button data passed as
arguments to the method. This method is the same as calling
:meth:`add_button` repeatedly. The button data pairs - button text (or
- stock ID) and a response ID integer are passed individually. For example::
+ :ref:`stock item <stock-items>`) and a response ID integer are passed
+ individually. For example::
dialog.add_buttons(Gtk.STOCK_OPEN, 42, "Close", Gtk.ResponseType.CLOSE)
View
@@ -77,7 +77,8 @@ Entry Objects
.. method:: set_icon_from_stock(icon_pos, stock_id)
- Sets the icon shown in the entry at the specified position from a stock image.
+ Sets the icon shown in the entry at the specified position from a
+ :ref:`stock item <stock-items>`.
If *stock_id* is ``None``, no icon will be shown in the specified position.
*icon_pos* specifies the side of the entry at which an icon is placed and
View
@@ -37,8 +37,8 @@ Different classes representing different types of actions exist:
Actions represent operations that the user can be perform, along with some
information how it should be presented in the interface, including its name
(not for display), its label (for display), an accelerator, whether a label
-indicates a stock ID, a tooltip, as well as the callback that is called when
-the action gets activated.
+indicates a :ref:`stock item <stock-items>`, a tooltip, as well as the callback
+that is called when the action gets activated.
You can create actions by either calling one of the constructors directly and
adding them to a :class:`Gtk.ActionGroup` by calling
@@ -62,7 +62,8 @@ Action Objects
If *tooltip* is not ``None``, it is used as tooltip for the action.
- If *stock_id* is not ``None``, it is used to lookup the stock icon to display
+ If *stock_id* is not ``None``, it is used to lookup the
+ :ref:`stock item <stock-items>` stock icon to display
in widgets representing the action.
.. class:: Gtk.ToggleAction(name, label, tooltip, stock_id)
@@ -118,7 +119,7 @@ Action Objects
items with the following information:
* The name of the action (mandatory)
- * The stock ID of the action (default: ``None``)
+ * The :ref:`stock item <stock-items>` of the action (default: ``None``)
* The label for the action (default: ``None``)
* The accelerator for the action, in the format understood by the
:func:`Gtk.accelerator_parse` function (default: ``None``)
@@ -140,7 +141,7 @@ Action Objects
items with the following information:
* The name of the action (mandatory)
- * The stock ID of the action (default: ``None``)
+ * The :ref:`stock item <stock-items>` of the action (default: ``None``)
* The label for the action (default: ``None``)
* The accelerator for the action, in the format understood by the
:func:`Gtk.accelerator_parse` function (default: ``None``)
@@ -164,7 +165,7 @@ Action Objects
items with the following information:
* The name of the action (mandatory)
- * The stock ID of the action (default: ``None``)
+ * The :ref:`stock item <stock-items>` of the action (default: ``None``)
* The label for the action (default: ``None``)
* The accelerator for the action, in the format understood by the
:func:`Gtk.accelerator_parse` function (default: ``None``)
View
@@ -1,3 +1,5 @@
+.. _stock-items:
+
Stock Items
============

0 comments on commit acc8362

Please sign in to comment.