diff options
Diffstat (limited to 'docs')
29 files changed, 114 insertions, 103 deletions
diff --git a/docs/reference/pygtk-gtkiconsource.xml b/docs/reference/pygtk-gtkiconsource.xml index e1c0b151..0c0ccc72 100644 --- a/docs/reference/pygtk-gtkiconsource.xml +++ b/docs/reference/pygtk-gtkiconsource.xml @@ -440,7 +440,7 @@ a base for any icon size variant</simpara></listitem> </varlistentry> </variablelist> - <para>The <methodname>get_size_widcarded</methodname>() method gets + <para>The <methodname>get_size_wildcarded</methodname>() method gets the value set by the <link linkend="method-gtkiconsource--set-size-wildcarded"><methodname>set_size_wildcarded</methodname>()</link> method.</para> @@ -594,7 +594,7 @@ matches</simpara></listitem> </varlistentry> </variablelist> - <para>The <methodname>get_direction</methodname>() emthod obtains the + <para>The <methodname>get_direction</methodname>() method obtains the text direction this icon source applies to. The return value is only useful and meaningful if the text direction is <emphasis>not</emphasis> wildcarded.</para> @@ -859,7 +859,7 @@ size</simpara></listitem> </variablelist> <para>The <function>gtk.icon_size_from_name</function>() function -returns the integer representing the icon size associated with the sepcified +returns the integer representing the icon size associated with the specified <parameter>name</parameter>.</para> </refsect2> diff --git a/docs/reference/pygtk-gtkicontheme.xml b/docs/reference/pygtk-gtkicontheme.xml index e2e0d31b..c50d2955 100644 --- a/docs/reference/pygtk-gtkicontheme.xml +++ b/docs/reference/pygtk-gtkicontheme.xml @@ -4,7 +4,7 @@ <refentry id="class-gtkicontheme"> <refnamediv> <refname>gtk.IconTheme</refname> - <refpurpose>look up icons by name and size</refpurpose> + <refpurpose>look up icons by name and size (new in PyGTK 2.4)</refpurpose> </refnamediv> <refsect1> @@ -246,7 +246,7 @@ functions rather than creating a new icon theme object from scratch.</para> </note> <para>The <methodname>set_screen</methodname>() method sets the <link -linkend="class-gdkscreen"><classname>gtk.gdkScreen</classname></link> for +linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link> for an icon theme to <parameter>screen</parameter>. The screen is used to track the user's currently configured icon theme, which might be different for different screens.</para> @@ -474,12 +474,12 @@ icon specified by <parameter>icon_name</parameter>, <link linkend="class-gtkiconinfo"><classname>gtk.IconInfo</classname></link> object containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using the <link -linkend="method-gtkiconinfo--load-icon"><methodname>GtkIconInfo.load_icon()</methodname></link> +linkend="method-gtkiconinfo--load-icon"><methodname>gtk.IconInfo.load_icon()</methodname></link> method. (the <link linkend="method-gtkicontheme--load-icon"><methodname>load_icon()</methodname></link> method combines these two steps if all you need is the pixbuf.)</para> - <para>The value of flags msut be a combination of:</para> + <para>The value of flags must be a combination of:</para> <variablelist> <varlistentry> @@ -536,7 +536,7 @@ method combines these two steps if all you need is the pixbuf.)</para> <term><parameter role="keyword">size</parameter> :</term> <listitem><simpara>the desired icon size. The resulting icon may not be exactly this size; see the <link - linkend="method-gtkiconinfo--load-icon"><methodname>GtkIconInfo.load_icon()</methodname></link> + linkend="method-gtkiconinfo--load-icon"><methodname>gtk.IconInfo.load_icon()</methodname></link> method.</simpara></listitem> </varlistentry> <varlistentry> @@ -726,7 +726,7 @@ function.</para> <para>The <function>gtk.icon_theme_get_for_screen</function>() function returns the icon theme object associated with the <link -linkend="class-gdkscreen"><classname>gtk.gdkScreen</classname></link> +linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link> specified by <parameter>screen</parameter>. If this function has not previously been called for the given screen, a new icon theme object will be created and associated with the screen. Icon theme objects are fairly diff --git a/docs/reference/pygtk-gtkimage.xml b/docs/reference/pygtk-gtkimage.xml index 227d3b38..c95993c1 100644 --- a/docs/reference/pygtk-gtkimage.xml +++ b/docs/reference/pygtk-gtkimage.xml @@ -394,7 +394,7 @@ data will be removed.</para> </varlistentry> </variablelist> - <para>The <methodname>set_fron_file</methodname>() method sets the + <para>The <methodname>set_from_file</methodname>() method sets the image data from the contents of the file named <parameter>filename</parameter>. If the file isn't found or can't be loaded, the resulting <link @@ -1074,7 +1074,7 @@ displayed by the <link linkend="class-gtkimage"><classname>gtk.Image</classname></link>. The return value may be None if no image data is set. If the storage type of the image is not either <literal>gtk.IMAGE_EMPTY</literal> or -<literal>gtk.IMAGE_PIXBUF</literal> the VlaueError exception will be +<literal>gtk.IMAGE_PIXBUF</literal> the ValueError exception will be raised.</para> </refsect2> @@ -1194,8 +1194,9 @@ size</simpara></listitem> </varlistentry> <varlistentry> <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new gtkImage displaying the stock -icon</simpara></listitem> + <listitem><simpara>a new <link + linkend="class-gtkimage"><classname>gtk.Image</classname></link> + displaying the stock icon</simpara></listitem> </varlistentry> </variablelist> diff --git a/docs/reference/pygtk-gtkimcontext.xml b/docs/reference/pygtk-gtkimcontext.xml index b6de3bb1..0e887fcf 100644 --- a/docs/reference/pygtk-gtkimcontext.xml +++ b/docs/reference/pygtk-gtkimcontext.xml @@ -220,9 +220,11 @@ linkend="class-gtkentry"><classname>gtk.Entry</classname></link> and <link linkend="class-gtktextview"><classname>gtk.TextView</classname></link> widgets.</para> - <para>The gtkIMContext manages the context of the text surrounding the -cursor and the preedit text that provides feedback about the in-process -multiple character composition.</para> + <para>The <link +linkend="class-gtkimcontext"><classname>gtk.IMContext</classname></link> +manages the context of the text surrounding the cursor and the preedit text +that provides feedback about the in-process multiple character +composition.</para> </refsect1> @@ -498,7 +500,7 @@ handled.</simpara></listitem> </varlistentry> </variablelist> - <para>The delete_surrounding() emthod asks the widget that the input + <para>The delete_surrounding() method asks the widget that the input context is attached to to delete characters around the cursor position by emitting the "delete_surrounding" signal. Note that <parameter>offset</parameter> and <parameter>n_chars</parameter> are in @@ -509,13 +511,13 @@ class.</para> <para>In order to use this function, you should first call <link linkend="method-gtkimcontext--get-surrounding"><methodname>get_surrounding</methodname>()</link> -to get the current context, and call this function immediately afterwards to +to get the current context, and call this function immediately afterward to make sure that you know what you are deleting. You should also account for the fact that even if the signal was handled, the input context might not have deleted all the characters that were requested to be deleted.</para> <para>This function is used by an input method that wants to make -subsitutions in the existing text in response to new input. It is not useful +substitutions in the existing text in response to new input. It is not useful for applications.</para> </refsect2> diff --git a/docs/reference/pygtk-gtkitemfactory.xml b/docs/reference/pygtk-gtkitemfactory.xml index fa5ba34a..ea145516 100644 --- a/docs/reference/pygtk-gtkitemfactory.xml +++ b/docs/reference/pygtk-gtkitemfactory.xml @@ -608,8 +608,9 @@ object</simpara></listitem> </varlistentry> <varlistentry> <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the gtkItemFactory that created -<parameter>widget</parameter></simpara></listitem> + <listitem><simpara>the <link + linkend="class-gtkitemfactory"><classname>gtk.ItemFactory</classname></link> + that created <parameter>widget</parameter></simpara></listitem> </varlistentry> </variablelist> @@ -646,7 +647,7 @@ that created <parameter>widget</parameter></simpara></listitem> </variablelist> <para>The <function>gtk.item_factory_path_from_widget</function>() -function returns the full psth to the <link +function returns the full path to the <link linkend="class-gtkitemfactory"><classname>gtk.ItemFactory</classname></link> that created the <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> specified diff --git a/docs/reference/pygtk-gtklabel.xml b/docs/reference/pygtk-gtklabel.xml index c811effb..562b3c5a 100644 --- a/docs/reference/pygtk-gtklabel.xml +++ b/docs/reference/pygtk-gtklabel.xml @@ -375,9 +375,10 @@ method.</para> <para>To make it easy to format text in a label (changing colors, fonts, etc.), the label text can be provided in the Pango markup format which is a -simple XML markup format. The gtklabel.set_markup() method sets the label -using text in valid markup format (e.g. '<', '>' and '&' -characters must be replaced by &lt;, &gt; and &amp; +simple XML markup format. The <link +linkend="method-gtklabel--set-markup"><methodname>gtk.Label.set_markup</methodname>()</link> +method sets the label using text in valid markup format (e.g. '<', '>' +and '&' characters must be replaced by &lt;, &gt; and &amp; respectively.</para> <para>The label text layout can be modified using methods that affect @@ -661,7 +662,7 @@ accelerator.</simpara></listitem> </varlistentry> </variablelist> - <para>The <methodname>get_use_underline</methodname>() emthod returns + <para>The <methodname>get_use_underline</methodname>() method returns the value of the "use-underline" property. If <literal>TRUE</literal> an embedded underscore in the label indicates the next character is a mnemonic. See <link @@ -706,7 +707,7 @@ method.</para> <variablelist> <varlistentry> <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a keyval, or the voidsymbol + <listitem><simpara>a keyval, or the void symbol keyval</simpara></listitem> </varlistentry> </variablelist> @@ -783,7 +784,7 @@ linkend="method-gtklabel--set-mnemonic-widget"><methodname>set_mnemonic_widget</ <varlistentry> <term><parameter role="keyword">str</parameter> :</term> <listitem><simpara>the label text with embedded underscore -characters incidcating the mnemonic characters</simpara></listitem> +characters indicating the mnemonic characters</simpara></listitem> </varlistentry> </variablelist> diff --git a/docs/reference/pygtk-gtkliststore.xml b/docs/reference/pygtk-gtkliststore.xml index d1adcb53..df976072 100644 --- a/docs/reference/pygtk-gtkliststore.xml +++ b/docs/reference/pygtk-gtkliststore.xml @@ -177,7 +177,7 @@ column</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>...</parameter> :</term> - <listitem><simpara>optional types for suceeding + <listitem><simpara>optional types for succeeding columns</simpara></listitem> </varlistentry> <varlistentry> @@ -189,7 +189,7 @@ linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link></simpar <para>Creates a new list store as with one or more columns with the type specified by the arguments passed to the constructor. For example, -<literal>gtkListStore(gobject.TYPE_INT, gobject.TYPE_STRING, +<literal>gtk.ListStore(gobject.TYPE_INT, gobject.TYPE_STRING, gtk.gdk.Pixbuf);</literal> will create a new <link linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link> with three columns, of type int, string and <link @@ -747,7 +747,7 @@ unsorted stores.</para> <para>This method is available in PyGTK 2.4 and above.</para> </note> - <para>The <methodname>swap</methodname>() method swaps the listtore + <para>The <methodname>swap</methodname>() method swaps the liststore rows specified by the <link linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>s <parameter>a</parameter> and <parameter>b</parameter>. Note that this method diff --git a/docs/reference/pygtk-gtkmenuitem.xml b/docs/reference/pygtk-gtkmenuitem.xml index 32becfc1..b41f1733 100644 --- a/docs/reference/pygtk-gtkmenuitem.xml +++ b/docs/reference/pygtk-gtkmenuitem.xml @@ -285,7 +285,7 @@ item.</para> <varlistentry> <term><emphasis>Returns</emphasis> :</term> <listitem><simpara>the submenu for this menu item, or -<literal>None</literal> if trere is no submenu.</simpara></listitem> +<literal>None</literal> if there is no submenu.</simpara></listitem> </varlistentry> </variablelist> @@ -462,7 +462,7 @@ menu item</simpara></listitem> <para>The <methodname>set_accel_path</methodname>() method sets the accelerator path on the menu item. The accelerator path provides access to the menu item's accelerator allowing user changes to be identified and saved -to persistant storage. See also the <link +to persistent storage. See also the <link linkend="method-gtkmenu--set-accel-path"><methodname>gtk.Menu.set_accel_path</methodname>()</link> method for a more convenient variant of this function. This method is a convenience wrapper that handles calling <link diff --git a/docs/reference/pygtk-gtkmessagedialog.xml b/docs/reference/pygtk-gtkmessagedialog.xml index b968f419..f78e0482 100644 --- a/docs/reference/pygtk-gtkmessagedialog.xml +++ b/docs/reference/pygtk-gtkmessagedialog.xml @@ -309,7 +309,7 @@ warning, etc.) specified by <parameter>type</parameter> and some text the dialog. The <parameter>flags</parameter> allow the specification special dialog characteristics: make the dialog modal (<literal>gtk.DIALOG_MODAL</literal>) and destroy the dialog when the parent is -destroyed (<literal>gtk.DIALG_DESTROY_WITH_PARENT</literal>). When the user +destroyed (<literal>gtk.DIALOG_DESTROY_WITH_PARENT</literal>). When the user clicks a button a "response" signal is emitted with response IDs. <parameter>buttons</parameter> specifies the set of predefined buttons to use: <literal>gtk.BUTTONS_NONE</literal>, <literal>gtk.BUTTONS_OK</literal>, diff --git a/docs/reference/pygtk-gtkmisc.xml b/docs/reference/pygtk-gtkmisc.xml index eb8dc44d..178c2c25 100644 --- a/docs/reference/pygtk-gtkmisc.xml +++ b/docs/reference/pygtk-gtkmisc.xml @@ -140,7 +140,7 @@ alignment settings will have no effect.</para> </variablelist> <para>The <methodname>set_alignment</methodname>() method sets the -aligment of the widget in its allocated space. <parameter>xalign</parameter> +alignment of the widget in its allocated space. <parameter>xalign</parameter> sets the fraction (0.0-1.0) of free space (horizontal allocation minus widget width) to place to the left of the widget. <parameter>yalign</parameter> sets the fraction (0.0-1.0) of free space @@ -217,7 +217,7 @@ padding in pixels for the widget.</simpara></listitem> </variablelist> <para>The <methodname>get_padding</methodname>() method returns a -tuple containing the padding in the horizontal and veritcal directions of +tuple containing the padding in the horizontal and vertical directions of the widget. See <link linkend="method-gtkmisc--set-padding"><methodname>set_padding</methodname>()</link>.</para> diff --git a/docs/reference/pygtk-gtknotebook.xml b/docs/reference/pygtk-gtknotebook.xml index 190872e2..2647d202 100644 --- a/docs/reference/pygtk-gtknotebook.xml +++ b/docs/reference/pygtk-gtknotebook.xml @@ -568,7 +568,7 @@ linkend="signal-gtknotebook--switch-page">switch-page</link>"</term> linkend="class-gtknotebook"><classname>gtk.Notebook</classname></link> widget is a <link linkend="class-gtkcontainer"><classname>gtk.Container</classname></link> -whose children are overlapping pages that can be switched betweenby using +whose children are overlapping pages that can be switched between by using tab labels along one edge. There are many configuration options for the <link linkend="class-gtknotebook"><classname>gtk.Notebook</classname></link>. You @@ -585,7 +585,7 @@ linkend="method-gtknotebook--popup-disable"><methodname>popup_disable</methodnam <para>The <link linkend="class-gtknotebook"><classname>gtk.Notebook</classname></link> is -particularly useful for displaying a large numbe of application controls +particularly useful for displaying a large number of application controls that can be grouped into several functional areas. The typical example is the user preferences dialog in some applications. For example, a notebook page can be setup for each of font selection, color selection, formating, @@ -644,7 +644,7 @@ used as the label for the page,</simpara></listitem> <para>The <methodname>append_page</methodname>() method appends a page to the notebook using the widget specified by -<parameter>child</parameter> and the widget specififed by +<parameter>child</parameter> and the widget specified by <parameter>tab_label</parameter> as the label on the tab.</para> </refsect2> @@ -761,7 +761,7 @@ page-switch menu, if that is enabled.</simpara></listitem> <para>The <methodname>prepend_page_menu</methodname>() method prepends a page to the notebook specifying the widget to use as the label in the -popup menu. <parameter>child</parameter> specifies the widget ot use as teh +popup menu. <parameter>child</parameter> specifies the widget to use as the contents of the page; <parameter>tab_label</parameter> specifies the widget to use as the tab label; and, <parameter>menu_label</parameter> specifies the widget to use in the popup menu.</para> @@ -903,7 +903,7 @@ returned.</simpara></listitem> </varlistentry> </variablelist> - <para>The <methodname>get_current_page</methodname>() emthod returns + <para>The <methodname>get_current_page</methodname>() method returns the page index of the current page numbered from 0.</para> </refsect2> @@ -920,7 +920,7 @@ the page index of the current page numbered from 0.</para> <varlistentry> <term><parameter role="keyword">page_num</parameter> :</term> <listitem><simpara>the index of a page in the -noteobok</simpara></listitem> +notebook</simpara></listitem> </varlistentry> <varlistentry> <term><emphasis>Returns</emphasis> :</term> @@ -1106,7 +1106,7 @@ shown.</simpara></listitem> <para>The <methodname>set_show_tabs</methodname>() method sets the "show-tabs" property to the value of <parameter>show_tabs</parameter>. If <parameter>show_tabs</parameter> is <literal>TRUE</literal> the notebook -tabs wiil be displayed.</para> +tabs will be displayed.</para> </refsect2> @@ -1304,7 +1304,7 @@ use.</simpara></listitem> </varlistentry> </variablelist> - <para>The <methodname>set_tab_label</methodname>() method replacces + <para>The <methodname>set_tab_label</methodname>() method replaces the tab label for the notebook page containing <parameter>child</parameter> with the widget specified by <parameter>tab_label</parameter>.</para> @@ -1520,7 +1520,7 @@ returns a tuple containing the packing attributes (expand, fill, pack type) for the tab label of the page containing <parameter>child</parameter>. If the expand attribute is <literal>TRUE</literal> the tab can expand to take up the free space in the tab area. If fill is <literal>TRUE</literal> the -label witdget in the tab can use up all the space in the tab. The pack type +label widget in the tab can use up all the space in the tab. The pack type can be one of <literal>gtk.PACK_START</literal> or <literal>gtk.PACK_END</literal> to specify whether the tab is packed to the left or right if tabs are on the top or bottom edge (top or bottom if the @@ -1551,7 +1551,7 @@ page</simpara></listitem> <varlistentry> <term><parameter role="keyword">expand</parameter> :</term> <listitem><simpara>if <literal>TRUE</literal> the tab can expand -to filel the free space in the tab area</simpara></listitem> +to fill the free space in the tab area</simpara></listitem> </varlistentry> <varlistentry> <term><parameter role="keyword">fill</parameter> :</term> @@ -1572,7 +1572,7 @@ the packing parameters for the tab label of the page containing <parameter>child</parameter>. If <parameter>expand</parameter> is <literal>TRUE</literal> the tab can expand to take up the free space in the tab area. If <parameter>fill</parameter> is <literal>TRUE</literal> the -label witdget in the tab can use up all the space in the tab. The +label widget in the tab can use up all the space in the tab. The <parameter>pack_type</parameter> can be one of <literal>gtk.PACK_START</literal> or <literal>gtk.PACK_END</literal> to specify whether the tab is packed to the left or right if tabs are on the @@ -1606,7 +1606,7 @@ end</simpara></listitem> </varlistentry> </variablelist> - <para>The <methodname>reorder_child</methodname>() nmethod reorders + <para>The <methodname>reorder_child</methodname>() method reorders the notebook pages so that <parameter>child</parameter> appears in the page whose index is specified by <parameter>position</parameter>. If <parameter>position</parameter> is greater than or equal to the number of @@ -1832,7 +1832,7 @@ any)</simpara></listitem> </variablelist> <para>The "switch-page" signal is emitted when the notebook page is -cahnged.</para> +changed.</para> </refsect2> diff --git a/docs/reference/pygtk-gtkobject.xml b/docs/reference/pygtk-gtkobject.xml index f48b489c..cec347a6 100644 --- a/docs/reference/pygtk-gtkobject.xml +++ b/docs/reference/pygtk-gtkobject.xml @@ -132,7 +132,7 @@ Python object is finalized. In the case mentioned above if a <link linkend="class-gtkbutton"><classname>gtk.Button</classname></link> is destroyed using the <link linkend="method-gtkobject--destroy"><methodname>destroy</methodname>()</link> -method, it will be removed from its container and unmapped and umrealized +method, it will be removed from its container and unmapped and unrealized but it will not be finalized because the Python wrapper object will still exist and hold a reference.</para> @@ -248,7 +248,7 @@ widget's sensitivity is to have this flag set.</simpara> <varlistentry> <term><literal>gtk.PARENT_SENSITIVE</literal></term> <listitem> - <simpara>This is the secondrequirement for the widget's + <simpara>This is the second requirement for the widget's sensitivity. Once a widget has <literal>gtk.SENSITIVE</literal> and <literal>gtk.PARENT_SENSITIVE set</literal>, its state is effectively sensitive.</simpara> @@ -291,9 +291,9 @@ the preferred one for receiving events.</simpara> <varlistentry> <term><literal>gtk.RC_STYLE</literal></term> <listitem> - <simpara>the widgets style has been looked up through the rc + <simpara>the widgets style has been looked up through the RC mechanism. It does not imply that the widget actually had a style defined -through the rc mechanism.</simpara> +through the RC mechanism.</simpara> </listitem> </varlistentry> <varlistentry> diff --git a/docs/reference/pygtk-gtkpaned.xml b/docs/reference/pygtk-gtkpaned.xml index d3467991..5b44ae81 100644 --- a/docs/reference/pygtk-gtkpaned.xml +++ b/docs/reference/pygtk-gtkpaned.xml @@ -299,7 +299,7 @@ widgets are added to the panes of the widget with the <link linkend="method-gtkpaned--pack1"><methodname>pack1</methodname>()</link> and <link linkend="method-gtkpaned--pack2"><methodname>pack2</methodname>()</link> -methods. The division beween the two children is set by default from the +methods. The division between the two children is set by default from the size requests of the children, but it can be adjusted by the user.</para> <para>A paned widget draws a separator between the two child widgets and @@ -544,7 +544,7 @@ parameters: <parameter>allocation</parameter>, <parameter>child1_req</parameter> and <parameter>child2_req</parameter>. The calculation is affected by the packing parameters of the child widgets depending on whether they can expand and shrink. This method is used by -subclases of <link +subclasses of <link linkend="class-gtkpaned"><classname>gtk.Paned</classname></link> and is usually not needed by applications. the <link linkend="method-gtkwidget--queue-resize"><methodname>gtk.Widget.queue_resize</methodname>()</link> diff --git a/docs/reference/pygtk-gtkradiomenuitem.xml b/docs/reference/pygtk-gtkradiomenuitem.xml index 1b568568..a44444f4 100644 --- a/docs/reference/pygtk-gtkradiomenuitem.xml +++ b/docs/reference/pygtk-gtkradiomenuitem.xml @@ -117,7 +117,7 @@ linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link> containing a label with its text specified by <parameter>label</parameter>. <parameter>label</parameter> will be parsed for underscores that indicate the mnemonic accelerator for the radiomenuitem. The radiomenuitem will be -added to the group conatining the <link +added to the group containing the <link linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link> specified by <parameter>group</parameter>. If <parameter>group</parameter> is <literal>None</literal>, a new group will be created to hold the new diff --git a/docs/reference/pygtk-gtkradiotoolbutton.xml b/docs/reference/pygtk-gtkradiotoolbutton.xml index b79e5ad2..9ef289bd 100644 --- a/docs/reference/pygtk-gtkradiotoolbutton.xml +++ b/docs/reference/pygtk-gtkradiotoolbutton.xml @@ -3,8 +3,8 @@ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> <refentry id="class-gtkradiotoolbutton"> <refnamediv> - <refname>gtk.RadioToolButton</refname> - <refpurpose>a toolbar item that contains a radio button.</refpurpose> + <refname>gtk.RadioToolButton</refname> <refpurpose>a toolbar item that + contains a radio button (new in PyGTK 2.4)</refpurpose> </refnamediv> <refsect1> @@ -124,9 +124,10 @@ linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></l <para>Creates a new <link linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link>, -adding it to the same group as the gtkRadioToolButton specified by -<parameter>group</parameter> if it is not <literal>None</literal>. The new -<link +adding it to the same group as the <link +linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link> +specified by <parameter>group</parameter> if it is not +<literal>None</literal>. The new <link linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link> will contain an icon and label from the stock item specified by <parameter>stock_id</parameter> if it is not <literal>None</literal>.</para> diff --git a/docs/reference/pygtk-gtkrange.xml b/docs/reference/pygtk-gtkrange.xml index 080f84c8..75ecee60 100644 --- a/docs/reference/pygtk-gtkrange.xml +++ b/docs/reference/pygtk-gtkrange.xml @@ -108,7 +108,7 @@ that contains the current value of this range object</entry> <entry>"inverted"</entry> <entry>Read-Write</entry> <entry>If <literal>TRUE</literal>, the slider movement is -reversed e.g rigth-to-left instead of left-to-right</entry> +reversed e.g right-to-left instead of left-to-right</entry> </row> <row valign="top"> @@ -484,7 +484,7 @@ Up</keycap> or <keycap>Page Down</keycap> keys.</para> </variablelist> <para>The <methodname>set_range</methodname>() method sets the minimum -and maximmum allowable values for the <link +and maximum allowable values for the <link linkend="class-gtkrange"><classname>gtk.Range</classname></link> to that values specified by <parameter>min</parameter> and <parameter>max</parameter> respectively. If the range has a non-zero page diff --git a/docs/reference/pygtk-gtkruler.xml b/docs/reference/pygtk-gtkruler.xml index ba6d9d6b..32e9dfb0 100644 --- a/docs/reference/pygtk-gtkruler.xml +++ b/docs/reference/pygtk-gtkruler.xml @@ -123,7 +123,7 @@ distribution.</para> linkend="class-gtkruler"><classname>gtk.Ruler</classname></link> widget is a base class for horizontal and vertical rulers. Rulers are used to show the mouse pointer's location in a window. Within the ruler a small triangle -indicates the location of the mouse relative to the horixontal or vertical +indicates the location of the mouse relative to the horizontal or vertical ruler. See <link linkend="class-gtkhruler"><classname>gtk.HRuler</classname></link> to learn about horizontal rulers. See <link diff --git a/docs/reference/pygtk-gtkscale.xml b/docs/reference/pygtk-gtkscale.xml index 955531ce..b35747e5 100644 --- a/docs/reference/pygtk-gtkscale.xml +++ b/docs/reference/pygtk-gtkscale.xml @@ -273,7 +273,7 @@ to be drawn next to the slider</simpara></listitem> </variablelist> <para>The <methodname>get_draw_value</methodname>() method returns the -calue of the "draw-value" property. If "draw-value" is +value of the "draw-value" property. If "draw-value" is <literal>TRUE</literal> the current scale value is drawn next to the slider.</para> diff --git a/docs/reference/pygtk-gtkscrolledwindow.xml b/docs/reference/pygtk-gtkscrolledwindow.xml index ccddfc07..633fe4fc 100644 --- a/docs/reference/pygtk-gtkscrolledwindow.xml +++ b/docs/reference/pygtk-gtkscrolledwindow.xml @@ -255,7 +255,7 @@ linkend="class-gtklayout"><classname>gtk.Layout</classname></link>.</simpara> <listitem> <simpara>Widgets that lack native scrolling support use the <link linkend="class-gtkviewport"><classname>gtk.Viewport</classname></link> -widget that acts as an adaptor class, implementing scrollability for child +widget that acts as an adapter class, implementing scrollability for child widgets that lack their own scrolling capabilities. Use <link linkend="class-gtkviewport"><classname>gtk.Viewport</classname></link> to scroll child widgets such as <link @@ -346,9 +346,10 @@ or None</simpara></listitem> </varlistentry> <varlistentry> <term><parameter -role="keyword">vadjustment</parameter> :</term> - <listitem><simpara>a vertical GtkAdjustment or -None</simpara></listitem> +role="keyword">vadjustment</parameter> :</term> <listitem><simpara>a +vertical <link +linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link> +or None</simpara></listitem> </varlistentry> <varlistentry> <term><emphasis>Returns</emphasis> :</term> @@ -536,7 +537,7 @@ scrollbar policies</simpara></listitem> </variablelist> <para>The <methodname>get_policy</methodname>() method returns a tuple -conatining the horizontal and vertical scrollbar policies. See the <link +containing the horizontal and vertical scrollbar policies. See the <link linkend="method-gtkscrolledwindow--set-policy"><methodname>set_policy</methodname>()</link> method for more detail.</para> </refsect2> @@ -569,7 +570,7 @@ location of the child widget with respect to the scrollbars. <term>gtk.CORNER_TOP_LEFT</term> <listitem> <simpara>Place the scrollbars on the right and bottom of the -widget (default behaviour).</simpara> +widget (default behavior).</simpara> </listitem> </varlistentry> <varlistentry> @@ -653,13 +654,13 @@ scrolled window. The shadow type must be one of:</para> <varlistentry> <term>gtk.SHADOW_IN</term> <listitem> - <simpara>The outline is bevelled inwards.</simpara> + <simpara>The outline is beveled inward.</simpara> </listitem> </varlistentry> <varlistentry> <term>gtk.SHADOW_OUT</term> <listitem> - <simpara>The outline is bevelled outwards.</simpara> + <simpara>The outline is beveled outward.</simpara> </listitem> </varlistentry> <varlistentry> diff --git a/docs/reference/pygtk-gtkselectiondata.xml b/docs/reference/pygtk-gtkselectiondata.xml index afa6e4a3..dfe2f24c 100644 --- a/docs/reference/pygtk-gtkselectiondata.xml +++ b/docs/reference/pygtk-gtkselectiondata.xml @@ -178,11 +178,12 @@ data</simpara></listitem> </variablelist> <para>The <methodname>set</methodname>() method sets the data for a -selection in the gtkSelectionData object. <parameter>data</parameter> is a -string contaiining the data to be set; <parameter>format</parameter> is the -number of bits in a unit of the data (e.g. integer data has a format of 32 -on most systems; string data format is 8); and, <parameter>type</parameter> -is a <link +selection in the <link +linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link> +object. <parameter>data</parameter> is a string containing the data to be +set; <parameter>format</parameter> is the number of bits in a unit of the +data (e.g. integer data has a format of 32 on most systems; string data +format is 8); and, <parameter>type</parameter> is a <link linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link> or a string that specifies a <link linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link>.</para> diff --git a/docs/reference/pygtk-gtkseparator.xml b/docs/reference/pygtk-gtkseparator.xml index 20fda500..1a035647 100644 --- a/docs/reference/pygtk-gtkseparator.xml +++ b/docs/reference/pygtk-gtkseparator.xml @@ -39,7 +39,7 @@ widget is an abstract base class, used only for deriving the subclasses linkend="class-gtkhseparator"><classname>gtk.HSeparator</classname></link> and <link linkend="class-gtkvseparator"><classname>gtk.VSeparator</classname></link>. -A sepearator is va visual delimiter between widgets.</para> +A separator is a visual delimiter between widgets.</para> </refsect1> diff --git a/docs/reference/pygtk-gtksettings.xml b/docs/reference/pygtk-gtksettings.xml index 05189263..14fe32c6 100644 --- a/docs/reference/pygtk-gtksettings.xml +++ b/docs/reference/pygtk-gtksettings.xml @@ -134,7 +134,7 @@ blink</entry> <entry>"gtk-cursor-blink-time"</entry> <entry>Read-Write</entry> <entry>The length of the cursor blink cycle, in -milleseconds</entry> +milliseconds</entry> </row> <row valign="top"> @@ -209,7 +209,7 @@ menus. Available in GTK+ 2.4 and above.</entry> <entry>"gtk-menu-popdown-delay"</entry> <entry>Read-Write</entry> <entry>The time before hiding a submenu when the pointer is -moving towards the submenu. Available in GTK+ 2.2 and above.</entry> +moving toward the submenu. Available in GTK+ 2.2 and above.</entry> </row> <row valign="top"> @@ -301,10 +301,12 @@ Available in GTK+ 2.4 and above.</entry> <para>The <link linkend="class-gtksettings"><classname>gtk.Settings</classname></link> object is a singleton object that stores the values of the global settings. -The singleton gtkSettings object can be retrieved using the <link -linkend="function-gtk--settings-get-default"><function>settings_get_default</function>()</link> +The singleton <link +linkend="class-gtksettings"><classname>gtk.Settings</classname></link> +object can be retrieved using the <link +linkend="function-gtk--settings-get-default"><function>settings_get_default</function>()</link> function or the <link -linkend="method-gtkwidget--get-settings"><methodname>gtk.Widget.get_settings</methodname>()</link> +linkend="method-gtkwidget--get-settings"><methodname>gtk.Widget.get_settings</methodname>()</link> method.</para> </refsect1> diff --git a/docs/reference/pygtk-gtksizegroup.xml b/docs/reference/pygtk-gtksizegroup.xml index dcd20fff..cd225103 100644 --- a/docs/reference/pygtk-gtksizegroup.xml +++ b/docs/reference/pygtk-gtksizegroup.xml @@ -126,7 +126,7 @@ or both sizes:</para> <varlistentry> <term><literal>gtk.SIZE_GROUP_BOTH</literal></term> <listitem> - <simpara>the group affects boththe horizontal and vertical + <simpara>the group affects both the horizontal and vertical requisition</simpara> </listitem> </varlistentry> diff --git a/docs/reference/pygtk-gtkspinbutton.xml b/docs/reference/pygtk-gtkspinbutton.xml index b2ec0e8d..e04a1040 100644 --- a/docs/reference/pygtk-gtkspinbutton.xml +++ b/docs/reference/pygtk-gtkspinbutton.xml @@ -766,7 +766,7 @@ linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>.</sim <para>The <methodname>get_update_policy</methodname>() method returns the value of the "update-policy" property that determines the update behavior of a spin button. See the <link -linkend="method-gtkspinbutton--set-update-policy"><methodname>set_update_polic</methodname>y()</link> +linkend="method-gtkspinbutton--set-update-policy"><methodname>set_update_policy</methodname>()</link> method for more detail.</para> </refsect2> @@ -962,7 +962,7 @@ should be corrected.</simpara></listitem> </variablelist> <para>The <methodname>set_snap_to_ticks</methodname>() method sets the -"snap-to-ticks" preoperty to the value of +"snap-to-ticks" property to the value of <parameter>snap_to_ticks</parameter>. If <parameter>snap_to_ticks</parameter> is <literal>TRUE</literal> values are corrected to the nearest step increment when a spin button is activated @@ -986,7 +986,7 @@ to the nearest step.</simpara></listitem> <para>The <methodname>get_snap_to_ticks</methodname>() method returns the value of the "snap-to-ticks" property. If the value of "snap-to-ticks" -is <literal>TRUE</literal> the imput values are corrected to the nearest +is <literal>TRUE</literal> the input values are corrected to the nearest step. See the <link linkend="method-gtkspinbutton--set-snap-to-ticks"><methodname>set_snap_to_ticks</methodname>()</link> method.</para> @@ -1050,7 +1050,7 @@ any)</simpara></listitem> </varlistentry> </variablelist> - <para>The "change-value" signal is emitted when the spibutton value is + <para>The "change-value" signal is emitted when the spinbutton value is changed by keyboard action using the <keycombo><keycap>Up Arrow</keycap> </keycombo>, <keycombo><keycap>Down Arrow</keycap> </keycombo>, <keycombo><keycap>Page Up</keycap> </keycombo>, <keycombo><keycap>Page diff --git a/docs/reference/pygtk-gtkstatusbar.xml b/docs/reference/pygtk-gtkstatusbar.xml index a2d0ea31..e15f14ce 100644 --- a/docs/reference/pygtk-gtkstatusbar.xml +++ b/docs/reference/pygtk-gtkstatusbar.xml @@ -273,7 +273,7 @@ role="keyword">context_id</parameter> :</term> </varlistentry> <varlistentry> <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>an inieger message + <listitem><simpara>an integer message identifier</simpara></listitem> </varlistentry> </variablelist> @@ -373,7 +373,7 @@ displayed</simpara></listitem> </variablelist> <para>The <methodname>get_has_resize_grip</methodname>() method -returns the value of the internal "has_resize_grip" property tht determines +returns the value of the internal "has_resize_grip" property that determines if a resize grip is displayed on the statusbar.</para> </refsect2> diff --git a/docs/reference/pygtk-gtkstyle.xml b/docs/reference/pygtk-gtkstyle.xml index 8dcd48f7..27964087 100644 --- a/docs/reference/pygtk-gtkstyle.xml +++ b/docs/reference/pygtk-gtkstyle.xml @@ -711,7 +711,7 @@ using the base colors.</entry> <entry>Read</entry> <entry>An array of graphics contexts (<link linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>) for drawing -using the anit-aliased text colors.</entry> +using the anti-aliased text colors.</entry> </row> <row valign="top"> @@ -782,7 +782,7 @@ button that is pressed but not yet released</simpara> <term><literal>gtk.STATE_PRELIGHT</literal></term> <listitem> <simpara>The state of a sensitive widget that has the focus e.g. a -button that has teh mouse pointer over it.</simpara> +button that has the mouse pointer over it.</simpara> </listitem> </varlistentry> <varlistentry> @@ -854,7 +854,7 @@ object</simpara></listitem> </variablelist> <para>The <methodname>copy</methodname>() method returns a copy of the -gtkStyle object.</para> +style object.</para> </refsect2> @@ -1023,7 +1023,7 @@ linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link></simpara></ <para>The <methodname>lookup_icon_set</methodname>() method looks in the <link linkend="class-gtkiconfactory"><classname>gtk.IconFactory</classname></link> -list associated with the style and the deafult icon factory for the stock +list associated with the style and the default icon factory for the stock icon specified by <parameter>stock_id</parameter>. If the stock icon iconset is found it is returned.</para> @@ -1259,7 +1259,8 @@ clipped by the rectangle specified by <parameter>area</parameter>.</para> <variablelist> <varlistentry> <term><parameter role="keyword">window</parameter> :</term> - <listitem><simpara>a GdkWindow*</simpara></listitem> + <listitem><simpara>a <link + linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>*</simpara></listitem> </varlistentry> <varlistentry> <term><parameter diff --git a/docs/reference/pygtk-gtktable.xml b/docs/reference/pygtk-gtktable.xml index c97227eb..94186853 100644 --- a/docs/reference/pygtk-gtktable.xml +++ b/docs/reference/pygtk-gtktable.xml @@ -214,7 +214,7 @@ same width or height</entry> <row valign="top"> <entry>"x-options"</entry> <entry>Read-Write</entry> - <entry>the horizontal behaviour of the child - a combination + <entry>the horizontal behavior of the child - a combination of: <literal>gtk.EXPAND</literal>, <literal>gtk.SHRINK</literal> and <literal>gtk.FILL</literal></entry> </row> @@ -229,7 +229,7 @@ and right neighbors, in pixels</entry> <row valign="top"> <entry>"y-options"</entry> <entry>Read-Write</entry> - <entry>the vertical behaviour of the child - a combination of: + <entry>the vertical behavior of the child - a combination of: <literal>gtk.EXPAND</literal>, <literal>gtk.SHRINK</literal> and <literal>gtk.FILL</literal></entry> </row> @@ -513,7 +513,7 @@ spacing</simpara></listitem> </variablelist> <para>The <methodname>set_row_spacing</methodname>() method sets the -spacing in pixels (specifed by <parameter>spacing</parameter>) between the +spacing in pixels (specified by <parameter>spacing</parameter>) between the specified <parameter>row</parameter> and the following row.</para> </refsect2> @@ -570,7 +570,7 @@ spacing</simpara></listitem> </variablelist> <para>The <methodname>set_col_spacing</methodname>() method sets the -spacing in pixels (specifed by <parameter>spacing</parameter>) between the +spacing in pixels (specified by <parameter>spacing</parameter>) between the specified <parameter>column</parameter> and the following column.</para> </refsect2> @@ -701,7 +701,7 @@ linkend="method-gtktable--set-col-spacings"><methodname>set_col_spacings</method <varlistentry> <term><parameter role="keyword">homogeneous</parameter> :</term> - <listitem><simpara>if <literal>TRUE</literal> all cells willb e + <listitem><simpara>if <literal>TRUE</literal> all cells will be the same size as the largest cell</simpara></listitem> </varlistentry> </variablelist> diff --git a/docs/reference/pygtk-gtktextattributes.xml b/docs/reference/pygtk-gtktextattributes.xml index 46f7b1b7..c45f5821 100644 --- a/docs/reference/pygtk-gtktextattributes.xml +++ b/docs/reference/pygtk-gtktextattributes.xml @@ -159,7 +159,7 @@ are set</entry> <row valign="top"> <entry>"pixels_inside_wrap"</entry> <entry>Read</entry> - <entry>The number of pixels of spece between wrapped lines in + <entry>The number of pixels of space between wrapped lines in a paragraph</entry> </row> diff --git a/docs/reference/pygtk-gtktextmark.xml b/docs/reference/pygtk-gtktextmark.xml index 05e841d5..79bb5d5a 100644 --- a/docs/reference/pygtk-gtktextmark.xml +++ b/docs/reference/pygtk-gtktextmark.xml @@ -77,7 +77,7 @@ method. A <link linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link> has two built-in <link linkend="class-gtktextmark"><classname>gtk.TextMark</classname></link> -objectss named: <literal>insert</literal> and +objects named: <literal>insert</literal> and <literal>selection_bound</literal> which refer to the insertion point and the boundary of the selection (these may refer to the same location).</para> |