diff options
162 files changed, 7520 insertions, 2170 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 7654f1da..7cdf3708 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,9 @@ +2006-06-27 John Finlay <finlay@moeraki.com> + + * Add links to ancestor properties and signals. Add new GTK 2.10 + classes, methods, functions and constants. Remove unused file + pygtk-classes.xml + 2006-06-22 John Finlay <finlay@moeraki.com> * pygtk-gladexml.xml (set_custom_widget_callbacks): Fix external link. diff --git a/docs/reference/pygtk-gdkevent.xml b/docs/reference/pygtk-gdkevent.xml index f9565270..a6032f4b 100644 --- a/docs/reference/pygtk-gdkevent.xml +++ b/docs/reference/pygtk-gdkevent.xml @@ -2048,116 +2048,11 @@ stamp from the event, if there is one; otherwise returns 0.</para> </note> <para>The <methodname>get_state</methodname>() method returns the -value of the modifier "state" field. If the event has no "state" field the -empty state value (0) is returned. The "state" field contains a modifier -type: a combination of:</para> - - <variablelist> - <varlistentry> - <term><literal>gtk.gdk.SHIFT_MASK</literal></term> - <listitem> - <simpara>The Shift key.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.LOCK_MASK</literal></term> - <listitem> - <simpara>A Lock key (depending on the modifier mapping of the X -server this may either be CapsLock or ShiftLock).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.CONTROL_MASK</literal></term> - <listitem> - <simpara>The Control key. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.MOD1_MASK</literal></term> - <listitem> - <simpara>The fourth modifier key (it depends on the modifier -mapping of the X server which key is interpreted as this modifier, but -normally it is the Alt key).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.MOD2_MASK</literal></term> - <listitem> - <simpara>The fifth modifier key (it depends on the modifier -mapping of the X server which key is interpreted as this -modifier).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.MOD3_MASK</literal></term> - <listitem> - <simpara>The sixth modifier key (it depends on the modifier -mapping of the X server which key is interpreted as this -modifier).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.MOD4_MASK</literal></term> - <listitem> - <simpara>The seventh modifier key (it depends on the modifier -mapping of the X server which key is interpreted as this -modifier).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.MOD5_MASK</literal></term> - <listitem> - <simpara>The eighth modifier key (it depends on the modifier -mapping of the X server which key is interpreted as this -modifier).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BUTTON1_MASK</literal></term> - <listitem> - <simpara>The first mouse button.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BUTTON2_MASK</literal></term> - <listitem> - <simpara>The second mouse button.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BUTTON3_MASK</literal></term> - <listitem> - <simpara>The third mouse button.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BUTTON4_MASK</literal></term> - <listitem> - <simpara>The fourth mouse button.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BUTTON5_MASK</literal></term> - <listitem> - <simpara>The fifth mouse button.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.RELEASE_MASK</literal></term> - <listitem> - <simpara>Differentiates between (keyval, modifiers) pairs from -key press and release events.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.MODIFIER_MASK</literal></term> - <listitem> - <simpara>all of the above</simpara> - </listitem> - </varlistentry> - </variablelist> - - <para></para> + value of the modifier "state" field. If the event has no "state" field + the empty state value (0) is returned. The "state" field contains a + modifier type: a combination of the <xref + linkend="gdk-modifier-constants" + endterm="gdk-modifier-constants-title"></xref>.</para> </refsect2> @@ -2170,7 +2065,7 @@ key press and release events.</simpara> <title><literal>gtk.gdk.NO_EXPOSE</literal></title> <blockquote> - <para>These events does not have any additional attributes.</para> + <para>These events do not have any additional attributes.</para> </blockquote> </refsect2> diff --git a/docs/reference/pygtk-gdkkeymap.xml b/docs/reference/pygtk-gdkkeymap.xml index 1d7c48df..b05c1634 100644 --- a/docs/reference/pygtk-gdkkeymap.xml +++ b/docs/reference/pygtk-gdkkeymap.xml @@ -300,131 +300,27 @@ level</simpara> </note> <para>The <methodname>translate_keyboard_state</methodname>() method -translates the contents of a keyboard <link -linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> -(specified by <parameter>keycode</parameter>, <parameter>state</parameter> -and <parameter>group</parameter>) into a keyval, effective group, level and -consumed modifiers that affected the translation (and are unavailable for -application use) which are returned in a 4-tuple. See the <link -linkend="method-gdkkeymap--lookup-key"><methodname>lookup_key</methodname>()</link> -method for an explanation of groups and levels. The effective group is the -group that was actually used for the translation; some keys such as -<keycap>Enter</keycap> are not affected by the active keyboard group. The -level is derived from <parameter>state</parameter>. For convenience, the -keyboard <link -linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> already -contains the translated keyval, so this method isn't as useful as you might -think.</para> + translates the contents of a keyboard <link + linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> + (specified by <parameter>keycode</parameter>, + <parameter>state</parameter> and <parameter>group</parameter>) into a + keyval, effective group, level and consumed modifiers that affected + the translation (and are unavailable for application use) which are + returned in a 4-tuple. See the <link + linkend="method-gdkkeymap--lookup-key"><methodname>lookup_key</methodname>()</link> + method for an explanation of groups and levels. The effective group is + the group that was actually used for the translation; some keys such + as <keycap>Enter</keycap> are not affected by the active keyboard + group. The level is derived from <parameter>state</parameter>. For + convenience, the keyboard <link + linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> + already contains the translated keyval, so this method isn't as useful + as you might think.</para> <para>The value of <parameter>state</parameter> or the consumed -modifiers is a combination of:</para> - - <variablelist> - <varlistentry> - <term><literal>gtk.gdk.SHIFT_MASK</literal></term> - <listitem> - <simpara>The Shift key.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.LOCK_MASK</literal></term> - <listitem> - <simpara>A Lock key (depending on the modifier mapping of the X -server this may either be CapsLock or ShiftLock).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.CONTROL_MASK</literal></term> - <listitem> - <simpara>The Control key. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.MOD1_MASK</literal></term> - <listitem> - <simpara>The fourth modifier key (it depends on the modifier -mapping of the X server which key is interpreted as this modifier, but -normally it is the Alt key).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.MOD2_MASK</literal></term> - <listitem> - <simpara>The fifth modifier key (it depends on the modifier -mapping of the X server which key is interpreted as this -modifier).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.MOD3_MASK</literal></term> - <listitem> - <simpara>The sixth modifier key (it depends on the modifier -mapping of the X server which key is interpreted as this -modifier).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.MOD4_MASK</literal></term> - <listitem> - <simpara>The seventh modifier key (it depends on the modifier -mapping of the X server which key is interpreted as this -modifier).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.MOD5_MASK</literal></term> - <listitem> - <simpara>The eighth modifier key (it depends on the modifier -mapping of the X server which key is interpreted as this -modifier).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BUTTON1_MASK</literal></term> - <listitem> - <simpara>The first mouse button.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BUTTON2_MASK</literal></term> - <listitem> - <simpara>The second mouse button.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BUTTON3_MASK</literal></term> - <listitem> - <simpara>The third mouse button.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BUTTON4_MASK</literal></term> - <listitem> - <simpara>The fourth mouse button.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BUTTON5_MASK</literal></term> - <listitem> - <simpara>The fifth mouse button.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.RELEASE_MASK</literal></term> - <listitem> - <simpara>Differentiates between (keyval, modifiers) pairs from -key press and release events.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.MODIFIER_MASK</literal></term> - <listitem> - <simpara>all of the above</simpara> - </listitem> - </varlistentry> - </variablelist> - - <para></para> + modifiers is a combination of the <xref + linkend="gdk-modifier-constants" + endterm="gdk-modifier-constants-title"></xref>.</para> <refsect3> <title>Consumed Modifiers</title> diff --git a/docs/reference/pygtk-gladexml.xml b/docs/reference/pygtk-gladexml.xml index 52cb3f84..e9ff5630 100644 --- a/docs/reference/pygtk-gladexml.xml +++ b/docs/reference/pygtk-gladexml.xml @@ -6,8 +6,7 @@ <refnamediv> <refname>gtk.glade.XML</refname> <refpurpose>Allows dynamic loading of user interfaces - from XML descriptions -</refpurpose> + from XML descriptions.</refpurpose> </refnamediv> <refsect1> @@ -85,6 +84,12 @@ linkend="constructor-gladexml">gtk.glade.XML</link></methodname> </refsect1> + <refsect1 id="signal-prototypes-gladexml"> + <title>gtk.glade.XML Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> +</refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gobject.xml b/docs/reference/pygtk-gobject.xml index 81947606..fd758291 100644 --- a/docs/reference/pygtk-gobject.xml +++ b/docs/reference/pygtk-gobject.xml @@ -114,7 +114,7 @@ linkend="method-gobject--stop-emission">stop_emission</link></methodname> </methodsynopsis> <methodsynopsis language="python"> <methodname><link -linkend="method-gobject--stop-emission">emit_stop_by_name</link></methodname> +linkend="method-gobject--emit-stop-by-name">emit_stop_by_name</link></methodname> <methodparam><parameter>detailed_signal</parameter></methodparam> </methodsynopsis> <methodsynopsis language="python"> @@ -175,8 +175,9 @@ linkend="method-gobject--chain">chain</link></methodname> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gobject"> + <title>gobject.GObject Signal Prototypes</title> + <variablelist> <varlistentry> @@ -196,13 +197,17 @@ linkend="method-gobject--chain">chain</link></methodname> <refsect1> <title>Description</title> - <para>The GObject class is the base class providing the common -attributes and methods for the PyGTK classes. The GObject class is not a -user interface widget class.</para> - - <para>The GObject class provides the signal management methods, the -object property access methods and the object data management -methods.</para> + <para>The <link + linkend="class-gobject"><classname>gobject.GObject</classname></link> + class is the base class providing the common attributes and methods for + the PyGTK classes. The <link + linkend="class-gobject"><classname>gobject.GObject</classname></link> + class is not a user interface widget class.</para> + + <para>The <link + linkend="class-gobject"><classname>gobject.GObject</classname></link> + class provides the signal management methods, the object property access + methods and the object data management methods.</para> </refsect1> diff --git a/docs/reference/pygtk-gtk-classes.xml b/docs/reference/pygtk-gtk-classes.xml index b93d1630..b0759947 100644 --- a/docs/reference/pygtk-gtk-classes.xml +++ b/docs/reference/pygtk-gtk-classes.xml @@ -104,9 +104,13 @@ <xi:include href="pygtk-gtkobject.xml"/> <xi:include href="pygtk-gtkoptionmenu.xml"/> <xi:include href="pygtk-gtkpagesetup.xml"/> - <xi:include href="pygtk-gtkpapersize.xml"/> <xi:include href="pygtk-gtkpaned.xml"/> + <xi:include href="pygtk-gtkpapersize.xml"/> <xi:include href="pygtk-gtkplug.xml"/> + <xi:include href="pygtk-gtkprintcontext.xml"/> + <xi:include href="pygtk-gtkprintoperation.xml"/> + <xi:include href="pygtk-gtkprintoperationpreview.xml"/> + <xi:include href="pygtk-gtkprintsettings.xml"/> <xi:include href="pygtk-gtkprogressbar.xml"/> <xi:include href="pygtk-gtkradioaction.xml"/> <xi:include href="pygtk-gtkradiobutton.xml"/> @@ -114,6 +118,13 @@ <xi:include href="pygtk-gtkradiotoolbutton.xml"/> <xi:include href="pygtk-gtkrange.xml"/> <xi:include href="pygtk-gtkrcstyle.xml"/> + <xi:include href="pygtk-gtkrecentchooserdialog.xml"/> + <xi:include href="pygtk-gtkrecentchoosermenu.xml"/> + <xi:include href="pygtk-gtkrecentchooserwidget.xml"/> + <xi:include href="pygtk-gtkrecentchooser.xml"/> + <xi:include href="pygtk-gtkrecentfilter.xml"/> + <xi:include href="pygtk-gtkrecentinfo.xml"/> + <xi:include href="pygtk-gtkrecentmanager.xml"/> <xi:include href="pygtk-gtkrequisition.xml"/> <xi:include href="pygtk-gtkruler.xml"/> <xi:include href="pygtk-gtkscale.xml"/> @@ -128,6 +139,7 @@ <xi:include href="pygtk-gtksocket.xml"/> <xi:include href="pygtk-gtkspinbutton.xml"/> <xi:include href="pygtk-gtkstatusbar.xml"/> + <xi:include href="pygtk-gtkstatusicon.xml"/> <xi:include href="pygtk-gtkstyle.xml"/> <xi:include href="pygtk-gtktable.xml"/> <xi:include href="pygtk-gtktearoffmenuitem.xml"/> diff --git a/docs/reference/pygtk-gtk-constants.xml b/docs/reference/pygtk-gtk-constants.xml index 7a80db46..980f8ff4 100644 --- a/docs/reference/pygtk-gtk-constants.xml +++ b/docs/reference/pygtk-gtk-constants.xml @@ -53,15 +53,26 @@ <xref linkend="gtk-pack-direction-constants" endterm="gtk-pack-direction-constants-title"></xref> <xref linkend="gtk-pack-type-constants" endterm="gtk-pack-type-constants-title"></xref> <xref linkend="gtk-page-orientation-constants" endterm="gtk-page-orientation-constants-title"></xref> +<xref linkend="gtk-page-set-constants" endterm="gtk-page-set-constants-title"></xref> <xref linkend="gtk-paper-name-constants" endterm="gtk-paper-name-constants-title"></xref> <xref linkend="gtk-path-priority-type-constants" endterm="gtk-path-priority-type-constants-title"></xref> <xref linkend="gtk-path-type-constants" endterm="gtk-path-type-constants-title"></xref> <xref linkend="gtk-policy-type-constants" endterm="gtk-policy-type-constants-title"></xref> <xref linkend="gtk-position-type-constants" endterm="gtk-position-type-constants-title"></xref> +<xref linkend="gtk-print-duplex-constants" endterm="gtk-print-duplex-constants-title"></xref> +<xref linkend="gtk-print-error-constants" endterm="gtk-print-error-constants-title"></xref> +<xref linkend="gtk-print-pages-constants" endterm="gtk-print-pages-constants-title"></xref> +<xref linkend="gtk-print-operation-action-constants" endterm="gtk-print-operation-action-constants-title"></xref> +<xref linkend="gtk-print-operation-result-constants" endterm="gtk-print-operation-result-constants-title"></xref> +<xref linkend="gtk-print-quality-constants" endterm="gtk-print-quality-constants-title"></xref> +<xref linkend="gtk-print-status-constants" endterm="gtk-print-status-constants-title"></xref> <xref linkend="gtk-progressbar-orientation-constants" endterm="gtk-progressbar-orientation-constants-title"></xref> <xref linkend="gtk-progressbar-style-constants" endterm="gtk-progressbar-style-constants-title"></xref> <xref linkend="gtk-rc-flags-constants" endterm="gtk-rc-flags-constants-title"></xref> <xref linkend="gtk-rc-token-type-constants" endterm="gtk-rc-token-type-constants-title"></xref> +<xref linkend="gtk-recent-chooser-error-constants" endterm="gtk-recent-chooser-error-constants-title"></xref> +<xref linkend="gtk-recent-filter-flags-constants" endterm="gtk-recent-filter-flags-constants-title"></xref> +<xref linkend="gtk-recent-sort-type-constants" endterm="gtk-recent-sort-type-constants-title"></xref> <xref linkend="gtk-relief-style-constants" endterm="gtk-relief-style-constants-title"></xref> <xref linkend="gtk-resize-mode-constants" endterm="gtk-resize-mode-constants-title"></xref> <xref linkend="gtk-response-type-constants" endterm="gtk-response-type-constants-title"></xref> @@ -78,10 +89,12 @@ <xref linkend="gtk-text-direction-constants" endterm="gtk-text-direction-constants-title"></xref> <xref linkend="gtk-text-search-flags-constants" endterm="gtk-text-search-flags-constants-title"></xref> <xref linkend="gtk-text-window-type-constants" endterm="gtk-text-window-type-constants-title"></xref> +<xref linkend="gtk-textbuffer-target-info-constants" endterm="gtk-textbuffer-target-info-constants-title"></xref> <xref linkend="gtk-toolbar-space-style-constants" endterm="gtk-toolbar-space-style-constants-title"></xref> <xref linkend="gtk-toolbar-style-constants" endterm="gtk-toolbar-style-constants-title"></xref> <xref linkend="gtk-treemodel-flags-constants" endterm="gtk-treemodel-flags-constants-title"></xref> <xref linkend="gtk-treeview-drop-position-constants" endterm="gtk-treeview-drop-position-constants-title"></xref> +<xref linkend="gtk-treeview-grid-lines-constants" endterm="gtk-treeview-grid-lines-constants-title"></xref> <xref linkend="gtk-treeviewcolumn-sizing-constants" endterm="gtk-treeviewcolumn-sizing-constants-title"></xref> <xref linkend="gtk-uimanager-item-type-constants" endterm="gtk-uimanager-item-type-constants-title"></xref> <xref linkend="gtk-unit-constants" endterm="gtk-unit-constants-title"></xref> @@ -1773,6 +1786,35 @@ linkend="class-gtkbuttonbox"><classname>gtk.ButtonBox</classname></link>).</para </refsect2> + <refsect2 id="gtk-page-set-constants"> + <title id="gtk-page-set-constants-title">GTK Page Set Constants</title> + + <para>The Page Set constants specify the set of + pages to print.</para> + + <variablelist> + <varlistentry> + <term><literal>gtk.PAGE_SET_ALL</literal></term> + <listitem> + <simpara>print all pages</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PAGE_SET_EVEN</literal></term> + <listitem> + <simpara>print even pages only</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PAGE_SET_ODD</literal></term> + <listitem> + <simpara>print odd pages only</simpara> + </listitem> + </varlistentry> + </variablelist> + + </refsect2> + <refsect2 id="gtk-paper-name-constants"> <title id="gtk-paper-name-constants-title">GTK Papaer Name Constants</title> @@ -1965,6 +2007,275 @@ contents are larger than the window</simpara> </refsect2> + <refsect2 id="gtk-print-duplex-constants"> + <title id="gtk-print-duplex-constants-title">GTK Print Duplex Constants</title> + + <para>The Print Status constants specify how the output pages should + be duplexed:</para> + + <variablelist> + <varlistentry> + <term><literal>gtk.PRINT_DUPLEX_SIMPLEX</literal></term> + <listitem> + <simpara>one page per sheet i.e. no duplexing</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_DUPLEX_HORIZONTAL</literal></term> + <listitem> + <simpara>two pages per sheet horizontally duplexed</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_DUPLEX_VERTICAL</literal></term> + <listitem> + <simpara>two pages per sheet vertically duplexed</simpara> + </listitem> + </varlistentry> + </variablelist> + + </refsect2> + + <refsect2 id="gtk-print-error-constants"> + <title id="gtk-print-error-constants-title">GTK Print Error Constants</title> + + <para>The Print Error constants specify the type of printing + error:</para> + + <variablelist> + <varlistentry> + <term><literal>gtk.PRINT_ERROR_GENERAL</literal></term> + <listitem> + <simpara></simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_ERROR_INTERNAL_ERROR</literal></term> + <listitem> + <simpara></simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_ERROR_NOMEM</literal></term> + <listitem> + <simpara></simpara> + </listitem> + </varlistentry> + </variablelist> + + </refsect2> + + <refsect2 id="gtk-print-pages-constants"> + <title id="gtk-print-pages-constants-title">GTK Print Pages Constants</title> + + <para>The Print Pages constants specify the set that should be + printed:</para> + + <variablelist> + <varlistentry> + <term><literal>gtk.PRINT_PAGES_ALL</literal></term> + <listitem> + <simpara>print all pages</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_PAGES_CURRENT</literal></term> + <listitem> + <simpara>print the current page</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_PAGES_RANGES</literal></term> + <listitem> + <simpara>print the specified ranges of pages</simpara> + </listitem> + </varlistentry> + </variablelist> + + </refsect2> + + <refsect2 id="gtk-print-operation-action-constants"> + <title id="gtk-print-operation-action-constants-title">GTK Print Operation Action Constants</title> + + <para>The Print Operation Action constants specify the print operation + to be performed:</para> + + <variablelist> + <varlistentry> + <term><literal>gtk.PRINT_OPERATION_ACTION_PRINT_DIALOG</literal></term> + <listitem> + <simpara>Show the print dialog.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_OPERATION_ACTION_PRINT</literal></term> + <listitem> + <simpara>Start to print without showing the print dialog, based + on the current print settings.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_OPERATION_ACTION_PREVIEW</literal></term> + <listitem> + <simpara>Show the print preview.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_OPERATION_ACTION_EXPORT</literal></term> + <listitem> + <simpara>Export to a file. This requires the "export-filename" + property to be set.</simpara> + </listitem> + </varlistentry> + </variablelist> + + </refsect2> + + <refsect2 id="gtk-print-operation-result-constants"> + <title id="gtk-print-operation-result-constants-title">GTK Print Operation Result Constants</title> + + <para>The Print Operation Result constants specify the result of the + print operation as returned by the <link + linkend="method-gtkprintoperation--run"><methodname>gtk.PrintOperation.run</methodname>()</link>) + method:</para> + + <variablelist> + <varlistentry> + <term><literal>gtk.PRINT_OPERATION_RESULT_ERROR</literal></term> + <listitem> + <simpara>An error has occured.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_OPERATION_RESULT_APPLY</literal></term> + <listitem> + <simpara>The print settings should be stored.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_OPERATION_RESULT_CANCEL</literal></term> + <listitem> + <simpara>The print operation has been canceled, the print + settings should not be stored.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_OPERATION_RESULT_IN_PROGRESS</literal></term> + <listitem> + <simpara>The print operation is complete yet. This value will + only be returned when running asynchronously.</simpara> + </listitem> + </varlistentry> + </variablelist> + + </refsect2> + + <refsect2 id="gtk-print-quality-constants"> + <title id="gtk-print-quality-constants-title">GTK Print Quality Constants</title> + + <para>The Print Quality constants specify the quality that should be + used when printing the output pages:</para> + + <variablelist> + <varlistentry> + <term><literal>gtk.PRINT_QUALITY_LOW</literal></term> + <listitem> + <simpara>low quality</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_QUALITY_NORMAL</literal></term> + <listitem> + <simpara>normal quality</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_QUALITY_HIGH</literal></term> + <listitem> + <simpara>high quality</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_QUALITY_DRAFT</literal></term> + <listitem> + <simpara>draft quality</simpara> + </listitem> + </varlistentry> + </variablelist> + + </refsect2> + + <refsect2 id="gtk-print-status-constants"> + <title id="gtk-print-status-constants-title">GTK Print Status Constants</title> + + <para>The Print Status constants specify </para> + + <variablelist> + <varlistentry> + <term><literal>gtk.PRINT_STATUS_INITIAL</literal></term> + <listitem> + <simpara>The printing has not started yet; this status is set + initially, and while the print dialog is shown.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_STATUS_PREPARING</literal></term> + <listitem> + <simpara>This status is set while the "begin-print" signal is + emitted and during pagination.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_STATUS_GENERATING_DATA</literal></term> + <listitem> + <simpara>This status is set while the pages are being + rendered.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_STATUS_SENDING_DATA</literal></term> + <listitem> + <simpara>The print job is being sent off to the + printer.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_STATUS_PENDING</literal></term> + <listitem> + <simpara>The print job has been sent to the printer, but is not + printed for some reason, e.g. the printer may be + stopped.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_STATUS_PENDING_ISSUE</literal></term> + <listitem> + <simpara>Some problem has occurred during printing, e.g. a paper + jam.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_STATUS_PRINTING</literal></term> + <listitem> + <simpara>The printer is processing the print job.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_STATUS_FINISHED</literal></term> + <listitem> + <simpara>The printing has been completed successfully.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.PRINT_STATUS_FINISHED_ABORTED</literal></term> + <listitem> + <simpara>The printing has been aborted. </simpara> + </listitem> + </varlistentry> + </variablelist> + + </refsect2> + <refsect2 id="gtk-progressbar-orientation-constants"> <title id="gtk-progressbar-orientation-constants-title">GTK ProgressBar Orientation Constants</title> @@ -2314,6 +2625,122 @@ parsing the theme-engine specific portions of a RC file.</para> </refsect2> + <refsect2 id="gtk-recent-chooser-error-constants"> + <title id="gtk-recent-chooser-error-constants-title">GTK Recent Chooser Error Constants</title> + + <para>The Recent Recent Chooser Error constants specify the various + errors that can occur while calling <link + linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link> + methods:</para> + + <variablelist> + <varlistentry> + <term><literal>gtk.RECENT_CHOOSER_ERROR_NOT_FOUND</literal></term> + <listitem> + <simpara>Indicates that a file does not exist</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.RECENT_CHOOSER_ERROR_INVALID_URI</literal></term> + <listitem> + <simpara>Indicates a malformed URI</simpara> + </listitem> + </varlistentry> + </variablelist> + + </refsect2> + + <refsect2 id="gtk-recent-filter-flags-constants"> + <title id="gtk-recent-filter-flags-constants-title">GTK Recent Filter Flags</title> + + <para>The Recent Filter Flags specify what types of filtering are + needed:</para> + + <variablelist> + <varlistentry> + <term><literal>gtk.RECENT_FILTER_URI</literal></term> + <listitem> + <simpara>the URI of the file being tested</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.RECENT_FILTER_DISPLAY_NAME</literal></term> + <listitem> + <simpara>the string that will be used to display the file in the + recent chooser</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.RECENT_FILTER_MIME_TYPE</literal></term> + <listitem> + <simpara>the mime type of the file</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.RECENT_FILTER_APPLICATION</literal></term> + <listitem> + <simpara>the list of applications that have registered the + file</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.RECENT_FILTER_GROUP</literal></term> + <listitem> + <simpara>the groups to which the file belongs</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.RECENT_FILTER_AGE</literal></term> + <listitem> + <simpara>the number of days elapsed since the file has been + registered</simpara> + </listitem> + </varlistentry> + </variablelist> + + </refsect2> + + <refsect2 id="gtk-recent-sort-type-constants"> + <title id="gtk-recent-sort-type-constants-title">GTK Recent Sort Type Constants</title> + + <para>The Recent Sort Type constants specify the sorting method to be + applyed to the recently used resource list.</para> + + <variablelist> + <varlistentry> + <term><literal>gtk.RECENT_SORT_NONE</literal></term> + <listitem> + <simpara>Do not sort the returned list of recently used + resources.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.RECENT_SORT_MRU</literal></term> + <listitem> + <simpara>Sort the returned list with the most recently used + items first.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.RECENT_SORT_LRU</literal></term> + <listitem> + <simpara>Sort the returned list with the least recently used + items first.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.RECENT_SORT_CUSTOM</literal></term> + <listitem> + <simpara>Sort the returned list using a custom sorting function + passed using the <link + linkend="method-gtkrecentchooser--set-sort-func"><methodname>gtk.RecentChooser.set_sort_func</methodname>()</link> + method.</simpara> + </listitem> + </varlistentry> + </variablelist> + + </refsect2> + <refsect2 id="gtk-relief-style-constants"> <title id="gtk-relief-style-constants-title">GTK Relief Style Constants</title> @@ -3015,6 +3442,39 @@ linkend="class-gtktextview"><classname>gtk.TextView</classname></link>.</simpara </refsect2> + <refsect2 id="gtk-textbuffer-target-info-constants"> + <title id="gtk-textbuffer-target-info-constants-title">GTK TextBuffer Target Info Constants</title> + + <para>The TextBuffer Target Info constants specify the info integer + for use with the <link + linkend="function-gtk--target-list-add-rich-text-targets"><function>gtk.target_list_add_rich_text_targets</function>()</link> + and <link + linkend="function-gtk--target-list-add-text-targets"><function>gtk.target_list_add_text_targets</function>()</link> + functions.</para> + + <variablelist> + <varlistentry> + <term><literal>gtk.TEXT_BUFFER_TARGET_INFO_BUFFER_CONTENTS</literal></term> + <listitem> + <simpara></simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.TEXT_BUFFER_TARGET_INFO_RICH_TEXT</literal></term> + <listitem> + <simpara></simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.TEXT_BUFFER_TARGET_INFO_TEXT</literal></term> + <listitem> + <simpara></simpara> + </listitem> + </varlistentry> + </variablelist> + + </refsect2> + <refsect2 id="gtk-toolbar-space-style-constants"> <title id="gtk-toolbar-space-style-constants-title">GTK Toolbar Space Style Constants</title> @@ -3150,6 +3610,40 @@ on. Fallback to goes after.</simpara> </refsect2> + <refsect2 id="gtk-treeview-grid-lines-constants"> + <title id="gtk-treeview-grid-lines-constants-title">GTK TreeView Grid Lines Constants</title> + + <para>The TreeView Grid Lines constants specify how grid lines should be applied to a TreeView.</para> + + <variablelist> + <varlistentry> + <term><literal>gtk.TREE_VIEW_GRID_LINES_NONE</literal></term> + <listitem> + <simpara></simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.TREE_VIEW_GRID_LINES_HORIZONTAL</literal></term> + <listitem> + <simpara></simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.TREE_VIEW_GRID_LINES_VERTICAL</literal></term> + <listitem> + <simpara></simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>gtk.TREE_VIEW_GRID_LINES_BOTH</literal></term> + <listitem> + <simpara></simpara> + </listitem> + </varlistentry> + </variablelist> + + </refsect2> + <refsect2 id="gtk-treeviewcolumn-sizing-constants"> <title id="gtk-treeviewcolumn-sizing-constants-title">GTK TreeViewColumn Sizing Constants</title> diff --git a/docs/reference/pygtk-gtk-functions.xml b/docs/reference/pygtk-gtk-functions.xml index 9b661aa7..c1a0ed8d 100644 --- a/docs/reference/pygtk-gtk-functions.xml +++ b/docs/reference/pygtk-gtk-functions.xml @@ -450,6 +450,19 @@ linkend="function-gtk--binding-entry-remove">gtk.binding_entry_remove</link></me </refsect2> <refsect2> + <title><link linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link> Functions</title> + + <programlisting><methodsynopsis language="python"> + <methodname><link linkend="function-gtk--recent-manager-get-default">gtk.recent_manager_get_default</link></methodname> + <methodparam></methodparam> + </methodsynopsis><methodsynopsis language="python"> + <methodname><link linkend="function-gtk--recent-manager-get-for-screen">gtk.recent_manager_get_for_screen</link></methodname> + <methodparam><parameter role="keyword">screen</parameter></methodparam> + </methodsynopsis></programlisting> + + </refsect2> + + <refsect2> <title><link linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link> Functions</title> <programlisting><methodsynopsis language="python"> @@ -492,6 +505,29 @@ linkend="function-gtk--settings-get-for-screen">gtk.settings_get_for_screen</lin </refsect2> <refsect2> + <title><link linkend="class-gtkstatusicon"><classname>gtk.StatusIcon</classname></link> Functions</title> + + <programlisting><methodsynopsis language="python"> + <methodname><link linkend="function-gtk--status-icon-new-from-pixbuf">gtk.status_icon_new_from_pixbuf</link></methodname> + <methodparam><parameter role="keyword">pixbuf</parameter></methodparam> + </methodsynopsis><methodsynopsis language="python"> + <methodname><link linkend="function-gtk--status-icon-new-from-file">gtk.status_icon_new_from_file</link></methodname> + <methodparam><parameter role="keyword">filename</parameter></methodparam> + </methodsynopsis><methodsynopsis language="python"> + <methodname><link linkend="function-gtk--status-icon-new-from-stock">gtk.status_icon_new_from_stock</link></methodname> + <methodparam><parameter role="keyword">stock_id</parameter></methodparam> + </methodsynopsis><methodsynopsis language="python"> + <methodname><link linkend="function-gtk--status-icon-new-from-icon-name">gtk.status_icon_new_from_icon_name</link></methodname> + <methodparam><parameter role="keyword">icon_name</parameter></methodparam> + </methodsynopsis><methodsynopsis language="python"> + <methodname><link linkend="function-gtk--status-icon-position-menu">gtk.status_icon_position_menu</link></methodname> + <methodparam><parameter>menu</parameter></methodparam> + <methodparam><parameter>statusicon</parameter></methodparam> + </methodsynopsis></programlisting> + + </refsect2> + + <refsect2> <title><link linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link> Functions</title> <programlisting><methodsynopsis language="python"> diff --git a/docs/reference/pygtk-gtkaboutdialog.xml b/docs/reference/pygtk-gtkaboutdialog.xml index 87264a64..0a2bd8e2 100644 --- a/docs/reference/pygtk-gtkaboutdialog.xml +++ b/docs/reference/pygtk-gtkaboutdialog.xml @@ -137,8 +137,14 @@ linkend="constructor-gtkaboutdialog">gtk.AboutDialog</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkaboutdialog"> + <title>gtk.AboutDialog 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> + <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para> + <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -152,85 +158,99 @@ linkend="constructor-gtkaboutdialog">gtk.AboutDialog</link></methodname> <entry>"artists"</entry> <entry>Read-Write</entry> <entry>The list of people who have contributed artwork to -the program.</entry> +the program. +This property is available in GTK+ 2.6 and above.</entry> </row> <row valign="top"> <entry>"authors"</entry> <entry>Read-Write</entry> - <entry>The list of authors of the program.</entry> + <entry>The list of authors of the program. +This property is available in GTK+ 2.6 and above.</entry> </row> <row valign="top"> <entry>"comments"</entry> <entry>Read-Write</entry> <entry>A string containing comments about the program. -Default value: <literal>None</literal>.</entry> +Default value: <literal>None</literal>. +This property is available in GTK+ 2.6 and above.</entry> </row> <row valign="top"> <entry>"copyright"</entry> <entry>Read-Write</entry> <entry>A string containing copyright information for -the program. Default value: <literal>None</literal>.</entry> +the program. Default value: <literal>None</literal>. +This property is available in GTK+ 2.6 and above.</entry> </row> <row valign="top"> <entry>"documenters"</entry> <entry>Read-Write</entry> - <entry>The list of people documenting the program.</entry> + <entry>The list of people documenting the program. +This property is available in GTK+ 2.6 and above.</entry> </row> <row valign="top"> <entry>"license"</entry> <entry>Read-Write</entry> <entry>A string containing the license of the program. -Default value: <literal>None</literal>.</entry> +Default value: <literal>None</literal>. +This property is available in GTK+ 2.6 and above.</entry> </row> <row valign="top"> <entry>"logo"</entry> <entry>Read-Write</entry> <entry>A logo for the about box. If this is not set, -it defaults to the default window icon list..</entry> +it defaults to the default window icon list. +This property is available in GTK+ 2.6 and above.</entry> </row> <row valign="top"> <entry>"logo-icon-name"</entry> <entry>Read-Write</entry> <entry>The name of an icon to use as the logo for the -about box. Default value: <literal>None</literal>.</entry> +about box. Default value: <literal>None</literal>. +This property is available in GTK+ 2.6 and above.</entry> </row> <row valign="top"> <entry>"name"</entry> <entry>Read-Write</entry> <entry>The name of the program. If this is not set, it defaults to g_get_application_name(). -Default value: <literal>None</literal>.</entry> +Default value: <literal>None</literal>. +This property is available in GTK+ 2.6 and above.</entry> </row> <row valign="top"> <entry>"translator-credits"</entry> <entry>Read-Write</entry> <entry>Credits to the translators. This string should be -marked as translatable. Default value: <literal>None</literal>.</entry> +marked as translatable. Default value: <literal>None</literal>. +This property is available in GTK+ 2.6 and above.</entry> </row> <row valign="top"> <entry>"version"</entry> <entry>Read-Write</entry> <entry>A string containing the version of the program. -Default value: <literal>None</literal>.</entry> +Default value: <literal>None</literal>. +This property is available in GTK+ 2.6 and above.</entry> </row> <row valign="top"> <entry>"website"</entry> <entry>Read-Write</entry> <entry>The URL for the link to the website of the -program. Default value: <literal>None</literal>.</entry> +program. Default value: <literal>None</literal>. +This property is available in GTK+ 2.6 and above.</entry> </row> <row valign="top"> <entry>"website-label"</entry> <entry>Read-Write</entry> <entry>The label for the link to the website of the program. If this is not set, it defaults to the URL. -Default value: <literal>None</literal>.</entry> +Default value: <literal>None</literal>. +This property is available in GTK+ 2.6 and above.</entry> </row> <row valign="top"> <entry>"wrap-license"</entry> <entry>Read-Write</entry> <entry>If <literal>TRUE</literal> the license text should be -wrapped. Default value: <literal>FALSE</literal>.</entry> +wrapped. Default value: <literal>FALSE</literal>. +This property is available in GTK+ 2.6 and above.</entry> </row> </tbody> @@ -240,8 +260,11 @@ wrapped. Default value: <literal>FALSE</literal>.</entry> </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="style-properties-gtkaboutdialog"> + <title>gtk.AboutDialog Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -254,7 +277,8 @@ wrapped. Default value: <literal>FALSE</literal>.</entry> <row valign="top"> <entry>"link-color"</entry> <entry>Read</entry> - <entry>The color of hyperlinks.</entry> + <entry>The color of hyperlinks. This property is not available + in GTK+ 2.10 and above.</entry> </row> </tbody> @@ -264,6 +288,17 @@ wrapped. Default value: <literal>FALSE</literal>.</entry> </refsect1> + <refsect1 id="signal-prototypes-gtkaboutdialog"> + <title>gtk.AboutDialog 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> + <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> @@ -272,13 +307,26 @@ wrapped. Default value: <literal>FALSE</literal>.</entry> </note> <para>The <link -linkend="class-gtkaboutdialog"><classname>gtk.AboutDialog</classname></link> -offers a simple way to display information about a program like its logo, -name, copyright, website and license. It is also possible to give credits to -the authors, documenters, translators and artists who have worked on the -program. An about dialog is typically opened when the user selects the -<guimenu>Help</guimenu><guimenuitem>About</guimenuitem> menu. All parts of -the dialog are optional.</para> + linkend="class-gtkaboutdialog"><classname>gtk.AboutDialog</classname></link> + offers a simple way to display information about a program like its + logo, name, copyright, website and license. It is also possible to give + credits to the authors, documenters, translators and artists who have + worked on the program. An about dialog is typically opened when the user + selects the <guimenu>Help</guimenu><guimenuitem>About</guimenuitem> + menu. All parts of the dialog are optional.</para> + + <para>About dialog often contain links and email addresses. <link + linkend="class-gtkaboutdialog"><classname>gtk.AboutDialog</classname></link> + supports this by offering global hooks, which are called when the user + clicks on a link or email address, see the <link + linkend="function-gtk--about-dialog-set-email-hook"><function>gtk.about_dialog_set_email_hook</function>()</link> + and <link + linkend="function-gtk--about-dialog-set-url-hook"><function>gtk.about_dialog_set_url_hook</function>()</link> + functions. Email addresses in the authors, documenters and artists + properties are recognized by looking for <literal><user@<!-- + -->host></literal>, URLs are recognized by looking for + <literal>http://url</literal>, with <literal>url</literal> extending to + the next space, tab or line break.</para> </refsect1> diff --git a/docs/reference/pygtk-gtkaccelgroup.xml b/docs/reference/pygtk-gtkaccelgroup.xml index d62752e7..1fd7cb71 100644 --- a/docs/reference/pygtk-gtkaccelgroup.xml +++ b/docs/reference/pygtk-gtkaccelgroup.xml @@ -176,8 +176,8 @@ linkend="function-gtk--accel-groups-from-object">gtk.accel_groups_from_object</l </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkaccelgroup"> + <title>gtk.AccelGroup Signal Prototypes</title> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkaccellabel.xml b/docs/reference/pygtk-gtkaccellabel.xml index 5e96b10a..e7583331 100644 --- a/docs/reference/pygtk-gtkaccellabel.xml +++ b/docs/reference/pygtk-gtkaccellabel.xml @@ -66,9 +66,13 @@ linkend="method-gtkaccellabel--refetch">refetch</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkaccellabel"> + <title>gtk.AccelLabel 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-gtkmisc">gtk.Misc Properties</link></para> + <para><link linkend="properties-gtklabel">gtk.Label Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> <tgroup cols="3"> @@ -97,6 +101,23 @@ label</entry> </refsect1> + <refsect1 id="style-properties-gtkaccellabel"> + <title>gtk.AccelLabel Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + + </refsect1> + + <refsect1 id="signal-prototypes-gtkaccellabel"> + <title>gtk.AccelLabel 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-gtklabel">gtk.Label Signal Prototypes</link></para> +</refsect1> + <refsect1> <title>Description</title> @@ -161,7 +182,9 @@ always used to display just one accelerator.</para> accelerator and enables the display of the accelerator key string in the menu item label:</para> - <programlisting> +<example> +<title>Creating a simple menu item with an accelerator key.</title> +<programlisting> # Create an accelgroup and add it to the window accel_group = gtk.AccelGroup() window.add_accel_group(accel_group) @@ -177,7 +200,7 @@ menu item label:</para> save_item.add_accelerator("activate", accel_group, ord("S"), gtk.gdk.CONTROL_MASK, gtk.ACCEL_VISIBLE) </programlisting> - <para></para> +</example> </refsect1> diff --git a/docs/reference/pygtk-gtkaccessible.xml b/docs/reference/pygtk-gtkaccessible.xml index 412f208d..b69f70aa 100644 --- a/docs/reference/pygtk-gtkaccessible.xml +++ b/docs/reference/pygtk-gtkaccessible.xml @@ -33,6 +33,21 @@ linkend="method-gtkaccessible--connect-widget-destroyed">connect_widget_destroye </refsect1> + <refsect1 id="properties-gtkaccessible"> + <title>gtk.Accessible Properties</title> + + <para><link linkend="properties-atkobject">atk.Object Properties</link></para> + + + </refsect1> + + <refsect1 id="signal-prototypes-gtkaccessible"> + <title>gtk.Accessible Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-atkobject">atk.Object Signal Prototypes</link></para> +</refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkaction.xml b/docs/reference/pygtk-gtkaction.xml index c1a577d4..67e8bf83 100644 --- a/docs/reference/pygtk-gtkaction.xml +++ b/docs/reference/pygtk-gtkaction.xml @@ -118,8 +118,8 @@ item (new in PyGTK 2.4)</refpurpose> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkaction"> + <title>gtk.Action Properties</title> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -224,8 +224,10 @@ visible when the toolbar is in a vertical orientation.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkaction"> + <title>gtk.Action Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkactiongroup.xml b/docs/reference/pygtk-gtkactiongroup.xml index 3a18bc6e..06b97659 100644 --- a/docs/reference/pygtk-gtkactiongroup.xml +++ b/docs/reference/pygtk-gtkactiongroup.xml @@ -95,8 +95,8 @@ </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkactiongroup"> + <title>gtk.ActionGroup Properties</title> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -133,8 +133,10 @@ visible.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkactiongroup"> + <title>gtk.ActionGroup Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkadjustment.xml b/docs/reference/pygtk-gtkadjustment.xml index 63b646dd..6c3aead1 100644 --- a/docs/reference/pygtk-gtkadjustment.xml +++ b/docs/reference/pygtk-gtkadjustment.xml @@ -88,50 +88,14 @@ linkend="method-gtkadjustment--set-value">set_value</link></methodname> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="properties-gtkadjustment"> + <title>gtk.Adjustment Properties</title> - <variablelist> - <varlistentry> - <term>"<link -linkend="signal-gtkadjustment--changed">changed</link>"</term> - <listitem> - <methodsynopsis - language="python"><methodname>callback</methodname> - <methodparam><parameter>adjustment</parameter> - </methodparam> - <methodparam><parameter>user_param1</parameter> - </methodparam> - <methodparam><parameter>...</parameter> - </methodparam> - </methodsynopsis> - </listitem> - </varlistentry> - <varlistentry> - <term>"<link -linkend="signal-gtkadjustment--value-changed">value-changed</link>"</term> - <listitem> - <methodsynopsis - language="python"><methodname>callback</methodname> - <methodparam><parameter>adjustment</parameter> - </methodparam> - <methodparam><parameter>user_param1</parameter> - </methodparam> - <methodparam><parameter>...</parameter> - </methodparam> - </methodsynopsis> - </listitem> - </varlistentry> - </variablelist> - - </refsect1> - - <refsect1> - <title>Properties</title> + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> <note> - <para>These properties are only available in GTK+ 2.4 and above. The - GTK+ version is contained in the 3-tuple gtk.gtk_version.</para> + <para>These properties are available in GTK+ 2.4 and above. The GTK+ + version is contained in the 3-tuple gtk.gtk_version.</para> </note> <blockquote role="properties"> @@ -249,6 +213,47 @@ this is the size of the area which is currently visible. (float)</entry> </refsect1> + <refsect1 id="signal-prototypes-gtkadjustment"> + <title>gtk.Adjustment 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> + + <variablelist> + <varlistentry> + <term>"<link +linkend="signal-gtkadjustment--changed">changed</link>"</term> + <listitem> + <methodsynopsis + language="python"><methodname>callback</methodname> + <methodparam><parameter>adjustment</parameter> + </methodparam> + <methodparam><parameter>user_param1</parameter> + </methodparam> + <methodparam><parameter>...</parameter> + </methodparam> + </methodsynopsis> + </listitem> + </varlistentry> + <varlistentry> + <term>"<link +linkend="signal-gtkadjustment--value-changed">value-changed</link>"</term> + <listitem> + <methodsynopsis + language="python"><methodname>callback</methodname> + <methodparam><parameter>adjustment</parameter> + </methodparam> + <methodparam><parameter>user_param1</parameter> + </methodparam> + <methodparam><parameter>...</parameter> + </methodparam> + </methodsynopsis> + </listitem> + </varlistentry> + </variablelist> + + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkalignment.xml b/docs/reference/pygtk-gtkalignment.xml index 9bc2e4f7..9fb07ab0 100644 --- a/docs/reference/pygtk-gtkalignment.xml +++ b/docs/reference/pygtk-gtkalignment.xml @@ -73,8 +73,13 @@ linkend="method-gtkalignment--get-padding">get_padding</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkalignment"> + <title>gtk.Alignment 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"> @@ -84,41 +89,23 @@ linkend="method-gtkalignment--get-padding">get_padding</link></methodname> <colspec column="3" colwidth="3.5in"/> <tbody> - <row valign="top"> - <entry>"xalign"</entry> - <entry>Read/Write</entry> - <entry>The fraction of horizontal <emphasis>free</emphasis> space to -the left of the child. 0.0 means no <emphasis>free</emphasis> space to the -left, 1.0 means all <emphasis>free</emphasis> space to the left.</entry> - </row> - <row valign="top"> - <entry>"yalign"</entry> - <entry>Read/Write</entry> - <entry>The fraction of vertical <emphasis>free</emphasis> space -above the child. 0.0 means no <emphasis>free</emphasis> space above, 1.0 -means all <emphasis>free</emphasis> space above.</entry> + <entry>"bottom-padding"</entry> <entry>Read/Write</entry> + <entry>The padding to insert at the bottom of the widget. GTK+ 2.4 + and above.</entry> </row> <row valign="top"> - <entry>"xscale"</entry> + <entry>"left-padding"</entry> <entry>Read/Write</entry> - <entry>The fraction of horizontal <emphasis>free</emphasis> space -(beyond that needed by the child) that the child will absorb. 0.0 means the -child will absorb none, 1.0 means the child will absorb all</entry> + <entry>The padding to insert at the left of the widget. GTK+ 2.4 + and above.</entry> </row> <row valign="top"> - <entry>"yscale"</entry> + <entry>"right-padding"</entry> <entry>Read/Write</entry> - <entry>The fraction of vertical <emphasis>free</emphasis> space -(beyond that needed by the child) that the child will absorb. 0.0 means the -child will absorb none, 1.0 means the child will absorb all</entry> - </row> - - <row valign="top"> - <entry>"bottom-padding"</entry> <entry>Read/Write</entry> - <entry>The padding to insert at the bottom of the widget. GTK+ 2.4 + <entry>The padding to insert at the right of the widget. GTK+ 2.4 and above.</entry> </row> @@ -129,18 +116,38 @@ child will absorb none, 1.0 means the child will absorb all</entry> and above.</entry> </row> + <row valign="top"> + <entry>"xalign"</entry> + <entry>Read/Write</entry> + <entry>The fraction of horizontal <emphasis>free</emphasis> space + to the left of the child. 0.0 means no <emphasis>free</emphasis> + space to the left, 1.0 means all <emphasis>free</emphasis> space + to the left.</entry> + </row> + <row valign="top"> - <entry>"left-padding"</entry> + <entry>"xscale"</entry> <entry>Read/Write</entry> - <entry>The padding to insert at the left of the widget. GTK+ 2.4 - and above.</entry> + <entry>The fraction of horizontal <emphasis>free</emphasis> space +(beyond that needed by the child) that the child will absorb. 0.0 means the +child will absorb none, 1.0 means the child will absorb all</entry> </row> <row valign="top"> - <entry>"right-padding"</entry> + <entry>"yalign"</entry> <entry>Read/Write</entry> - <entry>The padding to insert at the right of the widget. GTK+ 2.4 - and above.</entry> + <entry>The fraction of vertical <emphasis>free</emphasis> space + above the child. 0.0 means no <emphasis>free</emphasis> space + above, 1.0 means all <emphasis>free</emphasis> space + above.</entry> + </row> + + <row valign="top"> + <entry>"yscale"</entry> + <entry>Read/Write</entry> + <entry>The fraction of vertical <emphasis>free</emphasis> space +(beyond that needed by the child) that the child will absorb. 0.0 means the +child will absorb none, 1.0 means the child will absorb all</entry> </row> </tbody> @@ -150,6 +157,23 @@ child will absorb none, 1.0 means the child will absorb all</entry> </refsect1> + <refsect1 id="style-properties-gtkalignment"> + <title>gtk.Alignment Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + + </refsect1> + + <refsect1 id="signal-prototypes-gtkalignment"> + <title>gtk.Alignment 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> +</refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkarrow.xml b/docs/reference/pygtk-gtkarrow.xml index dab946f6..e992151d 100644 --- a/docs/reference/pygtk-gtkarrow.xml +++ b/docs/reference/pygtk-gtkarrow.xml @@ -47,8 +47,12 @@ linkend="method-gtkarrow--set">set</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkarrow"> + <title>gtk.Arrow 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-gtkmisc">gtk.Misc Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -68,8 +72,9 @@ gtk.ARROW_DOWN, gtk.ARROW_LEFT, or gtk.ARROW_RIGHT)</entry> <row valign="top"> <entry>"shadow-type"</entry> <entry>Read/Write</entry> - <entry>Appearance of the shadow surrounding the arrow (gtk.SHADOW -IN, gtk.SHADOW OUT, gtk.ETCHED IN, or gtk.ETCHED OUT)</entry> + <entry>Appearance of the shadow surrounding the arrow + (<literal>gtk.SHADOW IN, gtk.SHADOW OUT, gtk.ETCHED IN, or + gtk.ETCHED OUT</literal>)</entry> </row> </tbody> @@ -79,6 +84,22 @@ IN, gtk.SHADOW OUT, gtk.ETCHED IN, or gtk.ETCHED OUT)</entry> </refsect1> + <refsect1 id="style-properties-gtkarrow"> + <title>gtk.Arrow Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + + </refsect1> + + <refsect1 id="signal-prototypes-gtkarrow"> + <title>gtk.Arrow 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> +</refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkaspectframe.xml b/docs/reference/pygtk-gtkaspectframe.xml index ec14cff5..11a15e1a 100644 --- a/docs/reference/pygtk-gtkaspectframe.xml +++ b/docs/reference/pygtk-gtkaspectframe.xml @@ -59,9 +59,13 @@ linkend="method-gtkaspectframe--set">set</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkaspectframe"> + <title>gtk.AspectFrame 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> + <para><link linkend="properties-gtkframe">gtk.Frame Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> <tgroup cols="3"> @@ -70,34 +74,36 @@ linkend="method-gtkaspectframe--set">set</link></methodname> <colspec column="3" colwidth="4.5in"/> <tbody> - <row valign="top"> - <entry>"xalign"</entry> - <entry>Read/Write</entry> - <entry>The fraction of horizontal <emphasis>free</emphasis> space to -the left of the child. 0.0 means no <emphasis>free</emphasis> space to the -left, 1.0 means all <emphasis>free</emphasis> space to the left.</entry> - </row> + <row valign="top"> + <entry>"obey-child"</entry> + <entry>Read/Write</entry> + <entry>Make aspect ratio match that of the child widget</entry> + </row> <row valign="top"> - <entry>"yalign"</entry> + <entry>"xalign"</entry> <entry>Read/Write</entry> - <entry>The fraction of vertical <emphasis>free</emphasis> space -above the child. 0.0 means no <emphasis>free</emphasis> space above, 1.0 -means all <emphasis>free</emphasis> space above.</entry> + <entry>The fraction of horizontal <emphasis>free</emphasis> space + to the left of the child. 0.0 means no <emphasis>free</emphasis> + space to the left, 1.0 means all <emphasis>free</emphasis> space + to the left.</entry> </row> <row valign="top"> <entry>"ratio"</entry> <entry>Read/Write</entry> <entry>The aspect ratio of the widget in the range of 0.0001 to -10000.0 if "obey-child" is FALSE.</entry> + 10000.0 if "obey-child" is <literal>FALSE</literal>.</entry> </row> - <row valign="top"> - <entry>"obey-child"</entry> - <entry>Read/Write</entry> - <entry>Make aspect ratio match that of the child widget</entry> - </row> + <row valign="top"> + <entry>"yalign"</entry> + <entry>Read/Write</entry> + <entry>The fraction of vertical <emphasis>free</emphasis> space + above the child. 0.0 means no <emphasis>free</emphasis> space + above, 1.0 means all <emphasis>free</emphasis> space + above.</entry> + </row> </tbody> </tgroup> @@ -106,6 +112,23 @@ means all <emphasis>free</emphasis> space above.</entry> </refsect1> + <refsect1 id="style-properties-gtkaspectframe"> + <title>gtk.AspectFrame Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + + </refsect1> + + <refsect1 id="signal-prototypes-gtkaspectframe"> + <title>gtk.AspectFrame 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> +</refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkbin.xml b/docs/reference/pygtk-gtkbin.xml index 55bfa11e..9de8dd51 100644 --- a/docs/reference/pygtk-gtkbin.xml +++ b/docs/reference/pygtk-gtkbin.xml @@ -36,6 +36,33 @@ linkend="method-gtkbin--get-child">get_child</link></methodname> </refsect1> + <refsect1 id="properties-gtkbin"> + <title>gtk.Bin 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> + + + </refsect1> + + <refsect1 id="style-properties-gtkbin"> + <title>gtk.Bin Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + + </refsect1> + + <refsect1 id="signal-prototypes-gtkbin"> + <title>gtk.Bin 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> +</refsect1> + <refsect1> <title>Attributes</title> diff --git a/docs/reference/pygtk-gtkborder.xml b/docs/reference/pygtk-gtkborder.xml index 83dc4b01..59294189 100644 --- a/docs/reference/pygtk-gtkborder.xml +++ b/docs/reference/pygtk-gtkborder.xml @@ -86,11 +86,11 @@ border object.</para> <warning> <para>This method is deprecated and should not be used since it can - crash your application.</para> + crash your application.</para> </warning> <para>The <methodname>free</methodname>() method frees the memory used -by the border.</para> + by the border.</para> </refsect2> diff --git a/docs/reference/pygtk-gtkbox.xml b/docs/reference/pygtk-gtkbox.xml index 801218ec..48e33c59 100644 --- a/docs/reference/pygtk-gtkbox.xml +++ b/docs/reference/pygtk-gtkbox.xml @@ -115,8 +115,12 @@ linkend="method-gtkbox--set-child-packing">set_child_packing</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkbox"> + <title>gtk.Box 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"> @@ -138,6 +142,12 @@ linkend="method-gtkbox--set-child-packing">set_child_packing</link></methodname> <entry>If TRUE the children should all be the same size.</entry> </row> + <row valign="top"> + <entry>"spacing"</entry> + <entry>Read/Write</entry> + <entry>The amount of space between children.</entry> + </row> + </tbody> </tgroup> </informaltable> @@ -145,59 +155,78 @@ linkend="method-gtkbox--set-child-packing">set_child_packing</link></methodname> </refsect1> - <refsect1> - <title>Child Properties</title> + <refsect1 id="style-properties-gtkbox"> + <title>gtk.Box Style Properties</title> - <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="3.5in"/> - <tbody> + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> - <row valign="top"> - <entry>"expand"</entry> - <entry>Read/Write</entry> - <entry>If TRUE the child should receive extra space when the parent -grows</entry> - </row> - <row valign="top"> - <entry>"fill"</entry> - <entry>Read/Write</entry> - <entry>If TRUE extra space given to the child should be allocated -to the child; if FALSE extra space given to the child should be used as -padding</entry> - </row> - - <row valign="top"> - <entry>"padding"</entry> - <entry>Read/Write</entry> - <entry>The amount of extra space to put between the child and its -neighbors, in pixels</entry> - </row> - - <row valign="top"> - <entry>"pack-type"</entry> - <entry>Read/Write</entry> - <entry>Indicates whether the child is packed with reference to the -start (gtk.PACK_START) or end (gtk.PACK_END) of the parent</entry> - </row> + </refsect1> - <row valign="top"> - <entry>"position"</entry> - <entry>Read/Write</entry> - <entry>The index of the child in the parent</entry> - </row> + <refsect1 id="child-properties-gtkbox"> + <title>gtk.Box Child Properties</title> - </tbody> - </tgroup> + <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="3.5in"/> + <tbody> + + <row valign="top"> + <entry>"expand"</entry> + <entry>Read/Write</entry> + <entry>If <literal>TRUE</literal> the child should receive + extra space when the parent grows</entry> + </row> + + <row valign="top"> + <entry>"fill"</entry> + <entry>Read/Write</entry> + <entry>If <literal>TRUE</literal> extra space given to the + child should be allocated to the child; if + <literal>FALSE</literal> extra space given to the child should + be used as padding</entry> + </row> + + <row valign="top"> + <entry>"padding"</entry> + <entry>Read/Write</entry> + <entry>The amount of extra space to put between the child and + its neighbors, in pixels</entry> + </row> + + <row valign="top"> + <entry>"pack-type"</entry> + <entry>Read/Write</entry> + <entry>Indicates whether the child is packed with reference to + the start (<literal>gtk.PACK_START</literal>) or end + (<literal>gtk.PACK_END</literal>) of the parent</entry> + </row> + + <row valign="top"> + <entry>"position"</entry> + <entry>Read/Write</entry> + <entry>The index of the child in the parent</entry> + </row> + + </tbody> + </tgroup> </informaltable> </blockquote> </refsect1> + <refsect1 id="signal-prototypes-gtkbox"> + <title>gtk.Box 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> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkbutton.xml b/docs/reference/pygtk-gtkbutton.xml index 98b94a73..1fd9c37c 100644 --- a/docs/reference/pygtk-gtkbutton.xml +++ b/docs/reference/pygtk-gtkbutton.xml @@ -136,8 +136,12 @@ linkend="method-gtkbutton--get-image">get_image</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkbutton"> + <title>gtk.Button 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"> @@ -242,8 +246,10 @@ This property is available in GTK+ 2.4 and above.</entry> </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="style-properties-gtkbutton"> + <title>gtk.Button Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -308,8 +314,13 @@ when the button is depressed. Default value: 0</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkbutton"> + <title>gtk.Button 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> diff --git a/docs/reference/pygtk-gtkbuttonbox.xml b/docs/reference/pygtk-gtkbuttonbox.xml index 1c909427..791c79d4 100644 --- a/docs/reference/pygtk-gtkbuttonbox.xml +++ b/docs/reference/pygtk-gtkbuttonbox.xml @@ -57,8 +57,13 @@ linkend="method-gtkbuttonbox--set-child-secondary">set_child_secondary</link></m </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkbuttonbox"> + <title>gtk.ButtonBox 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> + <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -85,8 +90,10 @@ styles are: <literal>gtk.BUTTONBOX_SPREAD</literal>, </refsect1> - <refsect1> - <title>Child Properties</title> + <refsect1 id="style-properties-gtkbuttonbox"> + <title>gtk.ButtonBox Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -97,11 +104,30 @@ styles are: <literal>gtk.BUTTONBOX_SPREAD</literal>, <tbody> <row valign="top"> - <entry>"secondary"</entry> - <entry>Read/Write</entry> - <entry>If <literal>TRUE</literal>, the child appears in a secondary -group of children, suitable for, e.g., help buttons.</entry> - </row> + <entry>"child-internal-pad-x"</entry> + <entry>Read</entry> + <entry>The amount of padding that increases a child's size on + the top and bottom</entry> + </row> + + <row valign="top"> + <entry>"child-internal-pad-y"</entry> + <entry>Read</entry> + <entry>The amount of padding that increases a child's size on + the top and bottom</entry> + </row> + + <row valign="top"> + <entry>"child-min-height"</entry> + <entry>Read</entry> + <entry>The minimum height of buttons inside the box.</entry> + </row> + + <row valign="top"> + <entry>"child-min-width"</entry> + <entry>Read</entry> + <entry>The minimum width of buttons inside the box.</entry> + </row> </tbody> </tgroup> @@ -110,8 +136,10 @@ group of children, suitable for, e.g., help buttons.</entry> </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="child-properties-gtkbuttonbox"> + <title>gtk.ButtonBox Child Properties</title> + + <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -122,30 +150,11 @@ group of children, suitable for, e.g., help buttons.</entry> <tbody> <row valign="top"> - <entry>"child-min-width"</entry> - <entry>Read</entry> - <entry>The minimum width of buttons inside the box.</entry> - </row> - - <row valign="top"> - <entry>"child-min-height"</entry> - <entry>Read</entry> - <entry>The minimum height of buttons inside the box.</entry> - </row> - - <row valign="top"> - <entry>"child-internal-pad-y"</entry> - <entry>Read</entry> - <entry>The amount of padding that increases a child's size on -the top and bottom</entry> - </row> - - <row valign="top"> - <entry>"child-internal-pad-x"</entry> - <entry>Read</entry> - <entry>The amount of padding that increases a child's size on -the top and bottom</entry> - </row> + <entry>"secondary"</entry> + <entry>Read/Write</entry> + <entry>If <literal>TRUE</literal>, the child appears in a secondary +group of children, suitable for, e.g., help buttons.</entry> + </row> </tbody> </tgroup> @@ -154,6 +163,15 @@ the top and bottom</entry> </refsect1> + <refsect1 id="signal-prototypes-gtkbuttonbox"> + <title>gtk.ButtonBox 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> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkcalendar.xml b/docs/reference/pygtk-gtkcalendar.xml index 52da0cf9..67f4c579 100644 --- a/docs/reference/pygtk-gtkcalendar.xml +++ b/docs/reference/pygtk-gtkcalendar.xml @@ -90,8 +90,11 @@ linkend="method-gtkcalendar--thaw">thaw</link></methodname> +-- <link linkend="class-gtkcalendar">gtk.Calendar</link> </synopsis> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkcalendar"> + <title>gtk.Calendar Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para> <note> <para>These properties are available in GTK+ 2.4 and above.</para> @@ -161,8 +164,19 @@ displayed.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="style-properties-gtkcalendar"> + <title>gtk.Calendar Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkcalendar"> + <title>gtk.Calendar 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> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkcelleditable.xml b/docs/reference/pygtk-gtkcelleditable.xml index 3c1bee38..05a3137b 100644 --- a/docs/reference/pygtk-gtkcelleditable.xml +++ b/docs/reference/pygtk-gtkcelleditable.xml @@ -32,8 +32,8 @@ linkend="method-gtkcelleditable--remove-widget">remove_widget</link></methodname </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkcelleditable"> + <title>gtk.CellEditable Signal Prototypes</title> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkcellrenderer.xml b/docs/reference/pygtk-gtkcellrenderer.xml index 95f10d2f..8418ba51 100644 --- a/docs/reference/pygtk-gtkcellrenderer.xml +++ b/docs/reference/pygtk-gtkcellrenderer.xml @@ -5,8 +5,8 @@ <refentry id="class-gtkcellrenderer"> <refnamediv> <refname>gtk.CellRenderer</refname> - <refpurpose>a base class for objects that render into Treeview -cells</refpurpose> + <refpurpose>a base class for objects that render on a <link + linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link></refpurpose> </refnamediv> <refsect1> @@ -109,8 +109,10 @@ linkend="method-gtkcellrenderer--get-fixed-size">get_fixed_size</link></methodna </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkcellrenderer"> + <title>gtk.CellRenderer Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -194,30 +196,30 @@ Default: -1.</entry> <entry>"xalign"</entry> <entry>Read/Write</entry> <entry>The fraction of <emphasis>free</emphasis> space to the left -of the cell in the range 0.0 to 1.0. Allowed values between 0 and 1. -Default: 0.5.</entry> + of the cell in the range 0.0 to 1.0. Allowed values between 0 and + 1. Default: 0.5.</entry> </row> <row valign="top"> <entry>"xpad"</entry> <entry>Read/Write</entry> <entry>The amount of padding to the left and right of the -cell. Default: 0.</entry> + cell. Default: 0.</entry> </row> <row valign="top"> <entry>"yalign"</entry> <entry>Read/Write</entry> <entry>The fraction of <emphasis>free</emphasis> space above the -cell in the range 0.0 to 1.0. Allowed values between 0 and 1. -Default: 0.5.</entry> + cell in the range 0.0 to 1.0. Allowed values between 0 and 1. + Default: 0.5.</entry> </row> <row valign="top"> <entry>"ypad"</entry> <entry>Read/Write</entry> - <entry>The amount of padding above and below cell. -Default: 0.</entry> + <entry>The amount of padding above and below cell. Default: + 0.</entry> </row> </tbody> @@ -227,8 +229,11 @@ Default: 0.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkcellrenderer"> + <title>gtk.CellRenderer 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> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkcellrendereraccel.xml b/docs/reference/pygtk-gtkcellrendereraccel.xml index 63d89943..19ea8546 100644 --- a/docs/reference/pygtk-gtkcellrendereraccel.xml +++ b/docs/reference/pygtk-gtkcellrendereraccel.xml @@ -36,8 +36,12 @@ </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkcellrendereraccel"> + <title>gtk.CellRendererAccel Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + <para><link linkend="properties-gtkcellrenderer">gtk.CellRenderer Properties</link></para> + <para><link linkend="properties-gtkcellrenderertext">gtk.CellRendererText Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -95,8 +99,13 @@ </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkcellrendereraccel"> + <title>gtk.CellRendererAccel 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-gtkcellrenderer">gtk.CellRenderer Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkcellrenderertext">gtk.CellRendererText Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkcellrenderercombo.xml b/docs/reference/pygtk-gtkcellrenderercombo.xml index 4bb2125e..636be958 100644 --- a/docs/reference/pygtk-gtkcellrenderercombo.xml +++ b/docs/reference/pygtk-gtkcellrenderercombo.xml @@ -40,8 +40,12 @@ linkend="constructor-gtkcellrenderercombo">gtk.CellRendererCombo</link></methodn </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkcellrenderercombo"> + <title>gtk.CellRendererCombo Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + <para><link linkend="properties-gtkcellrenderer">gtk.CellRenderer Properties</link></para> + <para><link linkend="properties-gtkcellrenderertext">gtk.CellRendererText Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -81,6 +85,15 @@ above.</entry> </refsect1> + <refsect1 id="signal-prototypes-gtkcellrenderercombo"> + <title>gtk.CellRendererCombo 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-gtkcellrenderer">gtk.CellRenderer Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkcellrenderertext">gtk.CellRendererText Signal Prototypes</link></para> +</refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkcellrendererpixbuf.xml b/docs/reference/pygtk-gtkcellrendererpixbuf.xml index e70c7513..63570277 100644 --- a/docs/reference/pygtk-gtkcellrendererpixbuf.xml +++ b/docs/reference/pygtk-gtkcellrendererpixbuf.xml @@ -37,8 +37,11 @@ linkend="constructor-gtkcellrendererpixbuf">gtk.CellRendererPixbuf</link></metho </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkcellrendererpixbuf"> + <title>gtk.CellRendererPixbuf Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + <para><link linkend="properties-gtkcellrenderer">gtk.CellRenderer Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -48,49 +51,76 @@ linkend="constructor-gtkcellrendererpixbuf">gtk.CellRendererPixbuf</link></metho <colspec column="3" colwidth="3.5in"/> <tbody> - <row valign="top"> - <entry>"pixbuf"</entry> - <entry>Read/Write</entry> - <entry>The pixbuf to render.</entry> - </row> - - <row valign="top"> - <entry>"pixbuf-expander-open"</entry> - <entry>Read/Write</entry> - <entry>Pixbuf for open expander.</entry> - </row> - - <row valign="top"> - <entry>"pixbuf-expander-closed"</entry> - <entry>Read/Write</entry> - <entry>Pixbuf for closed expander.</entry> - </row> - - <row valign="top"> - <entry>"stock-id"</entry> - <entry>Read/Write</entry> - <entry>The stock ID of the stock icon to render</entry> - </row> - - <row valign="top"> - <entry>"stock-size"</entry> - <entry>Read/Write</entry> - <entry>The size of the rendered icon</entry> - </row> - - <row valign="top"> - <entry>"stock-detail"</entry> - <entry>Read/Write</entry> - <entry>Render detail to pass to the theme engine</entry> - </row> - - </tbody> - </tgroup> + <row valign="top"> + <entry>"follow-state"</entry> + <entry>Read-Write</entry> + <entry>If <literal>TRUE</literal> the rendered pixbuf should be + colorized according to the <xref + linkend="gtk-cellrenderer-state-constants" + endterm="gtk-cellrenderer-state-constants-title"></xref>. This + property is available in GTK+ 2.8 and above.</entry> + </row> + + <row valign="top"> + <entry>"icon-name"</entry> + <entry>Read-Write</entry> + <entry>The name of the themed icon to display. This property only + has an effect if not overridden by "stock_id" or "pixbuf" + properties. This property is available in GTK+ 2.8 and + above.</entry> + </row> + + <row valign="top"> + <entry>"pixbuf"</entry> + <entry>Read/Write</entry> + <entry>The pixbuf to render.</entry> + </row> + + <row valign="top"> + <entry>"pixbuf-expander-closed"</entry> + <entry>Read/Write</entry> + <entry>Pixbuf for closed expander.</entry> + </row> + + <row valign="top"> + <entry>"pixbuf-expander-open"</entry> + <entry>Read/Write</entry> + <entry>Pixbuf for open expander.</entry> + </row> + + <row valign="top"> + <entry>"stock-detail"</entry> + <entry>Read/Write</entry> + <entry>Render detail to pass to the theme engine</entry> + </row> + + <row valign="top"> + <entry>"stock-id"</entry> + <entry>Read/Write</entry> + <entry>The stock ID of the stock icon to render</entry> + </row> + + <row valign="top"> + <entry>"stock-size"</entry> + <entry>Read/Write</entry> + <entry>The size of the rendered icon</entry> + </row> + + </tbody> + </tgroup> </informaltable> </blockquote> </refsect1> + <refsect1 id="signal-prototypes-gtkcellrendererpixbuf"> + <title>gtk.CellRendererPixbuf 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-gtkcellrenderer">gtk.CellRenderer Signal Prototypes</link></para> +</refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkcellrendererprogress.xml b/docs/reference/pygtk-gtkcellrendererprogress.xml index 9efa2493..4f57e85e 100644 --- a/docs/reference/pygtk-gtkcellrendererprogress.xml +++ b/docs/reference/pygtk-gtkcellrendererprogress.xml @@ -37,8 +37,11 @@ linkend="constructor-gtkcellrendererprogress">gtk.CellRendererProgress</link></m </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkcellrendererprogress"> + <title>gtk.CellRendererProgress Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + <para><link linkend="properties-gtkcellrenderer">gtk.CellRenderer Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -72,6 +75,14 @@ Available in GTK+ 2.6 and above.</entry> </refsect1> + <refsect1 id="signal-prototypes-gtkcellrendererprogress"> + <title>gtk.CellRendererProgress 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-gtkcellrenderer">gtk.CellRenderer Signal Prototypes</link></para> +</refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkcellrendererspin.xml b/docs/reference/pygtk-gtkcellrendererspin.xml index c4171d71..f319fa63 100644 --- a/docs/reference/pygtk-gtkcellrendererspin.xml +++ b/docs/reference/pygtk-gtkcellrendererspin.xml @@ -36,8 +36,12 @@ </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkcellrendererspin"> + <title>gtk.CellRendererSpin Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + <para><link linkend="properties-gtkcellrenderer">gtk.CellRenderer Properties</link></para> + <para><link linkend="properties-gtkcellrenderertext">gtk.CellRendererText Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -80,6 +84,15 @@ </refsect1> + <refsect1 id="signal-prototypes-gtkcellrendererspin"> + <title>gtk.CellRendererSpin 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-gtkcellrenderer">gtk.CellRenderer Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkcellrenderertext">gtk.CellRendererText Signal Prototypes</link></para> +</refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkcellrenderertext.xml b/docs/reference/pygtk-gtkcellrenderertext.xml index 57dbb554..db4cbf4a 100644 --- a/docs/reference/pygtk-gtkcellrenderertext.xml +++ b/docs/reference/pygtk-gtkcellrenderertext.xml @@ -42,8 +42,11 @@ linkend="method-gtkcellrenderertext--set-fixed-height-from-font">set_fixed_heigh </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkcellrenderertext"> + <title>gtk.CellRendererText Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + <para><link linkend="properties-gtkcellrenderer">gtk.CellRenderer Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -340,14 +343,33 @@ weight. Default: <literal>FALSE</literal></entry> <row valign="top"> <entry>"width-chars"</entry> - <entry>Read/Write</entry> - <entry>The desired width of the cell, in characters. If this -property is set to -1, the width will be calculated automatically, -otherwise the cell will request either 3 characters or the property -value, whichever is greater. GTK+ 2.6 and above. -Allowed values >= -1. Default value: -1</entry> + <entry>Read/Write</entry> <entry>The desired width of the cell, in + characters. If this property is set to -1, the width will be + calculated automatically, otherwise the cell will request either 3 + characters or the property value, whichever is greater. GTK+ 2.6 + and above. Allowed values >= -1. Default value: -1</entry> </row> + <row valign="top"> + <entry>"wrap-mode"</entry> + <entry>Read-Write</entry> + <entry>Specifies how to break the string into multiple lines, if + the cell renderer does not have enough room to display the entire + string. This property has no effect unless the "wrap-width" + property is set. This property is available in GTK+ 2.8 and + above.</entry> + </row> + + <row valign="top"> + <entry>"wrap-width"</entry> + <entry>Read-Write</entry> + <entry>Specifies the width at which the text is wrapped. The + "wrap-mode" property can be used to influence at what character + positions the line breaks can be placed. Setting "wrap-width" to + -1 turns wrapping off. This property is available in GTK+ 2.8 and + above.</entry> + </row> + </tbody> </tgroup> </informaltable> @@ -355,8 +377,12 @@ Allowed values >= -1. Default value: -1</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkcellrenderertext"> + <title>gtk.CellRendererText 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-gtkcellrenderer">gtk.CellRenderer Signal Prototypes</link></para> <variablelist> <varlistentry> @@ -386,10 +412,12 @@ linkend="signal-gtkcellrenderertext--edited">edited</link>"</term> <title>Description</title> <para>The <link -linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link> -manages the rendering of text into a <link -linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link> -cell.</para> + linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link> + manages the rendering of text into a <link + linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link> + cell, using the font, color and style information provided by its + properties. The text will be ellipsized if it is too long and the + "ellipsize" property allows it.</para> </refsect1> diff --git a/docs/reference/pygtk-gtkcellrenderertoggle.xml b/docs/reference/pygtk-gtkcellrenderertoggle.xml index 161a16b8..46cff912 100644 --- a/docs/reference/pygtk-gtkcellrenderertoggle.xml +++ b/docs/reference/pygtk-gtkcellrenderertoggle.xml @@ -54,8 +54,11 @@ linkend="method-gtkcellrenderertoggle--set-active">set_active</link></methodname </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkcellrenderertoggle"> + <title>gtk.CellRendererToggle Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + <para><link linkend="properties-gtkcellrenderer">gtk.CellRenderer Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -69,7 +72,7 @@ linkend="method-gtkcellrenderertoggle--set-active">set_active</link></methodname <entry>"activatable"</entry> <entry>Read/Write</entry> <entry>If <literal>TRUE</literal>, the toggle button can be -activated</entry> + activated</entry> </row> <row valign="top"> @@ -79,17 +82,24 @@ activated</entry> </row> <row valign="top"> - <entry>"radio"</entry> + <entry>"inconsistent"</entry> <entry>Read/Write</entry> - <entry>If <literal>TRUE</literal>, draw the toggle button as a -radio button</entry> + <entry>If <literal>TRUE</literal>, the button is in an + inconsistent state. GTK+ 2.2 and above.</entry> </row> + <row valign="top"> + <entry>"indicator-size"</entry> + <entry>Read-Write</entry> + <entry>Size of check or radio indicator. Allowed values: >= 0. + Default value: 12.</entry> + </row> + <row valign="top"> - <entry>"inconsistent"</entry> + <entry>"radio"</entry> <entry>Read/Write</entry> - <entry>If <literal>TRUE</literal>, the button is in an inconsistent -state. GTK+ 2.2 and above.</entry> + <entry>If <literal>TRUE</literal>, draw the toggle button as a + radio button</entry> </row> </tbody> @@ -99,8 +109,12 @@ state. GTK+ 2.2 and above.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkcellrenderertoggle"> + <title>gtk.CellRendererToggle 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-gtkcellrenderer">gtk.CellRenderer Signal Prototypes</link></para> <variablelist> <varlistentry> @@ -128,10 +142,11 @@ linkend="signal-gtkcellrenderertoggle--toggled">toggled</link>"</term> <title>Description</title> <para>The <link -linkend="class-gtkcellrenderertoggle"><classname>gtk.CellRendererToggle</classname></link> -manages the rendering of toggle button into a <link -linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link> -cell.</para> + linkend="class-gtkcellrenderertoggle"><classname>gtk.CellRendererToggle</classname></link> + manages the rendering of toggle button into a <link + linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link> + cell. The button is drawn as a radio- or checkbutton, depending on the + "radio" property. When activated, it emits the toggled signal.</para> </refsect1> diff --git a/docs/reference/pygtk-gtkcellview.xml b/docs/reference/pygtk-gtkcellview.xml index 280e1c42..2a7fdd1c 100644 --- a/docs/reference/pygtk-gtkcellview.xml +++ b/docs/reference/pygtk-gtkcellview.xml @@ -16,6 +16,7 @@ linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> <classsynopsis language="python"> <ooclass><classname>gtk.CellView</classname></ooclass> <ooclass><classname><link linkend="class-gtkwidget">gtk.Widget</link></classname></ooclass> + <ooclass><classname><link linkend="class-gtkcelllayout">gtk.CellLayout</link></classname></ooclass> <constructorsynopsis language="python"> <methodname><link linkend="constructor-gtkcellview">gtk.CellView</link></methodname> @@ -70,13 +71,16 @@ linkend="constructor-gtkcellview">gtk.CellView</link></methodname> <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-gtkcellview">gtk.CellView</link> + +-- <link linkend="class-gtkcellview">gtk.CellView</link> (implements <link linkend="class-gtkcelllayout">gtk.CellLayout</link>) </synopsis> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkcellview"> + <title>gtk.CellView Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -107,6 +111,13 @@ linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>.</entry> property to set the background color.</entry> </row> + <row valign="top"> + <entry>"model"</entry> + <entry>Read-Write</entry> + <entry>The model for cell view. Available in GTK+ 2.10 and + above.</entry> + </row> + </tbody> </tgroup> </informaltable> @@ -114,6 +125,21 @@ property to set the background color.</entry> </refsect1> + <refsect1 id="style-properties-gtkcellview"> + <title>gtk.CellView Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkcellview"> + <title>gtk.CellView 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> +</refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkcheckbutton.xml b/docs/reference/pygtk-gtkcheckbutton.xml index 6d0e88df..b26a9f1d 100644 --- a/docs/reference/pygtk-gtkcheckbutton.xml +++ b/docs/reference/pygtk-gtkcheckbutton.xml @@ -43,8 +43,22 @@ linkend="constructor-gtkcheckbutton">gtk.CheckButton</link></methodname> </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="properties-gtkcheckbutton"> + <title>gtk.CheckButton 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> + <para><link linkend="properties-gtkbutton">gtk.Button Properties</link></para> + <para><link linkend="properties-gtktogglebutton">gtk.ToggleButton Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkcheckbutton"> + <title>gtk.CheckButton Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkbutton">gtk.Button Style Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -54,25 +68,36 @@ linkend="constructor-gtkcheckbutton">gtk.CheckButton</link></methodname> <colspec column="3" colwidth="3.5in"/> <tbody> - <row valign="top"> - <entry>"indicator-spacing"</entry> - <entry>Read/Write</entry> - <entry>The spacing around the check or radio indicator</entry> - </row> + <row valign="top"> + <entry>"indicator-size"</entry> + <entry>Read/Write</entry> + <entry>The size of the check or radio indicator</entry> + </row> - <row valign="top"> - <entry>"indicator-size"</entry> - <entry>Read/Write</entry> - <entry>The size of the check or radio indicator</entry> - </row> + <row valign="top"> + <entry>"indicator-spacing"</entry> + <entry>Read/Write</entry> + <entry>The spacing around the check or radio indicator</entry> + </row> - </tbody> - </tgroup> + </tbody> + </tgroup> </informaltable> </blockquote> </refsect1> + <refsect1 id="signal-prototypes-gtkcheckbutton"> + <title>gtk.CheckButton 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> + <para><link linkend="signal-prototypes-gtkbutton">gtk.Button Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtktogglebutton">gtk.ToggleButton Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkcheckmenuitem.xml b/docs/reference/pygtk-gtkcheckmenuitem.xml index 2975bec5..230a2465 100644 --- a/docs/reference/pygtk-gtkcheckmenuitem.xml +++ b/docs/reference/pygtk-gtkcheckmenuitem.xml @@ -76,8 +76,12 @@ linkend="method-gtkcheckmenuitem--get-draw-as-radio">get_draw_as_radio</link></m </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkcheckmenuitem"> + <title>gtk.CheckMenuItem 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"> @@ -114,8 +118,11 @@ GTK+ 2.4 and above.</entry> </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="style-properties-gtkcheckmenuitem"> + <title>gtk.CheckMenuItem Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkmenuitem">gtk.MenuItem Style Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -164,8 +171,15 @@ checked.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkcheckmenuitem"> + <title>gtk.CheckMenuItem 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> + <para><link linkend="signal-prototypes-gtkitem">gtk.Item Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkmenuitem">gtk.MenuItem Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkclipboard.xml b/docs/reference/pygtk-gtkclipboard.xml index 96a8d5b6..fc5be179 100644 --- a/docs/reference/pygtk-gtkclipboard.xml +++ b/docs/reference/pygtk-gtkclipboard.xml @@ -134,6 +134,27 @@ </refsect1> + <refsect1 id="signal-prototypes-gtkclipboard"> + <title>gtk.Clipboard Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> + + <variablelist> + <varlistentry> + <term>"<link linkend="signal-gtkclipboard--owner-change">owner-change</link></term> + <listitem> + <methodsynopsis language="python"><methodname>callback</methodname> + <methodparam><parameter>clipboard</parameter></methodparam> + <methodparam><parameter>event</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis> + </listitem> + </varlistentry> + </variablelist> + + </refsect1> + <refsect1> <title>Description</title> @@ -1210,4 +1231,51 @@ constructor for more information.</para> </refsect1> + <refsect1> + <title>Signals</title> + + <refsect2 id="signal-gtkclipboard--owner-change"> + <title>The "owner-change" gtk.Clipboard Signal</title> + + <programlisting><methodsynopsis language="python"><methodname>callback</methodname> + <methodparam><parameter>clipboard</parameter></methodparam> + <methodparam><parameter>event</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter>clipboard</parameter> :</term> + <listitem><simpara>the object that received the signal.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter>event</parameter> :</term> + <listitem><simpara>the event marking the ownership + change.</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> + + <note> + <para>This signal is available in GTK+ 2.8 and above.</para> + </note> + + <para>The "owner-changed" signal is emitted when the owner of the + clipboard is changed.</para> + + </refsect2> + + </refsect1> + </refentry> diff --git a/docs/reference/pygtk-gtkcolorbutton.xml b/docs/reference/pygtk-gtkcolorbutton.xml index e25a9af5..c9107ce2 100644 --- a/docs/reference/pygtk-gtkcolorbutton.xml +++ b/docs/reference/pygtk-gtkcolorbutton.xml @@ -65,8 +65,13 @@ </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkcolorbutton"> + <title>gtk.ColorButton 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> + <para><link linkend="properties-gtkbutton">gtk.Button Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -93,16 +98,16 @@ fully opaque). Available in GTK+ 2.4 and above.</entry> <entry>"title"</entry> <entry>Read-Write</entry> <entry>The title of the color selection dialog. Available in -GTK+ 2.4 and above.</entry> + GTK+ 2.4 and above.</entry> </row> <row valign="top"> <entry>"use-alpha"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, the color swatch on the button - is rendered against a checkerboard background to show its opacity and the -opacity slider is displayed in the color selection dialog. Available in -GTK+ 2.4 and above.</entry> + <entry>If <literal>TRUE</literal>, the color swatch on the + button is rendered against a checkerboard background to show + its opacity and the opacity slider is displayed in the color + selection dialog. Available in GTK+ 2.4 and above.</entry> </row> </tbody> @@ -112,8 +117,22 @@ GTK+ 2.4 and above.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="style-properties-gtkcolorbutton"> + <title>gtk.ColorButton Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkbutton">gtk.Button Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkcolorbutton"> + <title>gtk.ColorButton 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> + <para><link linkend="signal-prototypes-gtkbutton">gtk.Button Signal Prototypes</link></para> <variablelist> <varlistentry> @@ -135,7 +154,7 @@ GTK+ 2.4 and above.</entry> <para>The <link linkend="class-gtkcolorbutton"><classname>gtk.ColorButton</classname></link> - is a button which displays the currently selected color and, when + is a button that displays the currently selected color and, when clicked, opens a <link linkend="class-gtkcolorselectiondialog"><classname>gtk.ColorSelectionDialog</classname></link> to change the color. It's a suitable widget for selecting a color in a diff --git a/docs/reference/pygtk-gtkcolorselection.xml b/docs/reference/pygtk-gtkcolorselection.xml index 3924e708..4f0b4ff3 100644 --- a/docs/reference/pygtk-gtkcolorselection.xml +++ b/docs/reference/pygtk-gtkcolorselection.xml @@ -114,8 +114,13 @@ linkend="method-gtkcolorselection--is-adjusting">is_adjusting</link></methodname </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkcolorselection"> + <title>gtk.ColorSelection 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> + <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -125,42 +130,61 @@ linkend="method-gtkcolorselection--is-adjusting">is_adjusting</link></methodname <colspec column="3" colwidth="3.5in"/> <tbody> - <row valign="top"> - <entry>"has-palette"</entry> - <entry>Read/Write</entry> - <entry>If <literal>TRUE</literal>, a palette should be used</entry> - </row> - - <row valign="top"> - <entry>"has-opacity-control"</entry> - <entry>Read/Write</entry> - <entry>If <literal>TRUE</literal>, the color selector should allow -setting opacity</entry> - </row> - - <row valign="top"> - <entry>"current-color"</entry> - <entry>Read/Write</entry> - <entry>The current color as a <link -linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></entry> - </row> - - <row valign="top"> - <entry>"current-alpha"</entry> - <entry>Read/Write</entry> - <entry>The current opacity value (0 fully transparent, 65535 fully -opaque)</entry> - </row> - - </tbody> - </tgroup> + <row valign="top"> + <entry>"current-alpha"</entry> + <entry>Read/Write</entry> + <entry>The current opacity value (0 fully transparent, 65535 fully + opaque)</entry> + </row> + + <row valign="top"> + <entry>"current-color"</entry> + <entry>Read/Write</entry> + <entry>The current color as a <link + linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></entry> + </row> + + <row valign="top"> + <entry>"has-opacity-control"</entry> + <entry>Read/Write</entry> + <entry>If <literal>TRUE</literal>, the color selector should allow + setting opacity</entry> + </row> + + <row valign="top"> + <entry>"has-palette"</entry> + <entry>Read/Write</entry> + <entry>If <literal>TRUE</literal>, a palette should be used</entry> + </row> + + </tbody> + </tgroup> </informaltable> </blockquote> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="style-properties-gtkcolorselection"> + <title>gtk.ColorSelection Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="child-properties-gtkcolorselection"> + <title>gtk.ColorSelection Child Properties</title> + + <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkcolorselection"> + <title>gtk.ColorSelection 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> diff --git a/docs/reference/pygtk-gtkcolorselectiondialog.xml b/docs/reference/pygtk-gtkcolorselectiondialog.xml index 340d2e6e..4c4bfcd0 100644 --- a/docs/reference/pygtk-gtkcolorselectiondialog.xml +++ b/docs/reference/pygtk-gtkcolorselectiondialog.xml @@ -40,6 +40,25 @@ linkend="constructor-gtkcolorselectiondialog">gtk.ColorSelectionDialog</link></m </refsect1> + <refsect1 id="properties-gtkcolorselectiondialog"> + <title>gtk.ColorSelectionDialog 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> + <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para> + <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkcolorselectiondialog"> + <title>gtk.ColorSelectionDialog Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para> + + </refsect1> + <refsect1> <title>Attributes</title> @@ -84,6 +103,17 @@ widget contained in the dialog.</entry> </refsect1> + <refsect1 id="signal-prototypes-gtkcolorselectiondialog"> + <title>gtk.ColorSelectionDialog 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> + <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para> +</refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkcombo.xml b/docs/reference/pygtk-gtkcombo.xml index 58f51f5d..28579b1c 100644 --- a/docs/reference/pygtk-gtkcombo.xml +++ b/docs/reference/pygtk-gtkcombo.xml @@ -77,8 +77,13 @@ linkend="method-gtkcombo--disable-activate">disable_activate</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkcombo"> + <title>gtk.Combo 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> + <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -88,44 +93,58 @@ linkend="method-gtkcombo--disable-activate">disable_activate</link></methodname> <colspec column="3" colwidth="3.5in"/> <tbody> - <row valign="top"> - <entry>"enable-arrow-keys"</entry> - <entry>Read/Write</entry> - <entry>If <literal>TRUE</literal>, the arrow keys move through the -list of items</entry> - </row> - <row valign="top"> - <entry>"enable-arrows-always"</entry> - <entry>Read/Write</entry> - <entry>If <literal>TRUE</literal>, the arrow keys work, even if -the entry contents are not in the list</entry> - </row> - <row valign="top"> - <entry>"case-sensitive"</entry> - <entry>Read/Write</entry> - <entry>If <literal>TRUE</literal>, list item matching is case -sensitive</entry> - </row> - <row valign="top"> - <entry>"allow-empty"</entry> - <entry>Read/Write</entry> - <entry>If <literal>TRUE</literal>, an empty value may be entered -in this field</entry> - </row> - <row valign="top"> - <entry>"value-in-list"</entry> - <entry>Read/Write</entry> - <entry>If <literal>TRUE</literal>, entered values must already be -present in the list</entry> - </row> - - </tbody> - </tgroup> + <row valign="top"> + <entry>"allow-empty"</entry> + <entry>Read/Write</entry> + <entry>If <literal>TRUE</literal>, an empty value may be entered + in this field</entry> + </row> + <row valign="top"> + <entry>"case-sensitive"</entry> + <entry>Read/Write</entry> + <entry>If <literal>TRUE</literal>, list item matching is case + sensitive</entry> + </row> + <row valign="top"> + <entry>"enable-arrow-keys"</entry> + <entry>Read/Write</entry> + <entry>If <literal>TRUE</literal>, the arrow keys move through the + list of items</entry> + </row> + <row valign="top"> + <entry>"enable-arrows-always"</entry> + <entry>Read/Write</entry> + <entry>If <literal>TRUE</literal>, the arrow keys work, even if + the entry contents are not in the list</entry> + </row> + <row valign="top"> + <entry>"value-in-list"</entry> + <entry>Read/Write</entry> + <entry>If <literal>TRUE</literal>, entered values must already be + present in the list</entry> + </row> + + </tbody> + </tgroup> </informaltable> </blockquote> </refsect1> + <refsect1 id="style-properties-gtkcombo"> + <title>gtk.Combo Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="child-properties-gtkcombo"> + <title>gtk.Combo Child Properties</title> + + <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para> + + </refsect1> + <refsect1> <title>Attributes</title> @@ -156,6 +175,15 @@ present in the list</entry> </refsect1> + <refsect1 id="signal-prototypes-gtkcombo"> + <title>gtk.Combo 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> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkcombobox.xml b/docs/reference/pygtk-gtkcombobox.xml index 533014fe..1c8e8307 100644 --- a/docs/reference/pygtk-gtkcombobox.xml +++ b/docs/reference/pygtk-gtkcombobox.xml @@ -156,8 +156,12 @@ END NOT IMPLEMENTED --> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkcombobox"> + <title>gtk.ComboBox 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"> @@ -170,37 +174,51 @@ END NOT IMPLEMENTED --> <row valign="top"> <entry>"active"</entry> <entry>Read-Write</entry> - <entry>The index of the item that is currently active.</entry> + <entry>The index of the item that is currently active.. If the + model is a non-flat treemodel, and the active item is not an + immediate child of the root of the tree, this property has the + value of the first index of the path of the item. This + property is available in GTK+ 2.4 and above.</entry> </row> <row valign="top"> <entry>"add-tearoffs"</entry> <entry>Read-Write</entry> <entry>If <literal>TRUE</literal> generated menus have tearoff -menu items. Note that this only affects menu style combo boxes. -Default value: <literal>FALSE</literal>. Available in GTK+ 2.6 and -above.</entry> + menu items. Note that this only affects menu style combo + boxes. Default value: <literal>FALSE</literal>. Available in + GTK+ 2.6 and above.</entry> </row> <row valign="top"> <entry>"column-span-column"</entry> <entry>Read-Write</entry> - <entry>The TreeModel column containing the column span -values.</entry> + <entry>The TreeModel column containing the column span values. + This property is available in GTK+ 2.4 and above</entry> </row> + <row valign="top"> + <entry>"focus-on-click"</entry> + <entry>Read-Write</entry> + <entry>If <literal>TRUE</literal> the combo box grabs focus + when it is clicked with the mouse. Default value: + <literal>TRUE</literal></entry> + </row> + <row valign="top"> <entry>"has-frame"</entry> <entry>Read-Write</entry> <entry>If <literal>TRUE</literal> the combo box grabs focus -when it is clicked with the mouse. Default value: <literal>TRUE</literal>. -Available in GTK+ 2.6 and above.</entry> + when it is clicked with the mouse. Default value: + <literal>TRUE</literal>. Available in GTK+ 2.6 and + above.</entry> </row> <row valign="top"> <entry>"model"</entry> <entry>Read-Write</entry> - <entry>The TreeModel for the combo box.</entry> + <entry>The TreeModel for the combo box. This property is + available in GTK+ 2.4 and above.</entry> </row> <row valign="top"> @@ -217,7 +235,8 @@ Available in GTK+ 2.6 and above.</entry> <entry>"row-span-column"</entry> <entry>Read-Write</entry> <entry>The TreeModel column containing the row span -values.</entry> + values. This property is available in GTK+ 2.4 and + above.</entry> </row> <row valign="top"> @@ -232,7 +251,8 @@ values.</entry> <entry>"wrap-width"</entry> <entry>Read-Write</entry> <entry>The number of columns to use to lay out the popup -items.</entry> + items. This property is available in GTK+ 2.4 and + above.</entry> </row> </tbody> @@ -242,8 +262,10 @@ items.</entry> </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="style-properties-gtkcombobox"> + <title>gtk.ComboBox Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -256,8 +278,8 @@ items.</entry> <row valign="top"> <entry>"appears-as-list"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, the combo box dropdowns should -look like lists rather than menus.</entry> + <entry>If <literal>TRUE</literal>, the combo box dropdowns + should look like lists rather than menus.</entry> </row> </tbody> @@ -267,8 +289,14 @@ look like lists rather than menus.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkcombobox"> + <title>gtk.ComboBox 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> + <para><link linkend="signal-prototypes-gtkcelleditable">gtk.CellEditable Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkcomboboxentry.xml b/docs/reference/pygtk-gtkcomboboxentry.xml index 54291028..1301eedc 100644 --- a/docs/reference/pygtk-gtkcomboboxentry.xml +++ b/docs/reference/pygtk-gtkcomboboxentry.xml @@ -53,8 +53,13 @@ </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkcomboboxentry"> + <title>gtk.ComboBoxEntry 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> + <para><link linkend="properties-gtkcombobox">gtk.ComboBox Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -79,6 +84,25 @@ </refsect1> + <refsect1 id="style-properties-gtkcomboboxentry"> + <title>gtk.ComboBoxEntry Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkcombobox">gtk.ComboBox Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkcomboboxentry"> + <title>gtk.ComboBoxEntry 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> + <para><link linkend="signal-prototypes-gtkcombobox">gtk.ComboBox Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkcelleditable">gtk.CellEditable Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkcontainer.xml b/docs/reference/pygtk-gtkcontainer.xml index 66f0866d..bbab7f3b 100644 --- a/docs/reference/pygtk-gtkcontainer.xml +++ b/docs/reference/pygtk-gtkcontainer.xml @@ -208,8 +208,11 @@ linkend="method-gtkcontainer--child-get-property">child_get_property</link></met </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkcontainer"> + <title>gtk.Container Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -224,23 +227,24 @@ linkend="method-gtkcontainer--child-get-property">child_get_property</link></met <entry>"border-width"</entry> <entry>Read/Write</entry> <entry>The width of the empty border outside the containers -children.</entry> + children.</entry> </row> <row valign="top"> - <entry>"resize-mode"</entry> - <entry>Read/Write</entry> - <entry>Specify how resize events are handled. One of: -<literal>gtk.RESIZE_PARENT</literal>, <literal>gtk.RESIZE_QUEUE</literal> or -<literal>gtk.RESIZE_IMMEDIATE</literal></entry> - </row> - - <row valign="top"> <entry>"child"</entry> <entry>Read</entry> <entry>The child widget in the container</entry> </row> + <row valign="top"> + <entry>"resize-mode"</entry> + <entry>Read/Write</entry> + <entry>Specify how resize events are handled. One of: + <literal>gtk.RESIZE_PARENT</literal>, + <literal>gtk.RESIZE_QUEUE</literal> or + <literal>gtk.RESIZE_IMMEDIATE</literal></entry> + </row> + </tbody> </tgroup> </informaltable> @@ -248,6 +252,13 @@ children.</entry> </refsect1> + <refsect1 id="style-properties-gtkcontainer"> + <title>gtk.Container Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + <refsect1> <title>Attributes</title> @@ -308,8 +319,12 @@ set</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkcontainer"> + <title>gtk.Container 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> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkcurve.xml b/docs/reference/pygtk-gtkcurve.xml index abcf5d4f..a606c58a 100644 --- a/docs/reference/pygtk-gtkcurve.xml +++ b/docs/reference/pygtk-gtkcurve.xml @@ -75,8 +75,11 @@ linkend="method-gtkcurve--set-curve-type">set_curve_type</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkcurve"> + <title>gtk.Curve Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -97,27 +100,27 @@ linkend="method-gtkcurve--set-curve-type">set_curve_type</link></methodname> </row> <row valign="top"> - <entry>"min-x"</entry> + <entry>"max-x"</entry> <entry>Read/Write</entry> - <entry>The minimum possible value for X</entry> + <entry>The maximum possible value for X</entry> </row> <row valign="top"> - <entry>"max-x"</entry> + <entry>"max-y"</entry> <entry>Read/Write</entry> - <entry>The maximum possible value for X</entry> + <entry>The maximum possible value for Y</entry> </row> <row valign="top"> - <entry>"min-y"</entry> + <entry>"min-x"</entry> <entry>Read/Write</entry> - <entry>The minimum possible value for Y</entry> + <entry>The minimum possible value for X</entry> </row> <row valign="top"> - <entry>"max-y"</entry> + <entry>"min-y"</entry> <entry>Read/Write</entry> - <entry>The maximum possible value for Y</entry> + <entry>The minimum possible value for Y</entry> </row> </tbody> @@ -128,8 +131,19 @@ linkend="method-gtkcurve--set-curve-type">set_curve_type</link></methodname> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="style-properties-gtkcurve"> + <title>gtk.Curve Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkcurve"> + <title>gtk.Curve 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> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkdialog.xml b/docs/reference/pygtk-gtkdialog.xml index 8f1e6e8e..22761cf1 100644 --- a/docs/reference/pygtk-gtkdialog.xml +++ b/docs/reference/pygtk-gtkdialog.xml @@ -122,8 +122,13 @@ linkend="function-gtk- -alternative-dialog-button-order">gtk.alternative_dialog_ </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkdialog"> + <title>gtk.Dialog 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> + <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -147,8 +152,10 @@ above its buttons</entry> </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="style-properties-gtkdialog"> + <title>gtk.Dialog Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -221,8 +228,14 @@ the buttons of the dialog.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkdialog"> + <title>gtk.Dialog 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> + <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para> <variablelist> <varlistentry> @@ -264,58 +277,59 @@ linkend="signal-gtkdialog--response">response</link>"</term> <title>Description</title> <para>Dialog boxes are a convenient way to prompt the user for a small -amount of input, e.g. to display a message, ask a question, or anything else -that does not require extensive effort on the user's part. Dialogs are -organized as a window split vertically. The top section is a <link -linkend="class-gtkvbox"><classname>gtk.VBox</classname></link>, and is where -widgets such as a <link -linkend="class-gtklabel"><classname>gtk.Label</classname></link> or a <link -linkend="class-gtkentry"><classname>gtk.Entry</classname></link> should be -packed. The bottom area is known as the action_area which is generally used -for packing buttons into the dialog which may perform functions such as -cancel, ok, or apply. The two areas are separated by a <link -linkend="class-gtkhseparator"><classname>gtk.HSeparator</classname></link>.</para> + amount of input, e.g. to display a message, ask a question, or anything + else that does not require extensive effort on the user's part. Dialogs + are organized as a window split vertically. The top section is a <link + linkend="class-gtkvbox"><classname>gtk.VBox</classname></link>, and is + where widgets such as a <link + linkend="class-gtklabel"><classname>gtk.Label</classname></link> or a + <link linkend="class-gtkentry"><classname>gtk.Entry</classname></link> + should be packed. The bottom area is known as the action_area which is + generally used for packing buttons into the dialog which may perform + functions such as cancel, ok, or apply. The two areas are separated by a + <link + linkend="class-gtkhseparator"><classname>gtk.HSeparator</classname></link>.</para> <para>The <link -linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link> boxes are -created with a call to <link -linkend="constructor-gtkdialog"><methodname>gtk.Dialog</methodname>()</link>() -that sets the dialog title, some convenient flags, and adds simple buttons. -In a newly created dialog, the two primary areas of the window can be -accessed as the vbox and action_area attributes, as can be seen from the -example, below. A modal dialog (that is, one which freezes the rest of the -application from user input), can be created by passing the -<literal>gtk.DIALOG_MODAL</literal> flag to the <link -linkend="constructor-gtkdialog"><methodname>gtk.Dialog</methodname>()</link> -constructor or by calling <link -linkend="method-gtkwindow--set-modal"><methodname>set_modal</methodname>()</link> -on the dialog.</para> + linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link> boxes + are created with a call to <link + linkend="constructor-gtkdialog"><methodname>gtk.Dialog</methodname>()</link>() + that sets the dialog title, some convenient flags, and adds simple + buttons. In a newly created dialog, the two primary areas of the window + can be accessed as the vbox and action_area attributes, as can be seen + from the example, below. A modal dialog (that is, one which freezes the + rest of the application from user input), can be created by passing the + <literal>gtk.DIALOG_MODAL</literal> flag to the <link + linkend="constructor-gtkdialog"><methodname>gtk.Dialog</methodname>()</link> + constructor or by calling <link + linkend="method-gtkwindow--set-modal"><methodname>set_modal</methodname>()</link> + on the dialog.</para> <para>If you add buttons to <link -linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link> using -<link -linkend="constructor-gtkdialog"><methodname>gtk.Dialog</methodname>()</link>, -<link -linkend="method-gtkdialog--add-button"><methodname>add_button</methodname>()</link>, -or <link -linkend="method-gtkdialog--add-action-widget"><methodname>add_action_widget</methodname>()</link>, -clicking the button will emit a signal called "response" with a response ID -that you specified. PyGTK will never assign a meaning to positive response -IDs; these are entirely user-defined. But for convenience, you can use the -pre-defined <xref linkend="gtk-response-type-constants" -endterm="gtk-response-type-constants-title"></xref> (these all have values -less than zero).</para> + linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link> using + <link + linkend="constructor-gtkdialog"><methodname>gtk.Dialog</methodname>()</link>, + <link + linkend="method-gtkdialog--add-button"><methodname>add_button</methodname>()</link>, + or <link + linkend="method-gtkdialog--add-action-widget"><methodname>add_action_widget</methodname>()</link>, + clicking the button will emit a signal called "response" with a response + ID that you specified. PyGTK will never assign a meaning to positive + response IDs; these are entirely user-defined. But for convenience, you + can use the pre-defined <xref linkend="gtk-response-type-constants" + endterm="gtk-response-type-constants-title"></xref> (these all have + values less than zero).</para> <para>If a dialog receives a delete event, the "response" signal will be -emitted with a response ID of -<literal>gtk.RESPONSE_DELETE_EVENT</literal>.</para> + emitted with a response ID of + <literal>gtk.RESPONSE_DELETE_EVENT</literal>.</para> <para>If you want to block waiting for a dialog to return before -returning control flow to your code, you can call <link -linkend="method-gtkdialog--run"><methodname>run</methodname>()</link>. This -function enters a recursive main loop and waits for the user to respond to -the dialog, returning the response ID corresponding to the button the user -clicked.</para> + returning control flow to your code, you can call <link + linkend="method-gtkdialog--run"><methodname>run</methodname>()</link>. This + function enters a recursive main loop and waits for the user to respond + to the dialog, returning the response ID corresponding to the button the + user clicked.</para> </refsect1> @@ -378,7 +392,7 @@ linkend="gtk-dialog-flag-constants" endterm="gtk-dialog-flag-constants-title"></xref> for more information). After <parameter>flags</parameter>, a tuple of button text/response ID pairs should be listed, or <literal>None</literal> (the -default value) is no buttons are needed. The button text can be either a +default value) if no buttons are needed. The button text can be either a stock ID such as <literal>gtk.STOCK_OK</literal>, or some arbitrary text. A response ID can be any positive number, or one of the pre-defined <xref linkend="gtk-response-type-constants" diff --git a/docs/reference/pygtk-gtkdrawingarea.xml b/docs/reference/pygtk-gtkdrawingarea.xml index 988169bc..3c7d5536 100644 --- a/docs/reference/pygtk-gtkdrawingarea.xml +++ b/docs/reference/pygtk-gtkdrawingarea.xml @@ -34,6 +34,29 @@ linkend="constructor-gtkdrawingarea">gtk.DrawingArea</link></methodname> </refsect1> + <refsect1 id="properties-gtkdrawingarea"> + <title>gtk.DrawingArea Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkdrawingarea"> + <title>gtk.DrawingArea Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkdrawingarea"> + <title>gtk.DrawingArea 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> +</refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkeditable.xml b/docs/reference/pygtk-gtkeditable.xml index 1bf4f547..312d04a4 100644 --- a/docs/reference/pygtk-gtkeditable.xml +++ b/docs/reference/pygtk-gtkeditable.xml @@ -90,8 +90,8 @@ linkend="method-gtkeditable--get-editable">get_editable</link></methodname> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkeditable"> + <title>gtk.Editable Signal Prototypes</title> <variablelist> <varlistentry> @@ -157,13 +157,13 @@ linkend="signal-gtkeditable--insert-text">insert-text</link>"</term> <title>Description</title> <para><link -linkend="class-gtkeditable"><classname>gtk.Editable</classname></link> -is an interface for text editing widgets, such as <link -linkend="class-gtkentry"><classname>gtk.Entry</classname></link>. The -editable class contains methods for generically manipulating an editable -widget, a large number of action signals used for key bindings, and several -signals that an application can connect to to modify the behavior of a -widget.</para> + linkend="class-gtkeditable"><classname>gtk.Editable</classname></link> + is an interface for text editing widgets, such as <link + linkend="class-gtkentry"><classname>gtk.Entry</classname></link>. The + editable class contains methods for generically manipulating an editable + widget, a large number of action signals used for key bindings, and + several signals that an application can connect to to modify the + behavior of a widget.</para> </refsect1> diff --git a/docs/reference/pygtk-gtkentry.xml b/docs/reference/pygtk-gtkentry.xml index 1c165d7d..de364dde 100644 --- a/docs/reference/pygtk-gtkentry.xml +++ b/docs/reference/pygtk-gtkentry.xml @@ -155,8 +155,11 @@ linkend="method-gtkentry--get-completion">get_completion</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkentry"> + <title>gtk.Entry Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -283,8 +286,41 @@ linkend="method-gtkentry--get-completion">get_completion</link></methodname> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="style-properties-gtkentry"> + <title>gtk.Entry 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="3.5in"/> + <tbody> + + <row valign="top"> + <entry>"inner-border"</entry> + <entry>Read</entry> + <entry>Sets the text area's border between the text and the frame + This property is available in GTK+ 2.10 and above.</entry> + </row> + + </tbody> + </tgroup> + </informaltable> + </blockquote> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkentry"> + <title>gtk.Entry 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-gtkeditable">gtk.Editable Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkcelleditable">gtk.CellEditable Signal Prototypes</link></para> <variablelist> <varlistentry> @@ -303,6 +339,16 @@ linkend="signal-gtkentry--activate">activate</link>"</term> </listitem> </varlistentry> <varlistentry> + <term>"<link linkend="signal-gtkentry--backspace">backspace</link></term> + <listitem> + <methodsynopsis language="python"><methodname>callback</methodname> + <methodparam><parameter>entry</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis> + </listitem> + </varlistentry> + <varlistentry> <term>"<link linkend="signal-gtkentry--copy-clipboard">copy-clipboard</link>"</term> <listitem> @@ -444,11 +490,11 @@ linkend="signal-gtkentry--toggle-overwrite">toggle-overwrite</link>"</term> <title>Description</title> <para>The <link -linkend="class-gtkentry"><classname>gtk.Entry</classname></link> widget is a -single line text entry widget. A fairly large set of key bindings are -supported by default. If the entered text is longer than the allocation of -the widget, the widget will scroll so that the cursor position is -visible.</para> + linkend="class-gtkentry"><classname>gtk.Entry</classname></link> widget + is a single line text entry widget. A fairly large set of key bindings + are supported by default. If the entered text is longer than the + allocation of the widget, the widget will scroll so that the cursor + position is visible.</para> </refsect1> @@ -475,8 +521,8 @@ linkend="class-gtkentry"><classname>gtk.Entry</classname></link>.</simpara></lis </variablelist> <para>Creates a new <link -linkend="class-gtkentry"><classname>gtk.Entry</classname></link> widget with -the maximum length specified by <parameter>max</parameter>.</para> + linkend="class-gtkentry"><classname>gtk.Entry</classname></link> widget + with the maximum length specified by <parameter>max</parameter>.</para> </refsect1> @@ -500,14 +546,15 @@ the maximum length specified by <parameter>max</parameter>.</para> </variablelist> <para>The <methodname>set_visibility</methodname>() method sets the -"visibility" property to the value of <parameter>visible</parameter>. If -visible is <literal>TRUE</literal> the contents of the entry are displayed -as plain text. If visible is <literal>FALSE</literal>, the contents are -obscured by replacing the characters with the invisible character (specified -by the "invisible-char" property). The characters will also be obscured when -the text in the entry widget is copied elsewhere. The default invisible char -is the asterisk '*', but it can be changed with <link -linkend="method-gtkentry--set-invisible-char"><methodname>set_invisible_char</methodname>()</link>.</para> + "visibility" property to the value of + <parameter>visible</parameter>. If visible is <literal>TRUE</literal> + the contents of the entry are displayed as plain text. If visible is + <literal>FALSE</literal>, the contents are obscured by replacing the + characters with the invisible character (specified by the + "invisible-char" property). The characters will also be obscured when + the text in the entry widget is copied elsewhere. The default + invisible char is the asterisk '*', but it can be changed with <link + linkend="method-gtkentry--set-invisible-char"><methodname>set_invisible_char</methodname>()</link>.</para> </refsect2> @@ -526,9 +573,9 @@ currently visible</simpara></listitem> </variablelist> <para>The <methodname>get_visibility</methodname>() method retrieves -the value of the "visibility" property that determines whether the text in -<parameter>entry</parameter> is visible. See <link -linkend="method-gtkentry--set-visibility"><methodname>set_visibility</methodname>()</link>.</para> + the value of the "visibility" property that determines whether the + text in <parameter>entry</parameter> is visible. See <link + linkend="method-gtkentry--set-visibility"><methodname>set_visibility</methodname>()</link>.</para> </refsect2> @@ -548,15 +595,16 @@ linkend="method-gtkentry--set-visibility"><methodname>set_visibility</methodname </variablelist> <para>The <methodname>set_invisible_char</methodname>() method sets -the "invisible-char" property with the value of <parameter>ch</parameter>. -The "invisible-char" is the character to use in place of the actual text -when <link -linkend="method-gtkentry--set-visibility"><methodname>set_visibility</methodname>()</link> -has been called to set text visibility to <literal>FALSE</literal>. i.e. -this is the character used in "password mode" to show the user how many -characters have been typed. The default invisible character is an asterisk -('*'). If you set the invisible character to 0, then the user will get no -feedback at all; there will be no text on the screen as they type.</para> + the "invisible-char" property with the value of + <parameter>ch</parameter>. The "invisible-char" is the character to + use in place of the actual text when <link + linkend="method-gtkentry--set-visibility"><methodname>set_visibility</methodname>()</link> + has been called to set text visibility to + <literal>FALSE</literal>. i.e. this is the character used in + "password mode" to show the user how many characters have been + typed. The default invisible character is an asterisk ('*'). If you + set the invisible character to 0, then the user will get no feedback + at all; there will be no text on the screen as they type.</para> </refsect2> @@ -575,10 +623,10 @@ does not show invisible text at all.</simpara></listitem> </variablelist> <para>The get_invisible_char() method retrieves the value of the -"invisible-char" property. The "invisible-char" is the character displayed -in place of the real characters for entries with visibility set to -<literal>FALSE</literal>. See <link -linkend="method-gtkentry--set-invisible-char"><methodname>set_invisible_char</methodname>()</link>.</para> + "invisible-char" property. The "invisible-char" is the character + displayed in place of the real characters for entries with visibility + set to <literal>FALSE</literal>. See <link + linkend="method-gtkentry--set-invisible-char"><methodname>set_invisible_char</methodname>()</link>.</para> </refsect2> @@ -599,9 +647,9 @@ frame around it.</simpara></listitem> </variablelist> <para>The <methodname>set_has_frame</methodname>() method sets the -"has-frame" property to the value of <parameter>setting</parameter>. If -<parameter>setting</parameter> is <literal>TRUE</literal> the entry is -displayed with a beveled frame around it.</para> + "has-frame" property to the value of <parameter>setting</parameter>. + If <parameter>setting</parameter> is <literal>TRUE</literal> the entry + is displayed with a beveled frame around it.</para> </refsect2> @@ -619,9 +667,10 @@ frame</simpara></listitem> </varlistentry> </variablelist> - <para>The get_has_frame() method gets the value of the "has-frame" -property. If "has-frame" is TRUE the entry will be displayed with a beveled -frame around it.</para> + <para>The <methodname>get_has_frame</methodname>() method gets the + value of the "has-frame" property. If "has-frame" is + <literal>TRUE</literal> the entry will be displayed with a beveled + frame around it.</para> </refsect2> @@ -637,17 +686,18 @@ frame around it.</para> <varlistentry> <term><parameter role="keyword">max</parameter> :</term> <listitem><simpara>the maximum length of the entry, or 0 for no -maximum. (other than the maximum length of entries.) The value passed in -will be clamped to the range 0-65536.</simpara></listitem> + maximum. (other than the maximum length of entries.) The value + passed in will be clamped to the range + 0-65536.</simpara></listitem> </varlistentry> </variablelist> <para>The <methodname>set_max_length</methodname>() method sets the -"max-length" property to the value of <parameter>max</parameter>. The -"max-length" property sets the maximum allowed length of the contents of the -widget. If the current contents are longer than the given length, then they -will be truncated to fit. If max is 0 then there is no maximum length (other -than 65536).</para> + "max-length" property to the value of <parameter>max</parameter>. The + "max-length" property sets the maximum allowed length of the contents + of the widget. If the current contents are longer than the given + length, then they will be truncated to fit. If max is 0 then there is + no maximum length (other than 65536).</para> </refsect2> @@ -666,10 +716,10 @@ if there is no maximum.</simpara></listitem> </varlistentry> </variablelist> - <para>The get_max_length() method retrieves the value of the -"max-length" property that specifies the maximum allowed length of the text -in the entry. See <link -linkend="method-gtkentry--set-max-length"><methodname>set_max_length</methodname>()</link>.</para> + <para>The <methodname>get_max_length</methodname>() method retrieves + the value of the "max-length" property that specifies the maximum + allowed length of the text in the entry. See <link + linkend="method-gtkentry--set-max-length"><methodname>set_max_length</methodname>()</link>.</para> </refsect2> @@ -691,18 +741,19 @@ key press</simpara></listitem> </variablelist> <para>The <methodname>set_activates_default</methodname>() method sets -the "activates-default" property to the value of -<parameter>setting</parameter>. If <parameter>setting</parameter> is -<literal>TRUE</literal>, pressing the <keycap>Enter</keycap> key in the -entry will activate the default widget for the window containing the entry. -This usually means that the dialog box containing the entry will be closed, -since the default widget is usually one of the dialog buttons.</para> + the "activates-default" property to the value of + <parameter>setting</parameter>. If <parameter>setting</parameter> is + <literal>TRUE</literal>, pressing the <keycap>Enter</keycap> key in + the entry will activate the default widget for the window containing + the entry. This usually means that the dialog box containing the + entry will be closed, since the default widget is usually one of the + dialog buttons.</para> <para>(For experts: if <parameter>setting</parameter> is -<literal>TRUE</literal>, the entry calls <link -linkend="method-gtkwindow--activate-default"><methodname>gtk.Window.activate_default</methodname>()</link> -on the window containing the entry, in the default handler for the -"activate" signal.)</para> + <literal>TRUE</literal>, the entry calls <link + linkend="method-gtkwindow--activate-default"><methodname>gtk.Window.activate_default</methodname>()</link> + on the window containing the entry, in the default handler for the + "activate" signal.)</para> </refsect2> @@ -721,12 +772,12 @@ activate the default widget</simpara></listitem> </variablelist> <para>The <methodname>get_activates_default</methodname>() method -retrieves the value of the "activates-default" property which is set by -<link -linkend="method-gtkentry--set-activates-default"><methodname>set_activates_default</methodname>()</link>. -If "activates-default" is TRUE pressing the <keycap>Enter</keycap> key in -the entry will activate the default widget for the window containing the -entry.</para> + retrieves the value of the "activates-default" property which is set + by <link + linkend="method-gtkentry--set-activates-default"><methodname>set_activates_default</methodname>()</link>. + If "activates-default" is <literal>TRUE</literal> pressing the + <keycap>Enter</keycap> key in the entry will activate the default + widget for the window containing the entry.</para> </refsect2> @@ -746,13 +797,13 @@ entry.</para> </variablelist> <para>The <methodname>set_width_chars</methodname>() method sets the -"width-chars" property to the value of <parameter>n_char</parameter>. -Setting the "width-chars" property changes the size request of the entry to -be about the right size for <parameter>n_chars</parameter> characters. Note -that it only changes the size <emphasis>request</emphasis>, the size can -still be affected by how you pack the widget into containers. If -<parameter>n_chars</parameter> is -1, the size reverts to the default entry -size.</para> + "width-chars" property to the value of <parameter>n_char</parameter>. + Setting the "width-chars" property changes the size request of the + entry to be about the right size for <parameter>n_chars</parameter> + characters. Note that it only changes the size + <emphasis>request</emphasis>, the size can still be affected by how + you pack the widget into containers. If <parameter>n_chars</parameter> + is -1, the size reverts to the default entry size.</para> </refsect2> @@ -771,9 +822,9 @@ negative if unset</simpara></listitem> </variablelist> <para>The <methodname>get_width_chars</methodname>() method gets the -value of the "width-chars" property which is set by the <link -linkend="method-gtkentry--set-width-chars"><methodname>set_width_chars</methodname>()</link> -method.</para> + value of the "width-chars" property which is set by the <link + linkend="method-gtkentry--set-width-chars"><methodname>set_width_chars</methodname>()</link> + method.</para> </refsect2> @@ -794,9 +845,9 @@ entry</simpara></listitem> </variablelist> <para>The <methodname>set_text</methodname>() method sets the "text" -property to the value of <parameter>text</parameter>. The string in -<parameter>text</parameter> replaces the current contents of the -entry.</para> + property to the value of <parameter>text</parameter>. The string in + <parameter>text</parameter> replaces the current contents of the + entry.</para> </refsect2> @@ -815,8 +866,8 @@ string</simpara></listitem> </variablelist> <para>The <methodname>get_text</methodname>() method returns the value -of the "text" property which is a string containing the contents of the -entry.</para> + of the "text" property which is a string containing the contents of + the entry.</para> </refsect2> @@ -835,11 +886,11 @@ this entry</simpara></listitem> </varlistentry> </variablelist> - <para>The get_layout() method gets the <link -linkend="class-pangolayout"><classname>pango.Layout</classname></link> used -to display the entry. The layout is useful to e.g. convert text positions to -pixel positions, in combination with <link -linkend="method-gtkentry--get-layout-offsets"><methodname>get_layout_offsets</methodname>()</link>.</para> + <para>The <methodname>get_layout</methodname>() method gets the <link + linkend="class-pangolayout"><classname>pango.Layout</classname></link> + used to display the entry. The layout is useful to e.g. convert text + positions to pixel positions, in combination with <link + linkend="method-gtkentry--get-layout-offsets"><methodname>get_layout_offsets</methodname>()</link>.</para> </refsect2> @@ -859,19 +910,20 @@ pango layout</simpara></listitem> </variablelist> <para>The <methodname>get_layout_offsets</methodname>() method obtains -the position of the <link -linkend="class-pangolayout"><classname>pango.Layout</classname></link> used -to render text in the entry, in widget coordinates and returns it as a -tuple. This method is used to line up the text in an entry with some other -text, e.g. when using the entry to implement editable cells in a sheet -widget. It is also useful to convert mouse events into coordinates inside -the <link -linkend="class-pangolayout"><classname>pango.Layout</classname></link>, e.g. -to take some action if some part of the entry text is clicked.</para> + the position of the <link + linkend="class-pangolayout"><classname>pango.Layout</classname></link> + used to render text in the entry, in widget coordinates and returns it + as a tuple. This method is used to line up the text in an entry with + some other text, e.g. when using the entry to implement editable cells + in a sheet widget. It is also useful to convert mouse events into + coordinates inside the <link + linkend="class-pangolayout"><classname>pango.Layout</classname></link>, + e.g. to take some action if some part of the entry text is + clicked.</para> <para>Note that as the user scrolls around in the entry the offsets -will change; you'll need to connect to the "notify::scroll_offset" signal to -track this.</para> + will change; you'll need to connect to the "notify::scroll_offset" + signal to track this.</para> </refsect2> @@ -897,11 +949,11 @@ track this.</para> </note> <para>The <methodname>set_alignment</methodname>() method sets the -"xalign" property to the value of <parameter>xalign</parameter>. The -alignment controls the horizontal positioning of the contents when the -displayed text is shorter than the width of the entry. The value of -<parameter>xalign</parameter> is the fraction of freespace to the left -(right in RTL layouts) of the text.</para> + "xalign" property to the value of <parameter>xalign</parameter>. The + alignment controls the horizontal positioning of the contents when the + displayed text is shorter than the width of the entry. The value of + <parameter>xalign</parameter> is the fraction of freespace to the left + (right in RTL layouts) of the text.</para> </refsect2> @@ -925,8 +977,8 @@ displayed text is shorter than the width of the entry. The value of </note> <para>The <methodname>get_alignment</methodname>() method returns the -value of the "xalign" property which is the fraction of freespace (if any) -to the left (right in RTL layouts) of the text.</para> + value of the "xalign" property which is the fraction of freespace (if + any) to the left (right in RTL layouts) of the text.</para> </refsect2> @@ -952,14 +1004,14 @@ to the left (right in RTL layouts) of the text.</para> </note> <para>The <methodname>set_completion</methodname>() method sets the -<link -linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link> -specified by <parameter>completion</parameter> to be the auxiliary -completion object to use with the entry. All further configuration of the -completion mechanism is done using <parameter>completion</parameter> and the -<link -linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link> -methods.</para> + <link + linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link> + specified by <parameter>completion</parameter> to be the auxiliary + completion object to use with the entry. All further configuration of + the completion mechanism is done using + <parameter>completion</parameter> and the <link + linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link> + methods.</para> </refsect2> @@ -981,9 +1033,9 @@ methods.</para> </note> <para>The <methodname>get_completion</methodname>() method returns the -<link -linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link> -object currently in use by the entry.</para> + <link + linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link> + object currently in use by the entry.</para> </refsect2> @@ -1085,10 +1137,42 @@ any)</simpara></listitem> </variablelist> <para>The "activate" signal is emitted when the entry is activated -either by user action (pressing the <keycap>Enter</keycap> key) or -programmatically with the <link -linkend="method-gtkwidget--activate"><methodname>gtk.Widget.activate</methodname>()</link> -method</para> + either by user action (pressing the <keycap>Enter</keycap> key) or + programmatically with the <link + linkend="method-gtkwidget--activate"><methodname>gtk.Widget.activate</methodname>()</link> + method</para> + + </refsect2> + + <refsect2 id="signal-gtkentry--backspace"> + <title>The "backspace" gtk.Entry Signal</title> + + <programlisting><methodsynopsis language="python"><methodname>callback</methodname> + <methodparam><parameter>entry</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter>entry</parameter> :</term> + <listitem><simpara>the object which 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 "backspace" signal is emitted when the + <keysym>Backspace</keysym> key is entered from the keyboard.</para> </refsect2> @@ -1123,7 +1207,7 @@ any)</simpara></listitem> </variablelist> <para>The "copy-clipboard" signal is emitted when the selection text -in the entry is copied to the clipboard.</para> + in the entry is copied to the clipboard.</para> </refsect2> @@ -1158,7 +1242,8 @@ any)</simpara></listitem> </variablelist> <para>The "cut-clipboard" signal is emitted when the selection in the -entry is cut (removed from the entry) and placed in the clipboard.</para> + entry is cut (removed from the entry) and placed in the + clipboard.</para> </refsect2> @@ -1204,10 +1289,10 @@ any)</simpara></listitem> </variablelist> <para>The "delete-from-cursor" signal is emitted when the a deletion -from the cursor i.e. removal o text at the cursor position, either before it -(negative <parameter>count</parameter>) or after it (positive -<parameter>count</parameter>). The value of -<parameter>delete_type</parameter> can be one of:</para> + from the cursor i.e. removal o text at the cursor position, either + before it (negative <parameter>count</parameter>) or after it + (positive <parameter>count</parameter>). The value of + <parameter>delete_type</parameter> can be one of:</para> <itemizedlist> <listitem> @@ -1275,7 +1360,7 @@ any)</simpara></listitem> </variablelist> <para>The "insert-at-cursor" signal is emitted when text is being -inserted in the entry.</para> + inserted in the entry.</para> </refsect2> @@ -1328,10 +1413,11 @@ any)</simpara></listitem> </variablelist> <para>The "move-cursor" signal is emitted when the cursor is being -moved by <parameter>count</parameter> steps of size -<parameter>step</parameter>. If <parameter>extend_selection</parameter> is -<literal>TRUE</literal> the selection is extended as the cursor is being -moved. The value of <parameter>step</parameter> can be one of:</para> + moved by <parameter>count</parameter> steps of size + <parameter>step</parameter>. If + <parameter>extend_selection</parameter> is <literal>TRUE</literal> the + selection is extended as the cursor is being moved. The value of + <parameter>step</parameter> can be one of:</para> <itemizedlist> <listitem> @@ -1396,7 +1482,7 @@ any)</simpara></listitem> </variablelist> <para>The "paste-clipboard" signal is emitted when the contents of the -clipboard are pasted into the entry.</para> + clipboard are pasted into the entry.</para> </refsect2> @@ -1437,7 +1523,7 @@ any)</simpara></listitem> </variablelist> <para>The "populate-popup" signal is emitted when the -<parameter>menu</parameter> needs populating.</para> + <parameter>menu</parameter> needs populating.</para> </refsect2> @@ -1472,8 +1558,8 @@ any)</simpara></listitem> </variablelist> <para>The "toggle-overwrite" signal is emitted when the internal entry -attribute "overwrite_mode" is toggled by pressing the -<keycap>Insert</keycap> key.</para> + attribute "overwrite_mode" is toggled by pressing the + <keycap>Insert</keycap> key.</para> </refsect2> diff --git a/docs/reference/pygtk-gtkentrycompletion.xml b/docs/reference/pygtk-gtkentrycompletion.xml index 22ca95dd..c362bae9 100644 --- a/docs/reference/pygtk-gtkentrycompletion.xml +++ b/docs/reference/pygtk-gtkentrycompletion.xml @@ -135,8 +135,8 @@ </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkentrycompletion"> + <title>gtk.EntryCompletion Properties</title> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -150,8 +150,9 @@ <entry>"inline-completion"</entry> <entry>Read-Write</entry> <entry>If <literal>TRUE</literal> the common prefix should be -inserted automatically. Default value: <literal>FALSE</literal>. Available -in GTK+ 2.6 and above.</entry> + inserted automatically. Default value: + <literal>FALSE</literal>. Available in GTK+ 2.6 and + above.</entry> </row> <row valign="top"> @@ -164,42 +165,44 @@ in GTK+ 2.6 and above.</entry> <row valign="top"> <entry>"model"</entry> <entry>Read-Write</entry> - <entry>The <link -linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> to -find matches in.</entry> + <entry>The <link + linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> + to find matches in.</entry> </row> <row valign="top"> <entry>"popup-completion"</entry> <entry>Read-Write</entry> <entry>If <literal>TRUE</literal> the completions should be -shown in a popup window. Default value: <literal>TRUE</literal>. Available -in GTK+ 2.6 and above.</entry> + shown in a popup window. Default value: + <literal>TRUE</literal>. Available in GTK+ 2.6 and + above.</entry> </row> <row valign="top"> <entry>"popup-set-width"</entry> <entry>Read-Write</entry> <entry>If <literal>TRUE</literal> the completions popup window -will be resized to the width of the entry. -Default value: <literal>TRUE</literal>. Available in GTK+ 2.8 and -above.</entry> + will be resized to the width of the entry. Default value: + <literal>TRUE</literal>. Available in GTK+ 2.8 and + above.</entry> </row> <row valign="top"> <entry>"popup-single-match"</entry> <entry>Read-Write</entry> <entry>If <literal>TRUE</literal> the completions popup window -will be for a single possible completion. -Default value: <literal>TRUE</literal>. Available in GTK+ 2.8 and -above.</entry> + will be for a single possible completion. Default value: + <literal>TRUE</literal>. Available in GTK+ 2.8 and + above.</entry> </row> <row valign="top"> <entry>"text-column"</entry> <entry>Read-Write</entry> <entry>The column of the model containing the strings. Allowed -values: >= -1. Default value: -1. Available in GTK+ 2.6 and above.</entry> + values: >= -1. Default value: -1. Available in GTK+ 2.6 and + above.</entry> </row> </tbody> @@ -209,8 +212,10 @@ values: >= -1. Default value: -1. Available in GTK+ 2.6 and above.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkentrycompletion"> + <title>gtk.EntryCompletion Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> <variablelist> <varlistentry> @@ -259,56 +264,56 @@ values: >= -1. Default value: -1. Available in GTK+ 2.6 and above.</entry> </note> <para><link -linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link> -is an auxiliary object to be used in conjunction with <link -linkend="class-gtkentry"><classname>gtk.Entry</classname></link> to provide -completion functionality. It implements the <link -linkend="class-gtkcelllayout"><classname>gtk.CellLayout</classname></link> -interface, to allow the user to add extra cells to the popup display of -completions.</para> + linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link> + is an auxiliary object to be used in conjunction with <link + linkend="class-gtkentry"><classname>gtk.Entry</classname></link> to + provide completion functionality. It implements the <link + linkend="class-gtkcelllayout"><classname>gtk.CellLayout</classname></link> + interface, to allow the user to add extra cells to the popup display of + completions.</para> <para>To add completion functionality to an entry, use the <link -linkend="method-gtkentry--set-completion"><methodname>gtk.Entry.set_completion</methodname>()</link> -method. In addition to regular completion matches, that will be inserted -into the entry when they are selected, <link -linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link> -also allows "actions" to be displayed in the popup window below any -completions. Their appearance is similar to menuitems, to differentiate them -clearly from completion strings. When an action is selected, the -"action-activated" signal is emitted.</para> + linkend="method-gtkentry--set-completion"><methodname>gtk.Entry.set_completion</methodname>()</link> + method. In addition to regular completion matches, that will be + inserted into the entry when they are selected, <link + linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link> + also allows "actions" to be displayed in the popup window below any + completions. Their appearance is similar to menuitems, to differentiate + them clearly from completion strings. When an action is selected, the + "action-activated" signal is emitted.</para> <para>A <link -linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> -(e.g. a <link -linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>) -containing the completion strings is associated with the <link -linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link> -using the <link -linkend="method-gtkentrycompletion--set-model"><methodname>set_model</methodname>()</link> -method. The tree model column containing the completion strings can be set -using the convenience method <link -linkend="method-gtkentrycompletion--set-text-column"><methodname>set_text_column</methodname>()</link> -that also creates a <link -linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link> -and packs it into the entry completion.</para> + linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> + (e.g. a <link + linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>) + containing the completion strings is associated with the <link + linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link> + using the <link + linkend="method-gtkentrycompletion--set-model"><methodname>set_model</methodname>()</link> + method. The tree model column containing the completion strings can be + set using the convenience method <link + linkend="method-gtkentrycompletion--set-text-column"><methodname>set_text_column</methodname>()</link> + that also creates a <link + linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link> + and packs it into the entry completion.</para> <para>Otherwise, you can create <link -linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link> -objects and pack them into the <link -linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link> -using the <link -linkend="class-gtkcelllayout"><classname>gtk.CellLayout</classname></link> -methods <link -linkend="method-gtkcelllayout--pack-start"><methodname>gtk.CellLayout.pack_start</methodname>()</link> -or <link -linkend="method-gtkcelllayout--pack-start"><methodname>gtk.CellLayout.pack_start</methodname>()</link>. However, -you will also have to define a match function and set it with the <link -linkend="method-gtkentrycompletion--set-match-func"><methodname>set_match_func</methodname>()</link> -method.</para> + linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link> + objects and pack them into the <link + linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link> + using the <link + linkend="class-gtkcelllayout"><classname>gtk.CellLayout</classname></link> + methods <link + linkend="method-gtkcelllayout--pack-start"><methodname>gtk.CellLayout.pack_start</methodname>()</link> + or <link + linkend="method-gtkcelllayout--pack-start"><methodname>gtk.CellLayout.pack_start</methodname>()</link>. However, + you will also have to define a match function and set it with the <link + linkend="method-gtkentrycompletion--set-match-func"><methodname>set_match_func</methodname>()</link> + method.</para> <para>If you wanted to create a completion list with the strings to -insert and some additional info e.g. an icon or description you could do -something like:</para> + insert and some additional info e.g. an icon or description you could do + something like:</para> <programlisting> entry = gtk.Entry() @@ -327,7 +332,7 @@ something like:</para> </programlisting> <para>This will create an entry that will display a pixbuf and the text -string during completion.</para> + string during completion.</para> <para>Actions are easily managed using the <link linkend="method-gtkentrycompletion--insert-action-text"><methodname>insert_action_text</methodname>()</link>, diff --git a/docs/reference/pygtk-gtkeventbox.xml b/docs/reference/pygtk-gtkeventbox.xml index ec6e0a68..ca240893 100644 --- a/docs/reference/pygtk-gtkeventbox.xml +++ b/docs/reference/pygtk-gtkeventbox.xml @@ -51,8 +51,12 @@ linkend="constructor-gtkeventbox">gtk.EventBox</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkeventbox"> + <title>gtk.EventBox 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"> @@ -66,16 +70,16 @@ linkend="constructor-gtkeventbox">gtk.EventBox</link></methodname> <entry>"above-child"</entry> <entry>Read-Write</entry> <entry>If <literal>TRUE</literal>, the event-trapping window -of the eventbox is above the window of the child widget as opposed to below -it. Available in GTK+ 2.4 and above.</entry> + of the eventbox is above the window of the child widget as + opposed to below it. Available in GTK+ 2.4 and above.</entry> </row> <row valign="top"> <entry>"visible-window"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, the event box is visible, as -opposed to invisible and only used to trap events. Available in GTK+ 2.4 and -above.</entry> + <entry>If <literal>TRUE</literal>, the event box is visible, + as opposed to invisible and only used to trap + events. Available in GTK+ 2.4 and above.</entry> </row> </tbody> @@ -85,6 +89,22 @@ above.</entry> </refsect1> + <refsect1 id="style-properties-gtkeventbox"> + <title>gtk.EventBox Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkeventbox"> + <title>gtk.EventBox 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> +</refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkexpander.xml b/docs/reference/pygtk-gtkexpander.xml index f8c7f697..6fb43fda 100644 --- a/docs/reference/pygtk-gtkexpander.xml +++ b/docs/reference/pygtk-gtkexpander.xml @@ -88,8 +88,12 @@ +-- <link linkend="class-gtkexpander">gtk.Expander</link> </synopsis> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkexpander"> + <title>gtk.Expander 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"> @@ -149,8 +153,10 @@ key.</entry> </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="style-properties-gtkexpander"> + <title>gtk.Expander Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -181,8 +187,13 @@ key.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkexpander"> + <title>gtk.Expander 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> @@ -207,28 +218,28 @@ key.</entry> </note> <para>A <link -linkend="class-gtkexpander"><classname>gtk.Expander</classname></link> -allows the user to hide or show its child by clicking on an expander -triangle similar to the triangles used in a <link -linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>.</para> + linkend="class-gtkexpander"><classname>gtk.Expander</classname></link> + allows the user to hide or show its child by clicking on an expander + triangle similar to the triangles used in a <link + linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>.</para> <para>Normally you use an expander as you would use any other descendant -of <link linkend="class-gtkbin"><classname>gtk.Bin</classname></link>; you -create the child widget and use <link -linkend="method-gtkcontainer--add"><methodname>gtk.Container.add</methodname>()</link> -to add it to the expander. When the expander is toggled, it will take care -of showing and hiding the child automatically.</para> + of <link linkend="class-gtkbin"><classname>gtk.Bin</classname></link>; + you create the child widget and use <link + linkend="method-gtkcontainer--add"><methodname>gtk.Container.add</methodname>()</link> + to add it to the expander. When the expander is toggled, it will take + care of showing and hiding the child automatically.</para> <refsect2> <title>Special Usage</title> <para>There there are situations in which you may prefer to show and -hide the expanded widget yourself, such as when you want to actually create -the widget at expansion time. In this case, create a <link -linkend="class-gtkexpander"><classname>gtk.Expander</classname></link> but -do not add a child to it. The expander widget has the "expanded" property -that can be used to monitor its expansion state. You should watch this -property with a signal connection as follows:</para> + hide the expanded widget yourself, such as when you want to actually + create the widget at expansion time. In this case, create a <link + linkend="class-gtkexpander"><classname>gtk.Expander</classname></link> + but do not add a child to it. The expander widget has the "expanded" + property that can be used to monitor its expansion state. You should + watch this property with a signal connection as follows:</para> <programlisting> expander = gtk.expander_new_with_mnemonic("_More Options") @@ -244,9 +255,9 @@ property with a signal connection as follows:</para> </programlisting> <para>The "activate" signal can also be used to track the expansion -though it occurs before the "expanded" property is changed so the logic of -the <function>expander_callback</function>() function would have to be -reversed.</para> + though it occurs before the "expanded" property is changed so the + logic of the <function>expander_callback</function>() function would + have to be reversed.</para> </refsect2> diff --git a/docs/reference/pygtk-gtkfilechooser.xml b/docs/reference/pygtk-gtkfilechooser.xml index 6492bc2a..857c1c1c 100644 --- a/docs/reference/pygtk-gtkfilechooser.xml +++ b/docs/reference/pygtk-gtkfilechooser.xml @@ -4,9 +4,11 @@ <refentry id="class-gtkfilechooser"> <refnamediv> <refname>gtk.FileChooser</refname> - - <refpurpose>an interface for choosing files (new in PyGTK - 2.4)</refpurpose> + <refpurpose>an interface for choosing files used by <link + linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link> + and <link + linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link> + (new in PyGTK 2.4)</refpurpose> </refnamediv> <refsect1> @@ -208,8 +210,8 @@ </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkfilechooser"> + <title>gtk.FileChooser Properties</title> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -223,20 +225,21 @@ <entry>"action"</entry> <entry>Read-Write</entry> <entry>The type of operation that the file selector is -performing - one of: <literal>gtk.FILE_CHOOSER_ACTION_OPEN</literal>, -<literal>gtk.FILE_CHOOSER_ACTION_SAVE</literal>, -<literal>gtk.FILE_CHOOSER_ACTION_SELECT_FOLDER</literal> or -<literal>gtk.FILE_CHOOSER_ACTION_CREATE_FOLDER</literal>. Default value: -<literal>gtk.FILE_CHOOSER_ACTION_OPEN</literal></entry> + performing - one of the <xref + linkend="gtk-filechooser-action-constants" + endterm="gtk-filechooser-action-constants-title"></xref>. Default + value: <literal>gtk.FILE_CHOOSER_ACTION_OPEN</literal></entry> </row> <row valign="top"> <entry>"do-overwrite-confirmation"</entry> <entry>Read-Write</entry> <entry>If <literal>TRUE</literal> a file chooser in -<literal>gtk.FILE_CHOOSER_ACTION_SAVE</literal> will present an overwrite -confirmation dialog if the user selects a file name that already -exists. Default calue: <literal>FALSE</literal></entry> + <literal>gtk.FILE_CHOOSER_ACTION_SAVE</literal> will present + an overwrite confirmation dialog if the user selects a file + name that already exists. Default value: + <literal>FALSE</literal>. This property is available in GTK+ + 2.8 and above</entry> </row> <row valign="top"> @@ -314,8 +317,8 @@ the name of the previewed file. Default value: <literal>TRUE</literal></entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkfilechooser"> + <title>gtk.FileChooser Signal Prototypes</title> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkfilechooserbutton.xml b/docs/reference/pygtk-gtkfilechooserbutton.xml index 19ef2d3e..6ba43bee 100644 --- a/docs/reference/pygtk-gtkfilechooserbutton.xml +++ b/docs/reference/pygtk-gtkfilechooserbutton.xml @@ -33,18 +33,6 @@ linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname <methodname><link linkend="method-gtkfilechooserbutton--set-title">set_title</link></methodname> <methodparam><parameter role="keyword">title</parameter></methodparam> </methodsynopsis> - -<!-- REMOVED -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkfilechooserbutton- -get-active">get_active</link></methodname> - <methodparam><parameter role="keyword"></parameter></methodparam> - </methodsynopsis> -<methodsynopsis language="python"> - <methodname><link linkend="method-gtkfilechooserbutton- -set-active">set_active</link></methodname> - <methodparam><parameter role="keyword">is_active</parameter></methodparam> - </methodsynopsis> -END REMOVED --> - <methodsynopsis language="python"> <methodname><link linkend="method-gtkfilechooserbutton--get-width-chars">get_width_chars</link></methodname> <methodparam><parameter role="keyword"></parameter></methodparam> @@ -74,12 +62,18 @@ END REMOVED --> +-- <link linkend="class-gtkcontainer">gtk.Container</link> +-- <link linkend="class-gtkbox">gtk.Box</link> +-- <link linkend="class-gtkhbox">gtk.HBox</link> - +-- <link linkend="class-gtkfilechooserbutton">gtk.FileChooserButton</link></synopsis> + +-- <link linkend="class-gtkfilechooserbutton">gtk.FileChooserButton</link> (implements <link linkend="class-gtkfilechooser">gtk.FileChooser</link>)</synopsis> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkfilechooserbutton"> + <title>gtk.FileChooserButton Properties</title> + + <para><link linkend="properties-gtkfilechooser">gtk.FileChooser Properties</link></para> + <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> + <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -89,19 +83,6 @@ END REMOVED --> <colspec column="3" colwidth="4in"/> <tbody> -<!-- REMOVED - <row valign="top"> - <entry>"active"</entry> - <entry>Read-Write</entry> - - <entry>If <literal>TRUE</literal>, the <link -linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link> -associated with the button has been made visible. This can also be set by -the application, though it is rarely useful to do so. Default value: -<literal>FALSE</literal></entry> - </row> -END REMOVED --> - <row valign="top"> <entry>"dialog"</entry> <entry>Write-Construct Only</entry> @@ -148,6 +129,30 @@ END REMOVED --> </refsect1> + <refsect1 id="style-properties-gtkfilechooserbutton"> + <title>gtk.FileChooserButton Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="child-properties-gtkfilechooserbutton"> + <title>gtk.FileChooserButton Child Properties</title> + + <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkfilechooserbutton"> + <title>gtk.FileChooserButton 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> + <para><link linkend="signal-prototypes-gtkfilechooser">gtk.FileChooser Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> @@ -156,16 +161,16 @@ END REMOVED --> </note> <para>The <link -linkend="class-gtkfilechooserbutton"><classname>gtk.FileChooserButton</classname></link> -is a widget that lets the user select a file. It implements the <link -linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link> -interface. Visually, it is a file name with a button to bring up a <link -linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>. The -user can then use that dialog to change the file associated with that -button. This widget does not support setting the "select-multiple" property -to <literal>TRUE</literal>. For example to create a <link -linkend="class-gtkfilechooserbutton"><classname>gtk.FileChooserButton</classname></link> -and set the current folder to '/etc' use:</para> + linkend="class-gtkfilechooserbutton"><classname>gtk.FileChooserButton</classname></link> + is a widget that lets the user select a file. It implements the <link + linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link> + interface. Visually, it is a file name with a button to bring up a <link + linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>. The + user can then use that dialog to change the file associated with that + button. This widget does not support setting the "select-multiple" + property to <literal>TRUE</literal>. For example to create a <link + linkend="class-gtkfilechooserbutton"><classname>gtk.FileChooserButton</classname></link> + and set the current folder to '/etc' use:</para> <programlisting> filechooserbutton = gtk.FileChooserButton('Select a File') @@ -173,22 +178,22 @@ and set the current folder to '/etc' use:</para> </programlisting> <para>The <link -linkend="class-gtkfilechooserbutton"><classname>gtk.FileChooserButton</classname></link> -supports the <literal>gtk.FILE_CHOOSER_ACTION_OPEN</literal> and -<literal>gtk.FILE_CHOOSER_ACTION_SELECT_FOLDER</literal> actions of the -<xref linkend="gtk-filechooser-action-constants" -endterm="gtk-filechooser-action-constants-title"></xref>.</para> + linkend="class-gtkfilechooserbutton"><classname>gtk.FileChooserButton</classname></link> + supports the <literal>gtk.FILE_CHOOSER_ACTION_OPEN</literal> and + <literal>gtk.FILE_CHOOSER_ACTION_SELECT_FOLDER</literal> actions of the + <xref linkend="gtk-filechooser-action-constants" + endterm="gtk-filechooser-action-constants-title"></xref>.</para> <note> <para>The <link -linkend="class-gtkfilechooserbutton"><classname>gtk.FileChooserButton</classname></link> -will ellipsize the label, and thus will thus request little horizontal -space. To give the button more space, you should call the <link -linkend="method-gtkwidget--size-request"><methodname>gtk.Widget.size_request</methodname>()</link> -method, the <link -linkend="method-gtkfilechooserbutton--set-width-chars"><methodname>set_width_chars</methodname>()</link> -method, or pack the button in such a way that other interface elements give -space to the widget.</para> + linkend="class-gtkfilechooserbutton"><classname>gtk.FileChooserButton</classname></link> + will ellipsize the label, and thus will thus request little horizontal + space. To give the button more space, you should call the <link + linkend="method-gtkwidget--size-request"><methodname>gtk.Widget.size_request</methodname>()</link> + method, the <link + linkend="method-gtkfilechooserbutton--set-width-chars"><methodname>set_width_chars</methodname>()</link> + method, or pack the button in such a way that other interface elements + give space to the widget.</para> </note> </refsect1> @@ -325,65 +330,6 @@ linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname </refsect2> -<!-- REMOVED - <refsect2 id="method-gtkfilechooserbutton- -get-active"> - <title>gtk.FileChooserButton.get_active</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_active</methodname> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <term><parameter -role="keyword"></parameter> :</term> - <listitem><simpara><literal>TRUE</literal> if the dialog is -visible</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>get_active</methodname>() method returns the -value of the "active" property. If the "active" property is -<literal>TRUE</literal> the associated <link -linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link> -is visible.</para> - - </refsect2> - - <refsect2 id="method-gtkfilechooserbutton- -set-active"> - <title>gtk.FileChooserButton.set_active</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_active</methodname> - <methodparam><parameter - role="keyword">is_active</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">is_active</parameter> :</term> - <listitem><simpara>if <literal>TRUE</literal> the dialog is -visible</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.6 and above.</para> - </note> - - <para>The <methodname>set_active</methodname>() method sets the -"active" property to the value of <parameter>is_active</parameter>. If -<parameter>is_active</parameter> is <literal>TRUE</literal> the associated -<link -linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link> -is visible.</para> - - </refsect2> -END REMOVED --> - <refsect2 id="method-gtkfilechooserbutton--get-width-chars"> <title>gtk.FileChooserButton.get_width_chars</title> diff --git a/docs/reference/pygtk-gtkfilechooserdialog.xml b/docs/reference/pygtk-gtkfilechooserdialog.xml index a0ea8dfd..5602722e 100644 --- a/docs/reference/pygtk-gtkfilechooserdialog.xml +++ b/docs/reference/pygtk-gtkfilechooserdialog.xml @@ -42,6 +42,38 @@ </refsect1> + <refsect1 id="properties-gtkfilechooserdialog"> + <title>gtk.FileChooserDialog Properties</title> + + <para><link linkend="properties-gtkfilechooser">gtk.FileChooser Properties</link></para> + <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> + <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para> + <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkfilechooserdialog"> + <title>gtk.FileChooserDialog Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkfilechooserdialog"> + <title>gtk.FileChooserDialog 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> + <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkfilechooser">gtk.FileChooser Signal Prototypes</link></para> +</refsect1> + <refsect1> <title>Description</title> @@ -50,25 +82,25 @@ </note> <para><link -linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link> -is a dialog box suitable for use with "File/Open" or "File/Save as" -commands. This widget works by putting a <link -linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link> -inside a <link -linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link>. It -implements the <link -linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link> -interface, so you can use all of the <link -linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link> -methods, signals and properties on the file chooser dialog as well as those -for <link -linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link>.</para> + linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link> + is a dialog box suitable for use with "File/Open" or "File/Save as" + commands. This widget works by putting a <link + linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link> + inside a <link + linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link>. It + implements the <link + linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link> + interface, so you can use all of the <link + linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link> + methods, signals and properties on the file chooser dialog as well as + those for <link + linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link>.</para> <para>Note that <link -linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link> -does not have any methods of its own. Instead, you should use the methods -and signals that work on a <link -linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>.</para> + linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link> + does not have any methods of its own. Instead, you should use the + methods and signals that work on a <link + linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>.</para> </refsect1> diff --git a/docs/reference/pygtk-gtkfilechooserwidget.xml b/docs/reference/pygtk-gtkfilechooserwidget.xml index ca6414cd..68bd0734 100644 --- a/docs/reference/pygtk-gtkfilechooserwidget.xml +++ b/docs/reference/pygtk-gtkfilechooserwidget.xml @@ -38,6 +38,41 @@ </refsect1> + <refsect1 id="properties-gtkfilechooserwidget"> + <title>gtk.FileChooserWidget Properties</title> + + <para><link linkend="properties-gtkfilechooser">gtk.FileChooser Properties</link></para> + <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> + <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkfilechooserwidget"> + <title>gtk.FileChooserWidget Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="child-properties-gtkfilechooserwidget"> + <title>gtk.FileChooserWidget Child Properties</title> + + <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkfilechooserwidget"> + <title>gtk.FileChooserWidget 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> + <para><link linkend="signal-prototypes-gtkfilechooser">gtk.FileChooser Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> @@ -46,19 +81,19 @@ </note> <para>The <link -linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link> -is a widget suitable for selecting files. It is the main building block of a -<link -linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>. Most -applications will only need to use the latter; you can use <link -linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link> -as part of a larger window if you have special needs.</para> + linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link> + is a widget suitable for selecting files. It is the main building block + of a <link + linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>. Most + applications will only need to use the latter; you can use <link + linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link> + as part of a larger window if you have special needs.</para> <para>Note that <link -linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link> -does not have any methods, signals or properties of its own. Instead, you -should use the methods, signals and properties of the <link -linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>.</para> + linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link> + does not have any methods, signals or properties of its own. Instead, + you should use the methods, signals and properties of the <link + linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>.</para> </refsect1> diff --git a/docs/reference/pygtk-gtkfilefilter.xml b/docs/reference/pygtk-gtkfilefilter.xml index a163b6f7..de59b2cc 100644 --- a/docs/reference/pygtk-gtkfilefilter.xml +++ b/docs/reference/pygtk-gtkfilefilter.xml @@ -3,8 +3,9 @@ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> <refentry id="class-gtkfilefilter"> <refnamediv> - <refname>gtk.FileFilter</refname> <refpurpose>a filter for selecting a - file subset (new in PyGTK 2.4)</refpurpose> + <refname>gtk.FileFilter</refname> + <refpurpose>a filter for selecting a file subset (new in PyGTK + 2.4)</refpurpose> </refnamediv> <refsect1> @@ -65,6 +66,20 @@ </refsect1> + <refsect1 id="properties-gtkfilefilter"> + <title>gtk.FileFilter Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkfilefilter"> + <title>gtk.FileFilter 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> + </refsect1> + <refsect1> <title>Description</title> @@ -73,11 +88,13 @@ </note> <para>A <link -linkend="class-gtkfilefilter"><classname>gtk.FileFilter</classname></link> -is an object that filters files based on a set of rules that it -contains. The categories of information that <link -linkend="class-gtkfilefilter"><classname>gtk.FileFilter</classname></link> -uses to accept or reject the file are:</para> + linkend="class-gtkfilefilter"><classname>gtk.FileFilter</classname></link> + is an object that filters files based on a set of rules that it + contains. The categories of information that <link + linkend="class-gtkfilefilter"><classname>gtk.FileFilter</classname></link> + uses to accept or reject the file are given by the <xref + linkend="gtk-filefilter-flags-constants" + endterm="gtk-filefilter-flags-constants-title"></xref>:</para> <variablelist> <varlistentry> @@ -108,20 +125,22 @@ chooser.</simpara> </variablelist> <para>The <link -linkend="method-gtkfilefilter--add-pattern"><methodname>add_pattern</methodname>()</link> -method adds a rule that only uses the display name -(<literal>gtk.FILE_FILTER_DISPLAY_NAME</literal>) for filtering. The <link -linkend="method-gtkfilefilter--add-mime-type"><methodname>add_mime_type</methodname>()</link> -method adds a rule that only uses the mime type -(<literal>gtk.FILE_FILTER_MIME_TYPE</literal>) for filtering. To use the -file URI (<literal>gtk.FILE_FILTER_URI</literal>) or filename -(<literal>gtk.FILE_FILTER_FILENAME</literal>) you have to create a custom -filter rule using a callback function that is registered with the <link -linkend="method-gtkfilefilter--add-custom"><methodname>add_custom</methodname>()</link> -method.</para> + linkend="method-gtkfilefilter--add-pattern"><methodname>add_pattern</methodname>()</link> + method adds a rule that only uses the display name + (<literal>gtk.FILE_FILTER_DISPLAY_NAME</literal>) for filtering. The + <link + linkend="method-gtkfilefilter--add-mime-type"><methodname>add_mime_type</methodname>()</link> + method adds a rule that only uses the mime type + (<literal>gtk.FILE_FILTER_MIME_TYPE</literal>) for filtering. To use the + file URI (<literal>gtk.FILE_FILTER_URI</literal>) or filename + (<literal>gtk.FILE_FILTER_FILENAME</literal>) you have to create a + custom filter rule using a callback function that is registered with the + <link + linkend="method-gtkfilefilter--add-custom"><methodname>add_custom</methodname>()</link> + method.</para> <para>The pattern rule uses file globbing to match the file display -name:</para> + name:</para> <itemizedlist> <listitem> diff --git a/docs/reference/pygtk-gtkfileselection.xml b/docs/reference/pygtk-gtkfileselection.xml index 549e7b36..451856ce 100644 --- a/docs/reference/pygtk-gtkfileselection.xml +++ b/docs/reference/pygtk-gtkfileselection.xml @@ -6,7 +6,7 @@ <refnamediv> <refname>gtk.FileSelection</refname> <refpurpose>a dialog used to prompt the user for a file or directory -name</refpurpose> + name</refpurpose> </refnamediv> <refsect1> @@ -79,8 +79,14 @@ linkend="method-gtkfileselection--get-select-multiple">get_select_multiple</link </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkfileselection"> + <title>gtk.FileSelection 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> + <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para> + <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -91,13 +97,6 @@ linkend="method-gtkfileselection--get-select-multiple">get_select_multiple</link <colspec column="3" colwidth="3.5in"/> <tbody> - <row valign="top"> - <entry>"show-fileops"</entry> - <entry>Read/Write</entry> - <entry>If <literal>TRUE</literal> display the buttons for creating -and manipulating files.</entry> - </row> - <row valign="top"> <entry>"filename"</entry> <entry>Read/Write</entry> @@ -108,9 +107,16 @@ and manipulating files.</entry> <entry>"select-multiple"</entry> <entry>Read/Write</entry> <entry>If <literal>TRUE</literal> allow multiple files to be -selected.</entry> + selected.</entry> </row> + <row valign="top"> + <entry>"show-fileops"</entry> + <entry>Read/Write</entry> + <entry>If <literal>TRUE</literal> display the buttons for creating + and manipulating files.</entry> + </row> + </tbody> </tgroup> </informaltable> @@ -118,6 +124,14 @@ selected.</entry> </refsect1> + <refsect1 id="style-properties-gtkfileselection"> + <title>gtk.FileSelection Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para> + + </refsect1> + <refsect1> <title>Attributes</title> @@ -267,6 +281,17 @@ used by the application to add buttons, etc.</entry> </refsect1> + <refsect1 id="signal-prototypes-gtkfileselection"> + <title>gtk.FileSelection 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> + <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkfixed.xml b/docs/reference/pygtk-gtkfixed.xml index 67cf01e2..5764ab63 100644 --- a/docs/reference/pygtk-gtkfixed.xml +++ b/docs/reference/pygtk-gtkfixed.xml @@ -62,8 +62,24 @@ linkend="method-gtkfixed--get-has-window">get_has_window</link></methodname> </refsect1> - <refsect1> - <title>Child Properties</title> + <refsect1 id="properties-gtkfixed"> + <title>gtk.Fixed 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> + + </refsect1> + + <refsect1 id="style-properties-gtkfixed"> + <title>gtk.Fixed Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="child-properties-gtkfixed"> + <title>gtk.Fixed Child Properties</title> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -93,6 +109,15 @@ linkend="method-gtkfixed--get-has-window">get_has_window</link></methodname> </refsect1> + <refsect1 id="signal-prototypes-gtkfixed"> + <title>gtk.Fixed 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> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkfontbutton.xml b/docs/reference/pygtk-gtkfontbutton.xml index b39331aa..92b2e3b5 100644 --- a/docs/reference/pygtk-gtkfontbutton.xml +++ b/docs/reference/pygtk-gtkfontbutton.xml @@ -83,8 +83,13 @@ </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkfontbutton"> + <title>gtk.FontButton 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> + <para><link linkend="properties-gtkbutton">gtk.Button Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -104,16 +109,17 @@ <entry>"show-size"</entry> <entry>Read-Write</entry> <entry>If <literal>TRUE</literal>, the selected font size will -be shown in the label. For a more WYSIWIG way to show the selected size, see -the "use-size" property.</entry> + be shown in the label. For a more WYSIWIG way to show the + selected size, see the "use-size" property.</entry> </row> <row valign="top"> <entry>"show-style"</entry> <entry>Read-Write</entry> <entry>If <literal>TRUE</literal>, the name of the selected -font style will be shown in the label. For a more WYSIWIG way to show the -selected style, see the "use-font" property.</entry> + font style will be shown in the label. For a more WYSIWIG way + to show the selected style, see the "use-font" + property.</entry> </row> <row valign="top"> @@ -126,14 +132,14 @@ selected style, see the "use-font" property.</entry> <entry>"use-font"</entry> <entry>Read-Write</entry> <entry>If <literal>TRUE</literal>, the label will be drawn in -the selected font</entry> + the selected font</entry> </row> <row valign="top"> <entry>"use-size"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, the label will be drawn with -the selected font size.</entry> + <entry>If <literal>TRUE</literal>, the label will be drawn + with the selected font size.</entry> </row> </tbody> @@ -143,8 +149,22 @@ the selected font size.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="style-properties-gtkfontbutton"> + <title>gtk.FontButton Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkbutton">gtk.Button Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkfontbutton"> + <title>gtk.FontButton 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> + <para><link linkend="signal-prototypes-gtkbutton">gtk.Button Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkfontselection.xml b/docs/reference/pygtk-gtkfontselection.xml index cbbb0a7e..bd9526f9 100644 --- a/docs/reference/pygtk-gtkfontselection.xml +++ b/docs/reference/pygtk-gtkfontselection.xml @@ -57,8 +57,13 @@ linkend="method-gtkfontselection--set-preview-text">set_preview_text</link></met </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkfontselection"> + <title>gtk.FontSelection 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> + <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -69,34 +74,57 @@ linkend="method-gtkfontselection--set-preview-text">set_preview_text</link></met <colspec column="3" colwidth="3.5in"/> <tbody> - <row valign="top"> - <entry>"font-name"</entry> - <entry>Read/Write</entry> - <entry>The string that names the font</entry> - </row> - - <row valign="top"> - <entry>"font"</entry> - <entry>Read</entry> - <entry>The gtk.gdk.Font that is -currently selected. This property is deprecated.</entry> - </row> - - <row valign="top"> - <entry>"preview-text"</entry> - <entry>Read/Write</entry> - <entry>The text to display in order to demonstrate the selected -font. -</entry> - </row> - - </tbody> - </tgroup> + <row valign="top"> + <entry>"font"</entry> + <entry>Read</entry> + <entry>The gtk.gdk.Font that is + currently selected. This property is deprecated.</entry> + </row> + + <row valign="top"> + <entry>"font-name"</entry> + <entry>Read/Write</entry> + <entry>The string that names the font</entry> + </row> + + <row valign="top"> + <entry>"preview-text"</entry> + <entry>Read/Write</entry> + <entry>The text to display in order to demonstrate the selected + font. + </entry> + </row> + + </tbody> + </tgroup> </informaltable> </blockquote> </refsect1> + <refsect1 id="style-properties-gtkfontselection"> + <title>gtk.FontSelection Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="child-properties-gtkfontselection"> + <title>gtk.FontSelection Child Properties</title> + + <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkfontselection"> + <title>gtk.FontSelection 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> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkfontselectiondialog.xml b/docs/reference/pygtk-gtkfontselectiondialog.xml index 961f30d1..bad8b44d 100644 --- a/docs/reference/pygtk-gtkfontselectiondialog.xml +++ b/docs/reference/pygtk-gtkfontselectiondialog.xml @@ -60,6 +60,25 @@ linkend="method-gtkfontselectiondialog--set-preview-text">set_preview_text</link </refsect1> + <refsect1 id="properties-gtkfontselectiondialog"> + <title>gtk.FontSelectionDialog 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> + <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para> + <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkfontselectiondialog"> + <title>gtk.FontSelectionDialog Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para> + + </refsect1> + <refsect1> <title>Attributes</title> @@ -121,6 +140,17 @@ the action buttons</entry> </refsect1> + <refsect1 id="signal-prototypes-gtkfontselectiondialog"> + <title>gtk.FontSelectionDialog 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> + <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkframe.xml b/docs/reference/pygtk-gtkframe.xml index 09c28ddc..b71176c0 100644 --- a/docs/reference/pygtk-gtkframe.xml +++ b/docs/reference/pygtk-gtkframe.xml @@ -82,8 +82,12 @@ linkend="method-gtkframe--get-shadow-type">get_shadow_type</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkframe"> + <title>gtk.Frame 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"> @@ -100,6 +104,13 @@ linkend="method-gtkframe--get-shadow-type">get_shadow_type</link></methodname> </row> <row valign="top"> + <entry>"label-widget"</entry> + <entry>Read-Write</entry> + <entry>The widget to display in place of the usual frame +label.</entry> + </row> + + <row valign="top"> <entry>"label-xalign"</entry> <entry>Read-Write</entry> <entry>The horizontal alignment of the label widget in the @@ -122,13 +133,6 @@ label widget height in the range of 0.0 to 1.0</entry> <literal>gtk.SHADOW_ETCHED_OUT</literal></entry> </row> - <row valign="top"> - <entry>"label-widget"</entry> - <entry>Read-Write</entry> - <entry>The widget to display in place of the usual frame -label.</entry> - </row> - </tbody> </tgroup> </informaltable> @@ -136,6 +140,22 @@ label.</entry> </refsect1> + <refsect1 id="style-properties-gtkframe"> + <title>gtk.Frame Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkframe"> + <title>gtk.Frame 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> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkgammacurve.xml b/docs/reference/pygtk-gtkgammacurve.xml index 7eb36f93..5d5c96ef 100644 --- a/docs/reference/pygtk-gtkgammacurve.xml +++ b/docs/reference/pygtk-gtkgammacurve.xml @@ -39,6 +39,30 @@ linkend="constructor-gtkgammacurve">gtk.GammaCurve</link></methodname> </refsect1> + <refsect1 id="properties-gtkgammacurve"> + <title>gtk.GammaCurve 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> + <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkgammacurve"> + <title>gtk.GammaCurve Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="child-properties-gtkgammacurve"> + <title>gtk.GammaCurve Child Properties</title> + + <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para> + + </refsect1> + <refsect1> <title>Attributes</title> @@ -98,6 +122,15 @@ containing the gamma value in the gamma dialog</entry> </refsect1> + <refsect1 id="signal-prototypes-gtkgammacurve"> + <title>gtk.GammaCurve 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> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkhandlebox.xml b/docs/reference/pygtk-gtkhandlebox.xml index 1c89eba7..1a3434cc 100644 --- a/docs/reference/pygtk-gtkhandlebox.xml +++ b/docs/reference/pygtk-gtkhandlebox.xml @@ -66,8 +66,12 @@ linkend="method-gtkhandlebox--get-snap-edge">get_snap_edge</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkhandlebox"> + <title>gtk.HandleBox 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"> @@ -78,38 +82,36 @@ linkend="method-gtkhandlebox--get-snap-edge">get_snap_edge</link></methodname> <tbody> <row valign="top"> - <entry>"shadow-type"</entry> + <entry>"handle-position"</entry> <entry>Read-Write</entry> - <entry>The type of shadow; one of: -<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>, -<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>, -<literal>gtk.SHADOW_ETCHED_OUT</literal></entry> + <entry>The position of the handle relative to the child + widget; one of the <xref linkend="gtk-position-type-constants" + endterm="gtk-position-type-constants-title"></xref>.</entry> </row> <row valign="top"> - <entry>"handle-position"</entry> + <entry>"shadow-type"</entry> <entry>Read-Write</entry> - <entry>The position of the handle relative to the child -widget; one of: <literal>gtk.POS_LEFT</literal>, -<literal>gtk.POS_RIGHT</literal>, <literal>gtk.POS_TOP</literal>, -<literal>gtk.POS_BOTTOM</literal></entry> + <entry>The type of shadow; one of the <xref + linkend="gtk-shadow-type-constants" + endterm="gtk-shadow-type-constants-title"></xref>.</entry> </row> <row valign="top"> <entry>"snap-edge"</entry> <entry>Read-Write</entry> <entry>The side of the handlebox that's lined up with the -docking point to dock the handlebox; one of: -<literal>gtk.POS_LEFT</literal>, <literal>gtk.POS_RIGHT</literal>, -<literal>gtk.POS_TOP</literal>, <literal>gtk.POS_BOTTOM</literal></entry> + docking point to dock the handlebox; one of the <xref + linkend="gtk-position-type-constants" + endterm="gtk-position-type-constants-title"></xref>.</entry> </row> <row valign="top"> <entry>"snap-edge-set"</entry> <entry>Read-Write</entry> <entry>If <literal>TRUE</literal>, use the value from -"snap-edge"; otherwise, use a value derived from "handle-position". -Available in GTK+ 2.2 and above.</entry> + "snap-edge"; otherwise, use a value derived from + "handle-position". Available in GTK+ 2.2 and above.</entry> </row> </tbody> @@ -119,8 +121,20 @@ Available in GTK+ 2.2 and above.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="style-properties-gtkhandlebox"> + <title>gtk.HandleBox Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkhandlebox"> + <title>gtk.HandleBox 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> diff --git a/docs/reference/pygtk-gtkhbox.xml b/docs/reference/pygtk-gtkhbox.xml index e04fd345..ddfef3e8 100644 --- a/docs/reference/pygtk-gtkhbox.xml +++ b/docs/reference/pygtk-gtkhbox.xml @@ -40,6 +40,39 @@ linkend="constructor-gtkhbox">gtk.HBox</link></methodname> </refsect1> + <refsect1 id="properties-gtkhbox"> + <title>gtk.HBox 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> + <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkhbox"> + <title>gtk.HBox Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="child-properties-gtkhbox"> + <title>gtk.HBox Child Properties</title> + + <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkhbox"> + <title>gtk.HBox 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> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkhbuttonbox.xml b/docs/reference/pygtk-gtkhbuttonbox.xml index d1e9d3f1..3a0ead39 100644 --- a/docs/reference/pygtk-gtkhbuttonbox.xml +++ b/docs/reference/pygtk-gtkhbuttonbox.xml @@ -37,6 +37,42 @@ linkend="constructor-gtkhbuttonbox">gtk.HButtonBox</link></methodname> </refsect1> + <refsect1 id="properties-gtkhbuttonbox"> + <title>gtk.HButtonBox 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> + <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para> + <para><link linkend="properties-gtkbuttonbox">gtk.ButtonBox Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkhbuttonbox"> + <title>gtk.HButtonBox Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkbuttonbox">gtk.ButtonBox Style Properties</link></para> + + </refsect1> + + <refsect1 id="child-properties-gtkhbuttonbox"> + <title>gtk.HButtonBox Child Properties</title> + + <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para> + <para><link linkend="child-properties-gtkbuttonbox">gtk.ButtonBox Child Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkhbuttonbox"> + <title>gtk.HButtonBox 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> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkhpaned.xml b/docs/reference/pygtk-gtkhpaned.xml index 687e495a..c82e4546 100644 --- a/docs/reference/pygtk-gtkhpaned.xml +++ b/docs/reference/pygtk-gtkhpaned.xml @@ -37,6 +37,41 @@ linkend="constructor-gtkhpaned">gtk.HPaned</link></methodname> </refsect1> + <refsect1 id="properties-gtkhpaned"> + <title>gtk.HPaned 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> + <para><link linkend="properties-gtkpaned">gtk.Paned Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkhpaned"> + <title>gtk.HPaned Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkpaned">gtk.Paned Style Properties</link></para> + + </refsect1> + + <refsect1 id="child-properties-gtkhpaned"> + <title>gtk.HPaned Child Properties</title> + + <para><link linkend="child-properties-gtkpaned">gtk.Paned Child Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkhpaned"> + <title>gtk.HPaned 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> + <para><link linkend="signal-prototypes-gtkpaned">gtk.Paned Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkhruler.xml b/docs/reference/pygtk-gtkhruler.xml index 13c813d2..2e4adadc 100644 --- a/docs/reference/pygtk-gtkhruler.xml +++ b/docs/reference/pygtk-gtkhruler.xml @@ -35,6 +35,30 @@ linkend="constructor-gtkhruler">gtk.HRuler</link></methodname> </refsect1> + <refsect1 id="properties-gtkhruler"> + <title>gtk.HRuler 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-gtkruler">gtk.Ruler Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkhruler"> + <title>gtk.HRuler Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkhruler"> + <title>gtk.HRuler 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> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkhscale.xml b/docs/reference/pygtk-gtkhscale.xml index 48d3864e..aa39dea0 100644 --- a/docs/reference/pygtk-gtkhscale.xml +++ b/docs/reference/pygtk-gtkhscale.xml @@ -39,6 +39,35 @@ linkend="constructor-gtkhscale">gtk.HScale</link></methodname> </refsect1> + <refsect1 id="properties-gtkhscale"> + <title>gtk.HScale 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-gtkrange">gtk.Range Properties</link></para> + <para><link linkend="properties-gtkscale">gtk.Scale Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkhscale"> + <title>gtk.HScale Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkrange">gtk.Range Style Properties</link></para> + <para><link linkend="style-properties-gtkscale">gtk.Scale Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkhscale"> + <title>gtk.HScale 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-gtkrange">gtk.Range Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkscale">gtk.Scale Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkhscrollbar.xml b/docs/reference/pygtk-gtkhscrollbar.xml index c26da8d8..91db6630 100644 --- a/docs/reference/pygtk-gtkhscrollbar.xml +++ b/docs/reference/pygtk-gtkhscrollbar.xml @@ -38,6 +38,33 @@ linkend="constructor-gtkhscrollbar">gtk.HScrollbar</link></methodname> </refsect1> + <refsect1 id="properties-gtkhscrollbar"> + <title>gtk.HScrollbar 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-gtkrange">gtk.Range Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkhscrollbar"> + <title>gtk.HScrollbar Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkrange">gtk.Range Style Properties</link></para> + <para><link linkend="style-properties-gtkscrollbar">gtk.Scrollbar Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkhscrollbar"> + <title>gtk.HScrollbar 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-gtkrange">gtk.Range Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkhseparator.xml b/docs/reference/pygtk-gtkhseparator.xml index 8e0acd6e..9fe7e6fb 100644 --- a/docs/reference/pygtk-gtkhseparator.xml +++ b/docs/reference/pygtk-gtkhseparator.xml @@ -33,6 +33,29 @@ linkend="constructor-gtkhseparator">gtk.HSeparator</link></methodname> +-- <link linkend="class-gtkhseparator">gtk.HSeparator</link> </synopsis> + <refsect1 id="properties-gtkhseparator"> + <title>gtk.HSeparator Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkhseparator"> + <title>gtk.HSeparator Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkhseparator"> + <title>gtk.HSeparator 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> + </refsect1> + </refsect1> <refsect1> diff --git a/docs/reference/pygtk-gtkiconfactory.xml b/docs/reference/pygtk-gtkiconfactory.xml index 463762ab..d3a93a60 100644 --- a/docs/reference/pygtk-gtkiconfactory.xml +++ b/docs/reference/pygtk-gtkiconfactory.xml @@ -64,6 +64,12 @@ linkend="function-gtk--icon-factory-lookup-default">gtk.icon_factory_lookup_defa </refsect1> + <refsect1 id="signal-prototypes-gtkiconfactory"> + <title>gtk.IconFactory Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkicontheme.xml b/docs/reference/pygtk-gtkicontheme.xml index 91b5f113..fef67709 100644 --- a/docs/reference/pygtk-gtkicontheme.xml +++ b/docs/reference/pygtk-gtkicontheme.xml @@ -100,8 +100,10 @@ </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkicontheme"> + <title>gtk.IconTheme Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkiconview.xml b/docs/reference/pygtk-gtkiconview.xml index 53aec44f..ada229f1 100644 --- a/docs/reference/pygtk-gtkiconview.xml +++ b/docs/reference/pygtk-gtkiconview.xml @@ -15,6 +15,7 @@ PyGTK 2.6)</refpurpose> <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> @@ -233,12 +234,16 @@ PyGTK 2.6)</refpurpose> +-- <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></synopsis> + +-- <link linkend="class-gtkiconview">gtk.IconView</link> (implements <link linkend="class-gtkcelllayout">gtk.CellLayout</link>)</synopsis> </refsect1> - <refsect1> - <title>Properties</title> + <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"> @@ -378,8 +383,10 @@ to -1, no text is displayed. Allowed values: >= -1. Default value: </refsect1> - <refsect1> - <title>Style Properties</title> + <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"> @@ -412,8 +419,13 @@ and above.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <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> diff --git a/docs/reference/pygtk-gtkimage.xml b/docs/reference/pygtk-gtkimage.xml index 53d0d4ac..bbf2f5b0 100644 --- a/docs/reference/pygtk-gtkimage.xml +++ b/docs/reference/pygtk-gtkimage.xml @@ -164,8 +164,12 @@ linkend="method-gtkimage--clear">clear</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkimage"> + <title>gtk.Image 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-gtkmisc">gtk.Misc Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -287,6 +291,21 @@ endterm="gtk-image-type-constants-title"></xref>: </refsect1> + <refsect1 id="style-properties-gtkimage"> + <title>gtk.Image Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkimage"> + <title>gtk.Image 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> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkimagemenuitem.xml b/docs/reference/pygtk-gtkimagemenuitem.xml index b8ba67aa..a82ea5e8 100644 --- a/docs/reference/pygtk-gtkimagemenuitem.xml +++ b/docs/reference/pygtk-gtkimagemenuitem.xml @@ -53,8 +53,12 @@ linkend="method-gtkimagemenuitem--get-image">get_image</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkimagemenuitem"> + <title>gtk.ImageMenuItem 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"> @@ -78,6 +82,25 @@ item</entry> </refsect1> + <refsect1 id="style-properties-gtkimagemenuitem"> + <title>gtk.ImageMenuItem Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkmenuitem">gtk.MenuItem Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkimagemenuitem"> + <title>gtk.ImageMenuItem 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> + <para><link linkend="signal-prototypes-gtkitem">gtk.Item Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkmenuitem">gtk.MenuItem Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkimcontext.xml b/docs/reference/pygtk-gtkimcontext.xml index 57b46fe3..7dffe4a0 100644 --- a/docs/reference/pygtk-gtkimcontext.xml +++ b/docs/reference/pygtk-gtkimcontext.xml @@ -97,8 +97,8 @@ linkend="method-gtkimcontext--delete-surrounding">delete_surrounding</link></met </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkimcontext"> + <title>gtk.IMContext Signal Prototypes</title> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkimcontextsimple.xml b/docs/reference/pygtk-gtkimcontextsimple.xml index f9b738ac..b39671b6 100644 --- a/docs/reference/pygtk-gtkimcontextsimple.xml +++ b/docs/reference/pygtk-gtkimcontextsimple.xml @@ -45,6 +45,13 @@ END NOT IMPLEMENTED --> </refsect1> + <refsect1 id="signal-prototypes-gtkimcontextsimple"> + <title>gtk.IMContextSimple Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkimcontext">gtk.IMContext Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkimmulticontext.xml b/docs/reference/pygtk-gtkimmulticontext.xml index 5433b0f0..35a1b612 100644 --- a/docs/reference/pygtk-gtkimmulticontext.xml +++ b/docs/reference/pygtk-gtkimmulticontext.xml @@ -41,6 +41,13 @@ linkend="method-gtkimmulticontext--append-menuitems">append_menuitems</link></me </refsect1> + <refsect1 id="signal-prototypes-gtkimmulticontext"> + <title>gtk.IMMulticontext Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkimcontext">gtk.IMContext Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkinputdialog.xml b/docs/reference/pygtk-gtkinputdialog.xml index e4be51ef..2dd72fe3 100644 --- a/docs/reference/pygtk-gtkinputdialog.xml +++ b/docs/reference/pygtk-gtkinputdialog.xml @@ -39,8 +39,34 @@ linkend="constructor-gtkinputdialog">gtk.InputDialog</link></methodname> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="properties-gtkinputdialog"> + <title>gtk.InputDialog 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> + <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para> + <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkinputdialog"> + <title>gtk.InputDialog Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkinputdialog"> + <title>gtk.InputDialog 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> + <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkinvisible.xml b/docs/reference/pygtk-gtkinvisible.xml index 682abde2..a4cdb8de 100644 --- a/docs/reference/pygtk-gtkinvisible.xml +++ b/docs/reference/pygtk-gtkinvisible.xml @@ -41,8 +41,11 @@ linkend="constructor-gtkinvisible">gtk.Invisible</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkinvisible"> + <title>gtk.Invisible Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -65,6 +68,21 @@ linkend="constructor-gtkinvisible">gtk.Invisible</link></methodname> </refsect1> + <refsect1 id="style-properties-gtkinvisible"> + <title>gtk.Invisible Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkinvisible"> + <title>gtk.Invisible 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> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkitem.xml b/docs/reference/pygtk-gtkitem.xml index b67b9d95..290d99a5 100644 --- a/docs/reference/pygtk-gtkitem.xml +++ b/docs/reference/pygtk-gtkitem.xml @@ -45,8 +45,29 @@ linkend="method-gtkitem--toggle">toggle</link></methodname> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="properties-gtkitem"> + <title>gtk.Item 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> + + </refsect1> + + <refsect1 id="style-properties-gtkitem"> + <title>gtk.Item Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkitem"> + <title>gtk.Item 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> diff --git a/docs/reference/pygtk-gtkitemfactory.xml b/docs/reference/pygtk-gtkitemfactory.xml index f7dfbb42..8f1e984b 100644 --- a/docs/reference/pygtk-gtkitemfactory.xml +++ b/docs/reference/pygtk-gtkitemfactory.xml @@ -109,6 +109,20 @@ linkend="method-gtkitemfactory--popup">popup</link></methodname> </refsect1> + <refsect1 id="properties-gtkitemfactory"> + <title>gtk.ItemFactory Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkitemfactory"> + <title>gtk.ItemFactory 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> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtklabel.xml b/docs/reference/pygtk-gtklabel.xml index 4db8d8f6..6ff685d2 100644 --- a/docs/reference/pygtk-gtklabel.xml +++ b/docs/reference/pygtk-gtklabel.xml @@ -228,8 +228,12 @@ linkend="method-gtklabel--set-angle">set_angle</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtklabel"> + <title>gtk.Label 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-gtkmisc">gtk.Misc Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -401,8 +405,19 @@ becomes too wide. Default value: <literal>FALSE</literal></entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="style-properties-gtklabel"> + <title>gtk.Label Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtklabel"> + <title>gtk.Label 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> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtklayout.xml b/docs/reference/pygtk-gtklayout.xml index 228e1eb5..c5ceee4f 100644 --- a/docs/reference/pygtk-gtklayout.xml +++ b/docs/reference/pygtk-gtklayout.xml @@ -89,8 +89,12 @@ linkend="method-gtklayout--set-vadjustment">set_vadjustment</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtklayout"> + <title>gtk.Layout 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"> @@ -109,6 +113,12 @@ for the horizontal position.</entry> </row> <row valign="top"> + <entry>"height"</entry> + <entry>Read-Write</entry> + <entry>the layout height</entry> + </row> + + <row valign="top"> <entry>"vadjustment"</entry> <entry>Read-Write</entry> <entry>The <link @@ -122,12 +132,6 @@ for the vertical position.</entry> <entry>the layout width</entry> </row> - <row valign="top"> - <entry>"height"</entry> - <entry>Read-Write</entry> - <entry>the layout height</entry> - </row> - </tbody> </tgroup> </informaltable> @@ -135,8 +139,15 @@ for the vertical position.</entry> </refsect1> - <refsect1> - <title>Child Properties</title> + <refsect1 id="style-properties-gtklayout"> + <title>gtk.Layout Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="child-properties-gtklayout"> + <title>gtk.Layout Child Properties</title> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -189,8 +200,13 @@ for the vertical position.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtklayout"> + <title>gtk.Layout 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> diff --git a/docs/reference/pygtk-gtklinkbutton.xml b/docs/reference/pygtk-gtklinkbutton.xml index df2af853..5f99b47b 100644 --- a/docs/reference/pygtk-gtklinkbutton.xml +++ b/docs/reference/pygtk-gtklinkbutton.xml @@ -56,8 +56,13 @@ </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtklinkbutton"> + <title>gtk.LinkButton 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> + <para><link linkend="properties-gtkbutton">gtk.Button Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -81,6 +86,24 @@ </refsect1> + <refsect1 id="style-properties-gtklinkbutton"> + <title>gtk.LinkButton Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkbutton">gtk.Button Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtklinkbutton"> + <title>gtk.LinkButton 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> + <para><link linkend="signal-prototypes-gtkbutton">gtk.Button Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkliststore.xml b/docs/reference/pygtk-gtkliststore.xml index 2e635058..dcbd0726 100644 --- a/docs/reference/pygtk-gtkliststore.xml +++ b/docs/reference/pygtk-gtkliststore.xml @@ -146,6 +146,14 @@ linkend="method-gtkliststore--clear">clear</link></methodname> </refsect1> + <refsect1 id="signal-prototypes-gtkliststore"> + <title>gtk.ListStore Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtktreemodel">gtk.TreeModel Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtktreesortable">gtk.TreeSortable Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkmenu.xml b/docs/reference/pygtk-gtkmenu.xml index 68f20f5f..9255df17 100644 --- a/docs/reference/pygtk-gtkmenu.xml +++ b/docs/reference/pygtk-gtkmenu.xml @@ -32,6 +32,8 @@ linkend="method-gtkmenu--popup">popup</link></methodname> role="keyword">button</parameter></methodparam> <methodparam><parameter role="keyword">activate_time</parameter></methodparam> + <methodparam><parameter + role="keyword">data</parameter><initlaizer>None</initlaizer></methodparam> </methodsynopsis> <methodsynopsis language="python"> <methodname><link @@ -152,8 +154,13 @@ linkend="method-gtkmenu--reorder-child">reorder_child</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkmenu"> + <title>gtk.Menu 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> + <para><link linkend="properties-gtkmenushell">gtk.MenuShell Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -184,8 +191,10 @@ when this menu is torn-off. Default value: "".</entry> </refsect1> - <refsect1> - <title>Child Properties</title> + <refsect1 id="style-properties-gtkmenu"> + <title>gtk.Menu Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> <note> <para>These properties are available in GTK+ 2.4 and above.</para> @@ -200,31 +209,28 @@ when this menu is torn-off. Default value: "".</entry> <tbody> <row valign="top"> - <entry>"bottom-attach"</entry> - <entry>Read-Write</entry> - <entry>The row number to attach the bottom of the child - to. Allowed values: >= -1. Default value: -1.</entry> + <entry>"horizontal-offset"</entry> + <entry>Read</entry> + <entry>When the menu is a submenu, position it this number of pixels offset horizontally. Default value: -2.</entry> </row> - <row valign="top"> - <entry>"left-attach"</entry> - <entry>Read-Write</entry> - <entry>The column number to attach the left side of the child -to. Allowed values: >= -1. Default value: -1.</entry> - </row> + <row valign="top"> + <entry>"horizontal-padding"</entry> + <entry>Read</entry> + <entry>Extra space at the left and right edges of the menu</entry> + </row> <row valign="top"> - <entry>"right-attach"</entry> - <entry>Read-Write</entry> - <entry>The column number to attach the right side of the child -to. Allowed values: >= -1. Default value: -1.</entry> + <entry>"vertical-offset"</entry> + <entry>Read</entry> + <entry>When the menu is a submenu, position it this number of pixels offset vertically. Default value: 0.</entry> </row> <row valign="top"> - <entry>"top-attach"</entry> - <entry>Read-Write</entry> - <entry>The row number to attach the top of the child to. Allowed -values: >= -1. Default value: -1.</entry> + <entry>"vertical-padding"</entry> + <entry>Read</entry> + <entry>Extra space at the top and bottom of the menu. Allowed +values: >= 0. Default value: 1.</entry> </row> </tbody> @@ -234,8 +240,8 @@ values: >= -1. Default value: -1.</entry> </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="child-properties-gtkmenu"> + <title>gtk.Menu Child Properties</title> <note> <para>These properties are available in GTK+ 2.4 and above.</para> @@ -250,22 +256,31 @@ values: >= -1. Default value: -1.</entry> <tbody> <row valign="top"> - <entry>"horizontal-offset"</entry> - <entry>Read</entry> - <entry>When the menu is a submenu, position it this number of pixels offset horizontally. Default value: -2.</entry> + <entry>"bottom-attach"</entry> + <entry>Read-Write</entry> + <entry>The row number to attach the bottom of the child + to. Allowed values: >= -1. Default value: -1.</entry> </row> <row valign="top"> - <entry>"vertical-offset"</entry> - <entry>Read</entry> - <entry>When the menu is a submenu, position it this number of pixels offset vertically. Default value: 0.</entry> + <entry>"left-attach"</entry> + <entry>Read-Write</entry> + <entry>The column number to attach the left side of the child +to. Allowed values: >= -1. Default value: -1.</entry> </row> <row valign="top"> - <entry>"vertical-padding"</entry> - <entry>Read</entry> - <entry>Extra space at the top and bottom of the menu. Allowed -values: >= 0. Default value: 1.</entry> + <entry>"right-attach"</entry> + <entry>Read-Write</entry> + <entry>The column number to attach the right side of the child +to. Allowed values: >= -1. Default value: -1.</entry> + </row> + + <row valign="top"> + <entry>"top-attach"</entry> + <entry>Read-Write</entry> + <entry>The row number to attach the top of the child to. Allowed +values: >= -1. Default value: -1.</entry> </row> </tbody> @@ -275,8 +290,14 @@ values: >= 0. Default value: 1.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkmenu"> + <title>gtk.Menu 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> + <para><link linkend="signal-prototypes-gtkmenushell">gtk.MenuShell Signal Prototypes</link></para> <variablelist> <varlistentry> @@ -366,6 +387,8 @@ widget.</para> role="keyword">button</parameter></methodparam> <methodparam><parameter role="keyword">activate_time</parameter></methodparam> + <methodparam><parameter + role="keyword">data</parameter><initlaizer>None</initlaizer></methodparam> </methodsynopsis></programlisting> <variablelist> <varlistentry> @@ -396,30 +419,40 @@ role="keyword">activate_time</parameter> :</term> <listitem><simpara>the time at which the activation event occurred.</simpara></listitem> </varlistentry> - </variablelist> + <varlistentry> + <term><parameter +role="keyword">data</parameter> :</term> + <listitem><simpara>optional data to be passed to + <parameter>func</parameter></simpara></listitem> + </varlistentry> + </variablelist> <para>The <methodname>popup</methodname>() method displays a menu and -makes it available for selection. Applications can use this function to -display context-sensitive menus, and will typically supply -<literal>None</literal> for the <parameter>parent_menu_shell</parameter>, -<parameter>parent_menu_item</parameter> and <parameter>func</parameter> -parameters. The default menu positioning function will position the menu at -the current pointer position. The <parameter>button</parameter> and -<parameter>activate_time</parameter> values should be the mouse button that -was pressed to trigger the menu popup and the time the button was pressed. -These values can usually be retrieved from the "button_press_event".</para> + makes it available for selection. Applications can use this function + to display context-sensitive menus, and will typically supply + <literal>None</literal> for the + <parameter>parent_menu_shell</parameter>, + <parameter>parent_menu_item</parameter> and + <parameter>func</parameter> parameters. The default menu positioning + function will position the menu at the current pointer position. The + <parameter>button</parameter> and <parameter>activate_time</parameter> + values should be the mouse button that was pressed to trigger the menu + popup and the time the button was pressed. These values can usually + be retrieved from the "button_press_event".</para> <para>The signature of <parameter>func</parameter> is:</para> <programlisting> -def func(menu): + def func(menu, user_data): </programlisting> - <para><parameter>func</parameter> should return a 3-tuple containing -the x and y coordinates of the position to draw the menu and a boolean that, -if <literal>TRUE</literal>, indicates that the menu should be pushed in to -be completely inside the screen instead of just clamped to the size of the -screen.</para> + <para>where <parameter>user_data</parameter> is + <parameter>data</parameter> if not + <literal>None</literal>. <parameter>func</parameter> should return a + 3-tuple containing the x and y coordinates of the position to draw the + menu and a boolean that, if <literal>TRUE</literal>, indicates that + the menu should be pushed in to be completely inside the screen + instead of just clamped to the size of the screen.</para> </refsect2> diff --git a/docs/reference/pygtk-gtkmenubar.xml b/docs/reference/pygtk-gtkmenubar.xml index 283a4d0e..7c112470 100644 --- a/docs/reference/pygtk-gtkmenubar.xml +++ b/docs/reference/pygtk-gtkmenubar.xml @@ -58,8 +58,13 @@ linkend="method-gtkmenubar--get-child-pack-direction">get_child_pack_direction</ </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkmenubar"> + <title>gtk.MenuBar 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> + <para><link linkend="properties-gtkmenushell">gtk.MenuShell Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -94,8 +99,10 @@ Available in GTK+ 2.8 and above.</entry> </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="style-properties-gtkmenubar"> + <title>gtk.MenuBar Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -125,6 +132,16 @@ the menu items</entry> </refsect1> + <refsect1 id="signal-prototypes-gtkmenubar"> + <title>gtk.MenuBar 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> + <para><link linkend="signal-prototypes-gtkmenushell">gtk.MenuShell Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkmenuitem.xml b/docs/reference/pygtk-gtkmenuitem.xml index ca9069c4..b90c8010 100644 --- a/docs/reference/pygtk-gtkmenuitem.xml +++ b/docs/reference/pygtk-gtkmenuitem.xml @@ -100,8 +100,19 @@ linkend="method-gtkmenuitem--set-accel-path">set_accel_path</link></methodname> </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="properties-gtkmenuitem"> + <title>gtk.MenuItem 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> + + </refsect1> + + <refsect1 id="style-properties-gtkmenuitem"> + <title>gtk.MenuItem Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -111,11 +122,33 @@ linkend="method-gtkmenuitem--set-accel-path">set_accel_path</link></methodname> <colspec column="3" colwidth="4in"/> <tbody> - <row valign="top"> - <entry>"selected-shadow-type"</entry> - <entry>Read</entry> - <entry>The shadow type when the item is selected</entry> - </row> + <row valign="top"> + <entry>"arrow-spacing"</entry> + <entry>Read</entry> + <entry>Space between label and arrow. Allowed values: >= 0. + Default value: 10</entry> + </row> + + <row valign="top"> + <entry>"horizontal-padding"</entry> + <entry>Read</entry> + <entry>Padding to left and right of the menu item. Allowed + values: >= 0. Default value: 3</entry> + </row> + + <row valign="top"> + <entry>"selected-shadow-type"</entry> + <entry>Read</entry> + <entry>The shadow type when the item is selected. Default + value: <literal>gtk.SHADOW_NONE</literal></entry> + </row> + + <row valign="top"> + <entry>"toggle-spacing"</entry> + <entry>Read</entry> + <entry>Space between icon and label. Allowed values: >= 0. + Default value: 5</entry> + </row> </tbody> </tgroup> @@ -124,8 +157,14 @@ linkend="method-gtkmenuitem--set-accel-path">set_accel_path</link></methodname> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkmenuitem"> + <title>gtk.MenuItem 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> + <para><link linkend="signal-prototypes-gtkitem">gtk.Item Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkmenushell.xml b/docs/reference/pygtk-gtkmenushell.xml index 8bb3ea12..3e4819f9 100644 --- a/docs/reference/pygtk-gtkmenushell.xml +++ b/docs/reference/pygtk-gtkmenushell.xml @@ -93,8 +93,12 @@ linkend="method-gtkmenushell--get-take-focus">get_take_focus</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkmenushell"> + <title>gtk.MenuShell 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"> @@ -119,8 +123,20 @@ Available in GTK+ 2.8 and above.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="style-properties-gtkmenushell"> + <title>gtk.MenuShell Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkmenushell"> + <title>gtk.MenuShell 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> diff --git a/docs/reference/pygtk-gtkmenutoolbutton.xml b/docs/reference/pygtk-gtkmenutoolbutton.xml index f61f41d6..baef3581 100644 --- a/docs/reference/pygtk-gtkmenutoolbutton.xml +++ b/docs/reference/pygtk-gtkmenutoolbutton.xml @@ -59,8 +59,14 @@ containing a button with an additional dropdown menu (new in PyGTK </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkmenutoolbutton"> + <title>gtk.MenuToolButton 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> + <para><link linkend="properties-gtktoolitem">gtk.ToolItem Properties</link></para> + <para><link linkend="properties-gtktoolbutton">gtk.ToolButton Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -84,8 +90,23 @@ linkend="class-gtkmenu"><classname>gtk.Menu</classname></link>.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="style-properties-gtkmenutoolbutton"> + <title>gtk.MenuToolButton Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtktoolbutton">gtk.ToolButton Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkmenutoolbutton"> + <title>gtk.MenuToolButton 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> + <para><link linkend="signal-prototypes-gtktoolitem">gtk.ToolItem Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtktoolbutton">gtk.ToolButton Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkmessagedialog.xml b/docs/reference/pygtk-gtkmessagedialog.xml index a3e5d9c7..960eb0ed 100644 --- a/docs/reference/pygtk-gtkmessagedialog.xml +++ b/docs/reference/pygtk-gtkmessagedialog.xml @@ -67,8 +67,14 @@ linkend="constructor-gtkmessagedialog">gtk.MessageDialog</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkmessagedialog"> + <title>gtk.MessageDialog 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> + <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para> + <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -156,8 +162,11 @@ endterm="gtk-message-type-constants-title"></xref>: </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="style-properties-gtkmessagedialog"> + <title>gtk.MessageDialog Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -174,6 +183,14 @@ endterm="gtk-message-type-constants-title"></xref>: message dialog. Allowed values: >= 0. Default value: 12.</entry> </row> + <row valign="top"> + <entry>"use-separator"</entry> + <entry>Read</entry> + <entry>If <literal>TRUE</literal> draw a separator line between + the message label and the buttons in the dialog. This property is + available in GTK+ 2.4 and above.</entry> + </row> + </tbody> </tgroup> </informaltable> @@ -213,6 +230,17 @@ text.</entry> </refsect1> + <refsect1 id="signal-prototypes-gtkmessagedialog"> + <title>gtk.MessageDialog 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> + <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkmisc.xml b/docs/reference/pygtk-gtkmisc.xml index 178c2c25..1e8b6715 100644 --- a/docs/reference/pygtk-gtkmisc.xml +++ b/docs/reference/pygtk-gtkmisc.xml @@ -57,8 +57,11 @@ linkend="method-gtkmisc--get-padding">get_padding</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkmisc"> + <title>gtk.Misc Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -74,17 +77,17 @@ linkend="method-gtkmisc--get-padding">get_padding</link></methodname> <entry>The horizontal alignment, from 0.0 to 1.0</entry> </row> <row valign="top"> - <entry>"yalign"</entry> - <entry>Read-Write</entry> - <entry>The vertical alignment, from 0.0 to 1.0</entry> - </row> - <row valign="top"> <entry>"xpad"</entry> <entry>Read-Write</entry> <entry>The amount of space to add on the left and right of the widget, in pixels</entry> </row> <row valign="top"> + <entry>"yalign"</entry> + <entry>Read-Write</entry> + <entry>The vertical alignment, from 0.0 to 1.0</entry> + </row> + <row valign="top"> <entry>"ypad"</entry> <entry>Read-Write</entry> <entry>The amount of space to add above and below the widget, @@ -98,6 +101,21 @@ in pixels</entry> </refsect1> + <refsect1 id="style-properties-gtkmisc"> + <title>gtk.Misc Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkmisc"> + <title>gtk.Misc 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> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtknotebook.xml b/docs/reference/pygtk-gtknotebook.xml index a063dc8d..487b8d0b 100644 --- a/docs/reference/pygtk-gtknotebook.xml +++ b/docs/reference/pygtk-gtknotebook.xml @@ -288,8 +288,12 @@ linkend="method-gtknotebook--reorder-child">reorder_child</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtknotebook"> + <title>gtk.Notebook 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"> @@ -303,60 +307,77 @@ linkend="method-gtknotebook--reorder-child">reorder_child</link></methodname> <entry>"enable-popup"</entry> <entry>Read-Write</entry> <entry>If <literal>TRUE</literal>, pressing the right mouse -button on the notebook pops up a menu that you can use to go to a -page</entry> + button on the notebook pops up a menu that you can use to go + to a page. Default value: <literal>FALSE</literal>.</entry> </row> + <row valign="top"> + <entry>"group-id"</entry> + <entry>Read-Write</entry> + <entry>Group ID for tabs drag and drop. Allowed values: >= + -1. Default value: -1.</entry> + </row> + <row valign="top"> <entry>"homogeneous"</entry> <entry>Read-Write</entry> <entry>If <literal>TRUE</literal>, tabs should have -homogeneous sizes </entry> + homogeneous sizes. Default value: + <literal>FALSE</literal>.</entry> </row> <row valign="top"> <entry>"page"</entry> <entry>Read-Write</entry> - <entry>The index of the current page</entry> + <entry>The index of the current page. Allowed values: >= 0. + Default value: 0.</entry> </row> <row valign="top"> <entry>"scrollable"</entry> <entry>Read-Write</entry> <entry>If <literal>TRUE</literal>, scroll arrows are added if -there are too many tabs to fit</entry> + there are too many tabs to fit. Default value: + <literal>FALSE</literal>.</entry> </row> <row valign="top"> <entry>"show-border"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, the border should be -shown</entry> + <entry>If <literal>TRUE</literal>, the border should be shown. + Default value: <literal>TRUE</literal>.</entry> </row> <row valign="top"> <entry>"show-tabs"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, tabs should be -shown</entry> + <entry>If <literal>TRUE</literal>, tabs should be shown. + Default value: <literal>TRUE</literal>.</entry> </row> <row valign="top"> <entry>"tab-border"</entry> <entry>Write</entry> - <entry>The width of the border around the tab labels</entry> + <entry>The width of the border around the tab labels. Default + value: 2.</entry> </row> <row valign="top"> <entry>"tab-hborder"</entry> <entry>Read-Write</entry> - <entry>The width of the horizontal border of tab -labels</entry> + <entry>The width of the horizontal border of tab labels. + Default value: 2.</entry> </row> <row valign="top"> <entry>"tab-pos"</entry> <entry>Read-Write</entry> - <entry>The side of the notebook that holds the tabs: -<literal>gtk.POS_LEFT</literal>, <literal>gtk.POS_RIGHT</literal>, -<literal>gtk.POS_TOP</literal> or <literal>gtk.POS_BOTTOM</literal></entry> + <entry>The side of the notebook that holds the tabs - one of + the <xref linkend="gtk-position-type-constants" + endterm="gtk-position-type-constants-title"></xref>: + <literal>gtk.POS_LEFT</literal>, + <literal>gtk.POS_RIGHT</literal>, + <literal>gtk.POS_TOP</literal> or + <literal>gtk.POS_BOTTOM</literal>. Default value: + <literal>gtk.POS_TOP</literal>.</entry> </row> <row valign="top"> <entry>"tab-vborder"</entry> <entry>Read-Write</entry> - <entry>The width of the vertical border of tab labels</entry> + <entry>The width of the vertical border of tab labels. + Default value: 2,</entry> </row> </tbody> @@ -366,8 +387,10 @@ labels</entry> </refsect1> - <refsect1> - <title>Child Properties</title> + <refsect1 id="style-properties-gtknotebook"> + <title>gtk.Notebook Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -378,39 +401,61 @@ labels</entry> <tbody> <row valign="top"> - <entry>"menu-label"</entry> + <entry>"arrow-spacing"</entry> <entry>Read-Write</entry> - <entry>The string displayed in the child's menu entry</entry> + <entry>The "arrow-size" property defines the spacing between + the scroll arrows and the tabs. Allowed values: >= 0. + Default value: 0. Available in GTK+ 2.10.</entry> </row> + <row valign="top"> - <entry>"position"</entry> + <entry>"has-backward-stepper"</entry> <entry>Read-Write</entry> - <entry>The index of the child in the parent</entry> + <entry>If <literal>TRUE</literal> the standard backward arrow + button is displayed. Default value: + <literal>TRUE</literal>. Available in GTK+ 2.4 and + above.</entry> </row> + <row valign="top"> - <entry>"tab-expand"</entry> + <entry>"has-forward-stepper"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, expand the child's -tabs</entry> + <entry>If <literal>TRUE</literal> the standard forward arrow + button is displayed. Default value: + <literal>TRUE</literal>. Available in GTK+ 2.4 and above.</entry> </row> + <row valign="top"> - <entry>"tab-fill"</entry> + <entry>"has-secondary-backward-stepper"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, the child's tab should fill -the allocated area</entry> + <entry>If <literal>TRUE</literal> a second backward arrow + button is displayed on the opposite end of the tab + area. Default value: <literal>FALSE</literal>. Available in + GTK+ 2.4 and above.</entry> </row> + <row valign="top"> - <entry>"tab-label"</entry> + <entry>"has-secondary-forward-stepper"</entry> <entry>Read-Write</entry> - <entry>The string displayed on the child's tab label</entry> + <entry>If <literal>TRUE</literal> a second forward arrow + button is displayed on the opposite end of the tab + area. Default value: <literal>FALSE</literal>. Available in + GTK+ 2.4 and above.</entry> </row> + <row valign="top"> - <entry>tab-pack""</entry> + <entry>"tab-curvature"</entry> <entry>Read-Write</entry> - <entry>A pack type indicating whether the child is packed with -reference to the start or end of the parent: -<literal>gtk.PACK_START</literal> or -<literal>gtk.PACK_END</literal>.</entry> + <entry>The "tab-curvature" property defines size of tab + curvature. Allowed values: >= 0. Default value: 1. Available + in GTK+ 2.10.</entry> + </row> + + <row valign="top"> + <entry>"tab-overlap"</entry> + <entry>Read-Write</entry> + <entry>The "tab-overlap" property defines size of tab overlap + area. Default value: 2. Available in GTK+ 2.10.</entry> </row> </tbody> @@ -420,8 +465,8 @@ reference to the start or end of the parent: </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="child-properties-gtknotebook"> + <title>gtk.Notebook Child Properties</title> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -431,57 +476,54 @@ reference to the start or end of the parent: <colspec column="3" colwidth="4in"/> <tbody> - <row valign="top"> - <entry>"arrow-spacing"</entry> - <entry>Read-Write</entry> - <entry>The "arrow-size" property defines the spacing between - the scroll arrows and the tabs. Allowed values: >= 0. - Default value: 0. Available in GTK+ 2.10.</entry> - </row> + <row valign="top"> + <entry>"detachable"</entry> + <entry>Read-Write</entry> + <entry>if <literal>TRUE</literal> the tab is detachable. + Default value: <literal>FALSE</literal>.</entry> + </row> <row valign="top"> - <entry>"has-backward-stepper"</entry> + <entry>"menu-label"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal> the standard backward arrow - button is displayed. Available in GTK+ 2.4 and above.</entry> + <entry>The string displayed in the child's menu entry. + Default value: <literal>None</literal></entry> </row> - <row valign="top"> - <entry>"has-forward-stepper"</entry> + <entry>"position"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal> the standard forward arrow - button is displayed. Available in GTK+ 2.4 and above.</entry> + <entry>The index of the child in the parent. Allowed values: + >= -1 Default value: 0.</entry> </row> - <row valign="top"> - <entry>"has-secondary-backward-stepper"</entry> + <entry>"tab-expand"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal> a second backward arrow - button is displayed on the opposite end of the tab - area. Available in GTK+ 2.4 and above.</entry> + <entry>If <literal>TRUE</literal>, expand the child's tabs. + Default value: <literal>FALSE</literal>.</entry> </row> - <row valign="top"> - <entry>"has-secondary-forward-stepper"</entry> + <entry>"tab-fill"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal> a second forward arrow - button is displayed on the opposite end of the tab - area. Available in GTK+ 2.4 and above.</entry> + <entry>If <literal>TRUE</literal>, the child's tab should fill + the allocated area. Default value: + <literal>TRUE</literal>.</entry> </row> - <row valign="top"> - <entry>"tab-curvature"</entry> + <entry>"tab-label"</entry> <entry>Read-Write</entry> - <entry>The "tab-curvature" property defines size of tab - curvature. Allowed values: >= 0. Default value: 1. Available - in GTK+ 2.10.</entry> + <entry>The string displayed on the child's tab label. Default + value: <literal>None</literal>.</entry> </row> - <row valign="top"> - <entry>"tab-overlap"</entry> + <entry>tab-pack""</entry> <entry>Read-Write</entry> - <entry>The "tab-overlap" property defines size of tab overlap - area. Default value: 2. Available in GTK+ 2.10.</entry> + <entry>A pack type indicating whether the child is packed with + reference to the start or end of the parent - one of the <xref + linkend="gtk-pack-type-constants" + endterm="gtk-pack-type-constants-title"></xref>: + <literal>gtk.PACK_START</literal> or + <literal>gtk.PACK_END</literal>. Default value: + <literal>gtk.PACK_START</literal>.</entry> </row> </tbody> @@ -518,8 +560,13 @@ reference to the start or end of the parent: </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtknotebook"> + <title>gtk.Notebook 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> diff --git a/docs/reference/pygtk-gtkobject.xml b/docs/reference/pygtk-gtkobject.xml index af1bfa57..0e310e3e 100644 --- a/docs/reference/pygtk-gtkobject.xml +++ b/docs/reference/pygtk-gtkobject.xml @@ -84,8 +84,34 @@ linkend="function-gtk--binding-entry-remove">gtk.binding_entry_remove</link></me </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="properties-gtkobject"> + <title>gtk.Object Properties</title> + + <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="3.5in"/> + <tbody> + + <row valign="top"> + <entry>"user-data"</entry> + <entry>Read-Write</entry> + <entry>Anonymous User Data Pointer</entry> + </row> + + </tbody> + </tgroup> + </informaltable> + </blockquote> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkobject"> + <title>gtk.Object Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkoptionmenu.xml b/docs/reference/pygtk-gtkoptionmenu.xml index 68a07e6c..6216015a 100644 --- a/docs/reference/pygtk-gtkoptionmenu.xml +++ b/docs/reference/pygtk-gtkoptionmenu.xml @@ -61,8 +61,13 @@ linkend="method-gtkoptionmenu--set-history">set_history</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkoptionmenu"> + <title>gtk.OptionMenu 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> + <para><link linkend="properties-gtkbutton">gtk.Button Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -85,8 +90,11 @@ linkend="method-gtkoptionmenu--set-history">set_history</link></methodname> </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="style-properties-gtkoptionmenu"> + <title>gtk.OptionMenu Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkbutton">gtk.Button Style Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -97,14 +105,14 @@ linkend="method-gtkoptionmenu--set-history">set_history</link></methodname> <tbody> <row valign="top"> - <entry>"indicator-spacing"</entry> + <entry>"indicator-size"</entry> <entry>Read</entry> - <entry>The spacing around the indicator.</entry> + <entry>The size of the dropdown indicator</entry> </row> <row valign="top"> - <entry>"indicator-size"</entry> + <entry>"indicator-spacing"</entry> <entry>Read</entry> - <entry>The size of the dropdown indicator</entry> + <entry>The spacing around the indicator.</entry> </row> </tbody> @@ -114,8 +122,14 @@ linkend="method-gtkoptionmenu--set-history">set_history</link></methodname> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkoptionmenu"> + <title>gtk.OptionMenu 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> + <para><link linkend="signal-prototypes-gtkbutton">gtk.Button Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkpagesetup.xml b/docs/reference/pygtk-gtkpagesetup.xml index 4bbedd72..682e5947 100644 --- a/docs/reference/pygtk-gtkpagesetup.xml +++ b/docs/reference/pygtk-gtkpagesetup.xml @@ -98,6 +98,16 @@ </methodsynopsis> </classsynopsis> +<programlisting> +<emphasis role="bold">Functions</emphasis> + +<methodsynopsis language="python"> + <methodname><link linkend="function-gtk--print-run-page-setup-dialog">gtk.print_run_page_setup_dialog</link></methodname> + <methodparam><parameter role="keyword">parent</parameter></methodparam> + <methodparam><parameter role="keyword">page_setup</parameter></methodparam> + <methodparam><parameter role="keyword">settings</parameter></methodparam> + </methodsynopsis></programlisting> + </refsect1> <refsect1> @@ -109,6 +119,12 @@ </refsect1> + <refsect1 id="signal-prototypes-gtkpagesetup"> + <title>gtk.PageSetup Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> @@ -746,4 +762,56 @@ </refsect1> + <refsect1> + <title>Functions</title> + + <refsect2 id="function-gtk--print-run-page-setup-dialog"> + <title>gtk.print_run_page_setup_dialog</title> + + <programlisting><methodsynopsis language="python"> + <methodname>gtk.print_run_page_setup_dialog</methodname> + <methodparam><parameter + role="keyword">parent</parameter></methodparam> + <methodparam><parameter + role="keyword">page_setup</parameter></methodparam> + <methodparam><parameter + role="keyword">settings</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">parent</parameter> :</term> + <listitem><simpara>transient parent, or + <literal>None</literal></simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">page_setup</parameter> :</term> + <listitem><simpara>an existing <link + linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>, + or <literal>None</literal></simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">settings</parameter> :</term> + <listitem><simpara>a <link + linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link></simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>a new <link + linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link></simpara></listitem> + </varlistentry> + </variablelist> + + <para>Runs a page setup dialog, letting the user modify the values + from page_setup. If the user cancels the dialog, the returned <link + linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link> + is identical to the passed in page_setup, otherwise it contains the + modifications done in the dialog.</para> + + <para>Note that this function may use a recursive mainloop to show the + page setup dialog.</para> + + </refsect2> + + </refsect1> + </refentry> diff --git a/docs/reference/pygtk-gtkpagesetupunixdialog.xml b/docs/reference/pygtk-gtkpagesetupunixdialog.xml index 67a5a627..9b7613ed 100644 --- a/docs/reference/pygtk-gtkpagesetupunixdialog.xml +++ b/docs/reference/pygtk-gtkpagesetupunixdialog.xml @@ -56,6 +56,36 @@ </refsect1> + <refsect1 id="properties-gtkpagesetupunixdialog"> + <title>gtk.unixprint.PageSetupUnixDialog 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> + <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para> + <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkpagesetupunixdialog"> + <title>gtk.unixprint.PageSetupUnixDialog Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkpagesetupunixdialog"> + <title>gtk.unixprint.PageSetupUnixDialog 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> + <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkpaned.xml b/docs/reference/pygtk-gtkpaned.xml index ffe75f3a..c6b4b917 100644 --- a/docs/reference/pygtk-gtkpaned.xml +++ b/docs/reference/pygtk-gtkpaned.xml @@ -92,8 +92,12 @@ linkend="method-gtkpaned--compute-position">compute_position</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkpaned"> + <title>gtk.Paned 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"> @@ -140,8 +144,8 @@ valid.</entry> </refsect1> - <refsect1> - <title>Child Properties</title> + <refsect1 id="child-properties-gtkpaned"> + <title>gtk.Paned Child Properties</title> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -172,8 +176,10 @@ smaller than its requisition. Available in GTK+ 2.4 and above.</entry> </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="style-properties-gtkpaned"> + <title>gtk.Paned Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -196,11 +202,15 @@ smaller than its requisition. Available in GTK+ 2.4 and above.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkpaned"> + <title>gtk.Paned Signal Prototypes</title> - <variablelist> + <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-gtkpaned--accept-position">accept-position</link>"</term> diff --git a/docs/reference/pygtk-gtkplug.xml b/docs/reference/pygtk-gtkplug.xml index 28625303..6fc084c2 100644 --- a/docs/reference/pygtk-gtkplug.xml +++ b/docs/reference/pygtk-gtkplug.xml @@ -59,8 +59,31 @@ linkend="method-gtkplug--get-id">get_id</link></methodname> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="properties-gtkplug"> + <title>gtk.Plug 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> + <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkplug"> + <title>gtk.Plug Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkplug"> + <title>gtk.Plug 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> + <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkprinter.xml b/docs/reference/pygtk-gtkprinter.xml index c8412e13..3574725d 100644 --- a/docs/reference/pygtk-gtkprinter.xml +++ b/docs/reference/pygtk-gtkprinter.xml @@ -83,8 +83,8 @@ END NOT IMPLEMENTED --> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkprinter"> + <title>gtk.unixprint.Printer Properties</title> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -94,6 +94,20 @@ END NOT IMPLEMENTED --> <colspec column="3" colwidth="4in"/> <tbody> + <row valign="top"> + <entry>"accepts-pdf"</entry> + <entry>Read-Write-Construct Only</entry> + <entry>if <literal>TRUE</literal> this printer can accept + PDF. Available in GTK+ 2.10.</entry> + </row> + + <row valign="top"> + <entry>"accepts-ps"</entry> + <entry>Read-Write-Construct Only</entry> + <entry>if <literal>TRUE</literal> this printer can accept + PostScript. Available in GTK+ 2.10.</entry> + </row> + <row valign="top"> <entry>"backend"</entry> <entry>Read-Write-Construct Only</entry> @@ -153,8 +167,10 @@ END NOT IMPLEMENTED --> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkprinter"> + <title>gtk.unixprint.Printer Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkprintjob.xml b/docs/reference/pygtk-gtkprintjob.xml index e627bce5..a9918484 100644 --- a/docs/reference/pygtk-gtkprintjob.xml +++ b/docs/reference/pygtk-gtkprintjob.xml @@ -72,8 +72,8 @@ </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkprintjob"> + <title>gtk.unixprint.PrintJob Properties</title> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -109,6 +109,15 @@ <literal>None</literal>. Available in GTK+ 2.10.</entry> </row> + <row valign="top"> + <entry>"track-print-status"</entry> + <entry>Read-Write</entry> + <entry>if <literal>TRUE</literal> the print job will continue + to emit status-changed signals after the print data has been + sent to the printer or print server. Available in GTK+ + 2.10.</entry> + </row> + </tbody> </tgroup> </informaltable> @@ -116,8 +125,10 @@ </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkprintjob"> + <title>gtk.unixprint.PrintJob Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkprintunixdialog.xml b/docs/reference/pygtk-gtkprintunixdialog.xml index 06e04bd7..2457560f 100644 --- a/docs/reference/pygtk-gtkprintunixdialog.xml +++ b/docs/reference/pygtk-gtkprintunixdialog.xml @@ -77,8 +77,14 @@ </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkprintunixdialog"> + <title>gtk.unixprint.PrintUnixDialog 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> + <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para> + <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -117,7 +123,7 @@ <entry>Read-Write</entry> <entry>The <link linkend="class-gtkprinter"><classname>gtk.Printer</classname></link> - which is selected. Available in GTK+ 2.10.</entry> + that is selected. Available in GTK+ 2.10.</entry> </row> </tbody> @@ -127,6 +133,25 @@ </refsect1> + <refsect1 id="style-properties-gtkprintunixdialog"> + <title>gtk.unixprint.PrintUnixDialog Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkprintunixdialog"> + <title>gtk.unixprint.PrintUnixDialog 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> + <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkprogressbar.xml b/docs/reference/pygtk-gtkprogressbar.xml index 9b670e99..f5d23849 100644 --- a/docs/reference/pygtk-gtkprogressbar.xml +++ b/docs/reference/pygtk-gtkprogressbar.xml @@ -95,8 +95,12 @@ linkend="method-gtkprogressbar--get-ellipsize">get_ellipsize</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkprogressbar"> + <title>gtk.ProgressBar 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-gtkprogress">gtk.Progress Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -106,6 +110,29 @@ linkend="method-gtkprogressbar--get-ellipsize">get_ellipsize</link></methodname> <colspec column="3" colwidth="4in"/> <tbody> + <row valign="top"> + <entry>"discrete-blocks"</entry> + <entry>Read-Write</entry> + <entry>The number of discrete blocks in a progress bar (when shown + in the discrete style)</entry> + </row> + + <row valign="top"> + <entry>"ellipsize"</entry> + <entry>Read-Write</entry> + <entry>The preferred place to ellipsize the string, if the + progressbar does not have enough room to display the entire + string, specified as one of the <xref + linkend="pango-ellipsize-mode-constants" + endterm="pango-ellipsize-mode-constants-title"></xref>. Note that + setting this property to a value other than + <literal>pango.ELLIPSIZE_NONE</literal> has the side-effect that + the progressbar requests only enough space to display the ellipsis + "...". Another means to set a progressbar's width is the <link + linkend="method-gtkwidget--set-size-request"><methodname>gtk.Widget.set_size_request()</methodname></link>. + This property is available in GTK+ 2.6 and above.</entry> + </row> + <row valign="top"> <entry>"fraction"</entry> <entry>Read-Write</entry> @@ -113,13 +140,6 @@ linkend="method-gtkprogressbar--get-ellipsize">get_ellipsize</link></methodname> </row> <row valign="top"> - <entry>"pulse-step"</entry> - <entry>Read-Write</entry> - <entry>The fraction of total progress to move the bouncing -block when pulsed</entry> - </row> - - <row valign="top"> <entry>"orientation"</entry> <entry>Read-Write</entry> <entry>The orientation and growth direction of the progress @@ -133,6 +153,13 @@ endterm="gtk-progressbar-orientation-constants-title"></xref>: </row> <row valign="top"> + <entry>"pulse-step"</entry> + <entry>Read-Write</entry> + <entry>The fraction of total progress to move the bouncing +block when pulsed</entry> + </row> + + <row valign="top"> <entry>"text"</entry> <entry>Read-Write</entry> <entry>The text to be displayed in the progress bar</entry> @@ -145,6 +172,21 @@ endterm="gtk-progressbar-orientation-constants-title"></xref>: </refsect1> + <refsect1 id="style-properties-gtkprogressbar"> + <title>gtk.ProgressBar Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkprogressbar"> + <title>gtk.ProgressBar 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> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkradioaction.xml b/docs/reference/pygtk-gtkradioaction.xml index 337ed530..7f7209f5 100644 --- a/docs/reference/pygtk-gtkradioaction.xml +++ b/docs/reference/pygtk-gtkradioaction.xml @@ -50,12 +50,11 @@ </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkradioaction"> + <title>gtk.RadioAction Properties</title> - <note> - <para>These properties are available in GTK+ 2.4 and above.</para> - </note> + <para><link linkend="properties-gtkaction">gtk.Action Properties</link></para> + <para><link linkend="properties-gtktoggleaction">gtk.ToggleAction Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -65,10 +64,19 @@ <colspec column="3" colwidth="4in"/> <tbody> + <row valign="top"> + <entry>"current-value"</entry> + <entry>Read-Write</entry> + <entry>The value property of the currently active member of the + group to which this action belongs. This property is available in + GTK+ 2.10 and above.</entry> + </row> + <row valign="top"> <entry>"group"</entry> <entry>Write</entry> - <entry>Sets a new group for a radio action.</entry> + <entry>Sets a new group for a radio action. This property is + available in GTK+ 2.4 and above</entry> </row> <row valign="top"> @@ -76,12 +84,14 @@ <entry>Read-Write</entry> <entry>The value is an arbitrary integer which can be used as -a convenient way to determine which action in the group is currently active -in an "activate" or "changed" signal handler. See the <link -linkend="method-gtkradioaction--get-current-value"><methodname>get_current_value</methodname>()</link> -and the <link -linkend="method-gtkactiongroup--add-radio-actions"><methodname>gtk.ActionGroup.add_radio_actions</methodname>()</link> -methods for convenient ways to get and set this property.</entry> + a convenient way to determine which action in the group is + currently active in an "activate" or "changed" signal + handler. See the <link + linkend="method-gtkradioaction--get-current-value"><methodname>get_current_value</methodname>()</link> + and the <link + linkend="method-gtkactiongroup--add-radio-actions"><methodname>gtk.ActionGroup.add_radio_actions</methodname>()</link> + methods for convenient ways to get and set this property. This + property is available in GTK+ 2.4 and above</entry> </row> </tbody> @@ -91,12 +101,12 @@ methods for convenient ways to get and set this property.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkradioaction"> + <title>gtk.RadioAction Signal Prototypes</title> - <note> - <para>This signal is available in GTK+ 2.4 and above.</para> - </note> + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkaction">gtk.Action Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtktoggleaction">gtk.ToggleAction Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkradiobutton.xml b/docs/reference/pygtk-gtkradiobutton.xml index cb16bdaf..a932bc61 100644 --- a/docs/reference/pygtk-gtkradiobutton.xml +++ b/docs/reference/pygtk-gtkradiobutton.xml @@ -57,8 +57,14 @@ linkend="method-gtkradiobutton--set-group">set_group</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkradiobutton"> + <title>gtk.RadioButton 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> + <para><link linkend="properties-gtkbutton">gtk.Button Properties</link></para> + <para><link linkend="properties-gtktogglebutton">gtk.ToggleButton Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -81,8 +87,24 @@ linkend="method-gtkradiobutton--set-group">set_group</link></methodname> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="style-properties-gtkradiobutton"> + <title>gtk.RadioButton Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkbutton">gtk.Button Style Properties</link></para> + <para><link linkend="style-properties-gtkcheckbutton">gtk.CheckButton Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkradiobutton"> + <title>gtk.RadioButton 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> + <para><link linkend="signal-prototypes-gtkbutton">gtk.Button Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtktogglebutton">gtk.ToggleButton Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkradiomenuitem.xml b/docs/reference/pygtk-gtkradiomenuitem.xml index 1e79babd..3cc6a7bb 100644 --- a/docs/reference/pygtk-gtkradiomenuitem.xml +++ b/docs/reference/pygtk-gtkradiomenuitem.xml @@ -54,8 +54,55 @@ linkend="method-gtkradiomenuitem--set-group">set_group</link></methodname> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="properties-gtkradiomenuitem"> + <title>gtk.RadioMenuItem 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> + <para><link linkend="properties-gtkcheckmenuitem">gtk.CheckMenuItem 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="3.5in"/> + <tbody> + + <row valign="top"> + <entry>"group"</entry> + <entry>Write</entry> + <entry>The radio menu item whose group this widget belongs to. + This property is available in GTK+ 2.8 and above.</entry> + </row> + + </tbody> + </tgroup> + </informaltable> + </blockquote> + + </refsect1> + + <refsect1 id="style-properties-gtkradiomenuitem"> + <title>gtk.RadioMenuItem Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkmenuitem">gtk.MenuItem Style Properties</link></para> + <para><link linkend="style-properties-gtkcheckmenuitem">gtk.CheckMenuItem Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkradiomenuitem"> + <title>gtk.RadioMenuItem 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> + <para><link linkend="signal-prototypes-gtkitem">gtk.Item Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkmenuitem">gtk.MenuItem Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkcheckmenuitem">gtk.CheckMenuItem Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkradiotoolbutton.xml b/docs/reference/pygtk-gtkradiotoolbutton.xml index 0ecab09d..7bac5e60 100644 --- a/docs/reference/pygtk-gtkradiotoolbutton.xml +++ b/docs/reference/pygtk-gtkradiotoolbutton.xml @@ -46,12 +46,15 @@ </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkradiotoolbutton"> + <title>gtk.RadioToolButton Properties</title> - <note> - <para>This property is available in GTK+ 2.4 and above.</para> - </note> + <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> + <para><link linkend="properties-gtktoolitem">gtk.ToolItem Properties</link></para> + <para><link linkend="properties-gtktoolbutton">gtk.ToolButton Properties</link></para> + <para><link linkend="properties-gtktoggletoolbutton">gtk.ToggleToolButton Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -64,7 +67,8 @@ <row valign="top"> <entry>"group"</entry> <entry>Write</entry> - <entry>Sets a new group for a radio tool button.</entry> + <entry>Sets a new group for a radio tool button. This property + is available in GTK+ 2.4 and above.</entry> </row> </tbody> @@ -74,6 +78,26 @@ </refsect1> + <refsect1 id="style-properties-gtkradiotoolbutton"> + <title>gtk.RadioToolButton Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtktoolbutton">gtk.ToolButton Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkradiotoolbutton"> + <title>gtk.RadioToolButton 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> + <para><link linkend="signal-prototypes-gtktoolitem">gtk.ToolItem Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtktoolbutton">gtk.ToolButton Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtktoggletoolbutton">gtk.ToggleToolButton Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkrange.xml b/docs/reference/pygtk-gtkrange.xml index 52c69e99..fdaba965 100644 --- a/docs/reference/pygtk-gtkrange.xml +++ b/docs/reference/pygtk-gtkrange.xml @@ -85,8 +85,11 @@ linkend="method-gtkrange--get-value">get_value</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkrange"> + <title>gtk.Range Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -100,24 +103,31 @@ linkend="method-gtkrange--get-value">get_value</link></methodname> <entry>"adjustment"</entry> <entry>Read-Write</entry> <entry>The <link -linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link> -that contains the current value of this range object</entry> + linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link> + that contains the current value of this range object</entry> </row> <row valign="top"> <entry>"inverted"</entry> <entry>Read-Write</entry> <entry>If <literal>TRUE</literal>, the slider movement is -reversed e.g right-to-left instead of left-to-right</entry> + reversed e.g right-to-left instead of left-to-right</entry> </row> + <row valign="top"> + <entry>"lower-stepper-sensitivity"</entry> + <entry>Read-Write</entry> + <entry>The sensitivity policy for the stepper that points to the + adjustment's lower side</entry> + </row> + <row valign="top"> <entry>"update-policy"</entry> <entry>Read-Write</entry> <entry>How the range should be updated on the screen: -<literal>gtk.UPDATE_CONTINUOUS</literal>, -<literal>gtk.UPDATE_DISCONTINUOUS</literal>, -<literal>gtk.UPDATE_DELAYED</literal>.</entry> + <literal>gtk.UPDATE_CONTINUOUS</literal>, + <literal>gtk.UPDATE_DISCONTINUOUS</literal>, + <literal>gtk.UPDATE_DELAYED</literal>.</entry> </row> </tbody> @@ -127,8 +137,10 @@ reversed e.g right-to-left instead of left-to-right</entry> </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="style-properties-gtkrange"> + <title>gtk.Range Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -138,18 +150,26 @@ reversed e.g right-to-left instead of left-to-right</entry> <colspec column="3" colwidth="4in"/> <tbody> + <row valign="top"> + <entry>"activate-slider"</entry> + <entry>Read</entry> + <entry>With this option set to <literal>TRUE</literal>, + sliders will be drawn <literal>ACTIVE</literal> and with + shadow <literal>IN</literal> while they are dragged</entry> + </row> + <row valign="top"> <entry>"arrow-displacement-x"</entry> <entry>Read</entry> <entry>The distance horizontally to move the arrow when the -button is depressed</entry> + button is depressed</entry> </row> <row valign="top"> <entry>"arrow-displacement-y"</entry> <entry>Read</entry> <entry>The distance vertically to move the arrow when the -button is depressed</entry> + button is depressed</entry> </row> <row valign="top"> @@ -174,9 +194,26 @@ button is depressed</entry> <entry>"trough-border"</entry> <entry>Read</entry> <entry>The spacing between thumb or steppers and outer trough -bevel</entry> + bevel</entry> </row> + <row valign="top"> + <entry>"trough-side-details"</entry> + <entry>Read</entry> + <entry>This property is available in GTK+ 2.10 and above.</entry> + </row> + + <row valign="top"> + <entry>"trough-under-steppers"</entry> + <entry>Read</entry> + <entry>if <literal>TRUE</literal> draw the trough across the + full length of the range or to exclude the steppers and their + spacing. Note that setting the "stepper-spacing" style + property to any value > 0 will automatically enable + "trough-under-steppers" too. This property is available in + GTK+ 2.10 and above.</entry> + </row> + </tbody> </tgroup> </informaltable> @@ -184,8 +221,12 @@ bevel</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkrange"> + <title>gtk.Range 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> <variablelist> <varlistentry> @@ -202,6 +243,20 @@ linkend="signal-gtkrange--adjust-bounds">adjust-bounds</link>"</term> </listitem> </varlistentry> <varlistentry> + <term>"<link linkend="signal-gtkrange--change-value">change-value</link></term> + <listitem> + <methodsynopsis language="python"><methodname>callback</methodname> + <methodparam><parameter>range</parameter></methodparam> + <methodparam><parameter>scroll</parameter></methodparam> + <methodparam><parameter>value</parameter></methodparam> + <methodparam><parameter>arg1</parameter></methodparam> + <methodparam><parameter>arg2</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis> + </listitem> + </varlistentry> + <varlistentry> <term>"<link linkend="signal-gtkrange--move-slider">move-slider</link>"</term> <listitem> @@ -582,6 +637,75 @@ depends on the mouse position.</para> </refsect2> + <refsect2 id="signal-gtkrange--change-value"> + <title>The "change-value" gtk.Range Signal</title> + + <programlisting><methodsynopsis language="python"><methodname>callback</methodname> + <methodparam><parameter>range</parameter></methodparam> + <methodparam><parameter>scroll</parameter></methodparam> + <methodparam><parameter>value</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter>range</parameter> :</term> + <listitem><simpara>the range that received the signal. the object + which received the signal.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter>scroll</parameter> :</term> + <listitem><simpara>the type of scroll action that was performed - + one of the <xref linkend="gtk-scroll-type-constants" + endterm="gtk-scroll-type-constants-title"></xref>..</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter>value</parameter> :</term> + <listitem><simpara>the new value resulting from the scroll + action.</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> to prevent other + handlers from being invoked for the signal or + <literal>FALSE</literal> to propagate the signal + further.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This signal is available in GTK+ 2.6 and above.</para> + </note> + + <para>The "change-value" signal is emitted when a scroll action is + performed on a range. It allows an application to determine the type + of scroll event that occurred and the resultant new value. The + application can handle the event itself and return + <literal>TRUE</literal> to prevent further processing. Or, by + returning <literal>FALSE</literal>, it can pass the event to other + handlers until the default GTK+ handler is reached.</para> + + <para>The value parameter is unrounded. An application that overrides + the "change-value" signal is responsible for clamping the value to the + desired number of decimal digits.</para> + + <para>It is not possible to use delayed update policies in an + overridden "change-value" handler.</para> + + </refsect2> + <refsect2 id="signal-gtkrange--move-slider"> <title>The "move-slider" gtk.Range Signal</title> @@ -602,22 +726,9 @@ signal</simpara></listitem> <varlistentry> <term><parameter>scrolltype</parameter> :</term> <listitem><simpara>the scroll type issued because a key was -pressed by the user; one of: <literal>gtk.SCROLL_NONE</literal>, -<literal>gtk.SCROLL_JUMP</literal>, -<literal>gtk.SCROLL_STEP_BACKWARD</literal>, -<literal>gtk.SCROLL_STEP_FORWARD</literal>, -<literal>gtk.SCROLL_PAGE_BACKWARD</literal>, -<literal>gtk.SCROLL_PAGE_FORWARD</literal>, -<literal>gtk.SCROLL_STEP_UP</literal>, -<literal>gtk.SCROLL_STEP_DOWN</literal>, -<literal>gtk.SCROLL_PAGE_UP</literal>, -<literal>gtk.SCROLL_PAGE_DOWN</literal>, -<literal>gtk.SCROLL_STEP_LEFT</literal>, -<literal>gtk.SCROLL_STEP_RIGHT</literal>, -<literal>gtk.SCROLL_PAGE_LEFT</literal>, -<literal>gtk.SCROLL_PAGE_RIGHT</literal>, -<literal>gtk.SCROLL_START</literal> or -<literal>gtk.SCROLL_END</literal></simpara></listitem> + pressed by the user; one of the <xref + linkend="gtk-scroll-type-constants" + endterm="gtk-scroll-type-constants-title"></xref>.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>user_param1</parameter> :</term> diff --git a/docs/reference/pygtk-gtkrcstyle.xml b/docs/reference/pygtk-gtkrcstyle.xml index c599c67d..502be868 100644 --- a/docs/reference/pygtk-gtkrcstyle.xml +++ b/docs/reference/pygtk-gtkrcstyle.xml @@ -82,6 +82,12 @@ </refsect1> + <refsect1 id="signal-prototypes-gtkrcstyle"> + <title>gtk.RcStyle Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkruler.xml b/docs/reference/pygtk-gtkruler.xml index 32e9dfb0..d5ce0e42 100644 --- a/docs/reference/pygtk-gtkruler.xml +++ b/docs/reference/pygtk-gtkruler.xml @@ -65,8 +65,11 @@ linkend="method-gtkruler--get-range">get_range</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkruler"> + <title>gtk.Ruler Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -83,11 +86,18 @@ linkend="method-gtkruler--get-range">get_range</link></methodname> </row> <row valign="top"> - <entry>"upper"</entry> + <entry>"max-size"</entry> <entry>Read-Write</entry> - <entry>the upper limit of the ruler</entry> + <entry>the maximum size of the ruler</entry> </row> + <row valign="top"> + <entry>"metric"</entry> + <entry>Read-Write</entry> + <entry>The metric used for the ruler. This property is available + in GTK+ 2.8 and above.</entry> + </row> + <row valign="top"> <entry>"position"</entry> <entry>Read-Write</entry> @@ -95,9 +105,9 @@ linkend="method-gtkruler--get-range">get_range</link></methodname> </row> <row valign="top"> - <entry>"max-size"</entry> + <entry>"upper"</entry> <entry>Read-Write</entry> - <entry>the maximum size of the ruler</entry> + <entry>the upper limit of the ruler</entry> </row> </tbody> @@ -107,6 +117,21 @@ linkend="method-gtkruler--get-range">get_range</link></methodname> </refsect1> + <refsect1 id="style-properties-gtkruler"> + <title>gtk.Ruler Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkruler"> + <title>gtk.Ruler 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> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkscale.xml b/docs/reference/pygtk-gtkscale.xml index ce63c201..4ff4fa80 100644 --- a/docs/reference/pygtk-gtkscale.xml +++ b/docs/reference/pygtk-gtkscale.xml @@ -72,8 +72,12 @@ linkend="method-gtkscale--get-layout-offsets">get_layout_offsets</link></methodn </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkscale"> + <title>gtk.Scale 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-gtkrange">gtk.Range Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -112,8 +116,11 @@ displayed as a string next to the slider</entry> </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="style-properties-gtkscale"> + <title>gtk.Scale Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkrange">gtk.Range Style Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -133,7 +140,7 @@ displayed as a string next to the slider</entry> <entry>"value-spacing"</entry> <entry>Read</entry> <entry>The space between value text and the slider or trough -area</entry> + area</entry> </row> </tbody> @@ -143,8 +150,13 @@ area</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkscale"> + <title>gtk.Scale 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-gtkrange">gtk.Range Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkscrollbar.xml b/docs/reference/pygtk-gtkscrollbar.xml index 41613044..6406dc1b 100644 --- a/docs/reference/pygtk-gtkscrollbar.xml +++ b/docs/reference/pygtk-gtkscrollbar.xml @@ -31,8 +31,20 @@ linkend="class-gtkrange">gtk.Range</link></classname></ooclass> </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="properties-gtkscrollbar"> + <title>gtk.Scrollbar 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-gtkrange">gtk.Range Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkscrollbar"> + <title>gtk.Scrollbar Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkrange">gtk.Range Style Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -90,6 +102,15 @@ arrow button on the opposite end of the scrollbar</entry> </refsect1> + <refsect1 id="signal-prototypes-gtkscrollbar"> + <title>gtk.Scrollbar 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-gtkrange">gtk.Range Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkscrolledwindow.xml b/docs/reference/pygtk-gtkscrolledwindow.xml index 41ea7838..00977469 100644 --- a/docs/reference/pygtk-gtkscrolledwindow.xml +++ b/docs/reference/pygtk-gtkscrolledwindow.xml @@ -113,8 +113,12 @@ linkend="method-gtkscrolledwindow--add-with-viewport">add_with_viewport</link></ </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkscrolledwindow"> + <title>gtk.ScrolledWindow 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"> @@ -177,6 +181,14 @@ scrollbars; one of: <literal>gtk.CORNER_TOP_LEFT</literal>, <literal>gtk.CORNER_BOTTOM_RIGHT</literal>.</entry> </row> + <row valign="top"> + <entry>"window-placement-set"</entry> + <entry>Read-Write</entry> + <entry>If <literal>TRUE</literal> "window-placement" should be + used to determine the location of the contents with respect to the + scrollbars.</entry> + </row> + </tbody> </tgroup> </informaltable> @@ -184,8 +196,10 @@ scrollbars; one of: <literal>gtk.CORNER_TOP_LEFT</literal>, </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="style-properties-gtkscrolledwindow"> + <title>gtk.ScrolledWindow Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -211,8 +225,13 @@ scrollbars; one of: <literal>gtk.CORNER_TOP_LEFT</literal>, </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkscrolledwindow"> + <title>gtk.ScrolledWindow 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> diff --git a/docs/reference/pygtk-gtkselectiondata.xml b/docs/reference/pygtk-gtkselectiondata.xml index f0d9a41c..2bc70565 100644 --- a/docs/reference/pygtk-gtkselectiondata.xml +++ b/docs/reference/pygtk-gtkselectiondata.xml @@ -83,6 +83,14 @@ linkend="method-gtkselectiondata--get-uris">get_uris</link></methodname> linkend="method-gtkselectiondata--targets-include-image">targets_include_image</link></methodname> <methodparam><parameter role="keyword">writable</parameter></methodparam> </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkselectiondata--targets-include-rich-text">targets_include_rich_text</link></methodname> + <methodparam><parameter role="keyword">buffer</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkselectiondata--targets-include-uri">targets_include_uri</link></methodname> + <methodparam></methodparam> + </methodsynopsis> </classsynopsis> <programlisting> @@ -107,6 +115,26 @@ linkend="method-gtkselectiondata--targets-include-image">targets_include_image</ <methodname><link linkend="function-gtk--target-list-add-uri-targets">gtk.target_list_add_uri_targets</link></methodname> <methodparam><parameter role="keyword">list</parameter><initializer>None</initializer></methodparam> <methodparam><parameter role="keyword">info</parameter><initializer>0</initializer></methodparam> + </methodsynopsis><methodsynopsis language="python"> + <methodname><link linkend="function-gtk--target-list-add-rich-text-targets">gtk.target_list_add_rich_text_targets</link></methodname> + <methodparam><parameter role="keyword">list</parameter></methodparam> + <methodparam><parameter role="keyword">info</parameter></methodparam> + <methodparam><parameter role="keyword">deserializable</parameter></methodparam> + <methodparam><parameter role="keyword">buffer</parameter></methodparam> + </methodsynopsis><methodsynopsis language="python"> + <methodname><link linkend="function-gtk--targets-include-image">gtk.targets_include_image</link></methodname> + <methodparam><parameter role="keyword">targets</parameter></methodparam> + <methodparam><parameter role="keyword">writable</parameter></methodparam> + </methodsynopsis><methodsynopsis language="python"> + <methodname><link linkend="function-gtk--targets-include-rich-text">gtk.targets_include_rich_text</link></methodname> + <methodparam><parameter role="keyword">targets</parameter></methodparam> + <methodparam><parameter role="keyword">buffer</parameter></methodparam> + </methodsynopsis><methodsynopsis language="python"> + <methodname><link linkend="function-gtk--targets-include-text">gtk.targets_include_text</link></methodname> + <methodparam><parameter role="keyword">targets</parameter></methodparam> + </methodsynopsis><methodsynopsis language="python"> + <methodname><link linkend="function-gtk--targets-include-uri">gtk.targets_include_uri</link></methodname> + <methodparam><parameter role="keyword">targets</parameter></methodparam> </methodsynopsis> </programlisting> @@ -553,6 +581,63 @@ target.</para> </refsect2> + <refsect2 id="method-gtkselectiondata--targets-include-rich-text"> + <title>gtk.SelectionData.targets_include_rich_text</title> + + <programlisting><methodsynopsis language="python"> + <methodname>targets_include_rich_text</methodname> + <methodparam><parameter role="keyword">buffer</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter role="keyword">buffer</parameter> :</term> + <listitem><simpara>a <link + linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link></simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara><literal>TRUE</literal> if a suitable target + for rich text is included in the selectiondata + targets.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>Determines if any of the selectiondata targets can be used to + provide rich text.</para> + + </refsect2> + + <refsect2 id="method-gtkselectiondata--targets-include-uri"> + <title>gtk.SelectionData.targets_include_uri</title> + + <programlisting><methodsynopsis language="python"> + <methodname>targets_include_uri</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara><literal>TRUE</literal> if a suitable target + for uris is included in the selectiondata + targets.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>Determines if any of the selectiondata targets can be used to + provide a list of URIs.</para> + + </refsect2> + </refsect1> <refsect1> @@ -750,6 +835,193 @@ field of the target entry tuples.</para> </refsect2> + <refsect2 id="function-gtk--targets-include-uri"> + <title>gtk.targets_include_uri</title> + + <programlisting><methodsynopsis language="python"> + <methodname>gtk.targets_include_uri</methodname> + <methodparam><parameter + role="keyword">targets</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">targets</parameter> :</term> + <listitem><simpara>a list of target strings</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara><literal>TRUE</literal> if targets includes a + uri target.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This function is available in PyGTK 2.10 and above.</para> + </note> + + <para>Determines if any of the targets in + <parameter>targets</parameter> can be used to provide an uri + list.</para> + + </refsect2> + + <refsect2 id="function-gtk--targets-include-text"> + <title>gtk.targets_include_text</title> + + <programlisting><methodsynopsis language="python"> + <methodname>gtk.targets_include_text</methodname> + <methodparam><parameter + role="keyword">targets</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">targets</parameter> :</term> + <listitem><simpara>a list of target strings</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara><literal>TRUE</literal> if targets includes a + text target.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This function is available in PyGTK 2.10 and above.</para> + </note> + + <para>Determines if any of the targets in + <parameter>targets</parameter> can be used to provide text.</para> + + </refsect2> + + <refsect2 id="function-gtk--targets-include-rich-text"> + <title>gtk.targets_include_rich_text</title> + + <programlisting><methodsynopsis language="python"> + <methodname>gtk.targets_include_rich_text</methodname> + <methodparam><parameter + role="keyword">targets</parameter></methodparam> + <methodparam><parameter + role="keyword">buffer</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">targets</parameter> :</term> + <listitem><simpara>a list of target strings</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">buffer</parameter> :</term> + <listitem><simpara>a <link + linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link></simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara></simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This function is available in PyGTK 2.10 and above.</para> + </note> + + <para>Determines if any of the targets in + <parameter>targets</parameter> can be used to provide rich + text.</para> + + </refsect2> + + <refsect2 id="function-gtk--targets-include-image"> + <title>gtk.targets_include_image</title> + + <programlisting><methodsynopsis language="python"> + <methodname>gtk.targets_include_image</methodname> + <methodparam><parameter + role="keyword">targets</parameter></methodparam> + <methodparam><parameter + role="keyword">writable</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">targets</parameter> :</term> + <listitem><simpara>a list of target strings</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">writable</parameter> :</term> + <listitem><simpara>if <literal>TRUE</literal> accept only targets + for which GTK+ knows how to convert a pixbuf into the + format</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara><literal>TRUE</literal> if + <parameter>targets</parameter> include a suitable target for + images</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This function is available in PyGTK 2.10 and above.</para> + </note> + + <para>Determines if any of the targets in targets can be used to + provide a <link + linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>.</para> + + </refsect2> + + <refsect2 id="function-gtk--target-list-add-rich-text-targets"> + <title>gtk.target_list_add_rich_text_targets</title> + + <programlisting><methodsynopsis language="python"> + <methodname>gtk.target_list_add_rich_text_targets</methodname> + <methodparam><parameter role="keyword">list</parameter></methodparam> + <methodparam><parameter role="keyword">info</parameter></methodparam> + <methodparam><parameter role="keyword">deserializable</parameter></methodparam> + <methodparam><parameter role="keyword">buffer</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">list</parameter> :</term> + <listitem><simpara>a list of targets</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">info</parameter> :</term> + <listitem><simpara>an ID that will be passed back to the + application</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">deserializable</parameter> :</term> + <listitem><simpara>if <literal>TRUE</literal>, deserializable rich + text formats will be added, otherwise, serializable formats will + be added.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">buffer</parameter> :</term> + <listitem><simpara>a <link linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link></simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>a target list with the rich text targets + registered with <parameter>buffer</parameter> appended to + <parameter>list</parameter>.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This function is available in PyGTK 2.10 and above.</para> + </note> + + <para>Appends the rich text targets registered with the <link + linkend="method-gtktextbuffer--register-serialize-format"><methodname>register_serialize_format</methodname>()</link> + or <link + linkend="method-gtktextbuffer--register-deserialize-format"><methodname>register_deserialize_format</methodname>()</link> + methods to the target list. All targets are added with the same + <parameter>info</parameter>. + +list</para> + + </refsect2> + </refsect1> </refentry> diff --git a/docs/reference/pygtk-gtkseparator.xml b/docs/reference/pygtk-gtkseparator.xml index 1a035647..23fad7e0 100644 --- a/docs/reference/pygtk-gtkseparator.xml +++ b/docs/reference/pygtk-gtkseparator.xml @@ -29,6 +29,29 @@ </refsect1> + <refsect1 id="properties-gtkseparator"> + <title>gtk.Separator Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkseparator"> + <title>gtk.Separator Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkseparator"> + <title>gtk.Separator 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> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkseparatormenuitem.xml b/docs/reference/pygtk-gtkseparatormenuitem.xml index 202dc409..e91c2b97 100644 --- a/docs/reference/pygtk-gtkseparatormenuitem.xml +++ b/docs/reference/pygtk-gtkseparatormenuitem.xml @@ -38,6 +38,34 @@ linkend="constructor-gtkseparatormenuitem">gtk.SeparatorMenuItem</link></methodn </refsect1> + <refsect1 id="properties-gtkseparatormenuitem"> + <title>gtk.SeparatorMenuItem 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> + + </refsect1> + + <refsect1 id="style-properties-gtkseparatormenuitem"> + <title>gtk.SeparatorMenuItem Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkmenuitem">gtk.MenuItem Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkseparatormenuitem"> + <title>gtk.SeparatorMenuItem 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> + <para><link linkend="signal-prototypes-gtkitem">gtk.Item Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkmenuitem">gtk.MenuItem Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkseparatortoolitem.xml b/docs/reference/pygtk-gtkseparatortoolitem.xml index 9a9e9c22..197b78bc 100644 --- a/docs/reference/pygtk-gtkseparatortoolitem.xml +++ b/docs/reference/pygtk-gtkseparatortoolitem.xml @@ -42,8 +42,13 @@ items (new in PyGTK 2.4)</refpurpose> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkseparatortoolitem"> + <title>gtk.SeparatorToolItem 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> + <para><link linkend="properties-gtktoolitem">gtk.ToolItem Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -68,6 +73,23 @@ items (new in PyGTK 2.4)</refpurpose> </refsect1> + <refsect1 id="style-properties-gtkseparatortoolitem"> + <title>gtk.SeparatorToolItem Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkseparatortoolitem"> + <title>gtk.SeparatorToolItem 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> + <para><link linkend="signal-prototypes-gtktoolitem">gtk.ToolItem Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtksettings.xml b/docs/reference/pygtk-gtksettings.xml index a200dade..bc1e9dd1 100644 --- a/docs/reference/pygtk-gtksettings.xml +++ b/docs/reference/pygtk-gtksettings.xml @@ -93,8 +93,8 @@ linkend="function-gtk--settings-get-for-screen">gtk.settings_get_for_screen</lin </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtksettings"> + <title>gtk.Settings Properties</title> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -104,6 +104,15 @@ linkend="function-gtk--settings-get-for-screen">gtk.settings_get_for_screen</lin <colspec column="3" colwidth="4in"/> <tbody> + <row valign="top"> + <entry>"color-hash"</entry> + <entry>Read</entry> + <entry>Holds a hash table representation of the + gtk-color-scheme setting, mapping color names to <link + linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>s. + This property is available in GTK+ 2.10 and above.</entry> + </row> + <row valign="top"> <entry>"gtk-alternative-button-order"</entry> <entry>Read-Write</entry> @@ -135,6 +144,26 @@ value: <literal>FALSE</literal></entry> Default value: "black:white:gray50:red:purple:blue:light blue:green:yellow:orange:lavender:brown:goldenrod4:dodger blue:pink:light green:gray10:gray30:gray75:gray90"</entry> </row> + <row valign="top"> + <entry>"gtk-color-scheme"</entry> + <entry>Read-Write</entry> + <entry>A palette of named colors for use in themes. The format of + the string is: +<programlisting> +name1: color1 +name2: color2 +... +</programlisting> +Color names must be acceptable as identifiers in the <link +linkend="class-gtkrcstyle"><classname>gtk.RcStyle</classname></link> syntax, +and color specifications must be in the format accepted by the <link +linkend="function-gdk--color-parse"><function>gtk.gdk.color_parse</function>()</link> +function. Note that due to the way the color tables from different sources +are merged, color specifications will be converted to hexadecimal form when +getting this property. Default value: ''. This property is available in +GTK+ 2.10 and above.</entry> + </row> + <row valign="top"> <entry>"gtk-cursor-blink"</entry> <entry>Read-Write</entry> @@ -149,6 +178,21 @@ blink. Default value: <literal>TRUE</literal></entry> milliseconds. Allowed values: >= 100. Default value: 1200</entry> </row> + <row valign="top"> + <entry>"gtk-cursor-theme-name"</entry> + <entry>Read-Write</entry> + <entry>Name of the cursor theme to use, or + <literal>None</literal> to use the default theme. Default + value: <literal>None</literal></entry> + </row> + + <row valign="top"> + <entry>"gtk-cursor-theme-size"</entry> + <entry>Read-Write</entry> + <entry>Size to use for cursors, or 0 to use the default + size. Allowed values: [0,128]. Default value: 0.</entry> + </row> + <row valign="top"> <entry>"gtk-dnd-drag-threshold"</entry> <entry>Read-Write</entry> @@ -172,6 +216,22 @@ be considered a double click (in milliseconds). Allowed values: >= 0. Default value: 250</entry> </row> + <row valign="top"> + <entry>"gtk-enable-animations"</entry> + <entry>Read-Write</entry> + <entry>If <literal>TRUE</literal> enable toolkit-wide + animations. Default value: <literal>TRUE</literal>.</entry> + </row> + + <row valign="top"> + <entry>"gtk-entry-password-hint-timeout"</entry> + <entry>Read-Write</entry> + <entry>How long to show the last input character in hidden + entries. This value is in milliseconds. 0 disables showing the + last char. 600 is a good value for enabling it. Default value: + 0. This property is available in GTK+ 2.10 and above.</entry> + </row> + <row valign="top"> <entry>"gtk-entry-select-on-focus"</entry> <entry>Read-Write</entry> @@ -179,6 +239,13 @@ Default value: 250</entry> entry when it is focused. Default value: <literal>TRUE</literal></entry> </row> + <row valign="top"> + <entry>"gtk-fallback-icon-theme"</entry> + <entry>Read-Write</entry> + <entry>Name of a icon theme to fall back to. Default value: + <literal>None</literal>.</entry> + </row> + <row valign="top"> <entry>"gtk-font-name"</entry> <entry>Read-Write</entry> @@ -208,127 +275,193 @@ GTK+ 2.4 and above. Default value: "hicolor"</entry> Default value: <literal>None</literal></entry> </row> + <row valign="top"> + <entry>"gtk-label-select-on-focus"</entry> + <entry>Read-Write</entry> + <entry>If <literal>TRUE</literal> select the contents of a + selectable label when it is focused. Default value: + <literal>TRUE</literal>.</entry> + </row> + <row valign="top"> <entry>"gtk-menu-bar-accel"</entry> <entry>Read-Write</entry> - <entry>The keybinding to activate the menu bar. -Default value: "F10"</entry> + <entry>The keybinding to activate the menu bar. Default + value: "F10"</entry> </row> <row valign="top"> <entry>"gtk-menu-bar-popup-delay"</entry> <entry>Read-Write</entry> <entry>The delay before the submenus of a menu bar appear. -Allowed values: >= 0. Default value: 0 -Available in GTK+ 2.2 and above.</entry> + Allowed values: >= 0. Default value: 0 Available in GTK+ 2.2 + and above.</entry> </row> <row valign="top"> <entry>"gtk-menu-images"</entry> <entry>Read-Write</entry> <entry>If <literal>TRUE</literal> images should be shown in -menus. Default value: <literal>TRUE</literal>. Available in GTK+ 2.4 and -above.</entry> + menus. Default value: <literal>TRUE</literal>. Available in + GTK+ 2.4 and above.</entry> </row> <row valign="top"> <entry>"gtk-menu-popdown-delay"</entry> <entry>Read-Write</entry> <entry>The time before hiding a submenu when the pointer is -moving toward the submenu. Allowed values: >= 0. Default value: 1000. -Available in GTK+ 2.2 and above.</entry> + moving toward the submenu. Allowed values: >= 0. Default + value: 1000. Available in GTK+ 2.2 and above.</entry> </row> <row valign="top"> <entry>"gtk-menu-popup-delay"</entry> <entry>Read-Write</entry> <entry>Minimum time the pointer must stay over a menu item -before the submenu appears. Allowed values: >= 0. Default value: 225. -Available in GTK+ 2.2 and above.</entry> + before the submenu appears. Allowed values: >= 0. Default + value: 225. Available in GTK+ 2.2 and above.</entry> </row> <row valign="top"> <entry>"gtk-modules"</entry> <entry>Read-Write</entry> - <entry>The list of currently active GTK modules. -Default value: <literal>None</literal>. Available in GTK+ 2.6 and -above.</entry> + <entry>The list of currently active GTK modules. Default + value: <literal>None</literal>. Available in GTK+ 2.6 and + above.</entry> </row> + <row valign="top"> + <entry>"gtk-scrolled-window-placement"</entry> + <entry>Read-Write</entry> + <entry>Where the contents of scrolled windows are located with + respect to the scrollbars, if not overridden by the scrolled + window's own placement. Default value: + <literal>gtk.CORNER_TOP_LEFT</literal>.</entry> + </row> + + <row valign="top"> + <entry>"gtk-show-input-method-menu"</entry> + <entry>Read-Write</entry> + <entry>If <literal>TRUE</literal> the context menus of entries + and text views should offer to change the input + method. Default value: <literal>TRUE</literal>.</entry> + </row> + + <row valign="top"> + <entry>"gtk-show-unicode-menu"</entry> + <entry>Read-Write</entry> + <entry>If <literal>TRUE</literal> the context menus of entries + and text views should offer to insert control + characters. Default value: <literal>TRUE</literal>.</entry> + </row> + <row valign="top"> <entry>"gtk-split-cursor"</entry> <entry>Read-Write</entry> <entry>If <literal>TRUE</literal>, two cursors should be -displayed for mixed left-to-right and right-to-left text. -Default value: <literal>TRUE</literal></entry> + displayed for mixed left-to-right and right-to-left text. + Default value: <literal>TRUE</literal></entry> </row> <row valign="top"> <entry>"gtk-theme-name"</entry> <entry>Read-Write</entry> - <entry>The name of the theme RC file to load. -Default value: "Default"</entry> + <entry>The name of the theme RC file to load. Default value: + "Raleigh"</entry> </row> + <row valign="top"> + <entry>"gtk-timeout-expand"</entry> + <entry>Read-Write</entry> + <entry>Expand value for timeouts, when a widget is expanding a + new region. Allowed values: >= 0. Default value: 500.</entry> + </row> + + <row valign="top"> + <entry>"gtk-timeout-initial"</entry> + <entry>Read-Write</entry> + <entry>Starting value for timeouts, when button is + pressed. Allowed values: >= 0. Default value: 200.</entry> + </row> + + <row valign="top"> + <entry>"gtk-timeout-repeat"</entry> + <entry>Read-Write</entry> + <entry>Repeat value for timeouts, when button is + pressed. Allowed values: >= 0. Default value: 20.</entry> + </row> + <row valign="top"> <entry>"gtk-toolbar-icon-size"</entry> <entry>Read-Write</entry> <entry>the toolbar icon size - one of: -<literal>gtk.ICON_SIZE_MENU</literal>, -<literal>gtk.ICON_SIZE_SMALL_TOOLBAR</literal>, -<literal>gtk.ICON_SIZE_LARGE_TOOLBAR</literal>, -<literal>gtk.ICON_SIZE_BUTTON</literal>, -<literal>gtk.ICON_SIZE_DND</literal> or -<literal>gtk.ICON_SIZE_DIALOG</literal>. -Default value: <literal>gtk.ICON_SIZE_LARGE_TOOLBAR</literal></entry> + <literal>gtk.ICON_SIZE_MENU</literal>, + <literal>gtk.ICON_SIZE_SMALL_TOOLBAR</literal>, + <literal>gtk.ICON_SIZE_LARGE_TOOLBAR</literal>, + <literal>gtk.ICON_SIZE_BUTTON</literal>, + <literal>gtk.ICON_SIZE_DND</literal> or + <literal>gtk.ICON_SIZE_DIALOG</literal>. Default value: + <literal>gtk.ICON_SIZE_LARGE_TOOLBAR</literal>.</entry> </row> <row valign="top"> <entry>"gtk-toolbar-style"</entry> <entry>Read-Write</entry> <entry>The toolbar display style - one of: -<literal>gtk.TOOLBAR_ICONS</literal>, <literal>gtk.TOOLBAR_TEXT</literal>, -<literal>gtk.TOOLBAR_BOTH</literal> or -<literal>gtk.TOOLBAR_BOTH_HORIZ</literal>. -Default value: <literal>gtk.TOOLBAR_BOTH</literal></entry> + <literal>gtk.TOOLBAR_ICONS</literal>, + <literal>gtk.TOOLBAR_TEXT</literal>, + <literal>gtk.TOOLBAR_BOTH</literal> or + <literal>gtk.TOOLBAR_BOTH_HORIZ</literal>. Default value: + <literal>gtk.TOOLBAR_BOTH</literal></entry> </row> + <row valign="top"> + <entry>"gtk-touchscreen-mode"</entry> + <entry>Read-Write</entry> + <entry>When TRUE, there are no motion notify events delivered + on this screen, and widgets can't use the pointer hovering + them for any essential functionality. Default value: + <literal>FALSE</literal>. This property is available in GTK+ + 2.10 and above.</entry> + </row> + <row valign="top"> <entry>"gtk-xft-antialias"</entry> <entry>Read-Write</entry> - <entry>Whether to antialias Xft fonts; 0=no, 1=yes, -1=default. -Default value: -1. Available in GTK+ 2.4 and above.</entry> + <entry>Whether to antialias Xft fonts; 0=no, 1=yes, + -1=default. Default value: -1. Available in GTK+ 2.4 and + above.</entry> </row> <row valign="top"> <entry>"gtk-xft-dpi"</entry> <entry>Read-Write</entry> <entry>Resolution for Xft, in 1024 * dots/inch. -1 to use -default value. Allowed values: [-1,1048576]. Default value: -1. Available in -GTK+ 2.4 and above.</entry> + default value. Allowed values: [-1,1048576]. Default value: + -1. Available in GTK+ 2.4 and above.</entry> </row> <row valign="top"> <entry>"gtk-xft-hinting"</entry> <entry>Read-Write</entry> <entry>Whether to hint Xft fonts; 0=no, 1=yes, -1=default. -Default value: -1. Available in GTK+ 2.4 and above.</entry> + Default value: -1. Available in GTK+ 2.4 and above.</entry> </row> <row valign="top"> <entry>"gtk-xft-hintstyle"</entry> <entry>Read-Write</entry> - <entry>What degree of hinting to use; none, slight, medium, -or full. Default value: <literal>None</literal>. Available in GTK+ 2.4 and -above.</entry> + <entry>What degree of hinting to use; none, slight, medium, or + full. Default value: <literal>None</literal>. Available in + GTK+ 2.4 and above.</entry> </row> <row valign="top"> <entry>"gtk-xft-rgba"</entry> <entry>Read-Write</entry> - <entry>Type of subpixel antialiasing; none, rgb, bgr, vrgb, vbgr. -Default value: <literal>None</literal>. Available in GTK+ 2.4 and -above.</entry> + <entry>Type of subpixel antialiasing; none, rgb, bgr, vrgb, + vbgr. Default value: <literal>None</literal>. Available in + GTK+ 2.4 and above.</entry> </row> </tbody> diff --git a/docs/reference/pygtk-gtksizegroup.xml b/docs/reference/pygtk-gtksizegroup.xml index 43b53147..974e86af 100644 --- a/docs/reference/pygtk-gtksizegroup.xml +++ b/docs/reference/pygtk-gtksizegroup.xml @@ -69,8 +69,8 @@ linkend="method-gtksizegroup--remove-widget">remove_widget</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtksizegroup"> + <title>gtk.SizeGroup Properties</title> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -106,6 +106,12 @@ Default value: <literal>gtk.SIZE_GROUP_HORIZONTAL</literal>.</entry> </refsect1> + <refsect1 id="signal-prototypes-gtksizegroup"> + <title>gtk.SizeGroup Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtksocket.xml b/docs/reference/pygtk-gtksocket.xml index e813b157..9b82b368 100644 --- a/docs/reference/pygtk-gtksocket.xml +++ b/docs/reference/pygtk-gtksocket.xml @@ -45,8 +45,29 @@ linkend="method-gtksocket--get-id">get_id</link></methodname> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="properties-gtksocket"> + <title>gtk.Socket 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> + + </refsect1> + + <refsect1 id="style-properties-gtksocket"> + <title>gtk.Socket Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtksocket"> + <title>gtk.Socket 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> diff --git a/docs/reference/pygtk-gtkspinbutton.xml b/docs/reference/pygtk-gtkspinbutton.xml index 3e5ba260..7b03c3e0 100644 --- a/docs/reference/pygtk-gtkspinbutton.xml +++ b/docs/reference/pygtk-gtkspinbutton.xml @@ -162,8 +162,12 @@ linkend="method-gtkspinbutton--update">update</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkspinbutton"> + <title>gtk.SpinButton 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-gtkentry">gtk.Entry Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -235,8 +239,11 @@ upon reaching its limits</entry> </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="style-properties-gtkspinbutton"> + <title>gtk.SpinButton Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkentry">gtk.Entry Style Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -262,8 +269,15 @@ or <literal>gtk.SHADOW_ETCHED_OUT</literal></entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkspinbutton"> + <title>gtk.SpinButton 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-gtkentry">gtk.Entry Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkeditable">gtk.Editable Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkcelleditable">gtk.CellEditable Signal Prototypes</link></para> <variablelist> <varlistentry> @@ -316,6 +330,16 @@ linkend="signal-gtkspinbutton--value-changed">value-changed</link>"</term> </methodsynopsis> </listitem> </varlistentry> + <varlistentry> + <term>"<link linkend="signal-gtkspinbutton--wrapped">wrapped</link></term> + <listitem> + <methodsynopsis language="python"><methodname>callback</methodname> + <methodparam><parameter>spinbutton</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis> + </listitem> + </varlistentry> </variablelist> </refsect1> @@ -1184,6 +1208,43 @@ any)</simpara></listitem> </refsect2> + <refsect2 id="signal-gtkspinbutton--wrapped"> + <title>The "wrapped" gtk.SpinButton Signal</title> + + <programlisting><methodsynopsis language="python"><methodname>callback</methodname> + <methodparam><parameter>spinbutton</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter>spinbutton</parameter> :</term> + <listitem><simpara>the object which received the signal + the object which 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> + + <note> + <para>This signal is available in GTK+ 2.10 and above.</para> + </note> + + <para>The "wrapped" signal is emitted right after the spinbutton wraps + from its maximum to minimum value or vice-versa.</para> + + </refsect2> + </refsect1> </refentry> diff --git a/docs/reference/pygtk-gtkstatusbar.xml b/docs/reference/pygtk-gtkstatusbar.xml index a46d8a62..fbc775bc 100644 --- a/docs/reference/pygtk-gtkstatusbar.xml +++ b/docs/reference/pygtk-gtkstatusbar.xml @@ -80,8 +80,13 @@ linkend="method-gtkstatusbar--get-has-resize-grip">get_has_resize_grip</link></m </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkstatusbar"> + <title>gtk.Statusbar 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> + <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -107,8 +112,10 @@ linkend="method-gtkstatusbar--get-has-resize-grip">get_has_resize_grip</link></m </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="style-properties-gtkstatusbar"> + <title>gtk.Statusbar Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -131,8 +138,20 @@ linkend="method-gtkstatusbar--get-has-resize-grip">get_has_resize_grip</link></m </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="child-properties-gtkstatusbar"> + <title>gtk.Statusbar Child Properties</title> + + <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkstatusbar"> + <title>gtk.Statusbar 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> diff --git a/docs/reference/pygtk-gtkstyle.xml b/docs/reference/pygtk-gtkstyle.xml index 58c380fe..340f007c 100644 --- a/docs/reference/pygtk-gtkstyle.xml +++ b/docs/reference/pygtk-gtkstyle.xml @@ -755,6 +755,36 @@ be used for the background stippling in each widget state.</entry> </refsect1> + <refsect1 id="signal-prototypes-gtkstyle"> + <title>gtk.Style Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> + + <variablelist> + <varlistentry> + <term>"<link linkend="signal-gtkstyle--realize">realize</link></term> + <listitem> + <methodsynopsis language="python"><methodname>callback</methodname> + <methodparam><parameter>style</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis> + </listitem> + </varlistentry> + <varlistentry> + <term>"<link linkend="signal-gtkstyle--unrealize">unrealize</link></term> + <listitem> + <methodsynopsis language="python"><methodname>callback</methodname> + <methodparam><parameter>style</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis> + </listitem> + </varlistentry> + </variablelist> + + </refsect1> + <refsect1> <title>Description</title> @@ -2828,4 +2858,91 @@ while drawing. Currently the grip can only be drawn at the </refsect1> + <refsect1> + <title>Signals</title> + + <refsect2 id="signal-gtkstyle--realize"> + <title>The "realize" gtk.Style Signal</title> + + <programlisting><methodsynopsis language="python"><methodname>callback</methodname> + <methodparam><parameter>style</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter>style</parameter> :</term> + <listitem><simpara>the object which 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> + + <note> + <para>This signal is available in GTK+ 2.4 and above.</para> + </note> + + <para>Emitted when the style has been initialized for a particular + colormap and depth. Connecting to this signal is probably seldom + useful since most of the time applications and widgets only deal with + styles that have been already realized.</para> + + </refsect2> + + <refsect2 id="signal-gtkstyle--unrealize"> + <title>The "unrealize" gtk.Style Signal</title> + + <programlisting><methodsynopsis language="python"><methodname>callback</methodname> + <methodparam><parameter>style</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter>style</parameter> :</term> + <listitem><simpara>the object which 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> + + <note> + <para>This signal is available in GTK+ 2.4 and above.</para> + </note> + + <para>Emitted when the aspects of the style specific to a particular + colormap and depth are being cleaned up. A connection to this signal + can be useful if a widget wants to cache objects like a <link + linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> as + object data on <link + linkend="class-gtkstyle"><classname>gtk.Style</classname></link>. + This signal provides a convenient place to free such cached + objects.</para> + + </refsect2> + +</refsect1> + </refentry> diff --git a/docs/reference/pygtk-gtktable.xml b/docs/reference/pygtk-gtktable.xml index 94186853..d4a52b8f 100644 --- a/docs/reference/pygtk-gtktable.xml +++ b/docs/reference/pygtk-gtktable.xml @@ -126,8 +126,12 @@ linkend="method-gtktable--get-homogeneous">get_homogeneous</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtktable"> + <title>gtk.Table 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"> @@ -176,8 +180,15 @@ same width or height</entry> </refsect1> - <refsect1> - <title>Child Properties</title> + <refsect1 id="style-properties-gtktable"> + <title>gtk.Table Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="child-properties-gtktable"> + <title>gtk.Table Child Properties</title> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -246,6 +257,15 @@ and bottom neighbors, in pixels</entry> </informaltable> </blockquote> + <refsect1 id="signal-prototypes-gtktable"> + <title>gtk.Table 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> + </refsect1> + </refsect1> <refsect1> diff --git a/docs/reference/pygtk-gtktearoffmenuitem.xml b/docs/reference/pygtk-gtktearoffmenuitem.xml index a13fb57f..e4793bd3 100644 --- a/docs/reference/pygtk-gtktearoffmenuitem.xml +++ b/docs/reference/pygtk-gtktearoffmenuitem.xml @@ -39,6 +39,34 @@ linkend="constructor-gtktearoffmenuitem">gtk.TearoffMenuItem</link></methodname> </refsect1> + <refsect1 id="properties-gtktearoffmenuitem"> + <title>gtk.TearoffMenuItem 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> + + </refsect1> + + <refsect1 id="style-properties-gtktearoffmenuitem"> + <title>gtk.TearoffMenuItem Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkmenuitem">gtk.MenuItem Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtktearoffmenuitem"> + <title>gtk.TearoffMenuItem 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> + <para><link linkend="signal-prototypes-gtkitem">gtk.Item Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkmenuitem">gtk.MenuItem Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtktextbuffer.xml b/docs/reference/pygtk-gtktextbuffer.xml index 07065714..6509fb4b 100644 --- a/docs/reference/pygtk-gtktextbuffer.xml +++ b/docs/reference/pygtk-gtktextbuffer.xml @@ -401,6 +401,77 @@ linkend="method-gtktextbuffer--end-user-action">backspace</link></methodname> <methodparam><parameter role="keyword">default_editable</parameter></methodparam> </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktextbuffer--get-has-selection">get_has_selection</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktextbuffer--get-copy-target-list">get_copy_target_list</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktextbuffer--get-paste-target-list">get_paste_target_list</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktextbuffer--register-serialize-format">register_serialize_format</link></methodname> + <methodparam><parameter role="keyword">mime_type</parameter></methodparam> + <methodparam><parameter role="keyword">function</parameter></methodparam> + <methodparam><parameter role="keyword">user_data</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktextbuffer--register-serialize-tagset">register_serialize_tagset</link></methodname> + <methodparam><parameter role="keyword">tagset_name</parameter><initializer>NULL</initializer></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktextbuffer--register-deserialize-format">register_deserialize_format</link></methodname> + <methodparam><parameter role="keyword">mime_type</parameter></methodparam> + <methodparam><parameter role="keyword">function</parameter></methodparam> + <methodparam><parameter role="keyword">user_data</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktextbuffer--register-deserialize-tagset">register_deserialize_tagset</link></methodname> + <methodparam><parameter role="keyword">tagset_name</parameter><initializer>NULL</initializer></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktextbuffer--unregister-serialize-format">unregister_serialize_format</link></methodname> + <methodparam><parameter role="keyword">format</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktextbuffer--unregister-deserialize-format">unregister_deserialize_format</link></methodname> + <methodparam><parameter role="keyword">format</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktextbuffer--deserialize-set-can-create-tags">deserialize_set_can_create_tags</link></methodname> + <methodparam><parameter role="keyword">format</parameter></methodparam> + <methodparam><parameter role="keyword">can_create_tags</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktextbuffer--deserialize-get-can-create-tags">deserialize_get_can_create_tags</link></methodname> + <methodparam><parameter role="keyword">format</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktextbuffer--get-serialize-formats">get_serialize_formats</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktextbuffer--get-deserialize-formats">get_deserialize_formats</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktextbuffer--serialize">serialize</link></methodname> + <methodparam><parameter role="keyword">content_buffer</parameter></methodparam> + <methodparam><parameter role="keyword">format</parameter></methodparam> + <methodparam><parameter role="keyword">start</parameter></methodparam> + <methodparam><parameter role="keyword">end</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktextbuffer--deserialize">deserialize</link></methodname> + <methodparam><parameter role="keyword">content_buffer</parameter></methodparam> + <methodparam><parameter role="keyword">format</parameter></methodparam> + <methodparam><parameter role="keyword">iter</parameter></methodparam> + <methodparam><parameter role="keyword">data</parameter></methodparam> + </methodsynopsis> </classsynopsis> </refsect1> @@ -414,9 +485,9 @@ linkend="method-gtktextbuffer--end-user-action">backspace</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> - + <refsect1 id="properties-gtktextbuffer"> + <title>gtk.TextBuffer Properties</title> + <blockquote role="properties"> <informaltable pgwide="1" frame="none"> <tgroup cols="3"> @@ -426,13 +497,58 @@ linkend="method-gtktextbuffer--end-user-action">backspace</link></methodname> <tbody> <row valign="top"> + <entry>"copy-target-list"</entry> + <entry>Read</entry> + <entry>The list of targets this buffer supports for clipboard + copying and as DND source. This property is available in GTK+ + 2.10 and above.</entry> + </row> + + <row valign="top"> + <entry>"cursor-position"</entry> + <entry>Read</entry> + <entry>The position of the insert mark (as offset from the + beginning of the buffer). It is useful for getting notified + when the cursor moves. Allowed values: >= 0. Default value: + 0. This property is available in GTK+ 2.10 and above.</entry> + </row> + + <row valign="top"> + <entry>"has-selection"</entry> + <entry>Read</entry> + <entry>If <literal>TRUE</literal> the buffer has some text + currently selected. Default value: + <literal>FALSE</literal>. This property is available in GTK+ + 2.10 and above.</entry> + </row> + + <row valign="top"> + <entry>"paste-target-list"</entry> + <entry>Read</entry> + <entry>The list of targets this buffer supports for clipboard + pasting and as DND destination. This property is available in + GTK+ 2.10 and above.</entry> + </row> + + <row valign="top"> <entry>"tag-table"</entry> <entry>Read-Write-Construct Only</entry> <entry>The <link -linkend="class-gtktexttagtable"><classname>gtk.TextTagTable</classname></link> -associated with the textbuffer. Available in GTK+ 2.2 and above.</entry> + linkend="class-gtktexttagtable"><classname>gtk.TextTagTable</classname></link> + associated with the textbuffer. Available in GTK+ 2.2 and + above.</entry> </row> + <row valign="top"> + <entry>"text"</entry> + <entry>Read-Write</entry> + <entry>The text content of the buffer. Without child widgets + and images, see the <link + linkend="method-gtktextbuffer--get-text"><methodname>gtk.TextBuffer.get_text()</methodname></link> + method for more information. Default value: "". This property + is available in GTK+ 2.8 and above.</entry> + </row> + </tbody> </tgroup> </informaltable> @@ -467,8 +583,10 @@ associated with the textbuffer.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtktextbuffer"> + <title>gtk.TextBuffer Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> <variablelist> <varlistentry> @@ -2663,6 +2781,599 @@ deleted.</para> </refsect2> + <refsect2 id="method-gtktextbuffer--get-has-selection"> + <title>gtk.TextBuffer.get_has_selection</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_has_selection</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara><literal>TRUE</literal> if there is text + selected</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>Indicates whether the buffer has some text currently + selected.</para> + + </refsect2> + + <refsect2 id="method-gtktextbuffer--get-copy-target-list"> + <title>gtk.TextBuffer.get_copy_target_list</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_copy_target_list</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>a list of the targets each represented as a + 3-tuple containing the target name, a combination of the <xref + linkend="gtk-target-flags-constants" + endterm="gtk-target-flags-constants-title"></xref> and an + application assigned integer</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>This method returns the list of targets this text buffer can + provide for copying and as DND source. The targets in the list are + added with <literal>info</literal> values from the <xref + linkend="gtk-textbuffer-target-info-constants" + endterm="gtk-textbuffer-target-info-constants-title"></xref>, using + the <link + linkend="function-gtk--target-list-add-rich-text-targets"><function>gtk.target_list_add_rich_text_targets</function>()</link> + and <link + linkend="function-gtk--target-list-add-text-targets"><function>gtk.target_list_add_text_targets</function>()</link> + functions.</para> + + </refsect2> + + <refsect2 id="method-gtktextbuffer--get-paste-target-list"> + <title>gtk.TextBuffer.get_paste_target_list</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_paste_target_list</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>a list of the targets each represented as a + 3-tuple containing the target name, a combination of the <xref + linkend="gtk-target-flags-constants" + endterm="gtk-target-flags-constants-title"></xref> and an + application assigned integer</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>This method returns the list of targets this text buffer supports + for pasting and as DND destination. The targets in the list are + added with <literal>info</literal> values from the <xref + linkend="gtk-textbuffer-target-info-constants" + endterm="gtk-textbuffer-target-info-constants-title"></xref>, using + the <link + linkend="function-gtk--target-list-add-rich-text-targets"><function>gtk.target_list_add_rich_text_targets</function>()</link> + and <link + linkend="function-gtk--target-list-add-text-targets"><function>gtk.target_list_add_text_targets</function>()</link> + functions.</para> + + </refsect2> + + <refsect2 id="method-gtktextbuffer--register-serialize-format"> + <title>gtk.TextBuffer.register_serialize_format</title> + + <programlisting><methodsynopsis language="python"> + <methodname>register_serialize_format</methodname> + <methodparam><parameter role="keyword">mime_type</parameter></methodparam> + <methodparam><parameter role="keyword">function</parameter></methodparam> + <methodparam><parameter role="keyword">user_data</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter role="keyword">mime_type</parameter> :</term> + <listitem><simpara>the format's mime-type</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">function</parameter> :</term> + <listitem><simpara>the serialize function to register</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">user_data</parameter> :</term> + <listitem><simpara><literal>function</literal>'s user_data</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the newly registered format's + mime-type.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>This method registers a rich text serialization + <literal>function</literal> along with its + <literal>mime_type</literal> with the passed + <literal>buffer</literal>.</para> + + <para>The signature of function is:</para> + + <programlisting> + def function(register_buf, content_buf, start, end, data): + </programlisting> + + <para>where <parameter>register_buf</parameter> is the textbuffer that + the format is registered with, <parameter>content_buf</parameter> is + the textbuffer containing the text to be serialized, + <parameter>start</parameter> and <parameter>end</parameter> are + textiters bounding the text to be serialized and + <parameter>data</parameter> is + <parameter>user_data</parameter>. <parameter>function</parameter> + should return the serialized data.</para> + + </refsect2> + + <refsect2 id="method-gtktextbuffer--register-serialize-tagset"> + <title>gtk.TextBuffer.register_serialize_tagset</title> + + <programlisting><methodsynopsis language="python"> + <methodname>register_serialize_tagset</methodname> + <methodparam><parameter role="keyword">tagset_name</parameter><initializer>NULL</initializer></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter role="keyword">tagset_name</parameter> :</term> + <listitem><simpara>an optional tagset name, or + <literal>None</literal></simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the newly registered format's + mime-type.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>This method registers GTK+'s internal rich text serialization + format with this textbuffer. The internal format does not comply to + any standard rich text format and only works between <link + linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link> + instances. It is capable of serializing all of a text buffer's tags + and embedded pixbufs.</para> + + <para>This method is just a wrapper around <link + linkend="method-gtktextbuffer--register-serialize-format"><methodname>gtk.TextBuffer.register_serialize_format()</methodname></link>. The + <literal>mime_type</literal> used for registering is + "application/x-gtk-text-buffer-rich-text", or + "application/x-gtk-text-buffer-rich-text;format=<literal>tagset_name</literal>" + if a <literal>tagset_name</literal> was passed.</para> + + <para>The <literal>tagset_name</literal> can be used to restrict the + transfer of rich text to buffers with compatible sets of tags, in + order to avoid unknown tags from being pasted. It is probably the + common case to pass a non-<literal>None</literal> tagset here, + since the <literal>None</literal> tagset requires the receiving buffer + to deal with with pasting of arbitrary tags.</para> + + </refsect2> + + <refsect2 id="method-gtktextbuffer--register-deserialize-format"> + <title>gtk.TextBuffer.register_deserialize_format</title> + + <programlisting><methodsynopsis language="python"> + <methodname>register_deserialize_format</methodname> + <methodparam><parameter role="keyword">mime_type</parameter></methodparam> + <methodparam><parameter role="keyword">function</parameter></methodparam> + <methodparam><parameter role="keyword">user_data</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter role="keyword">mime_type</parameter> :</term> + <listitem><simpara>the format's mime-type</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">function</parameter> :</term> + <listitem><simpara>the deserialize function to register</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">user_data</parameter> :</term> + <listitem><simpara><literal>function</literal>'s user_data</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the newly registered format's + mime-type.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>This method registers a rich text deserialization + <literal>function</literal> along with its + <literal>mime_type</literal> with the passed + <literal>buffer</literal>.</para> + + <para>The signature of function is:</para> + + <programlisting> + def function(register_buf, content_buf, iter, data, create_tags, udata): + </programlisting> + + <para>where <parameter>register_buf</parameter> is the textbuffer that + the format is registered with, <parameter>content_buf</parameter> is + the textbuffer that data will be deserialized into, + <parameter>iter</parameter> is a textiter indicating the start of the + deserialized data in <parameter>content_buf</parameter>, create_tags + is a boolean indicating if tags should be created during + deserializtion and <parameter>udata</parameter> is + <parameter>user_data</parameter>. <parameter>function</parameter> + should return <literal>TRUE</literal> if the data was successfully + deserialized.</para> + + </refsect2> + + <refsect2 id="method-gtktextbuffer--register-deserialize-tagset"> + <title>gtk.TextBuffer.register_deserialize_tagset</title> + + <programlisting><methodsynopsis language="python"> + <methodname>register_deserialize_tagset</methodname> + <methodparam><parameter role="keyword">tagset_name</parameter><initializer>NULL</initializer></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter role="keyword">tagset_name</parameter> :</term> + <listitem><simpara>an optional tagset name, or + <literal>None</literal></simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the newly registered format's + mime-type.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>This method registers GTK+'s internal rich text serialization + format with this buffer. See the <link + linkend="method-gtktextbuffer--register-serialize-tagset"><methodname>gtk.TextBuffer.register_serialize_tagset()</methodname></link> + method for details.</para> + + </refsect2> + + <refsect2 id="method-gtktextbuffer--unregister-serialize-format"> + <title>gtk.TextBuffer.unregister_serialize_format</title> + + <programlisting><methodsynopsis language="python"> + <methodname>unregister_serialize_format</methodname> + <methodparam><parameter role="keyword">format</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter role="keyword">format</parameter> :</term> + <listitem><simpara>a target string representing a registered rich + text format.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>This method unregisters a rich text format that was previously + registered using the <link + linkend="method-gtktextbuffer--register-serialize-format"><methodname>gtk.TextBuffer.register_serialize_format()</methodname></link> + or <link + linkend="method-gtktextbuffer--register-serialize-tagset"><methodname>gtk.TextBuffer.register_serialize_tagset()</methodname></link> + methods.</para> + + </refsect2> + + <refsect2 id="method-gtktextbuffer--unregister-deserialize-format"> + <title>gtk.TextBuffer.unregister_deserialize_format</title> + + <programlisting><methodsynopsis language="python"> + <methodname>unregister_deserialize_format</methodname> + <methodparam><parameter role="keyword">format</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter role="keyword">format</parameter> :</term> + <listitem><simpara>a target string representing a registered rich + text format.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>This method unregisters a rich text format that was previously + registered using the <link + linkend="method-gtktextbuffer--register-deserialize-format"><methodname>gtk.TextBuffer.register_deserialize_format()</methodname></link> + or <link + linkend="method-gtktextbuffer--register-deserialize-tagset"><methodname>gtk.TextBuffer.register_deserialize_tagset()</methodname></link> + methods.</para> + + </refsect2> + + <refsect2 id="method-gtktextbuffer--deserialize-set-can-create-tags"> + <title>gtk.TextBuffer.deserialize_set_can_create_tags</title> + + <programlisting><methodsynopsis language="python"> + <methodname>deserialize_set_can_create_tags</methodname> + <methodparam><parameter role="keyword">format</parameter></methodparam> + <methodparam><parameter role="keyword">can_create_tags</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter role="keyword">format</parameter> :</term> + <listitem><simpara>a target string representing a registered rich + text format</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">can_create_tags</parameter> :</term> + <listitem><simpara>if <literal>TRUE</literal> deserializing + <parameter>format</parameter> may create tags</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>Use this method to allow a rich text deserialization function to + create new tags in the receiving buffer. Note that using this method + is almost always a bad idea, because the rich text functions you + register should know how to map the rich text format they handle to + your text buffers set of tags.</para> + + <para>The ability of creating new (arbitrary!) tags in the receiving + buffer is meant for special rich text formats like the internal one + that is registered using <link + linkend="method-gtktextbuffer--register-deserialize-tagset"><methodname>gtk.TextBuffer.register_deserialize_tagset()</methodname></link>, + because that format is essentially a dump of the internal structure of + the source buffer, including its tag names.</para> + + <para>You should allow creation of tags only if you know what you are + doing, e.g. if you defined a tagset name for your application suite's + text buffers and you know that it's fine to receive new tags from + these buffers, because you know that your application can handle the + newly created tags.</para> + + </refsect2> + + <refsect2 id="method-gtktextbuffer--deserialize-get-can-create-tags"> + <title>gtk.TextBuffer.deserialize_get_can_create_tags</title> + + <programlisting><methodsynopsis language="python"> + <methodname>deserialize_get_can_create_tags</methodname> + <methodparam><parameter role="keyword">format</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter role="keyword">format</parameter> :</term> + <listitem><simpara>a target string representing a registered rich + text format</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara><literal>TRUE</literal> if deserializing + <parameter>format</parameter> may create tags</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>This method returns the value set with the <link + linkend="method-gtktextbuffer--deserialize-set-can-create-tags"><methodname>gtk.TextBuffer.deserialize_set_can_create_tags()</methodname></link> + method.</para> + + </refsect2> + + <refsect2 id="method-gtktextbuffer--get-serialize-formats"> + <title>gtk.TextBuffer.get_serialize_formats</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_serialize_formats</methodname> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>a list of target strings representing the + registered formats.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>This method returns a list of the rich text serialize formats + registered using the <link + linkend="method-gtktextbuffer--register-serialize-format"><methodname>gtk.TextBuffer.register_serialize_format()</methodname></link> + or <link + linkend="method-gtktextbuffer--register-serialize-tagset"><methodname>gtk.TextBuffer.register_serialize_tagset()</methodname></link> + methods.</para> + + </refsect2> + + <refsect2 id="method-gtktextbuffer--get-deserialize-formats"> + <title>gtk.TextBuffer.get_deserialize_formats</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_deserialize_formats</methodname> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>a list of target strings representing the + registered formats.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>This method returns the rich text deserialize formats registered + using the <link + linkend="method-gtktextbuffer--register-deserialize-format"><methodname>gtk.TextBuffer.register_deserialize_format()</methodname></link> + or <link + linkend="method-gtktextbuffer--register-deserialize-tagset"><methodname>gtk.TextBuffer.register_deserialize_tagset()</methodname></link> + methods.</para> + + </refsect2> + + <refsect2 id="method-gtktextbuffer--serialize"> + <title>gtk.TextBuffer.serialize</title> + + <programlisting><methodsynopsis language="python"> + <methodname>serialize</methodname> + <methodparam><parameter role="keyword">content_buffer</parameter></methodparam> + <methodparam><parameter role="keyword">format</parameter></methodparam> + <methodparam><parameter role="keyword">start</parameter></methodparam> + <methodparam><parameter role="keyword">end</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter role="keyword">content_buffer</parameter> :</term> + <listitem><simpara>the <link + linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link> + to serialize</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">format</parameter> :</term> + <listitem><simpara>the rich text format to use for + serializing</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">start</parameter> :</term> + <listitem><simpara>start of block of text to + serialize</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">end</parameter> :</term> + <listitem><simpara>end of block of test to + serialize</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the serialized data, encoded as + <literal>format</literal></simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>This method serializes the portion of text between <literal>start</literal> + and <literal>end</literal> in the rich text format represented by <literal>format</literal>.</para> + + <para>The formats to be used must be registered using the <link + linkend="method-gtktextbuffer--register-serialize-format"><methodname>gtk.TextBuffer.register_serialize_format()</methodname></link> + or <link + linkend="method-gtktextbuffer--register-serialize-tagset"><methodname>gtk.TextBuffer.register_serialize_tagset()</methodname></link> + methods beforehand.</para> + + </refsect2> + + <refsect2 id="method-gtktextbuffer--deserialize"> + <title>gtk.TextBuffer.deserialize</title> + + <programlisting><methodsynopsis language="python"> + <methodname>deserialize</methodname> + <methodparam><parameter role="keyword">content_buffer</parameter></methodparam> + <methodparam><parameter role="keyword">format</parameter></methodparam> + <methodparam><parameter role="keyword">iter</parameter></methodparam> + <methodparam><parameter role="keyword">data</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter role="keyword">content_buffer</parameter> :</term> + <listitem><simpara>the <link + linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link> + to deserialize into</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">format</parameter> :</term> + <listitem><simpara>the rich text format to use for + deserializing</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">iter</parameter> :</term> + <listitem><simpara>insertion point for the deserialized + text</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">data</parameter> :</term> + <listitem><simpara>data to deserialize</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara><literal>TRUE</literal> on success, + <literal>FALSE</literal> otherwise.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>This method deserializes rich text in format + <literal>format</literal> and inserts it at <literal>iter</literal> in + <parameter>content_buffer</parameter>.</para> + + <para>The formats to be used must be registered using the <link + linkend="method-gtktextbuffer--register-deserialize-format"><methodname>gtk.TextBuffer.register_deserialize_format()</methodname></link> + or <link + linkend="method-gtktextbuffer--register-deserialize-tagset"><methodname>gtk.TextBuffer.register_deserialize_tagset()</methodname></link> + methods beforehand.</para> + + </refsect2> + </refsect1> <refsect1> diff --git a/docs/reference/pygtk-gtktextchildanchor.xml b/docs/reference/pygtk-gtktextchildanchor.xml index 6bdafdf8..4a6ec8b4 100644 --- a/docs/reference/pygtk-gtktextchildanchor.xml +++ b/docs/reference/pygtk-gtktextchildanchor.xml @@ -40,6 +40,12 @@ linkend="method-gtktextchildanchor--get-deleted">get_deleted</link></methodname> </refsect1> + <refsect1 id="signal-prototypes-gtktextchildanchor"> + <title>gtk.TextChildAnchor Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtktextmark.xml b/docs/reference/pygtk-gtktextmark.xml index 79bb5d5a..ece5a907 100644 --- a/docs/reference/pygtk-gtktextmark.xml +++ b/docs/reference/pygtk-gtktextmark.xml @@ -55,6 +55,12 @@ linkend="method-gtktextmark--get-left-gravity">get_left_gravity</link></methodna </refsect1> + <refsect1 id="signal-prototypes-gtktextmark"> + <title>gtk.TextMark Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtktexttag.xml b/docs/reference/pygtk-gtktexttag.xml index 2bdfcbaf..ad72f557 100644 --- a/docs/reference/pygtk-gtktexttag.xml +++ b/docs/reference/pygtk-gtktexttag.xml @@ -55,8 +55,8 @@ linkend="method-gtktexttag--event">event</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtktexttag"> + <title>gtk.TextTag Properties</title> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -67,22 +67,23 @@ linkend="method-gtktexttag--event">event</link></methodname> <tbody> <row valign="top"> - <entry>"name"</entry> - <entry>Read-Write</entry> - <entry>The name of the texttag or <literal>None</literal> if -anonymous</entry> - </row> - - <row valign="top"> <entry>"background"</entry> <entry>Write</entry> <entry>The background color as a string</entry> </row> <row valign="top"> - <entry>"foreground"</entry> - <entry>Write</entry> - <entry>The foreground color as a string</entry> + <entry>"background-full-height"</entry> + <entry>Read-Write</entry> + <entry>If <literal>TRUE</literal>, the background color fills +the entire line height</entry> + </row> + + <row valign="top"> + <entry>"background-full-height-set"</entry> + <entry>Read-Write</entry> + <entry>If <literal>TRUE</literal>, this tag affects background +height</entry> </row> <row valign="top"> @@ -93,10 +94,10 @@ linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></entry> </row> <row valign="top"> - <entry>"foreground-gdk"</entry> + <entry>"background-set"</entry> <entry>Read-Write</entry> - <entry>The foreground color as a (possibly unallocated) <link -linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></entry> + <entry>If <literal>TRUE</literal>, this tag affects the +background color</entry> </row> <row valign="top"> @@ -107,24 +108,32 @@ background</entry> </row> <row valign="top"> - <entry>"foreground-stipple"</entry> + <entry>"background-stipple-set"</entry> <entry>Read-Write</entry> - <entry>The bitmap to use as a mask when drawing the text -foreground</entry> + <entry>If <literal>TRUE</literal>, this tag affects the +background stipple</entry> </row> <row valign="top"> - <entry>"font"</entry> + <entry>"direction"</entry> <entry>Read-Write</entry> - <entry>The font description as a string, e.g. "Sans Italic -12"</entry> + <entry>The text direction: +<literal>gtk.TEXT_DIR_NONE</literal>, <literal>gtk.TEXT_DIR_LTR</literal> or +<literal>gtk.TEXT_DIR_RTL</literal></entry> </row> <row valign="top"> - <entry>"font-desc"</entry> + <entry>"editable"</entry> <entry>Read-Write</entry> - <entry>The font description as a pango.FontDescription -object</entry> + <entry>It <literal>TRUE</literal> the text can be modified by +the user</entry> + </row> + + <row valign="top"> + <entry>"editable-set"</entry> + <entry>Read-Write</entry> + <entry>If <literal>TRUE</literal>, this tag affects text +editability</entry> </row> <row valign="top"> @@ -135,109 +144,84 @@ Times, Monospace</entry> </row> <row valign="top"> - <entry>"style"</entry> + <entry>"family-set"</entry> <entry>Read-Write</entry> - <entry>The font style - one of: -<literal>pango.STYLE_NORMAL</literal>, -<literal>pango.STYLE_OBLIQUE</literal> or -<literal>pango.STYLE_ITALIC</literal>.</entry> + <entry>If <literal>TRUE</literal>, this tag affects the font +family</entry> </row> <row valign="top"> - <entry>"variant"</entry> + <entry>"font"</entry> <entry>Read-Write</entry> - <entry>The font variant - either -<literal>pango.VARIANT_NORMAL</literal> or -<literal>pango.VARIANT_SMALL_CAPS</literal>.</entry> + <entry>The font description as a string, e.g. "Sans Italic +12"</entry> </row> <row valign="top"> - <entry>"weight"</entry> + <entry>"font-desc"</entry> <entry>Read-Write</entry> - <entry>The font weight as an integer: -<literal>pango.WEIGHT_ULTRALIGHT</literal> = 200, -<literal>pango.WEIGHT_LIGHT</literal> = 300, -<literal>pango.WEIGHT_NORMAL</literal> = 400, -<literal>pango.WEIGHT_BOLD</literal> = 700, -<literal>pango.WEIGHT_ULTRABOLD</literal> = 800, -<literal>pango.WEIGHT_HEAVY</literal> = 900.</entry> + <entry>The font description as a pango.FontDescription +object</entry> </row> <row valign="top"> - <entry>"stretch"</entry> - <entry>Read-Write</entry> - <entry>The font stretch - one of: -<literal>pango.STRETCH_ULTRA_CONDENSED</literal>, -<literal>pango.STRETCH_EXTRA_CONDENSED</literal>, -<literal>pango.STRETCH_CONDENSED</literal>, -<literal>pango.STRETCH_SEMI_CONDENSED</literal>, -<literal>pango.STRETCH_NORMAL</literal>, -<literal>pango.STRETCH_SEMI_EXPANDED</literal>, -<literal>pango.STRETCH_EXPANDED</literal>, -<literal>pango.STRETCH_EXTRA_EXPANDED</literal>, -<literal>pango.STRETCH_ULTRA_EXPANDED</literal></entry> + <entry>"foreground"</entry> + <entry>Write</entry> + <entry>The foreground color as a string</entry> </row> <row valign="top"> - <entry>"size"</entry> + <entry>"foreground-gdk"</entry> <entry>Read-Write</entry> - <entry>The font size in Pango units.</entry> + <entry>The foreground color as a (possibly unallocated) <link +linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></entry> </row> <row valign="top"> - <entry>"size-points"</entry> + <entry>"foreground-set"</entry> <entry>Read-Write</entry> - <entry>The font size in points</entry> + <entry>If <literal>TRUE</literal>, this tag affects the +foreground color</entry> </row> <row valign="top"> - <entry>"scale"</entry> + <entry>"foreground-stipple"</entry> <entry>Read-Write</entry> - <entry>The font size as a scale factor relative to the default -font size. This properly adapts to theme changes etc. so is recommended. -Pango predefines some scales such as -<literal>pango.SCALE_XX_SMALL</literal>, -<literal>pango.SCALE_X_SMALL</literal>, -<literal>pango.SCALE_SMALL</literal>, <literal>pango.SCALE_MEDIUM</literal>, -<literal>pango.SCALE_LARGE</literal>, -<literal>pango.SCALE_X_LARGE</literal>, -<literal>pango.SCALE_XX_LARGE</literal>.</entry> + <entry>The bitmap to use as a mask when drawing the text +foreground</entry> </row> <row valign="top"> - <entry>"pixels-above-lines"</entry> + <entry>"foreground-stipple-set"</entry> <entry>Read-Write</entry> - <entry>The number of pixels of blank space above -paragraphs</entry> + <entry>If <literal>TRUE</literal>, this tag affects the +foreground stipple</entry> </row> <row valign="top"> - <entry>"pixels-below-lines"</entry> + <entry>"indent"</entry> <entry>Read-Write</entry> - <entry>The number of pixels of blank space below -paragraphs</entry> + <entry>The amount to indent the paragraph, in pixels</entry> </row> <row valign="top"> - <entry>"pixels-inside-wrap"</entry> + <entry>"indent-set"</entry> <entry>Read-Write</entry> - <entry>The number of pixels of blank space between wrapped -lines in a paragraph</entry> + <entry>If <literal>TRUE</literal>, this tag affects +indentation</entry> </row> <row valign="top"> - <entry>"editable"</entry> + <entry>"invisible"</entry> <entry>Read-Write</entry> - <entry>It <literal>TRUE</literal> the text can be modified by -the user</entry> + <entry>If <literal>TRUE</literal>, this text is hidden</entry> </row> <row valign="top"> - <entry>"wrap-mode"</entry> + <entry>"invisible-set"</entry> <entry>Read-Write</entry> - <entry>The wrap mode of the text: -<literal>gtk.WRAP_NONE</literal>, <literal>gtk.WRAP_CHAR</literal> or -<literal>gtk.WRAP_WORD</literal></entry> + <entry>If <literal>TRUE</literal>, this tag affects text +visibility</entry> </row> <row valign="top"> @@ -250,143 +234,170 @@ the user</entry> </row> <row valign="top"> - <entry>"direction"</entry> + <entry>"justification-set"</entry> <entry>Read-Write</entry> - <entry>The text direction: -<literal>gtk.TEXT_DIR_NONE</literal>, <literal>gtk.TEXT_DIR_LTR</literal> or -<literal>gtk.TEXT_DIR_RTL</literal></entry> + <entry>If <literal>TRUE</literal>, this tag affects paragraph +justification</entry> </row> <row valign="top"> - <entry>"left-margin"</entry> + <entry>"language"</entry> <entry>Read-Write</entry> - <entry>The width of the left margin in pixels</entry> + <entry>The language this text is in, as an ISO code. Pango can +use this as a hint when rendering the text. If you don't understand this +parameter, you probably don't need it.</entry> </row> <row valign="top"> - <entry>"indent"</entry> + <entry>"language-set"</entry> <entry>Read-Write</entry> - <entry>The amount to indent the paragraph, in pixels</entry> + <entry>If <literal>TRUE</literal>, this tag affects the +language the text is rendered as</entry> </row> <row valign="top"> - <entry>"strikethrough"</entry> + <entry>"left-margin"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, strike through the -text</entry> + <entry>The width of the left margin in pixels</entry> </row> <row valign="top"> - <entry>"right-margin"</entry> + <entry>"left-margin-set"</entry> <entry>Read-Write</entry> - <entry>The width of the right margin in pixels</entry> + <entry>If <literal>TRUE</literal>, this tag affects the left +margin</entry> </row> <row valign="top"> - <entry>"underline"</entry> + <entry>"name"</entry> <entry>Read-Write</entry> - <entry>The style of underline for this text: -<literal>pango.UNDERLINE_NONE</literal>, -<literal>pango.UNDERLINE_SINGLE</literal>, -<literal>pango.UNDERLINE_DOUBLE</literal> or -<literal>pango.UNDERLINE_LOW</literal></entry> + <entry>The name of the texttag or <literal>None</literal> if +anonymous</entry> </row> + <row valign="top"> + <entry>"paragraph-background"</entry> + <entry>Write</entry> + <entry>The paragraph background color as a string. This + property is available in GTK+ 2.8 and above.</entry> + </row> + + <row valign="top"> + <entry>"paragraph-background-gdk"</entry> + <entry>Read-Write</entry> + <entry>The paragraph background color as a as a (possibly + unallocated) <link + linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>. + This property is available in GTK+ 2.8 and above.</entry> + </row> + + <row valign="top"> + <entry>"paragraph-background-set"</entry> + <entry>Read-Write</entry> + <entry>if <literal>TRUE</literal> this tag affects the + paragraph background color</entry> + </row> + <row valign="top"> - <entry>"rise"</entry> + <entry>"pixels-above-lines"</entry> <entry>Read-Write</entry> - <entry>The offset of text above the baseline (below the -baseline if rise is negative) in pixels</entry> + <entry>The number of pixels of blank space above +paragraphs</entry> </row> <row valign="top"> - <entry>"background-full-height"</entry> + <entry>"pixels-above-lines-set"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, the background color fills -the entire line height</entry> + <entry>If <literal>TRUE</literal>, this tag affects the number +of pixels above lines</entry> </row> <row valign="top"> - <entry>"language"</entry> + <entry>"pixels-below-lines"</entry> <entry>Read-Write</entry> - <entry>The language this text is in, as an ISO code. Pango can -use this as a hint when rendering the text. If you don't understand this -parameter, you probably don't need it.</entry> + <entry>The number of pixels of blank space below +paragraphs</entry> </row> <row valign="top"> - <entry>"tabs"</entry> + <entry>"pixels-below-lines-set"</entry> <entry>Read-Write</entry> - <entry>The custom tabs for this text</entry> + <entry>If <literal>TRUE</literal>, this tag affects the number +of pixels above lines</entry> </row> <row valign="top"> - <entry>"invisible"</entry> + <entry>"pixels-inside-wrap"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this text is hidden</entry> + <entry>The number of pixels of blank space between wrapped +lines in a paragraph</entry> </row> <row valign="top"> - <entry>"background-set"</entry> + <entry>"pixels-inside-wrap-set"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects the -background color</entry> + <entry>If <literal>TRUE</literal>, this tag affects the number +of pixels between wrapped lines</entry> </row> <row valign="top"> - <entry>"foreground-set"</entry> + <entry>"right-margin"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects the -foreground color</entry> + <entry>The width of the right margin in pixels</entry> </row> <row valign="top"> - <entry>"background-stipple-set"</entry> + <entry>"right-margin-set"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects the -background stipple</entry> + <entry>If <literal>TRUE</literal>, this tag affects the right +margin</entry> </row> <row valign="top"> - <entry>"foreground-stipple-set"</entry> + <entry>"rise"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects the -foreground stipple</entry> + <entry>The offset of text above the baseline (below the +baseline if rise is negative) in pixels</entry> </row> <row valign="top"> - <entry>"family-set"</entry> + <entry>"rise-set"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects the font -family</entry> + <entry>If <literal>TRUE</literal>, this tag affects the +rise</entry> </row> <row valign="top"> - <entry>"style-set"</entry> + <entry>"scale"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects the font -style</entry> + <entry>The font size as a scale factor relative to the default +font size. This properly adapts to theme changes etc. so is recommended. +Pango predefines some scales such as +<literal>pango.SCALE_XX_SMALL</literal>, +<literal>pango.SCALE_X_SMALL</literal>, +<literal>pango.SCALE_SMALL</literal>, <literal>pango.SCALE_MEDIUM</literal>, +<literal>pango.SCALE_LARGE</literal>, +<literal>pango.SCALE_X_LARGE</literal>, +<literal>pango.SCALE_XX_LARGE</literal>.</entry> </row> <row valign="top"> - <entry>"variant-set"</entry> + <entry>"scale-set"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects the font -variant</entry> + <entry>If <literal>TRUE</literal>, this tag scales the font +size by a factor</entry> </row> <row valign="top"> - <entry>"weight-set"</entry> + <entry>"size"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects the font -weight</entry> + <entry>The font size in Pango units.</entry> </row> <row valign="top"> - <entry>"stretch-set"</entry> + <entry>"size-points"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects the font -stretch</entry> + <entry>The font size in points</entry> </row> <row valign="top"> @@ -397,122 +408,134 @@ size</entry> </row> <row valign="top"> - <entry>"scale-set"</entry> - <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag scales the font -size by a factor</entry> - </row> - - <row valign="top"> - <entry>"pixels-above-lines-set"</entry> + <entry>"stretch"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects the number -of pixels above lines</entry> + <entry>The font stretch - one of: +<literal>pango.STRETCH_ULTRA_CONDENSED</literal>, +<literal>pango.STRETCH_EXTRA_CONDENSED</literal>, +<literal>pango.STRETCH_CONDENSED</literal>, +<literal>pango.STRETCH_SEMI_CONDENSED</literal>, +<literal>pango.STRETCH_NORMAL</literal>, +<literal>pango.STRETCH_SEMI_EXPANDED</literal>, +<literal>pango.STRETCH_EXPANDED</literal>, +<literal>pango.STRETCH_EXTRA_EXPANDED</literal>, +<literal>pango.STRETCH_ULTRA_EXPANDED</literal></entry> </row> <row valign="top"> - <entry>"pixels-below-lines-set"</entry> + <entry>"stretch-set"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects the number -of pixels above lines</entry> + <entry>If <literal>TRUE</literal>, this tag affects the font +stretch</entry> </row> <row valign="top"> - <entry>"pixels-inside-wrap-set"</entry> + <entry>"strikethrough"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects the number -of pixels between wrapped lines</entry> + <entry>If <literal>TRUE</literal>, strike through the +text</entry> </row> <row valign="top"> - <entry>"editable-set"</entry> + <entry>"strikethrough-set"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects text -editability</entry> + <entry>If <literal>TRUE</literal>, this tag affects +strikethrough</entry> </row> <row valign="top"> - <entry>"wrap-mode-set"</entry> + <entry>"style"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects line wrap -mode</entry> + <entry>The font style - one of: +<literal>pango.STYLE_NORMAL</literal>, +<literal>pango.STYLE_OBLIQUE</literal> or +<literal>pango.STYLE_ITALIC</literal>.</entry> </row> <row valign="top"> - <entry>"justification-set"</entry> + <entry>"style-set"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects paragraph -justification</entry> + <entry>If <literal>TRUE</literal>, this tag affects the font +style</entry> </row> <row valign="top"> - <entry>"left-margin-set"</entry> + <entry>"tabs"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects the left -margin</entry> + <entry>The custom tabs for this text</entry> </row> <row valign="top"> - <entry>"indent-set"</entry> + <entry>"tabs-set"</entry> <entry>Read-Write</entry> <entry>If <literal>TRUE</literal>, this tag affects -indentation</entry> +tabs</entry> </row> <row valign="top"> - <entry>"strikethrough-set"</entry> + <entry>"underline"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects -strikethrough</entry> + <entry>The style of underline for this text: +<literal>pango.UNDERLINE_NONE</literal>, +<literal>pango.UNDERLINE_SINGLE</literal>, +<literal>pango.UNDERLINE_DOUBLE</literal> or +<literal>pango.UNDERLINE_LOW</literal></entry> </row> <row valign="top"> - <entry>"right-margin-set"</entry> + <entry>"underline-set"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects the right -margin</entry> + <entry>If <literal>TRUE</literal>, this tag affects +underlining</entry> </row> <row valign="top"> - <entry>"underline-set"</entry> + <entry>"variant"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects -underlining</entry> + <entry>The font variant - either +<literal>pango.VARIANT_NORMAL</literal> or +<literal>pango.VARIANT_SMALL_CAPS</literal>.</entry> </row> <row valign="top"> - <entry>"rise-set"</entry> + <entry>"variant-set"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects the -rise</entry> + <entry>If <literal>TRUE</literal>, this tag affects the font +variant</entry> </row> <row valign="top"> - <entry>"background-full-height-set"</entry> + <entry>"weight"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects background -height</entry> + <entry>The font weight as an integer: +<literal>pango.WEIGHT_ULTRALIGHT</literal> = 200, +<literal>pango.WEIGHT_LIGHT</literal> = 300, +<literal>pango.WEIGHT_NORMAL</literal> = 400, +<literal>pango.WEIGHT_BOLD</literal> = 700, +<literal>pango.WEIGHT_ULTRABOLD</literal> = 800, +<literal>pango.WEIGHT_HEAVY</literal> = 900.</entry> </row> <row valign="top"> - <entry>"language-set"</entry> + <entry>"weight-set"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects the -language the text is rendered as</entry> + <entry>If <literal>TRUE</literal>, this tag affects the font +weight</entry> </row> <row valign="top"> - <entry>"tabs-set"</entry> + <entry>"wrap-mode"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects -tabs</entry> + <entry>The wrap mode of the text: +<literal>gtk.WRAP_NONE</literal>, <literal>gtk.WRAP_CHAR</literal> or +<literal>gtk.WRAP_WORD</literal></entry> </row> <row valign="top"> - <entry>"invisible-set"</entry> + <entry>"wrap-mode-set"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, this tag affects text -visibility</entry> + <entry>If <literal>TRUE</literal>, this tag affects line wrap +mode</entry> </row> </tbody> @@ -522,8 +545,10 @@ visibility</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtktexttag"> + <title>gtk.TextTag Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtktexttagtable.xml b/docs/reference/pygtk-gtktexttagtable.xml index 4893b5bc..2c5e0a8b 100644 --- a/docs/reference/pygtk-gtktexttagtable.xml +++ b/docs/reference/pygtk-gtktexttagtable.xml @@ -59,8 +59,10 @@ linkend="method-gtktexttagtable--get-size">get_size</link></methodname> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtktexttagtable"> + <title>gtk.TextTagTable Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtktextview.xml b/docs/reference/pygtk-gtktextview.xml index 0ac42b0a..be5c9775 100644 --- a/docs/reference/pygtk-gtktextview.xml +++ b/docs/reference/pygtk-gtktextview.xml @@ -378,8 +378,12 @@ END OF NOT IMPLEMENTED --> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtktextview"> + <title>gtk.TextView 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"> @@ -498,8 +502,10 @@ wrapped lines in a paragraph</entry> </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="style-properties-gtktextview"> + <title>gtk.TextView Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -526,11 +532,26 @@ above.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtktextview"> + <title>gtk.TextView 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-gtktextview--backspace">backspace</link></term> + <listitem> + <methodsynopsis language="python"><methodname>callback</methodname> + <methodparam><parameter>textview</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis> + </listitem> + </varlistentry> + <varlistentry> <term>"<link linkend="signal-gtktextview--copy-clipboard">copy-clipboard</link>"</term> <listitem> <methodsynopsis language="python"><methodname>callback</methodname> @@ -2660,6 +2681,43 @@ method to get the attributes in effect at a given text position.</para> <refsect1> <title>Signals</title> + <refsect2 id="signal-gtktextview--backspace"> + <title>The "backspace" gtk.TextView Signal</title> + + <programlisting><methodsynopsis language="python"><methodname>callback</methodname> + <methodparam><parameter>textview</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter>textview</parameter> :</term> + <listitem><simpara>the object which 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> + + <note> + <para>This signal is available in GTK+ 2.10 and above.</para> + </note> + + <para>The "backspace" signal is emitted when the + <keycap>Backspace</keycap> key is pressed.</para> + + + </refsect2> + <refsect2 id="signal-gtktextview--copy-clipboard"> <title>The "copy-clipboard" gtk.TextView Signal</title> diff --git a/docs/reference/pygtk-gtktoggleaction.xml b/docs/reference/pygtk-gtktoggleaction.xml index 70a4a278..da07ef01 100644 --- a/docs/reference/pygtk-gtktoggleaction.xml +++ b/docs/reference/pygtk-gtktoggleaction.xml @@ -54,8 +54,10 @@ </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtktoggleaction"> + <title>gtk.ToggleAction Properties</title> + + <para><link linkend="properties-gtkaction">gtk.Action Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -65,11 +67,19 @@ <colspec column="3" colwidth="4in"/> <tbody> + <row valign="top"> + <entry>"active"</entry> + <entry>Read-Write</entry> + <entry>If the toggle action should be active in or not. This + property is available in GTK+ 2.10 and above.</entry> + </row> + <row valign="top"> <entry>"draw-as-radio"</entry> <entry>Read-Write</entry> <entry>If <literal>TRUE</literal>, the proxies for this action -look like radio action proxies. Available in GTK+ 2.4 and above.</entry> + look like radio action proxies. Available in GTK+ 2.4 and + above.</entry> </row> </tbody> @@ -79,8 +89,11 @@ look like radio action proxies. Available in GTK+ 2.4 and above.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtktoggleaction"> + <title>gtk.ToggleAction Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkaction">gtk.Action Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtktogglebutton.xml b/docs/reference/pygtk-gtktogglebutton.xml index 447f4274..c1804f0e 100644 --- a/docs/reference/pygtk-gtktogglebutton.xml +++ b/docs/reference/pygtk-gtktogglebutton.xml @@ -75,8 +75,13 @@ linkend="method-gtktogglebutton--get-inconsistent">get_inconsistent</link></meth </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtktogglebutton"> + <title>gtk.ToggleButton 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> + <para><link linkend="properties-gtkbutton">gtk.Button Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -94,17 +99,17 @@ pressed in.</entry> </row> <row valign="top"> - <entry>"inconsistent"</entry> + <entry>"draw-indicator"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, the toggle button is in an -"in between" state.</entry> + <entry>If <literal>TRUE</literal>, the toggle part of the +button is displayed.</entry> </row> <row valign="top"> - <entry>"draw-indicator"</entry> + <entry>"inconsistent"</entry> <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, the toggle part of the -button is displayed.</entry> + <entry>If <literal>TRUE</literal>, the toggle button is in an +"in between" state.</entry> </row> </tbody> @@ -114,6 +119,14 @@ button is displayed.</entry> </refsect1> + <refsect1 id="style-properties-gtktogglebutton"> + <title>gtk.ToggleButton Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkbutton">gtk.Button Style Properties</link></para> + + </refsect1> + <refsect1> <title>Attributes</title> @@ -140,8 +153,14 @@ button is displayed.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtktogglebutton"> + <title>gtk.ToggleButton 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> + <para><link linkend="signal-prototypes-gtkbutton">gtk.Button Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtktoggletoolbutton.xml b/docs/reference/pygtk-gtktoggletoolbutton.xml index 1f74668b..5d534ee5 100644 --- a/docs/reference/pygtk-gtktoggletoolbutton.xml +++ b/docs/reference/pygtk-gtktoggletoolbutton.xml @@ -47,8 +47,54 @@ containing a toggle button (new in PyGTK 2.4)</refpurpose> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="properties-gtktoggletoolbutton"> + <title>gtk.ToggleToolButton 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> + <para><link linkend="properties-gtktoolitem">gtk.ToolItem Properties</link></para> + <para><link linkend="properties-gtktoolbutton">gtk.ToolButton 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="3.5in"/> + <tbody> + + <row valign="top"> + <entry>"active"</entry> + <entry>Read-Write</entry> + <entry>If the toggle tool button should be pressed in or not. + This property is available in GTK+ 2.8 and above.</entry> + </row> + + </tbody> + </tgroup> + </informaltable> + </blockquote> + + </refsect1> + + <refsect1 id="style-properties-gtktoggletoolbutton"> + <title>gtk.ToggleToolButton Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtktoolbutton">gtk.ToolButton Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtktoggletoolbutton"> + <title>gtk.ToggleToolButton 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> + <para><link linkend="signal-prototypes-gtktoolitem">gtk.ToolItem Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtktoolbutton">gtk.ToolButton Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtktoolbar.xml b/docs/reference/pygtk-gtktoolbar.xml index 7e15f5c3..1039f202 100644 --- a/docs/reference/pygtk-gtktoolbar.xml +++ b/docs/reference/pygtk-gtktoolbar.xml @@ -305,8 +305,12 @@ linkend="method-gtktoolbar--get-tooltips">get_tooltips</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtktoolbar"> + <title>gtk.Toolbar 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"> @@ -316,7 +320,26 @@ linkend="method-gtktoolbar--get-tooltips">get_tooltips</link></methodname> <colspec column="3" colwidth="4in"/> <tbody> - <row valign="top"> + <row valign="top"> + <entry>"icon-size"</entry> + <entry>Read-Write</entry> + <entry>The size of the icons in a toolbar is normally determined + by the "toolbar-icon-size" setting. When this property is set, it + overrides the setting. This should only be used for + special-purpose toolbars, normal application toolbars should + respect the user preferences for the size of icons. This property + is available in GTK+ 2.10 and above.</entry> + </row> + + <row valign="top"> + <entry>"icon-size-set"</entry> + <entry>Read-Write</entry> + <entry>if <literal>TRUE</literal> the icon-size property has + been set. This property is available in GTK+ 2.10 and + above.</entry> + </row> + + <row valign="top"> <entry>"orientation"</entry> <entry>Read-Write</entry> <entry>The orientation of the toolbar: @@ -340,47 +363,24 @@ if the toolbar doesn't fit. Available in GTK+ 2.4 and above.</entry> <literal>gtk.TOOLBAR_BOTH_HORIZ</literal></entry> </row> - </tbody> - </tgroup> - </informaltable> - </blockquote> - - </refsect1> - - <refsect1> - <title>Child Properties</title> - - <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>"expand"</entry> - <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, the item should receive -extra space when the toolbar grows. Available in GTK+ 2.4 and above.</entry> - </row> + <row valign="top"> + <entry>"tooltips"</entry> + <entry>Read-Write</entry> + <entry>If the tooltips of the toolbar should be active or not. + This property is available in GTK+ 2.8 and above.</entry> + </row> </tbody> - <row valign="top"> - <entry>"homogeneous"</entry> - <entry>Read-Write</entry> - <entry>If <literal>TRUE</literal>, the item should be the -same size as other homogeneous items. Available in GTK+ 2.4 and above.</entry> - </row> - </tgroup> </informaltable> </blockquote> </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="style-properties-gtktoolbar"> + <title>gtk.Toolbar Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -405,6 +405,12 @@ same size as other homogeneous items. Available in GTK+ 2.4 and above.</entry> and the buttons</entry> </row> + <row valign="top"> + <entry>"max-child-expand"</entry> + <entry>Read</entry> + <entry>Maximum amount of space an expandable item will be given</entry> + </row> + <row valign="top"> <entry>"shadow-type"</entry> <entry>Read</entry> @@ -435,11 +441,70 @@ or <literal>gtk.SHADOW_ETCHED_OUT</literal></entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="child-properties-gtktoolbar"> + <title>gtk.Toolbar Child Properties</title> + + <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>"expand"</entry> + <entry>Read-Write</entry> + <entry>If <literal>TRUE</literal>, the item should receive +extra space when the toolbar grows. Available in GTK+ 2.4 and above.</entry> + </row> + + </tbody> + <row valign="top"> + <entry>"homogeneous"</entry> + <entry>Read-Write</entry> + <entry>If <literal>TRUE</literal>, the item should be the +same size as other homogeneous items. Available in GTK+ 2.4 and above.</entry> + </row> + + </tgroup> + </informaltable> + </blockquote> + + </refsect1> + + <refsect1 id="signal-prototypes-gtktoolbar"> + <title>gtk.Toolbar 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-gtktoolbar--focus-home-or-end">focus-home-or-end</link></term> + <listitem> + <methodsynopsis language="python"><methodname>callback</methodname> + <methodparam><parameter>toolbar</parameter></methodparam> + <methodparam><parameter>focus_home</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis> + </listitem> + </varlistentry> + <varlistentry> + <term>"<link linkend="signal-gtktoolbar--move-focus">move-focus</link></term> + <listitem> + <methodsynopsis language="python"><methodname>callback</methodname> + <methodparam><parameter>toolbar</parameter></methodparam> + <methodparam><parameter>dir</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis> + </listitem> + </varlistentry> + <varlistentry> <term>"<link linkend="signal-gtktoolbar--orientation-changed">orientation-changed</link>"</term> <listitem> @@ -2259,6 +2324,98 @@ method for more details.</para> <refsect1> <title>Signals</title> + <refsect2 id="signal-gtktoolbar--focus-home-or-end"> + <title>The "focus-home-or-end" gtk.Toolbar Signal</title> + + <programlisting><methodsynopsis language="python"><methodname>callback</methodname> + <methodparam><parameter>toolbar</parameter></methodparam> + <methodparam><parameter>focus_home</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter>toolbar</parameter> :</term> + <listitem><simpara>the <link linkend="class-gtktoolbar"><classname>gtk.Toolbar</classname></link> which emitted the signal + the object which received the signal.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter>focus_home</parameter> :</term> + <listitem><simpara><literal>TRUE</literal> if the first item + should be focused</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, <literal>FALSE</literal> if not</simpara></listitem> + </varlistentry> + </variablelist> + + <para>A keybinding signal used internally by GTK+. This signal can't + be used in application code</para> + + </refsect2> + + <refsect2 id="signal-gtktoolbar--move-focus"> + <title>The "move-focus" gtk.Toolbar Signal</title> + + <programlisting><methodsynopsis language="python"><methodname>callback</methodname> + <methodparam><parameter>toolbar</parameter></methodparam> + <methodparam><parameter>dir</parameter></methodparam> + <methodparam><parameter>arg1</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter>toolbar</parameter> :</term> + <listitem><simpara>the <link + linkend="class-gtktoolbar"><classname>gtk.Toolbar</classname></link> + which emitted the signal the object which received the + signal.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter>dir</parameter> :</term> + <listitem><simpara>one of the <xref + linkend="gtk-direction-type-constants" + endterm="gtk-direction-type-constants-title"></xref></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, <literal>FALSE</literal> if not</simpara></listitem> + </varlistentry> + </variablelist> + + <para>A keybinding signal used internally by GTK+. This signal can't + be used in application code.</para> + + </refsect2> + <refsect2 id="signal-gtktoolbar--orientation-changed"> <title>The "orientation-changed" gtk.Toolbar Signal</title> diff --git a/docs/reference/pygtk-gtktoolbutton.xml b/docs/reference/pygtk-gtktoolbutton.xml index 723c4036..f110bc3a 100644 --- a/docs/reference/pygtk-gtktoolbutton.xml +++ b/docs/reference/pygtk-gtktoolbutton.xml @@ -89,8 +89,13 @@ </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtktoolbutton"> + <title>gtk.ToolButton 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> + <para><link linkend="properties-gtktoolitem">gtk.ToolItem Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -154,6 +159,43 @@ Default value: <literal>FALSE</literal>.</entry> </refsect1> + <refsect1 id="style-properties-gtktoolbutton"> + <title>gtk.ToolButton 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="3.5in"/> + <tbody> + + <row valign="top"> + <entry>"icon-spacing"</entry> + <entry>Read-Write</entry> + <entry>Spacing in pixels between the icon and label</entry> + </row> + + </tbody> + </tgroup> + </informaltable> + </blockquote> + + </refsect1> + + <refsect1 id="signal-prototypes-gtktoolbutton"> + <title>gtk.ToolButton 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> + <para><link linkend="signal-prototypes-gtktoolitem">gtk.ToolItem Signal Prototypes</link></para> + + </refsect1> + <refsect1> <title>Signal Prototypes</title> diff --git a/docs/reference/pygtk-gtktoolitem.xml b/docs/reference/pygtk-gtktoolitem.xml index ba725bd2..c6ae06ac 100644 --- a/docs/reference/pygtk-gtktoolitem.xml +++ b/docs/reference/pygtk-gtktoolitem.xml @@ -122,8 +122,12 @@ </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtktoolitem"> + <title>gtk.ToolItem 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> <note> <para>These properties are available in GTK+ 2.4 and above.</para> @@ -172,8 +176,20 @@ when the toolbar is in a vertical orientation. Default value: </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="style-properties-gtktoolitem"> + <title>gtk.ToolItem Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtktoolitem"> + <title>gtk.ToolItem 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> diff --git a/docs/reference/pygtk-gtktooltips.xml b/docs/reference/pygtk-gtktooltips.xml index 0e527b46..e04a4ec3 100644 --- a/docs/reference/pygtk-gtktooltips.xml +++ b/docs/reference/pygtk-gtktooltips.xml @@ -65,6 +65,13 @@ linkend="function-gtk--tooltips-data-get">gtk.tooltips_data_get</link></methodna </refsect1> + <refsect1 id="properties-gtktooltips"> + <title>gtk.Tooltips Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + + </refsect1> + <refsect1> <title>Attributes</title> @@ -138,6 +145,13 @@ delay.</entry> </refsect1> + <refsect1 id="signal-prototypes-gtktooltips"> + <title>gtk.Tooltips 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> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtktreemodel.xml b/docs/reference/pygtk-gtktreemodel.xml index 71272a36..d8948cb0 100644 --- a/docs/reference/pygtk-gtktreemodel.xml +++ b/docs/reference/pygtk-gtktreemodel.xml @@ -195,8 +195,8 @@ linkend="function-gtk--tree-row-reference-deleted">gtk.tree_row_reference_delete </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtktreemodel"> + <title>gtk.TreeModel Signal Prototypes</title> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtktreemodelfilter.xml b/docs/reference/pygtk-gtktreemodelfilter.xml index 8ab2ee76..2bbc5d67 100644 --- a/docs/reference/pygtk-gtktreemodelfilter.xml +++ b/docs/reference/pygtk-gtktreemodelfilter.xml @@ -74,8 +74,8 @@ which hides parts of an underlying tree (new in PyGTK 2.4)</refpurpose> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtktreemodelfilter"> + <title>gtk.TreeModelFilter Properties</title> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -109,6 +109,13 @@ filtermodel. Available in GTK+ 2.4 and above.</entry> </refsect1> + <refsect1 id="signal-prototypes-gtktreemodelfilter"> + <title>gtk.TreeModelFilter Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtktreemodel">gtk.TreeModel Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtktreemodelsort.xml b/docs/reference/pygtk-gtktreemodelsort.xml index f1f4c523..2244852b 100644 --- a/docs/reference/pygtk-gtktreemodelsort.xml +++ b/docs/reference/pygtk-gtktreemodelsort.xml @@ -86,8 +86,8 @@ linkend="method-gtktreemodelsort--clear-cache">clear_cache</link></methodname> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtktreemodelsort"> + <title>gtk.TreeModelSort Properties</title> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -112,6 +112,14 @@ to sort.</entry> </refsect1> + <refsect1 id="signal-prototypes-gtktreemodelsort"> + <title>gtk.TreeModelSort Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtktreesortable">gtk.TreeSortable Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtktreemodel">gtk.TreeModel Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtktreeselection.xml b/docs/reference/pygtk-gtktreeselection.xml index 289a8d9c..1e0afd80 100644 --- a/docs/reference/pygtk-gtktreeselection.xml +++ b/docs/reference/pygtk-gtktreeselection.xml @@ -140,8 +140,10 @@ linkend="method-gtktreeselection--select-range">select_range</link></methodname> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtktreeselection"> + <title>gtk.TreeSelection Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtktreesortable.xml b/docs/reference/pygtk-gtktreesortable.xml index 53064ee1..64646ae8 100644 --- a/docs/reference/pygtk-gtktreesortable.xml +++ b/docs/reference/pygtk-gtktreesortable.xml @@ -55,8 +55,8 @@ linkend="method-gtktreesortable--has-default-sort-func">has_default_sort_func</l </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtktreesortable"> + <title>gtk.TreeSortable Signal Prototypes</title> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtktreestore.xml b/docs/reference/pygtk-gtktreestore.xml index f4c892f6..d2534319 100644 --- a/docs/reference/pygtk-gtktreestore.xml +++ b/docs/reference/pygtk-gtktreestore.xml @@ -165,6 +165,14 @@ linkend="method-gtktreestore--clear">clear</link></methodname> </refsect1> + <refsect1 id="signal-prototypes-gtktreestore"> + <title>gtk.TreeStore Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtktreesortable">gtk.TreeSortable Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtktreemodel">gtk.TreeModel Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtktreeview.xml b/docs/reference/pygtk-gtktreeview.xml index 1411d873..0adbf16c 100644 --- a/docs/reference/pygtk-gtktreeview.xml +++ b/docs/reference/pygtk-gtktreeview.xml @@ -447,6 +447,46 @@ END NOT IMPLEMENTED --> <methodsynopsis language="python"> <methodname><link linkend="method-gtktreeview--get-visible-range">get_visible_range</link></methodname> </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktreeview--get-headers-clickable">get_headers_clickable</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktreeview--get-search-entry">get_search_entry</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktreeview--set-search-entry">set_search_entry</link></methodname> + <methodparam><parameter role="keyword">entry</parameter><initializer>None</initializer></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktreeview--set-search-position-func">set_search_position_func</link></methodname> + <methodparam><parameter role="keyword">func</parameter></methodparam> + <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktreeview--set-rubber-banding">set_rubber_banding</link></methodname> + <methodparam><parameter role="keyword">enable</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktreeview--get-rubber-banding">get_rubber_banding</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktreeview--get-grid-lines">get_grid_lines</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktreeview--set-grid-lines">set_grid_lines</link></methodname> + <methodparam><parameter role="keyword">grid_lines</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktreeview--get-enable-tree-lines">get_enable_tree_lines</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktreeview--set-enable-tree-lines">set_enable_tree_lines</link></methodname> + <methodparam><parameter role="keyword">enabled</parameter></methodparam> </methodsynopsis> </classsynopsis> @@ -464,8 +504,12 @@ END NOT IMPLEMENTED --> </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtktreeview"> + <title>gtk.TreeView 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"> @@ -475,6 +519,13 @@ END NOT IMPLEMENTED --> <colspec column="3" colwidth="4in"/> <tbody> + <row valign="top"> + <entry>"enable-grid-lines"</entry> + <entry>Read-Write</entry> + <entry>If <literal>TRUE</literal> grid lines should be drawn + in the tree view</entry> + </row> + <row valign="top"> <entry>"enable-search"</entry> <entry>Read-Write</entry> @@ -482,6 +533,13 @@ END NOT IMPLEMENTED --> columns interactively. Default value: <literal>TRUE</literal></entry> </row> + <row valign="top"> + <entry>"enable-tree-lines"</entry> + <entry>Read-Write</entry> + <entry>If <literal>TRUE</literal> tree lines should be drawn + in the tree view</entry> + </row> + <row valign="top"> <entry>"expander-column"</entry> <entry>Read-Write</entry> @@ -544,6 +602,12 @@ linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></l value: <literal>FALSE</literal>. Available in GTK+ 2.6 and above.</entry> </row> + <row valign="top"> + <entry>"level-indentation"</entry> + <entry>Read-Write</entry> + <entry>Extra indentation for each level</entry> + </row> + <row valign="top"> <entry>"model"</entry> <entry>Read-Write</entry> @@ -557,6 +621,13 @@ value: <literal>FALSE</literal>. Available in GTK+ 2.6 and above.</entry> reorderable. Default value: <literal>FALSE</literal>.</entry> </row> + <row valign="top"> + <entry>"rubber-banding"</entry> + <entry>Read-Write</entry> + <entry>If <literal>TRUE</literal> enable selection of multiple + items by dragging the mouse pointer</entry> + </row> + <row valign="top"> <entry>"rules-hint"</entry> <entry>Read-Write</entry> @@ -572,6 +643,12 @@ draw rows in alternating colors. Default value: code. Allowed values: >= -1. Default value: -1</entry> </row> + <row valign="top"> + <entry>"show-expanders"</entry> + <entry>Read-Write</entry> + <entry>View has expanders</entry> + </row> + <row valign="top"> <entry>"vadjustment"</entry> <entry>Read-Write</entry> @@ -585,8 +662,8 @@ code. Allowed values: >= -1. Default value: -1</entry> </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="style-properties-gtktreeview"> + <title>gtk.TreeView Style Properties</title> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -618,6 +695,18 @@ to use for even rows. Available in GTK+ 2.2 and above.</entry> Default value: 12</entry> </row> + <row valign="top"> + <entry>"grid-line-pattern"</entry> + <entry>Read</entry> + <entry>Dash pattern used to draw the tree view grid lines</entry> + </row> + + <row valign="top"> + <entry>"grid-line-width"</entry> + <entry>Read</entry> + <entry>Width, in pixels, of the tree view grid lines</entry> + </row> + <row valign="top"> <entry>"horizontal-separator"</entry> <entry>Read</entry> @@ -640,6 +729,24 @@ linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> to use for odd rows. Available in GTK+ 2.2 and above.</entry> </row> + <row valign="top"> + <entry>"row-ending-details"</entry> + <entry>Read</entry> + <entry>Enable extended row background theming</entry> + </row> + + <row valign="top"> + <entry>"tree-line-pattern"</entry> + <entry>Read</entry> + <entry>Dash pattern used to draw the tree view lines</entry> + </row> + + <row valign="top"> + <entry>"tree-line-width"</entry> + <entry>Read</entry> + <entry>Width, in pixels, of the tree view lines</entry> + </row> + <row valign="top"> <entry>"vertical-separator"</entry> <entry>Read</entry> @@ -654,8 +761,13 @@ number. Allowed values: >= 0. Default value: 2</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtktreeview"> + <title>gtk.TreeView 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> @@ -2428,163 +2540,21 @@ drag</simpara></listitem> </variablelist> <para>The <methodname>enable_model_drag_source</methodname>() method -sets the treeview to start a drag operation when the user click and drags on -a row. The value of <parameter>start_button_mask</parameter> is a -combination of:</para> - - <variablelist> - <varlistentry> - <term><literal>gtk.gdk.SHIFT_MASK</literal></term> - <listitem> - <simpara>The Shift key.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.LOCK_MASK</literal></term> - <listitem> - <simpara>A Lock key (depending on the modifier mapping of the X -server this may either be Caps Lock or Shift Lock).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.CONTROL_MASK</literal></term> - <listitem> - <simpara>The Control key. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.MOD1_MASK</literal></term> - <listitem> - <simpara>The fourth modifier key (it depends on the modifier -mapping of the X server which key is interpreted as this modifier, but -normally it is the Alt key).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.MOD2_MASK</literal></term> - <listitem> - <simpara>The fifth modifier key (it depends on the modifier -mapping of the X server which key is interpreted as this -modifier).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.MOD3_MASK</literal></term> - <listitem> - <simpara>The sixth modifier key (it depends on the modifier -mapping of the X server which key is interpreted as this -modifier).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.MOD4_MASK</literal></term> - <listitem> - <simpara>The seventh modifier key (it depends on the modifier -mapping of the X server which key is interpreted as this -modifier).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.MOD5_MASK</literal></term> - <listitem> - <simpara>The eighth modifier key (it depends on the modifier -mapping of the X server which key is interpreted as this -modifier).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BUTTON1_MASK</literal></term> - <listitem> - <simpara>The first mouse button.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BUTTON2_MASK</literal></term> - <listitem> - <simpara>The second mouse button.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BUTTON3_MASK</literal></term> - <listitem> - <simpara>The third mouse button.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BUTTON4_MASK</literal></term> - <listitem> - <simpara>The fourth mouse button.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BUTTON5_MASK</literal></term> - <listitem> - <simpara>The fifth mouse button.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.RELEASE_MASK</literal></term> - <listitem> - <simpara>Differentiates between (keyval, modifiers) pairs from -key press and release events.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.MODIFIER_MASK</literal></term> - <listitem> - <simpara>all of the above</simpara> - </listitem> - </varlistentry> - </variablelist> + sets the treeview to start a drag operation when the user click and + drags on a row. The value of <parameter>start_button_mask</parameter> + is a combination of the<xref linkend="gdk-modifier-constants" + endterm="gdk-modifier-constants-title"></xref>.</para> <para><parameter>targets</parameter> is a sequence (list or tuple) of -tuples that contain information about the targets. The target data contains -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.</para> - - <para>The value of <parameter>actions</parameter> is one of:</para> - - <variablelist> - <varlistentry> - <term><literal>gtk.gdk.ACTION_DEFAULT</literal></term> - <term><literal>gtk.gdk.ACTION_COPY</literal></term> - <listitem> - <simpara>Copy the data.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.ACTION_MOVE</literal></term> - <listitem> - <simpara>Move the data, i.e. first copy it, then delete it from -the source using the <literal>DELETE</literal> target of the X selection -protocol.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.ACTION_LINK</literal></term> - <listitem> - <simpara>Add a link to the data. Note that this is only useful -if source and destination agree on what it means.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.ACTION_PRIVATE</literal></term> - <listitem> - <simpara>Special action which tells the source that the -destination will do something that the source doesn't understand.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.ACTION_ASK</literal></term> - <listitem> - <simpara>Ask the user what to do with the data.</simpara> - </listitem> - </varlistentry> - </variablelist> + tuples that contain information about the targets. The target data + contains a string representing the drag type, target flags (a + combination of the <xref linkend="gtk-target-flags-constants" + endterm="gtk-target-flags-constants-title"></xref>) and an application + assigned integer ID used for identification purposes.</para> - <para></para> + <para>The value of <parameter>actions</parameter> is one of the <xref + linkend="gdk-drag-action-constants" + endterm="gdk-drag-action-constants-title"></xref>.</para> </refsect2> @@ -2612,56 +2582,19 @@ drag</simpara></listitem> </variablelist> <para>The <methodname>enable_model_drag_dest</methodname>() method -sets the treeview to receive a drag drop.</para> + sets the treeview to receive a drag drop.</para> <para><parameter>targets</parameter> is a sequence (list or tuple) of -tuples that contain information about the targets. The target data contains -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.</para> - - <para>The value of <parameter>actions</parameter> is one of:</para> - - <variablelist> - <varlistentry> - <term><literal>gtk.gdk.ACTION_DEFAULT</literal></term> - <term><literal>gtk.gdk.ACTION_COPY</literal></term> - <listitem> - <simpara>Copy the data.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.ACTION_MOVE</literal></term> - <listitem> - <simpara>Move the data, i.e. first copy it, then delete it from -the source using the <literal>DELETE</literal> target of the X selection -protocol.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.ACTION_LINK</literal></term> - <listitem> - <simpara>Add a link to the data. Note that this is only useful -if source and destination agree on what it means.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.ACTION_PRIVATE</literal></term> - <listitem> - <simpara>Special action which tells the source that the -destination will do something that the source doesn't understand.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.ACTION_ASK</literal></term> - <listitem> - <simpara>Ask the user what to do with the data.</simpara> - </listitem> - </varlistentry> - </variablelist> + tuples that contain information about the targets. The target data + contains 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.</para> - <para></para> + <para>The value of <parameter>actions</parameter> is one of the <xref + linkend="gdk-drag-action-constants" + endterm="gdk-drag-action-constants-title"></xref>.</para> </refsect2> @@ -3278,6 +3211,282 @@ treeview. If no valid paths are available this method returns </refsect2> + <refsect2 id="method-gtktreeview--get-headers-clickable"> + <title>gtk.TreeView.get_headers_clickable</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_headers_clickable</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara><literal>TRUE</literal> if all header columns + are clickable</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>Returns <literal>TRUE</literal> if all header columns are + clickable.</para> + + </refsect2> + + <refsect2 id="method-gtktreeview--get-search-entry"> + <title>gtk.TreeView.get_search_entry</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_search_entry</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the entry currently in use as the search + entry.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>Returns the <link + linkend="class-gtkentry"><classname>gtk.Entry</classname></link> which + is currently in use as the interactive search entry for the treeview. + In case the built-in entry is being used, <literal>None</literal> will + be returned.</para> + + </refsect2> + + <refsect2 id="method-gtktreeview--set-search-entry"> + <title>gtk.TreeView.set_search_entry</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_search_entry</methodname> + <methodparam><parameter role="keyword">entry</parameter><initializer>None</initializer></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter role="keyword">entry</parameter> :</term> + <listitem><simpara>the entry the interactive search code of the + treeview should use or + <literal>None</literal></simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>Sets the entry which the interactive search code will use for + this treeview. This is useful when you want to provide a search entry + in our interface at all time at a fixed position. Passing + <literal>None</literal> for <parameter>entry</parameter> will make the + interactive search code use the built-in popup entry again.</para> + + </refsect2> + + <refsect2 id="method-gtktreeview--set-search-position-func"> + <title>gtk.TreeView.set_search_position_func</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_search_position_func</methodname> + <methodparam><parameter role="keyword">func</parameter></methodparam> + <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter role="keyword">func</parameter> :</term> + <listitem><simpara>the function to use to position the search + dialog, or <literal>None</literal> to use the default search + position function</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">data</parameter> :</term> + <listitem><simpara>user data to pass to + <parameter>func</parameter>, or + <literal>None</literal></simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>Sets the function to use when positioning the search dialog. The + signature of <parameter>func</parameter> is:</para> + + <programlisting> + def func(treeview, search_dialog, user_data): + </programlisting> + + <para>where <parameter>search_dialog</parameter> is the dialog to be + positioned and <parameter>user_data</parameter> is + <parameter>data</parameter>.</para> + + </refsect2> + + <refsect2 id="method-gtktreeview--set-rubber-banding"> + <title>gtk.TreeView.set_rubber_banding</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_rubber_banding</methodname> + <methodparam><parameter role="keyword">enable</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter role="keyword">enable</parameter> :</term> + <listitem><simpara>if <literal>TRUE</literal> enable rubber + banding</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>Enables or disables rubber banding. If the selection mode is + <literal>gtk.SELECTION_MULTIPLE</literal>, rubber banding will allow + the user to select multiple rows by dragging the mouse.</para> + + </refsect2> + + <refsect2 id="method-gtktreeview--get-rubber-banding"> + <title>gtk.TreeView.get_rubber_banding</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_rubber_banding</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara><literal>TRUE</literal> if rubber banding is + enabled.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>Returns whether rubber banding is enabled. If the selection + mode is <literal>gtk.SELECTION_MULTIPLE</literal>, rubber banding will + allow the user to select multiple rows by dragging the mouse.</para> + + </refsect2> + + <refsect2 id="method-gtktreeview--get-grid-lines"> + <title>gtk.TreeView.get_grid_lines</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_grid_lines</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>one of the <xref + linkend="gtk-treeview-grid-lines-constants" + endterm="gtk-treeview-grid-lines-constants-title"></xref> + indicating which grid lines are enabled.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>Returns which grid lines are enabled.</para> + + </refsect2> + + <refsect2 id="method-gtktreeview--set-grid-lines"> + <title>gtk.TreeView.set_grid_lines</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_grid_lines</methodname> + <methodparam><parameter role="keyword">grid_lines</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter role="keyword">grid_lines</parameter> :</term> + <listitem><simpara>one of the <xref + linkend="gtk-treeview-grid-lines-constants" + endterm="gtk-treeview-grid-lines-constants-title"></xref> + indicating which grid lines to enable.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>Sets which grid lines to draw.</para> + + </refsect2> + + <refsect2 id="method-gtktreeview--get-enable-tree-lines"> + <title>gtk.TreeView.get_enable_tree_lines</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_enable_tree_lines</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara><literal>TRUE</literal> if tree lines are + drawn.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>Returns <literal>TRUE</literal> if tree lines are drawn.</para> + + </refsect2> + + <refsect2 id="method-gtktreeview--set-enable-tree-lines"> + <title>gtk.TreeView.set_enable_tree_lines</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_enable_tree_lines</methodname> + <methodparam><parameter role="keyword">enabled</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter role="keyword">enabled</parameter> :</term> + <listitem><simpara>if <literal>TRUE</literal> enable tree line + drawing.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>Sets whether to draw lines interconnecting the expanders. This + does not have any visible effects for lists.</para> + + </refsect2> + </refsect1> <refsect1> diff --git a/docs/reference/pygtk-gtktreeviewcolumn.xml b/docs/reference/pygtk-gtktreeviewcolumn.xml index f9c07a3c..57f20438 100644 --- a/docs/reference/pygtk-gtktreeviewcolumn.xml +++ b/docs/reference/pygtk-gtktreeviewcolumn.xml @@ -312,8 +312,10 @@ linkend="method-gtktreeviewcolumn--queue-resize">queue_resize</link></methodname </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtktreeviewcolumn"> + <title>gtk.TreeViewColumn Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -400,6 +402,12 @@ indicator</entry> <literal>gtk.SORT_DESCENDING</literal></entry> </row> + <row valign="top"> + <entry>"spacing"</entry> + <entry>Read-Write</entry> + <entry>Space which is inserted between cells</entry> + </row> + <row valign="top"> <entry>"title"</entry> <entry>Read-Write</entry> @@ -432,8 +440,11 @@ of the column title</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtktreeviewcolumn"> + <title>gtk.TreeViewColumn 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> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkuimanager.xml b/docs/reference/pygtk-gtkuimanager.xml index 2f07b859..cb779fd6 100644 --- a/docs/reference/pygtk-gtkuimanager.xml +++ b/docs/reference/pygtk-gtkuimanager.xml @@ -102,8 +102,8 @@ </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkuimanager"> + <title>gtk.UIManager Properties</title> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -136,8 +136,10 @@ above.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkuimanager"> + <title>gtk.UIManager Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> <variablelist> <varlistentry> diff --git a/docs/reference/pygtk-gtkvbox.xml b/docs/reference/pygtk-gtkvbox.xml index a7ef8458..ef33bcb5 100644 --- a/docs/reference/pygtk-gtkvbox.xml +++ b/docs/reference/pygtk-gtkvbox.xml @@ -40,6 +40,39 @@ linkend="constructor-gtkvbox">gtk.VBox</link></methodname> </refsect1> + <refsect1 id="properties-gtkvbox"> + <title>gtk.VBox 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> + <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkvbox"> + <title>gtk.VBox Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="child-properties-gtkvbox"> + <title>gtk.VBox Child Properties</title> + + <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkvbox"> + <title>gtk.VBox 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> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkvbuttonbox.xml b/docs/reference/pygtk-gtkvbuttonbox.xml index 27e0c514..73f77969 100644 --- a/docs/reference/pygtk-gtkvbuttonbox.xml +++ b/docs/reference/pygtk-gtkvbuttonbox.xml @@ -37,6 +37,42 @@ linkend="constructor-gtkvbuttonbox">gtk.VButtonBox</link></methodname> </refsect1> + <refsect1 id="properties-gtkvbuttonbox"> + <title>gtk.VButtonBox 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> + <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para> + <para><link linkend="properties-gtkbuttonbox">gtk.ButtonBox Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkvbuttonbox"> + <title>gtk.VButtonBox Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkbuttonbox">gtk.ButtonBox Style Properties</link></para> + + </refsect1> + + <refsect1 id="child-properties-gtkvbuttonbox"> + <title>gtk.VButtonBox Child Properties</title> + + <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para> + <para><link linkend="child-properties-gtkbuttonbox">gtk.ButtonBox Child Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkvbuttonbox"> + <title>gtk.VButtonBox 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> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkviewport.xml b/docs/reference/pygtk-gtkviewport.xml index 947f5c40..e6d79f96 100644 --- a/docs/reference/pygtk-gtkviewport.xml +++ b/docs/reference/pygtk-gtkviewport.xml @@ -71,8 +71,12 @@ linkend="method-gtkviewport--get-shadow-type">get_shadow_type</link></methodname </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkviewport"> + <title>gtk.Viewport 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"> @@ -92,15 +96,6 @@ viewport.</entry> </row> <row valign="top"> - <entry>"vadjustment"</entry> - <entry>Read-Write</entry> - <entry>The <link -linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link> -that determines the values of the vertical position for this -viewport.</entry> - </row> - - <row valign="top"> <entry>"shadow-type"</entry> <entry>Read-Write</entry> <entry>The type of shadowed box around the viewport: @@ -109,6 +104,15 @@ viewport.</entry> or <literal>gtk.SHADOW_ETCHED_OUT</literal></entry> </row> + <row valign="top"> + <entry>"vadjustment"</entry> + <entry>Read-Write</entry> + <entry>The <link +linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link> +that determines the values of the vertical position for this +viewport.</entry> + </row> + </tbody> </tgroup> </informaltable> @@ -116,8 +120,20 @@ or <literal>gtk.SHADOW_ETCHED_OUT</literal></entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="style-properties-gtkviewport"> + <title>gtk.Viewport Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkviewport"> + <title>gtk.Viewport 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> diff --git a/docs/reference/pygtk-gtkvpaned.xml b/docs/reference/pygtk-gtkvpaned.xml index c34aabb7..9fde4ae5 100644 --- a/docs/reference/pygtk-gtkvpaned.xml +++ b/docs/reference/pygtk-gtkvpaned.xml @@ -36,6 +36,41 @@ linkend="constructor-gtkvpaned">gtk.VPaned</link></methodname> </refsect1> + <refsect1 id="properties-gtkvpaned"> + <title>gtk.VPaned 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> + <para><link linkend="properties-gtkpaned">gtk.Paned Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkvpaned"> + <title>gtk.VPaned Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkpaned">gtk.Paned Style Properties</link></para> + + </refsect1> + + <refsect1 id="child-properties-gtkvpaned"> + <title>gtk.VPaned Child Properties</title> + + <para><link linkend="child-properties-gtkpaned">gtk.Paned Child Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkvpaned"> + <title>gtk.VPaned 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> + <para><link linkend="signal-prototypes-gtkpaned">gtk.Paned Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkvruler.xml b/docs/reference/pygtk-gtkvruler.xml index dfa7b34d..d842aa67 100644 --- a/docs/reference/pygtk-gtkvruler.xml +++ b/docs/reference/pygtk-gtkvruler.xml @@ -35,6 +35,30 @@ linkend="constructor-gtkvruler">gtk.VRuler</link></methodname> </refsect1> + <refsect1 id="properties-gtkvruler"> + <title>gtk.VRuler 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-gtkruler">gtk.Ruler Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkvruler"> + <title>gtk.VRuler Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkvruler"> + <title>gtk.VRuler 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> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkvscale.xml b/docs/reference/pygtk-gtkvscale.xml index e7069297..2ace18e9 100644 --- a/docs/reference/pygtk-gtkvscale.xml +++ b/docs/reference/pygtk-gtkvscale.xml @@ -39,6 +39,35 @@ linkend="constructor-gtkvscale">gtk.VScale</link></methodname> </refsect1> + <refsect1 id="properties-gtkvscale"> + <title>gtk.VScale 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-gtkrange">gtk.Range Properties</link></para> + <para><link linkend="properties-gtkscale">gtk.Scale Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkvscale"> + <title>gtk.VScale Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkrange">gtk.Range Style Properties</link></para> + <para><link linkend="style-properties-gtkscale">gtk.Scale Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkvscale"> + <title>gtk.VScale 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-gtkrange">gtk.Range Signal Prototypes</link></para> + <para><link linkend="signal-prototypes-gtkscale">gtk.Scale Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkvscrollbar.xml b/docs/reference/pygtk-gtkvscrollbar.xml index b3576283..e58b2e4c 100644 --- a/docs/reference/pygtk-gtkvscrollbar.xml +++ b/docs/reference/pygtk-gtkvscrollbar.xml @@ -38,6 +38,33 @@ linkend="constructor-gtkvscrollbar">gtk.VScrollbar</link></methodname> </refsect1> + <refsect1 id="properties-gtkvscrollbar"> + <title>gtk.VScrollbar 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-gtkrange">gtk.Range Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkvscrollbar"> + <title>gtk.VScrollbar Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + <para><link linkend="style-properties-gtkrange">gtk.Range Style Properties</link></para> + <para><link linkend="style-properties-gtkscrollbar">gtk.Scrollbar Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkvscrollbar"> + <title>gtk.VScrollbar 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-gtkrange">gtk.Range Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkvseparator.xml b/docs/reference/pygtk-gtkvseparator.xml index 2f80b0c7..717dbe73 100644 --- a/docs/reference/pygtk-gtkvseparator.xml +++ b/docs/reference/pygtk-gtkvseparator.xml @@ -35,6 +35,29 @@ linkend="class-gtkseparator">gtk.Separator</link></classname></ooclass> </refsect1> + <refsect1 id="properties-gtkvseparator"> + <title>gtk.VSeparator Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> + <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para> + + </refsect1> + + <refsect1 id="style-properties-gtkvseparator"> + <title>gtk.VSeparator Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + + <refsect1 id="signal-prototypes-gtkvseparator"> + <title>gtk.VSeparator 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> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk-gtkwidget.xml b/docs/reference/pygtk-gtkwidget.xml index b6e6b783..4868007b 100644 --- a/docs/reference/pygtk-gtkwidget.xml +++ b/docs/reference/pygtk-gtkwidget.xml @@ -921,8 +921,12 @@ linkend="method-gtkwidget--set-activate-signal">set_scroll_adjustments_signal</l <methodname><link linkend="function-gtk--widget-get-default-direction">gtk.widget_get_default_direction</link></methodname> <methodparam></methodparam> </methodsynopsis><methodsynopsis language="python"> + <methodname><link linkend="function-gtk--widget-class-find-style-property">gtk.widget_class_find_style_property</link></methodname> + <methodparam><parameter role="keyword">widget</parameter></methodparam> + <methodparam><parameter role="keyword">property_name</parameter></methodparam> + </methodsynopsis><methodsynopsis language="python"> <methodname><link linkend="function-gtk--widget-class-list-style-properties">gtk.widget_class_list_style_properties</link></methodname> - <methodparam><parameter role="keyword">cmap</parameter></methodparam> + <methodparam><parameter role="keyword">widget</parameter></methodparam> </methodsynopsis><methodsynopsis language="python"> <methodname><link linkend="function-gtk--widget-class-install-style-property">gtk.widget_class_install_style_property</link></methodname> <methodparam><parameter role="keyword">widget</parameter></methodparam> @@ -941,8 +945,10 @@ linkend="method-gtkwidget--set-activate-signal">set_scroll_adjustments_signal</l </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkwidget"> + <title>gtk.Widget Properties</title> + + <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -1088,8 +1094,8 @@ request should be used.</entry> </refsect1> - <refsect1> - <title>Style Properties</title> + <refsect1 id="style-properties-gtkwidget"> + <title>gtk.Widget Style Properties</title> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> @@ -1114,6 +1120,14 @@ linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> with which to draw insertion cursor</entry> </row> + <row valign="top"> + <entry>"draw-border"</entry> + <entry>Read</entry> + <entry>The "draw-border" property defines the size of areas + outside the widget's allocation to draw. This property is + available in GTK+ 2.8 and above.</entry> + </row> + <row valign="top"> <entry>"focus-line-pattern"</entry> <entry>Read-Write</entry> @@ -1142,6 +1156,30 @@ the widget 'box'.</entry> inside widgets.</entry> </row> + <row valign="top"> + <entry>"link-color"</entry> + <entry>Read</entry> + <entry>The "link-color" property defines the color of + unvisited links. This property is available in GTK+ 2.10 and + above.</entry> + </row> + + <row valign="top"> + <entry>"scroll-arrow-hlength"</entry> + <entry>Read</entry> + <entry>The "scroll-arrow-hlength" property defines the length + of horizontal scroll arrows. This property is available in + GTK+ 2.10 and above.</entry> + </row> + + <row valign="top"> + <entry>"scroll-arrow-vlength"</entry> + <entry>Read</entry> + <entry>The "scroll-arrow-vlength" property defines the length + of vertical scroll arrows. This property is available in GTK+ + 2.10 and above.</entry> + </row> + <row valign="top"> <entry>"secondary-cursor-color"</entry> <entry>Read</entry> @@ -1151,6 +1189,41 @@ which to draw the secondary insertion cursor when editing mixed right-to-left and left-to-right text.</entry> </row> + <row valign="top"> + <entry>"separator-height"</entry> + <entry>Read</entry> + <entry>The "separator-height" property defines the height of + separators. This property only takes effect if + "wide-separators" is <literal>TRUE</literal>. This property + is available in GTK+ 2.10 and above.</entry> + </row> + + <row valign="top"> + <entry>"separator-width"</entry> + <entry>Read</entry> + <entry>The "separator-width" property defines the width of + separators. This property only takes effect if + "wide-separators" is <literal>TRUE</literal>. This property + is available in GTK+ 2.10 and above.</entry> + </row> + + <row valign="top"> + <entry>"visited-link-color"</entry> + <entry>Read</entry> + <entry>The "visited-link-color" property defines the color of + visited links. This property is available in GTK+ 2.10 and + above.</entry> + </row> + + <row valign="top"> + <entry>"wide-separators"</entry> + <entry>Read</entry> + <entry>The "wide-separators" property defines whether + separators have configurable width and should be drawn using a + box instead of a line. This property is available in GTK+ + 2.10 and above.</entry> + </row> + </tbody> </tgroup> </informaltable> @@ -1228,8 +1301,11 @@ by the widget. This attribute is writeable in PyGTK 2.4.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkwidget"> + <title>gtk.Widget 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> <variablelist> <varlistentry> @@ -1287,6 +1363,16 @@ by the widget. This attribute is writeable in PyGTK 2.4.</entry> </listitem> </varlistentry> <varlistentry> + <term>"<link linkend="signal-gtkwidget--composited-changed">composited-changed</link></term> + <listitem> + <methodsynopsis language="python"><methodname>callback</methodname> + <methodparam><parameter>widget</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis> + </listitem> + </varlistentry> + <varlistentry> <term>"<link linkend="signal-gtkwidget--client-event">client-event</link>"</term> <listitem> <methodsynopsis language="python"><methodname>callback</methodname> @@ -1522,6 +1608,17 @@ by the widget. This attribute is writeable in PyGTK 2.4.</entry> </listitem> </varlistentry> <varlistentry> + <term>"<link linkend="signal-gtkwidget--grab-broken-event">grab-broken-event</link></term> + <listitem> + <methodsynopsis language="python"><methodname>callback</methodname> + <methodparam><parameter>widget</parameter></methodparam> + <methodparam><parameter>event</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis> + </listitem> + </varlistentry> + <varlistentry> <term>"<link linkend="signal-gtkwidget--grab-focus">grab-focus</link>"</term> <listitem> <methodsynopsis language="python"><methodname>callback</methodname> @@ -1963,10 +2060,15 @@ the theme, giving theme authors more control over the look of applications without the need to write a theme engine in C.</para> <para>Use the <link -linkend="function-gtk--widget-class-list-style-properties"><function>gtk.widget_class_list_style_properties</function>()</link> -function to get information about existing style properties and the <link -linkend="method-gtkwidget--style-get-property"><methodname>style_get_property</methodname>()</link> -method to obtain the value of a style property.</para> + linkend="function-gtk--widget-class-install-style-property"><function>gtk.widget_class_install_style_property</function>()</link> + function to install style properties for a widget class, the <link + linkend="function-gtk--widget-class-find-style-property"><function>gtk.widget_class_find_style_property</function>()</link> + function or the <link + linkend="function-gtk--widget-class-list-style-properties"><function>gtk.widget_class_list_style_properties</function>()</link> + function to get information about existing style properties and the + <link + linkend="method-gtkwidget--style-get-property"><methodname>style_get_property</methodname>()</link> + method to obtain the value of a style property.</para> </refsect1> @@ -6529,6 +6631,42 @@ function.</para> </refsect2> + <refsect2 id="function-gtk--widget-class-find-style-property"> + <title>gtk.widget_class_find_style_property</title> + + <programlisting><methodsynopsis language="python"> + <methodname>gtk.widget_class_find_style_property</methodname> + <methodparam><parameter + role="keyword">widget</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">widget</parameter> :</term> + <listitem><simpara>a <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">property_name</parameter> :</term> + <listitem><simpara>a style property name</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the style property as a GParam + object</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This function is available in PyGTK 2.4 and above.</para> + </note> + + <para>The <function>gtk.widget_class_find_style_property</function>() + function returns the GParam object corresponding to the style + property specified by <parameter>property_name</parameter> of the <link + linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> + specified by <parameter>widget</parameter>.</para> + + </refsect2> + <refsect2 id="function-gtk--widget-class-list-style-properties"> <title>gtk.widget_class_list_style_properties</title> @@ -6886,6 +7024,36 @@ has sent an event to <parameter>widget</parameter>.</para> </refsect2> + <refsect2 id="signal-gtkwidget--composited-changed"> + <title>The "composited-changed" gtk.Widget Signal</title> + + <programlisting><methodsynopsis language="python"><methodname>callback</methodname> + <methodparam><parameter>widget</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter>widget</parameter> :</term> + <listitem><simpara>the object which 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> + + + </refsect2> + <refsect2 id="signal-gtkwidget--configure-event"> <title>The "configure-event" gtk.Widget Signal</title> @@ -7878,6 +8046,59 @@ any)</simpara></listitem> </refsect2> + <refsect2 id="signal-gtkwidget--grab-broken-event"> + <title>The "grab-broken-event" gtk.Widget Signal</title> + + <programlisting><methodsynopsis language="python"><methodname>callback</methodname> + <methodparam><parameter>widget</parameter></methodparam> + <methodparam><parameter>event</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter>widget</parameter> :</term> + <listitem><simpara>the object which received the + signal.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter>event</parameter> :</term> + <listitem><simpara>the gtk.gdk.EventGrabBroken + event</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> to stop other handlers + from being invoked for the event. <literal>FALSE</literal> to + propagate the event further.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This signal is available in GTK+ 2.8 and above.</para> + </note> + + <para>Emitted when a pointer or keyboard grab on a window belonging to + <parameter>widget</parameter> gets broken. </para> + + <para>On X11, this happens when the grab window becomes unviewable + (i.e. it or one of its ancestors is unmapped), or if the same + application grabs the pointer or keyboard again.</para> + + </refsect2> + <refsect2 id="signal-gtkwidget--grab-focus"> <title>The "grab-focus" gtk.Widget Signal</title> diff --git a/docs/reference/pygtk-gtkwindow.xml b/docs/reference/pygtk-gtkwindow.xml index 02010ec9..385f4243 100644 --- a/docs/reference/pygtk-gtkwindow.xml +++ b/docs/reference/pygtk-gtkwindow.xml @@ -460,6 +460,18 @@ linkend="method-gtkwindow--present-with-time">present_with_time</link></methodna <methodparam><parameter role="keyword">timestamp</parameter></methodparam> </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkwindow--set-deletable">set_deletable</link></methodname> + <methodparam><parameter role="keyword">setting</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkwindow--get-deletable">get_deletable</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkwindow--get-group">get_group</link></methodname> + <methodparam></methodparam> + </methodsynopsis> </classsynopsis> <programlisting> @@ -506,8 +518,12 @@ linkend="function-gtk--window-set-default-icon-name">gtk.window_set_default_icon </refsect1> - <refsect1> - <title>Properties</title> + <refsect1 id="properties-gtkwindow"> + <title>gtk.Window 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"> @@ -562,6 +578,14 @@ showing the window. Allowed values: >= -1. Default value: -1</entry> showing the window. Allowed values: >= -1. Default value: -1</entry> </row> + <row valign="top"> + <entry>"deletable"</entry> + <entry>Read-Write</entry> + <entry>If <literal>TRUE</literal> the window frame should have + a close button. This property is available in GTK+ 2.10 and + above.</entry> + </row> + <row valign="top"> <entry>"destroy-with-parent"</entry> <entry>Read-Write</entry> @@ -675,6 +699,15 @@ in the task bar. Default value: <literal>FALSE</literal>. Available in GTK+ <entry>The title of the window. Default value: <literal>None</literal>.</entry> </row> + <row valign="top"> + <entry>"transient-for"</entry> + <entry>Read-Write-Construct</entry> + <entry>The transient parent of the window. See <link + linkend="method-gtkwindow--set-transient-for"><methodname>gtk.Window.set_transient_for()</methodname></link> + for more details about transient windows. This property is + available in GTK+ 2.10 and above.</entry> + </row> + <row valign="top"> <entry>"type"</entry> <entry>Read-Write</entry> @@ -713,6 +746,13 @@ and above.</entry> </refsect1> + <refsect1 id="style-properties-gtkwindow"> + <title>gtk.Window Style Properties</title> + + <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> + + </refsect1> + <refsect1> <title>Attributes</title> @@ -1009,8 +1049,13 @@ method.</entry> </refsect1> - <refsect1> - <title>Signal Prototypes</title> + <refsect1 id="signal-prototypes-gtkwindow"> + <title>gtk.Window 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> @@ -3625,6 +3670,95 @@ method.</para> </refsect2> + <refsect2 id="method-gtkwindow--set-deletable"> + <title>gtk.Window.set_deletable</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_deletable</methodname> + <methodparam><parameter role="keyword">setting</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter role="keyword">setting</parameter> :</term> + <listitem><simpara>if <literal>TRUE</literal> decorate the window + as deletable</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>By default, windows have a close button in the window + frame. Some window managers allow GTK+ to disable this button. If you + set the deletable property to <literal>FALSE</literal> using this + method, GTK+ will do its best to convince the window manager not to + show a close button. Depending on the system, this method may not have + any effect when called on a window that is already visible, so you + should call it before calling + <methodname>gtk_window_show</methodname>().</para> + + <para>On Windows, this method always works, since there's no window + manager policy involved.</para> + + </refsect2> + + <refsect2 id="method-gtkwindow--get-deletable"> + <title>gtk.Window.get_deletable</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_deletable</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara><literal>TRUE</literal> if the window has been + set to have a close button</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>Returns whether the window has been set to have a close button + via the <link + linkend="method-gtkwindow--set-deletable"><methodname>gtk.Window.set_deletable()</methodname></link> + method.</para> + + </refsect2> + + <refsect2 id="method-gtkwindow--get-group"> + <title>gtk.Window.get_group</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_group</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the <link + linkend="class-gtkwindowgroup"><classname>gtk.WindowGroup</classname></link> + for a window or the default group</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.10 and above.</para> + </note> + + <para>Returns the <link + linkend="class-gtkwindowgroup"><classname>gtk.WindowGroup</classname></link> + or the default group, if the window does not have an explicit window + group.</para> + + </refsect2> + </refsect1> <refsect1> diff --git a/docs/reference/pygtk-gtkwindowgroup.xml b/docs/reference/pygtk-gtkwindowgroup.xml index 516649e3..e9306c14 100644 --- a/docs/reference/pygtk-gtkwindowgroup.xml +++ b/docs/reference/pygtk-gtkwindowgroup.xml @@ -46,6 +46,12 @@ linkend="method-gtkwindowgroup--remove-window">remove_window</link></methodname> </refsect1> + <refsect1 id="signal-prototypes-gtkwindowgroup"> + <title>gtk.WindowGroup Signal Prototypes</title> + + <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> + </refsect1> + <refsect1> <title>Description</title> diff --git a/docs/reference/pygtk2-ref.xml b/docs/reference/pygtk2-ref.xml index c1627aba..d399397e 100644 --- a/docs/reference/pygtk2-ref.xml +++ b/docs/reference/pygtk2-ref.xml @@ -4,10 +4,10 @@ ]> <book id="pygtk-reference" xmlns:xi="http://www.w3.org/2001/XInclude"> <bookinfo> - <pubdate>October 7, 2005</pubdate> + <pubdate>June 22, 2006</pubdate> <title>PyGTK 2.0 Reference Manual</title> - <edition>PyGTK Reference Manual version 2.8.2 for PyGTK 2.8.x</edition> - <releaseinfo>Version 2.8.2</releaseinfo> + <edition>PyGTK Reference Manual version 2.9.0 for PyGTK 2.9.x</edition> + <releaseinfo>Version 2.9.0</releaseinfo> <authorgroup> <author> <firstname>John</firstname> @@ -20,6 +20,16 @@ module.</para> </abstract> <!-- <revhistory> <revision> + <revnumber>2.9.0</revnumber> + <date>June 22, 2006</date> + <revremark>Release covering PyGTK 2.9.x (GTK+ 2.89)</revremark> + </revision> + <revision> + <revnumber>2.8.2</revnumber> + <date>October 7, 2005</date> + <revremark>Release covering PyGTK 2.8.x (GTK+ 2.8)</revremark> + </revision> + <revision> <revnumber>2.8.1</revnumber> <date>September 17, 2005</date> <revremark>Release covering PyGTK 2.8.x (GTK+ 2.8)</revremark> |