ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update docs for Gtk.

Browse source 
svn path=/trunk/gtk-sharp/; revision=12567
This commit is contained in:
Duncan Mak 2003-03-15 22:50:24 +00:00
parent 519ca82a97
commit 6a0ba3d687
15 changed files with 869 additions and 472 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
doc/en/Gtk/Alignment.xml
View file

@ -8,10 +8,12 @@
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>A container that controls the alignment and size of its child.</summary>
<remarks><para>An Alignment widget controls the alignment and size of its child widget. It has four settings: <see cref="P:Gtk.Alignment.Xscale"/>, <see cref="P:Gtk.Alignment.Yscale"/>, <see cref="P:Gtk.Alignment.Xalign"/>, and <see cref="P:Gtk.Alignment.Yalign"/>.</para>
<remarks>
<para>An Alignment widget controls the alignment and size of its child widget. It has four settings: <see cref="P:Gtk.Alignment.Xscale" />, <see cref="P:Gtk.Alignment.Yscale" />, <see cref="P:Gtk.Alignment.Xalign" />, and <see cref="P:Gtk.Alignment.Yalign" />.</para>
<para>The scale settings are used to specify how much the child widget should expand to fill the space allocated to the Alignment. The values can range from 0 (meaning the child doesn't expand at all) to 1 (meaning the child expands to fill all of the available space).</para>
<para>The alignment settings are used to position the child widget within the available area. The values range from 0 (top or left) to 1 (bottom or right). If the scale settings are both set to 1, (making the child expand), the alignment settings have no effect.</para>
<para>To add a child to an Alignment, use the <see cref="M:Gtk.Container.Add"/> method from the <see cref="T:Gtk.Container"/> class.</para></remarks>
<para>To add a child to an Alignment, use the <see cref="M:Gtk.Container.Add" /> method from the <see cref="T:Gtk.Container" /> class.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Bin</BaseTypeName>
@ -50,7 +52,9 @@
<param name="yalign">The vertical alignment of the child widget, from 0 (top) to 1 (bottom).</param>
<param name="xscale">The amount that the child widget expands horizontally to fill up unused space, from 0 to 1.</param>
<param name="yscale">The amount that the child widget expands vertically to fill up unused space, from 0 to 1.</param>
<remarks><para>For the scale parameters, a value of 0 indicates that the child widget should never expand. A value of 1 indicates that the child widget will expand to fill all of the space allocated for the Alignment.</para></remarks>
<remarks>
<para>For the scale parameters, a value of 0 indicates that the child widget should never expand. A value of 1 indicates that the child widget will expand to fill all of the space allocated for the Alignment.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -98,7 +102,7 @@
<param name="xscale">The amount that the child widget expands horizontally to fill up unused space, from 0 to 1.</param>
<param name="yscale">The amount that the child widget expands vertically to fill up unused space, from 0 to 1.</param>
<returns>A new Alignment.</returns>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
@ -108,8 +112,8 @@
<Parameters />
<Docs>
<summary>Internal constructor</summary>
<returns></returns>
<remarks></remarks>
<returns />
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -137,7 +141,9 @@
<summary>Manage the vertical alignment of the child widget.</summary>
<param name="value">A new vertical alignment for the child widget.</param>
<returns>The child widget's current vertical alignment.</returns>
<remarks><para>This property is a value between 0 and 1 where 0 indicates alignment at the top of the container, and 1 indicates alignment at the bottom of the container.</para></remarks>
<remarks>
<para>This property is a value between 0 and 1 where 0 indicates alignment at the top of the container, and 1 indicates alignment at the bottom of the container.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Xalign">
@ -153,7 +159,9 @@
<summary>Manage the horizontal alignment of the child widget.</summary>
<param name="value">A new horizontal alignment for the child widget.</param>
<returns>The child widget's current horizontal alignment.</returns>
<remarks><para>This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated horizontal size.</para></remarks>
<remarks>
<para>This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated horizontal size.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Xscale">
@ -169,7 +177,9 @@
<summary>Manage the horizontal expansion of the child widget.</summary>
<param name="value">The proportion that the child widget should expand horizontally.</param>
<returns>The current horizontal expansion of the child widget.</returns>
<remarks><para>This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated horizontal size.</para></remarks>
<remarks>
<para>This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated horizontal size.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Yscale">
@ -185,7 +195,9 @@
<summary>Manage the vertical expansion of the child widget.</summary>
<param name="value">The proportion that the child widget should expand vertically.</param>
<returns>The current vertical expansion of the child widget.</returns>
<remarks><para>This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated vertical size.</para></remarks>
<remarks>
<para>This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated vertical size.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">

12
doc/en/Gtk/Bin.xml
View file

@ -8,9 +8,11 @@
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>A container with just one child.</summary>
<remarks><para>A Bin widget is a <see cref="T:Gtk.Container"/> with just one child. It is used to create subclasses, since it provides common code needed for handling a single child <see cref="T:Gtk.Widget"/>.</para>
<para>Many GTK+ widgets are subclasses of Bin, including <see cref="T:Gtk.Window"/>, <see cref="T:Gtk.Button"/>, <see cref="T:Gtk.Frame"/>, <see cref="T:Gtk.HandleBox"/>, and <see cref="T:Gtk.ScrolledWindow"/>.</para>
<para>To place a child widget inside this container, use the standard <see cref="M:Gtk.Container.Add"/> method.</para></remarks>
<remarks>
<para>A Bin widget is a <see cref="T:Gtk.Container" /> with just one child. It is used to create subclasses, since it provides common code needed for handling a single child <see cref="T:Gtk.Widget" />.</para>
<para>Many GTK+ widgets are subclasses of Bin, including <see cref="T:Gtk.Window" />, <see cref="T:Gtk.Button" />, <see cref="T:Gtk.Frame" />, <see cref="T:Gtk.HandleBox" />, and <see cref="T:Gtk.ScrolledWindow" />.</para>
<para>To place a child widget inside this container, use the standard <see cref="M:Gtk.Container.Add" /> method.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Container</BaseTypeName>
@ -66,8 +68,8 @@
<Parameters />
<Docs>
<summary>Internal constructor</summary>
<returns></returns>
<remarks></remarks>
<returns />
<remarks />
</Docs>
</Member>
<Member MemberName="GType">

294
doc/en/Gtk/Button.xml
View file

@ -36,31 +36,309 @@
</Interfaces>
<Attributes />
<Members>
<Member MemberName="ColorSelectionDialog">
<MemberSignature Language="C#" Value="public Gtk.ColorSelectionDialog ColorSelectionDialog { get; };" />
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static uint GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.ColorSelectionDialog</ReturnType>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.ColorSelectionDialog'</returns>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="UseStock">
<MemberSignature Language="C#" Value="public bool UseStock { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="UseUnderline">
<MemberSignature Language="C#" Value="public bool UseUnderline { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Relief">
<MemberSignature Language="C#" Value="public Gtk.ReliefStyle Relief { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.ReliefStyle</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Gtk.ReliefStyle" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.ReliefStyle'</param>
<returns>To be added: an object of type 'Gtk.ReliefStyle'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Label">
<MemberSignature Language="C#" Value="public string Label { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Activated">
<MemberSignature Language="C#" Value="public event EventHandler Activated;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Clicked">
<MemberSignature Language="C#" Value="public event EventHandler Clicked;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Left">
<MemberSignature Language="C#" Value="public event EventHandler Left;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Pressed">
<MemberSignature Language="C#" Value="public event EventHandler Pressed;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Released">
<MemberSignature Language="C#" Value="public event EventHandler Released;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Entered">
<MemberSignature Language="C#" Value="public event EventHandler Entered;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ActionGetType">
<MemberSignature Language="C#" Value="public static uint ActionGetType ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="NewWithLabel">
<MemberSignature Language="C#" Value="public static Gtk.Button NewWithLabel (string label);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.Button</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="label" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="label">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'Gtk.Button'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="NewFromStock">
<MemberSignature Language="C#" Value="public static Gtk.Button NewFromStock (string stock_id);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.Button</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stock_id" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="stock_id">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'Gtk.Button'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Leave">
<MemberSignature Language="C#" Value="public void Leave ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Press">
<MemberSignature Language="C#" Value="public void Press ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Release">
<MemberSignature Language="C#" Value="public void Release ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Click">
<MemberSignature Language="C#" Value="public void Click ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Enter">
<MemberSignature Language="C#" Value="public void Enter ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected virtual void Finalize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Button (Gtk.ColorSelectionDialog cs, IntPtr raw);" />
<MemberSignature Language="C#" Value="protected Button (GLib.Type gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="gtype">To be added: an object of type 'GLib.Type'</param>
<returns>To be added: an object of type 'Gtk.Button'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Button (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="cs" Type="Gtk.ColorSelectionDialog" />
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="cs">To be added: an object of type 'Gtk.ColorSelectionDialog'</param>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Gtk.ColorSelectionDialog+Button'</returns>
<returns>To be added: an object of type 'Gtk.Button'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Button ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.Button'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Button (string label);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="label" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="label">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'Gtk.Button'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>

63
doc/en/Gtk/ColorSelectionButton.xml Normal file
View file

@ -0,0 +1,63 @@
<Type Name="ColorSelectionButton" FullName="Gtk.ColorSelectionDialog+ColorSelectionButton">
<TypeSignature Language="C#" Value="public class ColorSelectionButton : Gtk.Button, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey />
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyCulture>neutral</AssemblyCulture>
<Attributes />
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Button</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Atk.Implementor</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ColorSelectionButton (Gtk.ColorSelectionDialog cs, IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="cs" Type="Gtk.ColorSelectionDialog" />
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="cs">To be added: an object of type 'Gtk.ColorSelectionDialog'</param>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Gtk.ColorSelectionDialog+ColorSelectionButton'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ColorSelectionDialog">
<MemberSignature Language="C#" Value="public Gtk.ColorSelectionDialog ColorSelectionDialog { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.ColorSelectionDialog</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.ColorSelectionDialog'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>

15
doc/en/Gtk/Combo.xml
View file

@ -276,21 +276,6 @@
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AppendString">
<MemberSignature Language="C#" Value="public void AppendString (string text);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="text">To be added: an object of type 'string'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Combo (GLib.Type gtype);" />
<MemberType>Constructor</MemberType>

21
doc/en/Gtk/HScale.xml
View file

@ -8,7 +8,10 @@
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>A horizontal slider widget for selecting a value from a range.</summary>
<remarks><para>The HScale widget allows the user to select a value with a horizontal slider.</para><para>This widget and its model is manipulated using methods and properties in its super classes, <see cref="T:Gtk.Scale"/> and <see cref="T:Gtk.Range"/>.</para></remarks>
<remarks>
<para>The HScale widget allows the user to select a value with a horizontal slider.</para>
<para>This widget and its model is manipulated using methods and properties in its super classes, <see cref="T:Gtk.Scale" /> and <see cref="T:Gtk.Range" />.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Scale</BaseTypeName>
@ -65,10 +68,12 @@
<Parameter Name="adjustment" Type="Gtk.Adjustment" />
</Parameters>
<Docs>
<summary>Creates a new horizontal slider based on the data in <paramref name="adjustment"/>.</summary>
<summary>Creates a new horizontal slider based on the data in <paramref name="adjustment" />.</summary>
<param name="adjustment">The model to use for this HScale</param>
<returns>A new HScale</returns>
<remarks><para>To create a horizontal slider without explicit use of a <see cref="T:Gtk.Adjustment"/>, use the alternative constructor.</para></remarks>
<remarks>
<para>To create a horizontal slider without explicit use of a <see cref="T:Gtk.Adjustment" />, use the alternative constructor.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -81,12 +86,14 @@
<Parameter Name="step" Type="System.Double" />
</Parameters>
<Docs>
<summary>Creates a new horizontal slider without the need for an <see cref="T:Gtk.Adjustment"/> object.</summary>
<summary>Creates a new horizontal slider without the need for an <see cref="T:Gtk.Adjustment" /> object.</summary>
<param name="min">The minimum value that is accepted by this HScale.</param>
<param name="max">The maximum value that is accepted by this HScale.</param>
<param name="step">The value to adjust the HScale by when 'sliding'.</param>
<returns>A new HScale.</returns>
<remarks><para>Creates a new horizontal slider that lets the user input a number between (and including) <paramref name="min"/> and <paramref name="max"/>. Each adjustment of the slider changes the value by <paramref name="step"/>, which must be non-zero.</para></remarks>
<remarks>
<para>Creates a new horizontal slider that lets the user input a number between (and including) <paramref name="min" /> and <paramref name="max" />. Each adjustment of the slider changes the value by <paramref name="step" />, which must be non-zero.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -96,8 +103,8 @@
<Parameters />
<Docs>
<summary>Internal constructor</summary>
<returns></returns>
<remarks></remarks>
<returns />
<remarks />
</Docs>
</Member>
<Member MemberName="GType">

35
doc/en/Gtk/HandleBox.xml
View file

@ -8,10 +8,12 @@
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>A container with a handle and a detachable child widget.</summary>
<remarks><para>The HandleBox widget allows a portion of a window to be &quot;torn off&quot;. It is a <see cref="T:Gtk.Bin"/> widget that displays its child with a handle that the user can drag to create a separate floating window containing the child widget and the 'handle'.</para>
<para>A thin ghost is drawn in the original location of the HandleBox. By dragging the separate window back to its original location, it can be reattached. When reattaching, the ghost and float window, must be aligned along one of the edges, the <see cref="P:Gtk.HandlBox.SnapEdge"/>. This can either be specified by the application programmer explicitly, otherwise a reasonable default will be used, based on the <see cref="P:Gtk.HandleBox.HandlePosition"/>.</para>
<para>To make detaching and reattaching the HandleBox as minimally confusing as possible to the user, it is important to set the snap edge so that it does not move when the HandleBox is deattached. For instance, if the HandleBox is packed at the bottom of a <see cref="T:Gtk.VBox"/>, then when the HandleBox is detached, the bottom edge of the HandleBox's allocation will remain fixed as the height of the HandleBox shrinks, so the snap edge should be set to <see cref="P:Gtk.PositionType.Bottom"/>.</para>
<para>The child of this widget is set using the <see cref="M:Gtk.Container.Add"/> method in <see cref="T:Gtk.Container"/>.</para></remarks>
<remarks>
<para>The HandleBox widget allows a portion of a window to be "torn off". It is a <see cref="T:Gtk.Bin" /> widget that displays its child with a handle that the user can drag to create a separate floating window containing the child widget and the 'handle'.</para>
<para>A thin ghost is drawn in the original location of the HandleBox. By dragging the separate window back to its original location, it can be reattached. When reattaching, the ghost and float window, must be aligned along one of the edges, the <see cref="P:Gtk.HandlBox.SnapEdge" />. This can either be specified by the application programmer explicitly, otherwise a reasonable default will be used, based on the <see cref="P:Gtk.HandleBox.HandlePosition" />.</para>
<para>To make detaching and reattaching the HandleBox as minimally confusing as possible to the user, it is important to set the snap edge so that it does not move when the HandleBox is deattached. For instance, if the HandleBox is packed at the bottom of a <see cref="T:Gtk.VBox" />, then when the HandleBox is detached, the bottom edge of the HandleBox's allocation will remain fixed as the height of the HandleBox shrinks, so the snap edge should be set to <see cref="P:Gtk.PositionType.Bottom" />.</para>
<para>The child of this widget is set using the <see cref="M:Gtk.Container.Add" /> method in <see cref="T:Gtk.Container" />.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Bin</BaseTypeName>
@ -68,7 +70,9 @@
<Docs>
<summary>The main way to create a HandleBox.</summary>
<returns>A new HandleBox.</returns>
<remarks><para>Creates a new HandleBox, with the <see cref="P:Gtk.HandleBox.HandlePosition"/> set to the <see cref="P:Gtk.PositionType.Left"/>.</para></remarks>
<remarks>
<para>Creates a new HandleBox, with the <see cref="P:Gtk.HandleBox.HandlePosition" /> set to the <see cref="P:Gtk.PositionType.Left" />.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -96,7 +100,9 @@
<summary>Manage which edge a detached HandleBox must reattach to.</summary>
<param name="value">The new edge</param>
<returns>The current edge that snapping works with.</returns>
<remarks><para>To ensure good usability, this edge should be set to a side of the HandleBox whose position or size will not be altered when the child is detached.</para></remarks>
<remarks>
<para>To ensure good usability, this edge should be set to a side of the HandleBox whose position or size will not be altered when the child is detached.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ShadowType">
@ -109,10 +115,10 @@
<Parameter Name="value" Type="Gtk.ShadowType" />
</Parameters>
<Docs>
<summary>Manage the appearance of the <see cref="T:Gtk.Container"/> surrounding the child widget.</summary>
<summary>Manage the appearance of the <see cref="T:Gtk.Container" /> surrounding the child widget.</summary>
<param name="value">The new style of shadow to use for this HandleBox.</param>
<returns>The current style of shadow in use.</returns>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="HandlePosition">
@ -128,7 +134,10 @@
<summary>Manage where the handle of this container is placed.</summary>
<param name="value">A new position for the handle.</param>
<returns>The current position of the handle.</returns>
<remarks><para>Note: In western cultures, anything other than a <see cref="P:Gtk.PositionType.Left"/> handle for horizontal HandleBoxes, or a <see cref="P:Gtk.PositionType.Top"/> handle for vertical HandleBoxes, may seem strange to users.</para><para>The reverse is likely to be true for cultures with languages that are written from right to left.</para></remarks>
<remarks>
<para>Note: In western cultures, anything other than a <see cref="P:Gtk.PositionType.Left" /> handle for horizontal HandleBoxes, or a <see cref="P:Gtk.PositionType.Top" /> handle for vertical HandleBoxes, may seem strange to users.</para>
<para>The reverse is likely to be true for cultures with languages that are written from right to left.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Shadow">
@ -141,10 +150,10 @@
<Parameter Name="value" Type="Gtk.ShadowType" />
</Parameters>
<Docs>
<summary>Manage the appearance of the <see cref="T:Gtk.Container"/> surrounding the child widget.</summary>
<summary>Manage the appearance of the <see cref="T:Gtk.Container" /> surrounding the child widget.</summary>
<param name="value">The new style of shadow to use for this HandleBox.</param>
<returns>The current style of shadow in use.</returns>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="ChildAttached">
@ -154,7 +163,7 @@
<Parameters />
<Docs>
<summary>This event is fired when the contents of the HandleBox are reattached to the main window. </summary>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="ChildDetached">
@ -164,7 +173,7 @@
<Parameters />
<Docs>
<summary>This event is fired when the contents of the handlebox are detached from the main window.</summary>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">

3
doc/en/Gtk/NotebookPage.xml
View file

@ -78,8 +78,7 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>Creates a new instance of <see
cref="T:Gtk.NotebookPage" /></returns>
<returns>Creates a new instance of <see cref="T:Gtk.NotebookPage" /></returns>
<remarks>
<para>
This is a constructor used by derivative types of <see cref="T:Gtk.NotebookPage" />.

12
doc/en/Gtk/PositionType.xml
View file

@ -8,7 +8,9 @@
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>Indicates a position for placement or layout.</summary>
<remarks><para>A PositionType is used to place widgets, usually relative to other widgets or other parts of the same widget. For example, the position of a handle in a <see cref="T:Gtk.HandleBox"/>, or the position of tabs in a <see cref="T:Gtk.Notebook"/>.</para></remarks>
<remarks>
<para>A PositionType is used to place widgets, usually relative to other widgets or other parts of the same widget. For example, the position of a handle in a <see cref="T:Gtk.HandleBox" />, or the position of tabs in a <see cref="T:Gtk.Notebook" />.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -35,7 +37,7 @@
<Parameters />
<Docs>
<summary>The relevant item should be placed on the left.</summary>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Right">
@ -47,7 +49,7 @@
<Parameters />
<Docs>
<summary>The relevant item should be placed on the right.</summary>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Top">
@ -59,7 +61,7 @@
<Parameters />
<Docs>
<summary>The relevant item should be placed at the top.</summary>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Bottom">
@ -71,7 +73,7 @@
<Parameters />
<Docs>
<summary>The relevant item should be placed at the bottom.</summary>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="value__">

36
doc/en/Gtk/Range.xml
View file

@ -7,8 +7,10 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>Base class for widgets that visualize an <see cref="T:Gtk.Adjustment"/>.</summary>
<remarks><para>This class provides helper methods and properties for manipulating concrete widgets like <see cref="T:Gtk.HScale"/> and <see cref="T:Gtk.VScale"/>.</para></remarks>
<summary>Base class for widgets that visualize an <see cref="T:Gtk.Adjustment" />.</summary>
<remarks>
<para>This class provides helper methods and properties for manipulating concrete widgets like <see cref="T:Gtk.HScale" /> and <see cref="T:Gtk.VScale" />.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Widget</BaseTypeName>
@ -43,7 +45,9 @@
<summary>Sets the step and page sizes for this range.</summary>
<param name="step">Value difference for step movements, (see below).</param>
<param name="page">Value difference for page movements, (see below).</param>
<remarks><para>The <paramref name="step"/> size is used when the user clicks the <see cref="T:Gtk.Scrollbar"/> arrows or moves <see cref="T:Gtk.Scale"/> with arrow keys. The <paramref name="page"/> size is used for example when moving via Page Up or Page Down keys.</para></remarks>
<remarks>
<para>The <paramref name="step" /> size is used when the user clicks the <see cref="T:Gtk.Scrollbar" /> arrows or moves <see cref="T:Gtk.Scale" /> with arrow keys. The <paramref name="page" /> size is used for example when moving via Page Up or Page Down keys.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="SetRange">
@ -60,7 +64,7 @@
<summary>Sets the limits of this range.</summary>
<param name="min">The minimum acceptable value for this range.</param>
<param name="max">The maximum acceptable value for this range.</param>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Finalize">
@ -98,8 +102,8 @@
<Parameters />
<Docs>
<summary>Internal constructor</summary>
<returns></returns>
<remarks></remarks>
<returns />
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -127,7 +131,7 @@
<summary>Manage the value of this range.</summary>
<param name="value">The new value for this range.</param>
<returns>The current value of this range.</returns>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Inverted">
@ -141,9 +145,11 @@
</Parameters>
<Docs>
<summary>Manage whether the control of this range is manipulated in the opposite direction.</summary>
<param name="value">Set to <see langword="true"/> to invert the controls.</param>
<param name="value">Set to <see langword="true" /> to invert the controls.</param>
<returns>Whether visual control of the range is currently inverted.</returns>
<remarks><para>Setting this to <see langword="true"/> causes a <see cref="T:Gtk.VScale"/> widget to move from right to left, instead of left to right.</para></remarks>
<remarks>
<para>Setting this to <see langword="true" /> causes a <see cref="T:Gtk.VScale" /> widget to move from right to left, instead of left to right.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="UpdatePolicy">
@ -159,7 +165,7 @@
<summary>Manage how often the value label is updated.</summary>
<param name="value">A new update policy.</param>
<returns>The current update policy.</returns>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Adjustment">
@ -173,9 +179,9 @@
</Parameters>
<Docs>
<summary>Manipulate the underlying model of this range.</summary>
<param name="value">Sets a new <see cref="T:Gtk.Adjustment"/> object to model this range.</param>
<returns>The current <see cref="T:Gtk.Adjustment"/> underlying this range.</returns>
<remarks></remarks>
<param name="value">Sets a new <see cref="T:Gtk.Adjustment" /> object to model this range.</param>
<returns>The current <see cref="T:Gtk.Adjustment" /> underlying this range.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="MoveSlider">
@ -195,7 +201,9 @@
<Parameters />
<Docs>
<summary>Fired when the value in this range changes.</summary>
<remarks><para>Connect to this event with a standard <see cref="T:System.EventHandler"/> to find out when the value changes.</para></remarks>
<remarks>
<para>Connect to this event with a standard <see cref="T:System.EventHandler" /> to find out when the value changes.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="AdjustBounds">

27
doc/en/Gtk/Scale.xml
View file

@ -7,8 +7,10 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>A base class for the concrete slider widgets; <see cref="T:Gtk.HScale"/> and <see cref="T:Gtk.VScale"/>.</summary>
<remarks><para>A Scale is a slider control used to select a numeric value. Specific manipulation can be done with methods and properties on its base class, <see cref="T:Gtk.Range"/>. To set the value of a scale, you would normally use the <see cref="P:Gtk.Range.Value"/> property. To detect changes to the value, connect an event handler to the <see cref="F:Gtk.Range.ValueChanged"/> event.</para></remarks>
<summary>A base class for the concrete slider widgets; <see cref="T:Gtk.HScale" /> and <see cref="T:Gtk.VScale" />.</summary>
<remarks>
<para>A Scale is a slider control used to select a numeric value. Specific manipulation can be done with methods and properties on its base class, <see cref="T:Gtk.Range" />. To set the value of a scale, you would normally use the <see cref="P:Gtk.Range.Value" /> property. To detect changes to the value, connect an event handler to the <see cref="F:Gtk.Range.ValueChanged" /> event.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Range</BaseTypeName>
@ -64,8 +66,8 @@
<Parameters />
<Docs>
<summary>Internal constructor</summary>
<returns></returns>
<remarks></remarks>
<returns />
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -93,7 +95,9 @@
<summary>Manage the position of the value, relative to the slider.</summary>
<param name="value">The position to place the value</param>
<returns>Where the value is currently being drawn.</returns>
<remarks><para>Note: This property is only meaningful is a value is being drawn. To ensure a value is drawn, use the <see cref="P:Gtk.Scale.DrawValue"/> property.</para></remarks>
<remarks>
<para>Note: This property is only meaningful is a value is being drawn. To ensure a value is drawn, use the <see cref="P:Gtk.Scale.DrawValue" /> property.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="DrawValue">
@ -107,9 +111,12 @@
</Parameters>
<Docs>
<summary>Manage whether a label is displayed to show the current value.</summary>
<param name="value"><see langword="true"/> to display the value, <see langword="false"/> otherwise.</param>
<param name="value">
<see langword="true" /> to display the value, <see langword="false" /> otherwise.</param>
<returns>Whether the value is currently being displayed.</returns>
<remarks><para>Use the <see cref="P:Gtk.Scale.ValuePos"/> property to alter the position of displayed value.</para></remarks>
<remarks>
<para>Use the <see cref="P:Gtk.Scale.ValuePos" /> property to alter the position of displayed value.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Digits">
@ -125,7 +132,7 @@
<summary>Manage the number of decimal places for this slider.</summary>
<param name="value">The number of decimal places to display.</param>
<returns>The number of decimal places currently being displayed.</returns>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="FormatValue">
@ -135,7 +142,9 @@
<Parameters />
<Docs>
<summary>Allows the format of the displayed value to be altered.</summary>
<remarks><para>Note: The signature of this event handler is currently incorrect.</para></remarks>
<remarks>
<para>Note: The signature of this event handler is currently incorrect.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">

91
doc/en/Gtk/Table.xml
View file

@ -8,11 +8,13 @@
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>Pack widgets in grid/table patterns.</summary>
<remarks><para>The Table widget allows a programmer to arrange widgets in rows and columns, making it easy to align many widgets adjacent to each other, horizontally and vertically.</para>
<para>Tables are created with a specific size - the number of rows and columns. This can be changed dynamically with the <see cref="M:Gtk.Table.Resize"/> method. Widgets are packed into the table with <see cref="M:Gtk.Table.Attach"/> methods.</para>
<para>The layout of a table can be altered by setting the spacing between rows and columns. This is done with the <see cref="P:Gtk.Table.ColumnSpacing"/> and <see cref="P:Gtk.Table.RowSpacing"/> properties, respectively. The spacing of individual cells can be adjusted with <see cref="M:Gtk.Table.SetColSpacing"/>.</para>
<remarks>
<para>The Table widget allows a programmer to arrange widgets in rows and columns, making it easy to align many widgets adjacent to each other, horizontally and vertically.</para>
<para>Tables are created with a specific size - the number of rows and columns. This can be changed dynamically with the <see cref="M:Gtk.Table.Resize" /> method. Widgets are packed into the table with <see cref="M:Gtk.Table.Attach" /> methods.</para>
<para>The layout of a table can be altered by setting the spacing between rows and columns. This is done with the <see cref="P:Gtk.Table.ColumnSpacing" /> and <see cref="P:Gtk.Table.RowSpacing" /> properties, respectively. The spacing of individual cells can be adjusted with <see cref="M:Gtk.Table.SetColSpacing" />.</para>
<para>The following shows how to create a table with three widgets:
<example><code lang="C#">
<example>
<code lang="C#">
public Widget MakeTableTester()
{
// Create a table with 2 rows and 1 column
@ -28,8 +30,8 @@ public Widget MakeTableTester()
tableLayout.ShowAll();
return tableLayout;
}
</code></example>
</para>
</code>
</example></para>
</remarks>
</Docs>
<Base>
@ -64,8 +66,10 @@ public Widget MakeTableTester()
<Docs>
<summary>Sets the spacing around a specified column.</summary>
<param name="column">A zero-indexed column number to adjust the spacing of.</param>
<param name="spacing">The number of pixels on each side of the <paramref name="column"/>.</param>
<remarks><para>To adjust the spacing between all columns, use the <see cref="P:Gtk.Table.ColumnSpacing"/> property.</para></remarks>
<param name="spacing">The number of pixels on each side of the <paramref name="column" />.</param>
<remarks>
<para>To adjust the spacing between all columns, use the <see cref="P:Gtk.Table.ColumnSpacing" /> property.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="GetColSpacing">
@ -80,8 +84,8 @@ public Widget MakeTableTester()
<Docs>
<summary>The spacing currently set for a given column.</summary>
<param name="column">A zero-indexed column number to retrieve spacing information from.</param>
<returns>The number of pixels of spacing assigned to the specified <paramref name="column"/>.</returns>
<remarks></remarks>
<returns>The number of pixels of spacing assigned to the specified <paramref name="column" />.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Resize">
@ -95,10 +99,10 @@ public Widget MakeTableTester()
<Parameter Name="columns" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Resizes the table so that the specified number of <paramref name="rows"/> and <paramref name="columns"/> are available for widget packing.</summary>
<summary>Resizes the table so that the specified number of <paramref name="rows" /> and <paramref name="columns" /> are available for widget packing.</summary>
<param name="rows">The new number of rows this table should allow.</param>
<param name="columns">The new number of columns this table should allow.</param>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Attach">
@ -120,16 +124,17 @@ public Widget MakeTableTester()
</Parameters>
<Docs>
<summary>Packs a widget into the table.</summary>
<param name="child">The <see cref="T:Gtk.Widget"/> to add.</param>
<param name="left_attach">The column number to attach the left side of <paramref name="child"/> to.</param>
<param name="right_attach">The column number to attach the right side of <paramref name="child"/> to.</param>
<param name="top_attach">The row number to attach the top of <paramref name="child"/> to.</param>
<param name="bottom_attach">The row number to attach the bottom of <paramref name="child"/> to.</param>
<param name="xoptions">The horizontal packing options for this <paramref name="child"/>.</param>
<param name="yoptions">The vertical packing options for this <paramref name="child"/>.</param>
<param name="xpadding">The number of pixels of padding to add to the left and right of <paramref name="child"/>.</param>
<param name="ypadding">The number of pixels of padding to add to the top and bottom of <paramref name="child"/>.</param>
<remarks><para>You can pack widgets into the Table using default packing and padding with the <see cref="M:Gtk.Table.Attach(Gtk.Widget,uint,uint,uint,uint)"/> convenience method.</para>
<param name="child">The <see cref="T:Gtk.Widget" /> to add.</param>
<param name="left_attach">The column number to attach the left side of <paramref name="child" /> to.</param>
<param name="right_attach">The column number to attach the right side of <paramref name="child" /> to.</param>
<param name="top_attach">The row number to attach the top of <paramref name="child" /> to.</param>
<param name="bottom_attach">The row number to attach the bottom of <paramref name="child" /> to.</param>
<param name="xoptions">The horizontal packing options for this <paramref name="child" />.</param>
<param name="yoptions">The vertical packing options for this <paramref name="child" />.</param>
<param name="xpadding">The number of pixels of padding to add to the left and right of <paramref name="child" />.</param>
<param name="ypadding">The number of pixels of padding to add to the top and bottom of <paramref name="child" />.</param>
<remarks>
<para>You can pack widgets into the Table using default packing and padding with the <see cref="M:Gtk.Table.Attach(Gtk.Widget,uint,uint,uint,uint)" /> convenience method.</para>
<para>Child widgets can span as many table cells as they wish, allowing the programmer to create complex grids of Widgets.</para>
</remarks>
</Docs>
@ -149,12 +154,14 @@ public Widget MakeTableTester()
</Parameters>
<Docs>
<summary>Packs a widget into the table with default packing options.</summary>
<param name="child">The <see cref="T:Gtk.Widget"/> to add.</param>
<param name="left_attach">The column number to attach the left side of <paramref name="child"/> to.</param>
<param name="right_attach">The column number to attach the right side of <paramref name="child"/> to.</param>
<param name="top_attach">The row number to attach the top of <paramref name="child"/> to.</param>
<param name="bottom_attach">The row number to attach the bottom of <paramref name="child"/> to.</param>
<remarks><para>To pack widgets into the table with more control over size and padding, use the alternative <see cref="M:Gtk.Table.Attach(Gtk.Widget,uint,uint,uint,uint,Gtk.AttachOptions,Gtk.AttachOptions,uint,uint)"/> method.</para></remarks>
<param name="child">The <see cref="T:Gtk.Widget" /> to add.</param>
<param name="left_attach">The column number to attach the left side of <paramref name="child" /> to.</param>
<param name="right_attach">The column number to attach the right side of <paramref name="child" /> to.</param>
<param name="top_attach">The row number to attach the top of <paramref name="child" /> to.</param>
<param name="bottom_attach">The row number to attach the bottom of <paramref name="child" /> to.</param>
<remarks>
<para>To pack widgets into the table with more control over size and padding, use the alternative <see cref="M:Gtk.Table.Attach(Gtk.Widget,uint,uint,uint,uint,Gtk.AttachOptions,Gtk.AttachOptions,uint,uint)" /> method.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -200,7 +207,9 @@ public Widget MakeTableTester()
<param name="columns">The number of columns in this table.</param>
<param name="homogeneous">Whether all table cells are forced to be the same size.</param>
<returns>A new Table.</returns>
<remarks><para>The size of the table can be altered after its creation using the <see cref="M:Gtk.able.Resize"/> method.</para></remarks>
<remarks>
<para>The size of the table can be altered after its creation using the <see cref="M:Gtk.able.Resize" /> method.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -210,8 +219,8 @@ public Widget MakeTableTester()
<Parameters />
<Docs>
<summary>Internal constructor</summary>
<returns></returns>
<remarks></remarks>
<returns />
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -236,10 +245,10 @@ public Widget MakeTableTester()
<Parameter Name="value" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Sets the space between every column equal to <paramref name="value"/>.</summary>
<summary>Sets the space between every column equal to <paramref name="value" />.</summary>
<param name="value">The number of pixels to place between every column.</param>
<returns></returns>
<remarks></remarks>
<returns />
<remarks />
</Docs>
</Member>
<Member MemberName="DefaultRowSpacing">
@ -251,7 +260,7 @@ public Widget MakeTableTester()
<Docs>
<summary>Retrieve the spacing that gets placed between newly added rows by default.</summary>
<returns>Spacing between rows that will be added, in pixels.</returns>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="DefaultColSpacing">
@ -311,7 +320,7 @@ public Widget MakeTableTester()
<summary>Manage the number of columns in this Table.</summary>
<param name="value">The number of columns that this table should have.</param>
<returns>The number of columns this table currently has.</returns>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Homogeneous">
@ -325,9 +334,11 @@ public Widget MakeTableTester()
</Parameters>
<Docs>
<summary>Manage whether all cells must be of equal size.</summary>
<param name="value"><see langword="true"/> to set all cells to an equal size, <see langword="false"/> otherwise.</param>
<returns><see langword="true"/> if all cells are currently equally sized, <see langword="false"/> otherwise.</returns>
<remarks></remarks>
<param name="value">
<see langword="true" /> to set all cells to an equal size, <see langword="false" /> otherwise.</param>
<returns>
<see langword="true" /> if all cells are currently equally sized, <see langword="false" /> otherwise.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="RowSpacing">
@ -359,7 +370,7 @@ public Widget MakeTableTester()
<summary>Manage the number of rows in this Table.</summary>
<param name="value">The number of rows that this table should have.</param>
<returns>The number of rows this table currently has.</returns>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">

21
doc/en/Gtk/VScale.xml
View file

@ -8,7 +8,10 @@
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>A vertical slider widget for selecting a value from a range.</summary>
<remarks><para>The VScale widget allows the user to select a value with a vertical slider.</para><para>This widget and its model is manipulated using methods and properties in its super classes, <see cref="T:Gtk.Scale"/> and <see cref="T:Gtk.Range"/>.</para></remarks>
<remarks>
<para>The VScale widget allows the user to select a value with a vertical slider.</para>
<para>This widget and its model is manipulated using methods and properties in its super classes, <see cref="T:Gtk.Scale" /> and <see cref="T:Gtk.Range" />.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Scale</BaseTypeName>
@ -65,10 +68,12 @@
<Parameter Name="adjustment" Type="Gtk.Adjustment" />
</Parameters>
<Docs>
<summary>Creates a new vertical slider based on the data in <paramref name="adjustment"/>.</summary>
<summary>Creates a new vertical slider based on the data in <paramref name="adjustment" />.</summary>
<param name="adjustment">The model to use for this VScale</param>
<returns>A new VScale</returns>
<remarks><para>To create a vertical slider without explicit use of a <see cref="T:Gtk.Adjustment"/>, use the alternative constructor.</para></remarks>
<remarks>
<para>To create a vertical slider without explicit use of a <see cref="T:Gtk.Adjustment" />, use the alternative constructor.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -81,12 +86,14 @@
<Parameter Name="step" Type="System.Double" />
</Parameters>
<Docs>
<summary>Creates a new vertical slider without the need for an <see cref="T:Gtk.Adjustment"/> object.</summary>
<summary>Creates a new vertical slider without the need for an <see cref="T:Gtk.Adjustment" /> object.</summary>
<param name="min">The minimum value that is accepted by this VScale.</param>
<param name="max">The maximum value that is accepted by this VScale.</param>
<param name="step">The value to adjust the VScale by when 'sliding'.</param>
<returns>A new VScale.</returns>
<remarks><para>Creates a new vertical slider that lets the user input a number between (and including) <paramref name="min"/> and <paramref name="max"/>. Each adjustment of the slider changes the value by <paramref name="step"/>, which must be non-zero.</para></remarks>
<remarks>
<para>Creates a new vertical slider that lets the user input a number between (and including) <paramref name="min" /> and <paramref name="max" />. Each adjustment of the slider changes the value by <paramref name="step" />, which must be non-zero.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -96,8 +103,8 @@
<Parameters />
<Docs>
<summary>Internal constructor</summary>
<returns></returns>
<remarks></remarks>
<returns />
<remarks />
</Docs>
</Member>
<Member MemberName="GType">

397
doc/en/Gtk/Widget.xml
View file

@ -13,7 +13,7 @@
Style properties are set in resource files. This mechanism is used for configuring such things as the location of the scrollbar arrows through 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 <see cref="M:Gtk.Widget.StyleGetProperty"/>, <see cref="M:Gtk.Widget.Style"/> or <see cref="M:Gtk.Widget.StyleGetValist"/> to obtain the value of a style property.
Use <see cref="M:Gtk.Widget.StyleGetProperty" />, <see cref="M:Gtk.Widget.Style" /> or <see cref="M:Gtk.Widget.StyleGetValist" /> to obtain the value of a style property.
</para>
</remarks>
</Docs>
@ -44,10 +44,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Makes all newly-created <paramref name="widgets"/> as composite children until the corresponding <see cref="M:Gtk.Widget.PopCompositeChild"/> call.</summary>
<summary>Makes all newly-created <paramref name="widgets" /> as composite children until the corresponding <see cref="M:Gtk.Widget.PopCompositeChild" /> call.</summary>
<remarks>
<para>
A composite child is a child that's an implementation detail of the container it's inside and should not be visible to people using the container. Composite children aren't treated differently by GTK (but see <see cref="M:Gtk.Container.Foreach"/> vs. <see cref="M:GtkContainer.Forall"/>), but e.g. GUI builders might want to treat them in a different way.
A composite child is a child that's an implementation detail of the container it's inside and should not be visible to people using the container. Composite children aren't treated differently by GTK (but see <see cref="M:Gtk.Container.Foreach" /> vs. <see cref="M:GtkContainer.Forall" />), but e.g. GUI builders might want to treat them in a different way.
</para>
</remarks>
</Docs>
@ -62,11 +62,11 @@
<Parameter Name="cmap" Type="Gdk.Colormap" />
</Parameters>
<Docs>
<summary>Pushes <paramref name="cmap"/> onto a global stack of colormaps.</summary>
<param name="cmap">Colormap that is pushed by <see cref="T:Gdk.Colormap"/>.</param>
<summary>Pushes <paramref name="cmap" /> onto a global stack of colormaps.</summary>
<param name="cmap">Colormap that is pushed by <see cref="T:Gdk.Colormap" />.</param>
<remarks>
<para>
Pushes <paramref name="cmap"/> onto a global stack of colormaps; the topmost colormap on the stack will be used to create all widgets. Remove <paramref name="cmap"/> with <see cref="M:Gtk.Widget.PopColormap"/>. There's little reason to use this function.
Pushes <paramref name="cmap" /> onto a global stack of colormaps; the topmost colormap on the stack will be used to create all widgets. Remove <paramref name="cmap" /> with <see cref="M:Gtk.Widget.PopColormap" />. There's little reason to use this function.
</para>
</remarks>
</Docs>
@ -79,10 +79,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Removes a colormap pushed with <see cref="M:Gtk.Widget.PushColormap"/>.</summary>
<summary>Removes a colormap pushed with <see cref="M:Gtk.Widget.PushColormap" />.</summary>
<remarks>
<para>
Removes a colormap pushed with <see cref="M:Gtk.Widget.PushColormap"/>.
Removes a colormap pushed with <see cref="M:Gtk.Widget.PushColormap" />.
</para>
</remarks>
</Docs>
@ -95,10 +95,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Cancels the effect of a previous call to <see cref="M:Gtk.Widget.PushCompositeChild"/>.</summary>
<summary>Cancels the effect of a previous call to <see cref="M:Gtk.Widget.PushCompositeChild" />.</summary>
<remarks>
<para>
Cancels the effect of a previous call to <see cref="M:Gtk.Widget.PushCompositeChild"/>.
Cancels the effect of a previous call to <see cref="M:Gtk.Widget.PushCompositeChild" />.
</para>
</remarks>
</Docs>
@ -111,11 +111,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Gets a reference to an object's <see cref="T:Atk.Object"/> implementation.</summary>
<returns>An <see cref="T:Atk.Object"/>.</returns>
<summary>Gets a reference to an object's <see cref="T:Atk.Object" /> implementation.</summary>
<returns>An <see cref="T:Atk.Object" />.</returns>
<remarks>
<para>
Gets a reference to an object's <see cref="T:Atk.Object"/> implementation.
Gets a reference to an object's <see cref="T:Atk.Object" /> implementation.
</para>
</remarks>
</Docs>
@ -128,10 +128,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Shows a <paramref name="widget"/>.</summary>
<summary>Shows a <paramref name="widget" />.</summary>
<remarks>
<para>
If the <paramref name="widget"/> is an unmapped toplevel widget, a <see cref="T:Gtk.Window"/> that has not yet been shown, enter the main loop and wait for the window to actually be mapped. Be careful, because the main loop is running, anything can happen during this function.
If the <paramref name="widget" /> is an unmapped toplevel widget, a <see cref="T:Gtk.Window" /> that has not yet been shown, enter the main loop and wait for the window to actually be mapped. Be careful, because the main loop is running, anything can happen during this function.
</para>
</remarks>
</Docs>
@ -144,10 +144,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Causes <paramref name="widget"/> to become the default <paramref name="widget"/>.</summary>
<summary>Causes <paramref name="widget" /> to become the default <paramref name="widget" />.</summary>
<remarks>
<para>
The default <paramref name="widget"/> is activated when the user presses Enter in a window. Default widgets must be activatable, that is, <see cref="M:Gtk.Widget.Activate"/> should affect them. The <paramref name="widgets"/> must have the <see cref="F:Gtk.WidgetFlags.CanDefault"/> flag set; typically you have to set this flag yourself by calling <see cref="P:Gtk.Widget.CanDefault"/>.
The default <paramref name="widget" /> is activated when the user presses Enter in a window. Default widgets must be activatable, that is, <see cref="M:Gtk.Widget.Activate" /> should affect them. The <paramref name="widgets" /> must have the <see cref="F:Gtk.WidgetFlags.CanDefault" /> flag set; typically you have to set this flag yourself by calling <see cref="P:Gtk.Widget.CanDefault" />.
</para>
</remarks>
</Docs>
@ -162,11 +162,11 @@
<Parameter Name="new_parent" Type="Gtk.Widget" />
</Parameters>
<Docs>
<summary>Moves a <paramref name="widget"/> from one <see cref="T:Gtk.Container"/> to another, handling reference count issues to avoid destroying the widget.</summary>
<param name="new_parent">A <see cref="T:Gtk.Container"/> to move the widget into.</param>
<summary>Moves a <paramref name="widget" /> from one <see cref="T:Gtk.Container" /> to another, handling reference count issues to avoid destroying the widget.</summary>
<param name="new_parent">A <see cref="T:Gtk.Container" /> to move the widget into.</param>
<remarks>
<para>
Moves a widget from one <see cref="T:Gtk.Container"/> to another, handling reference count issues to avoid destroying the widget.
Moves a widget from one <see cref="T:Gtk.Container" /> to another, handling reference count issues to avoid destroying the widget.
</para>
</remarks>
</Docs>
@ -182,13 +182,14 @@
<Parameter Name="intersection" Type="Gdk.Rectangle" />
</Parameters>
<Docs>
<summary>Computes the intersection of a <paramref name="widget"/>'s area and <paramref name="area"/>.</summary>
<summary>Computes the intersection of a <paramref name="widget" />'s area and <paramref name="area" />.</summary>
<param name="area"> A rectangle.</param>
<param name="intersection"> A rectangle to store intersection of <paramref name="widget"/> and <paramref name="area"/>.</param>
<returns><see cref="langword:true"/> if there was an intersection.</returns>
<param name="intersection"> A rectangle to store intersection of <paramref name="widget" /> and <paramref name="area" />.</param>
<returns>
<see cref="langword:true" /> if there was an intersection.</returns>
<remarks>
<para>
Computes the intersection of a <paramref name="widget"/>'s area and <paramref name="area"/>, storing the intersection in <paramref name="intersection"/>, and returns <see cref="langword:true"/> if there was an intersection. <paramref name="intersection"/> may be <see cref="langword:null"/> if you're only interested in whether there was an intersection.
Computes the intersection of a <paramref name="widget" />'s area and <paramref name="area" />, storing the intersection in <paramref name="intersection" />, and returns <see cref="langword:true" /> if there was an intersection. <paramref name="intersection" /> may be <see cref="langword:null" /> if you're only interested in whether there was an intersection.
</para>
</remarks>
</Docs>
@ -203,18 +204,19 @@
<Parameter Name="direction" Type="Gtk.DirectionType" />
</Parameters>
<Docs>
<summary>Move focus to particular <paramref name="widget"/>.</summary>
<summary>Move focus to particular <paramref name="widget" />.</summary>
<param name="direction">Direction of focus movement.</param>
<returns><see cref="langword:true"/> if focus ended up inside widget.</returns>
<returns>
<see cref="langword:true" /> if focus ended up inside widget.</returns>
<remarks>
<para>
This function is used by custom widget implementations; if you're writing an app, you'd use <see cref="M:Gtk.Widget.GrabFocus"/> to move the focus to a particular widget, and <see cref="M:Gtk.Container.SetFocusChain"/> to change the focus tab order. So you may want to investigate those functions instead.
This function is used by custom widget implementations; if you're writing an app, you'd use <see cref="M:Gtk.Widget.GrabFocus" /> to move the focus to a particular widget, and <see cref="M:Gtk.Container.SetFocusChain" /> to change the focus tab order. So you may want to investigate those functions instead.
</para>
<para>
<see cref="M:Gtk.Widget.ChildFocus"/> is called by containers as the user moves around the window using keyboard shortcuts. <paramref name="direction"/> indicates what kind of motion is taking place (up, down, left, right, tab forward, tab backward). <see cref="M:Gtk.Widget.ChildFocus"/> invokes the "focus" signal on <see cref="T:Gtk.Widget"/>; widgets override the default handler for this signal in order to implement appropriate focus behavior.
<see cref="M:Gtk.Widget.ChildFocus" /> is called by containers as the user moves around the window using keyboard shortcuts. <paramref name="direction" /> indicates what kind of motion is taking place (up, down, left, right, tab forward, tab backward). <see cref="M:Gtk.Widget.ChildFocus" /> invokes the "focus" signal on <see cref="T:Gtk.Widget" />; widgets override the default handler for this signal in order to implement appropriate focus behavior.
</para>
<para>
The "focus" default handler for a widget should return <see cref="langword:true"/> if moving in direction left the focus on a focusable location inside that widget, and <see cref="langword:false"/> if moving in direction moved the focus outside the widget. If returning <see cref="langword:true"/>, widgets normally call <see cref="M:Gtk.Widget.GrabFocus"/> to place the focus accordingly; if returning <see cref="langword:false"/>, they don't modify the current focus location.
The "focus" default handler for a widget should return <see cref="langword:true" /> if moving in direction left the focus on a focusable location inside that widget, and <see cref="langword:false" /> if moving in direction moved the focus outside the widget. If returning <see cref="langword:true" />, widgets normally call <see cref="M:Gtk.Widget.GrabFocus" /> to place the focus accordingly; if returning <see cref="langword:false" />, they don't modify the current focus location.
</para>
</remarks>
</Docs>
@ -227,7 +229,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Should be called by implementations of the remove method on <see cref="T:Gtk.Container"/>, to dissociate a child from the container.</summary>
<summary>Should be called by implementations of the remove method on <see cref="T:Gtk.Container" />, to dissociate a child from the container.</summary>
<remarks>
<para>
This function is only for use in widget implementations.
@ -243,13 +245,13 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates the GDK (windowing system) resources associated with a <paramref name="widget"/>.</summary>
<summary>Creates the GDK (windowing system) resources associated with a <paramref name="widget" />.</summary>
<remarks>
<para>
For example, <paramref name="widget"/>->window will be created when a widget is realized. Normally realization happens implicitly; if you show a widget and all its parent containers, then the widget will be realized and mapped automatically. Realizing a widget requires all the widget's parent widgets to be realized; calling <see cref="M:Gtk.Widget.Realize"/> realizes the widget's parents in addition to widget itself. If a widget is not yet inside a toplevel window when you realize it, bad things will happen.
For example, <paramref name="widget" />-&gt;window will be created when a widget is realized. Normally realization happens implicitly; if you show a widget and all its parent containers, then the widget will be realized and mapped automatically. Realizing a widget requires all the widget's parent widgets to be realized; calling <see cref="M:Gtk.Widget.Realize" /> realizes the widget's parents in addition to widget itself. If a widget is not yet inside a toplevel window when you realize it, bad things will happen.
</para>
<para>
This function is primarily used in widget implementations, and isn't very useful otherwise. Many times when you think you might need it, a better approach is to connect to a signal that will be called after the widget is realized automatically, such as <see cref="F:Gtk.Widget.ExposeEvent"/>. Or simply <see cref="M:Glib.SignalAttr.ConnectAfter"/> to the realize signal.
This function is primarily used in widget implementations, and isn't very useful otherwise. Many times when you think you might need it, a better approach is to connect to a signal that will be called after the widget is realized automatically, such as <see cref="F:Gtk.Widget.ExposeEvent" />. Or simply <see cref="M:Glib.SignalAttr.ConnectAfter" /> to the realize signal.
</para>
</remarks>
</Docs>
@ -267,17 +269,17 @@
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Invalidates the rectangular area of a <paramref name="widget"/>.</summary>
<summary>Invalidates the rectangular area of a <paramref name="widget" />.</summary>
<param name="x">y coordinate of upper-left corner of rectangle to redraw.</param>
<param name="y">x coordinate of upper-left corner of rectangle to redraw.</param>
<param name="width">Width of region to draw.</param>
<param name="height">Height of region to draw.</param>
<remarks>
<para>
Invalidates the rectangular area of widget defined by <paramref name="x"/>, <paramref name="y"/>, <paramref name="width"/> and <paramref name="height"/> by calling <see cref="M:Gdk.Window.InvalidateRect"/> on the widget's window and all its child windows. Once the main loop becomes idle (after the current batch of events has been processed, roughly), the window will receive <see cref="F:Gtk.Widget.ExposeEvent"/> events for the union of all regions that have been invalidated.
Invalidates the rectangular area of widget defined by <paramref name="x" />, <paramref name="y" />, <paramref name="width" /> and <paramref name="height" /> by calling <see cref="M:Gdk.Window.InvalidateRect" /> on the widget's window and all its child windows. Once the main loop becomes idle (after the current batch of events has been processed, roughly), the window will receive <see cref="F:Gtk.Widget.ExposeEvent" /> events for the union of all regions that have been invalidated.
</para>
<para>
Normally you would only use this function in widget implementations. You might also use it, or <see cref="M:Gdk.Window.InvalidateRect"/> directly, to schedule a redraw of a <see cref="T:Gtk.DrawingArea"/> or some portion thereof. Frequently you can just call <see cref="M:Gdk.Window.InvalidateRect"/> or <see cref="M:Gdk.Window.InvalidateRegion"/> instead of this function. Those functions will invalidate only a single window, instead of the widget and all its children.
Normally you would only use this function in widget implementations. You might also use it, or <see cref="M:Gdk.Window.InvalidateRect" /> directly, to schedule a redraw of a <see cref="T:Gtk.DrawingArea" /> or some portion thereof. Frequently you can just call <see cref="M:Gdk.Window.InvalidateRect" /> or <see cref="M:Gdk.Window.InvalidateRegion" /> instead of this function. Those functions will invalidate only a single window, instead of the widget and all its children.
</para>
<para>
The advantage of adding to the invalidated region compared to simply drawing immediately is efficiency; using an invalid region ensures that you only have to redraw one time.
@ -296,12 +298,12 @@
<Parameter Name="color" Type="Gdk.Color" />
</Parameters>
<Docs>
<summary>Sets the foreground <paramref name="color"/> for a <paramref name="widget"/> in a particular <paramref name="state"/>.</summary>
<summary>Sets the foreground <paramref name="color" /> for a <paramref name="widget" /> in a particular <paramref name="state" />.</summary>
<param name="state">The state for which to set the background color.</param>
<param name="color">The color to assign (does not need to be allocated), or <see cref="langword:null"/> to undo the effect of previous calls to of <see cref="M:Gtk.Widget.ModifyFg"/>.</param>
<param name="color">The color to assign (does not need to be allocated), or <see cref="langword:null" /> to undo the effect of previous calls to of <see cref="M:Gtk.Widget.ModifyFg" />.</param>
<remarks>
<para>
All other style values are left untouched. See also <see cref="M:Gdk.Widget.ModifyStyle"/>.
All other style values are left untouched. See also <see cref="M:Gdk.Widget.ModifyStyle" />.
</para>
</remarks>
</Docs>
@ -318,17 +320,17 @@
<Parameter Name="detail" Type="System.String" />
</Parameters>
<Docs>
<summary>A convenience function that uses the theme engine and RC file settings for <paramref name="widget"/> to look up <paramref name="stock_id"/> and render it to a <see cref="T:Gdk.Pixbuf"/>.</summary>
<summary>A convenience function that uses the theme engine and RC file settings for <paramref name="widget" /> to look up <paramref name="stock_id" /> and render it to a <see cref="T:Gdk.Pixbuf" />.</summary>
<param name="stock_id">A stock ID.</param>
<param name="size">A stock size.</param>
<param name="detail">Render detail to pass to theme engine.</param>
<returns>A new <see cref="T:Gdk.Pixbuf"/>, or <see cref="langword:null"/> if the <paramref name="stock_id"/> wasn't known.</returns>
<returns>A new <see cref="T:Gdk.Pixbuf" />, or <see cref="langword:null" /> if the <paramref name="stock_id" /> wasn't known.</returns>
<remarks>
<para>
The <paramref name="stock_id"/> should be a stock icon ID such as <see cref="P:Gtk.Stock.Open"/> or <see cref="P:Gtk.Stock.Ok"/>. <paramref name="size"/> should be a size such as <see cref="F:Gtk.IconSize.Menu"/>. <paramref name="detail"/> should be a string that identifies the widget or code doing the rendering, so that theme engines can special-case rendering for that widget or code.
The <paramref name="stock_id" /> should be a stock icon ID such as <see cref="P:Gtk.Stock.Open" /> or <see cref="P:Gtk.Stock.Ok" />. <paramref name="size" /> should be a size such as <see cref="F:Gtk.IconSize.Menu" />. <paramref name="detail" /> should be a string that identifies the widget or code doing the rendering, so that theme engines can special-case rendering for that widget or code.
</para>
<para>
The pixels in the returned <see cref="T:Gdk.Pixbuf"/> are shared with the rest of the application and should not be modified. The <see cref="T:Gdk.Pixbuf"/> should be freed after use with <see cref="M:Glib.Object.Unref"/>.
The pixels in the returned <see cref="T:Gdk.Pixbuf" /> are shared with the rest of the application and should not be modified. The <see cref="T:Gdk.Pixbuf" /> should be freed after use with <see cref="M:Glib.Object.Unref" />.
</para>
</remarks>
</Docs>
@ -344,12 +346,12 @@
<Parameter Name="value" Type="GLib.Value" />
</Parameters>
<Docs>
<summary>Gets the <paramref name="value"/> of a style property of <paramref name="widget"/>.</summary>
<summary>Gets the <paramref name="value" /> of a style property of <paramref name="widget" />.</summary>
<param name="property_name">The name of a style property.</param>
<param name="value">Location to return the property value.</param>
<remarks>
<para>
Gets the <paramref name="value"/> of a style property of <paramref name="widget"/>.
Gets the <paramref name="value" /> of a style property of <paramref name="widget" />.
</para>
</remarks>
</Docs>
@ -365,12 +367,12 @@
<Parameter Name="var_args" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Gets the values of a multiple style properties of <paramref name="widgets"/>.</summary>
<summary>Gets the values of a multiple style properties of <paramref name="widgets" />.</summary>
<param name="first_property_name">The name of the first property to get.</param>
<param name="var_args">A va_list of pairs of property names and locations to return the property values, starting with the location for <paramref name="first_property_name"/>.</param>
<param name="var_args">A va_list of pairs of property names and locations to return the property values, starting with the location for <paramref name="first_property_name" />.</param>
<remarks>
<para>
Gets the values of a multiple style properties of <paramref name="widget"/>. Used primarily by language bindings.
Gets the values of a multiple style properties of <paramref name="widget" />. Used primarily by language bindings.
</para>
</remarks>
</Docs>
@ -383,10 +385,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Recursively shows a <paramref name="widget"/>, and any child <paramref name="widgets"/> (if the widget is a container).</summary>
<summary>Recursively shows a <paramref name="widget" />, and any child <paramref name="widgets" /> (if the widget is a container).</summary>
<remarks>
<para>
Recursively shows a <paramref name="widget"/>, and any child <paramref name="widgets"/> (if the widget is a container).
Recursively shows a <paramref name="widget" />, and any child <paramref name="widgets" /> (if the widget is a container).
</para>
</remarks>
</Docs>
@ -402,12 +404,12 @@
<Parameter Name="color" Type="Gdk.Color" />
</Parameters>
<Docs>
<summary>Sets the text <paramref name="color"/> for a <paramref name="widget"/> in a particular state.</summary>
<summary>Sets the text <paramref name="color" /> for a <paramref name="widget" /> in a particular state.</summary>
<param name="state">The state for which to set the text color.</param>
<param name="color">The color to assign (does not need to be allocated), or <see cref="langword:null"/> to undo the effect of previous calls to of <see cref="M:Gtk.Widget.ModifyText"/>.</param>
<param name="color">The color to assign (does not need to be allocated), or <see cref="langword:null" /> to undo the effect of previous calls to of <see cref="M:Gtk.Widget.ModifyText" />.</param>
<remarks>
<para>
All other style values are left untouched. The text color is the foreground color used along with the base color (see <see cref="M:Gtk.Widget.ModifyBase"/>) for widgets such as <see cref="T:Gtk.Entry"/> and <see cref="T:Gtk.TextView"/>. See also <see cref="M:Gtk.Widget.ModifyStyle"/>.
All other style values are left untouched. The text color is the foreground color used along with the base color (see <see cref="M:Gtk.Widget.ModifyBase" />) for widgets such as <see cref="T:Gtk.Entry" /> and <see cref="T:Gtk.TextView" />. See also <see cref="M:Gtk.Widget.ModifyStyle" />.
</para>
</remarks>
</Docs>
@ -420,11 +422,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates a new <see cref="P:Gtk.Widget.PangoContext"/> with the appropriate colormap, font description, and base direction for drawing text for <paramref name="widget"/>.</summary>
<returns>The new <see cref="P:Gtk.Widget.PangoContext"/>.</returns>
<summary>Creates a new <see cref="P:Gtk.Widget.PangoContext" /> with the appropriate colormap, font description, and base direction for drawing text for <paramref name="widget" />.</summary>
<returns>The new <see cref="P:Gtk.Widget.PangoContext" />.</returns>
<remarks>
<para>
See also <see cref="P:Gtk.Widget.PangoContext"/>.
See also <see cref="P:Gtk.Widget.PangoContext" />.
</para>
</remarks>
</Docs>
@ -437,11 +439,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Utility function; intended to be connected to the <see cref="F:Gtk.Widget.DeleteEvent"/> signal on a <see cref="T:Gtk.Window"/>.</summary>
<returns>Returns <see cref="langword:true"/>.</returns>
<summary>Utility function; intended to be connected to the <see cref="F:Gtk.Widget.DeleteEvent" /> signal on a <see cref="T:Gtk.Window" />.</summary>
<returns>Returns <see cref="langword:true" />.</returns>
<remarks>
<para>
The function calls <see cref="M:Gtk.Widget.Hide"/> on its argument, then returns <see cref="langword:true"/>. If connected to <see cref="F:Gtk.Widget.DeleteEvent"/>, the result is that clicking the close button for a window (on the window frame, top right corner usually) will hide but not destroy the window. By default, GTK+ destroys windows when <see cref="F:Gtk.Widget.DeleteEvent"/> is received.
The function calls <see cref="M:Gtk.Widget.Hide" /> on its argument, then returns <see cref="langword:true" />. If connected to <see cref="F:Gtk.Widget.DeleteEvent" />, the result is that clicking the close button for a window (on the window frame, top right corner usually) will hide but not destroy the window. By default, GTK+ destroys windows when <see cref="F:Gtk.Widget.DeleteEvent" /> is received.
</para>
</remarks>
</Docs>
@ -456,11 +458,11 @@
<Parameter Name="requisition" Type="Gtk.Requisition" />
</Parameters>
<Docs>
<summary>Obtains <paramref name="widget"/>-><paramref name="requisition"/>.</summary>
<param name="requisition">A <see cref="T:Gtk.Requisition"/> to be filled in.</param>
<summary>Obtains <paramref name="widget" />-&gt;<paramref name="requisition" />.</summary>
<param name="requisition">A <see cref="T:Gtk.Requisition" /> to be filled in.</param>
<remarks>
<para>
Obtains <paramref name="widget"/>-><paramref name="requisition"/>, unless someone has forced a particular geometry on the widget, in which case it returns that geometry instead of the widget's <paramref name="requisition"/>. This function differs from <see cref="M:Gtk.Widget.SizeRequest"/> in that it retrieves the last size request value from <paramref name="widget"/>-><paramref name="requisition"/>, while the <see cref="M:Gtk.Widget.SizeRequest"/> method computes the size request and fill in <paramref name="widget"/>-><paramref name="requisition"/>, and only then returns <paramref name="widget"/>-><paramref name="requisition"/>.
Obtains <paramref name="widget" />-&gt;<paramref name="requisition" />, unless someone has forced a particular geometry on the widget, in which case it returns that geometry instead of the widget's <paramref name="requisition" />. This function differs from <see cref="M:Gtk.Widget.SizeRequest" /> in that it retrieves the last size request value from <paramref name="widget" />-&gt;<paramref name="requisition" />, while the <see cref="M:Gtk.Widget.SizeRequest" /> method computes the size request and fill in <paramref name="widget" />-&gt;<paramref name="requisition" />, and only then returns <paramref name="widget" />-&gt;<paramref name="requisition" />.
</para>
</remarks>
</Docs>
@ -476,12 +478,12 @@
<Parameter Name="y" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Obtains the location of the mouse pointer in <paramref name="widget"/> coordinates.</summary>
<param name="x">Return location for the X coordinate, or <see cref="langword:null"/>.</param>
<param name="y">Return location for the Y coordinate, or <see cref="langword:null"/>.</param>
<summary>Obtains the location of the mouse pointer in <paramref name="widget" /> coordinates.</summary>
<param name="x">Return location for the X coordinate, or <see cref="langword:null" />.</param>
<param name="y">Return location for the Y coordinate, or <see cref="langword:null" />.</param>
<remarks>
<para>
Widget coordinates are a bit odd; for historical reasons, they are defined as <paramref name="widget"/>->window coordinates for widgets that are not <see cref="F:Gtk.WidgetFlags.NoWindow"/> widgets, and are relative to <paramref name="widget"/>->allocation.x, <paramref name="widget"/>->allocation.y for widgets that are <see cref="F:Gtk.WidgetFlags.NoWindow"/> widgets.
Widget coordinates are a bit odd; for historical reasons, they are defined as <paramref name="widget" />-&gt;window coordinates for widgets that are not <see cref="F:Gtk.WidgetFlags.NoWindow" /> widgets, and are relative to <paramref name="widget" />-&gt;allocation.x, <paramref name="widget" />-&gt;allocation.y for widgets that are <see cref="F:Gtk.WidgetFlags.NoWindow" /> widgets.
</para>
</remarks>
</Docs>
@ -494,10 +496,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Causes a <paramref name="widget"/> to have the keyboard focus for the <see cref="T:Gtk.Window"/> it's inside.</summary>
<summary>Causes a <paramref name="widget" /> to have the keyboard focus for the <see cref="T:Gtk.Window" /> it's inside.</summary>
<remarks>
<para>
The <paramref name="widget"/> must be a focusable widget, such as a <see cref="T:Gtk.Entry"/>; something like <see cref="T:Gtk.Frame"/> won't work (More precisely, it must have the <see cref="P:Gtk.Widget.CanFocus"/> flag set).
The <paramref name="widget" /> must be a focusable widget, such as a <see cref="T:Gtk.Entry" />; something like <see cref="T:Gtk.Frame" /> won't work (More precisely, it must have the <see cref="P:Gtk.Widget.CanFocus" /> flag set).
</para>
</remarks>
</Docs>
@ -510,10 +512,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Equivalent to calling <see cref="M:Gtk.Widget.QueueDrawArea"/> for the entire area of a <paramref name="widget"/>.</summary>
<summary>Equivalent to calling <see cref="M:Gtk.Widget.QueueDrawArea" /> for the entire area of a <paramref name="widget" />.</summary>
<remarks>
<para>
Equivalent to calling <see cref="M:Gtk.Widget.QueueDrawArea"/> for the entire area of a <paramref name="widget"/>.
Equivalent to calling <see cref="M:Gtk.Widget.QueueDrawArea" /> for the entire area of a <paramref name="widget" />.
</para>
</remarks>
</Docs>
@ -526,11 +528,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Determines if the <paramref name="widget"/> is the focus widget within its toplevel.</summary>
<returns><see cref="langword:true"/> if the widget is the focus widget.</returns>
<summary>Determines if the <paramref name="widget" /> is the focus widget within its toplevel.</summary>
<returns>
<see cref="langword:true" /> if the widget is the focus widget.</returns>
<remarks>
<para>
This does not mean that the <see cref="P:Gtk.Widget.HasFocus"/> flag is necessarily set; <see cref="P:Gtk.Widget.HasFocus"/> will only be set if the toplevel widget additionally has the global input focus.
This does not mean that the <see cref="P:Gtk.Widget.HasFocus" /> flag is necessarily set; <see cref="P:Gtk.Widget.HasFocus" /> will only be set if the toplevel widget additionally has the global input focus.
</para>
</remarks>
</Docs>
@ -546,15 +549,15 @@
<Parameter Name="accel_group" Type="Gtk.AccelGroup" />
</Parameters>
<Docs>
<summary>Given an accelerator group, <paramref name="accel_group"/>, and an accelerator path, <paramref name="accel_path"/>, sets up an accelerator in <paramref name="accel_group"/> so whenever the key binding that is defined for <paramref name="accel_path"/> is pressed, <paramref name="widget"/> will be activated.</summary>
<summary>Given an accelerator group, <paramref name="accel_group" />, and an accelerator path, <paramref name="accel_path" />, sets up an accelerator in <paramref name="accel_group" /> so whenever the key binding that is defined for <paramref name="accel_path" /> is pressed, <paramref name="widget" /> will be activated.</summary>
<param name="accel_path">Path used to look up the the accelerator.</param>
<param name="accel_group">A <see cref="T:Gtk.AccelGroup"/>.</param>
<param name="accel_group">A <see cref="T:Gtk.AccelGroup" />.</param>
<remarks>
<para>
This removes any accelerators (for any accelerator group) installed by previous calls to <see cref="M:Gtk.Widget.SetAccelPath"/>. Associating accelerators with paths allows them to be modified by the user and the modifications to be saved for future use.
This removes any accelerators (for any accelerator group) installed by previous calls to <see cref="M:Gtk.Widget.SetAccelPath" />. Associating accelerators with paths allows them to be modified by the user and the modifications to be saved for future use.
</para>
<para>
This function is a low level function that would most likely be used by a menu creation system like <see cref="T:Gtk.ItemFactory"/>. If you use <see cref="T:Gtk.ItemFactory"/>, setting up accelerator paths will be done automatically.
This function is a low level function that would most likely be used by a menu creation system like <see cref="T:Gtk.ItemFactory" />. If you use <see cref="T:Gtk.ItemFactory" />, setting up accelerator paths will be done automatically.
</para>
</remarks>
</Docs>
@ -573,7 +576,7 @@
<Parameter Name="accel_flags" Type="Gtk.AccelFlags" />
</Parameters>
<Docs>
<summary>Installs an accelerator for this <paramref name="widget"/> in <paramref name="accel-group"/> that causes <paramref name="accel_signal"/> to be emitted if the accelerator is activated.</summary>
<summary>Installs an accelerator for this <paramref name="widget" /> in <paramref name="accel-group" /> that causes <paramref name="accel_signal" /> to be emitted if the accelerator is activated.</summary>
<param name="accel_signal">Widget signal to emit on accelerator activation.</param>
<param name="accel_group">Accel group for this widget, added to its toplevel.</param>
<param name="accel_key">GDK keyval of the accelerator.</param>
@ -581,10 +584,10 @@
<param name="accel_flags">Flag accelerators.</param>
<remarks>
<para>
The <paramref name="accel-group"/> needs to be added to the widget's toplevel via <see cref="M:Gtk.Window.AddAccelGroup"/>, and the signal must be of type G_RUN_ACTION. Accelerators added through this function are not user changeable during runtime.
The <paramref name="accel-group" /> needs to be added to the widget's toplevel via <see cref="M:Gtk.Window.AddAccelGroup" />, and the signal must be of type G_RUN_ACTION. Accelerators added through this function are not user changeable during runtime.
</para>
<para>
Accelerators added through this function are not user changeable during runtime. If you want to support accelerators that can be changed by the user, use <see cref="M:Gtk.Window.SetAccelPath"/> instead.
Accelerators added through this function are not user changeable during runtime. If you want to support accelerators that can be changed by the user, use <see cref="M:Gtk.Window.SetAccelPath" /> instead.
</para>
</remarks>
</Docs>
@ -597,10 +600,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Flags a <paramref name="widget"/> to be displayed.</summary>
<summary>Flags a <paramref name="widget" /> to be displayed.</summary>
<remarks>
<para>
Any widget that isn't shown will not appear on the screen. If you want to show all the widgets in a container, it's easier to call <see cref="M:Gtk.Widget.ShowAll"/> on the container, instead of individually showing the widgets.
Any widget that isn't shown will not appear on the screen. If you want to show all the widgets in a container, it's easier to call <see cref="M:Gtk.Widget.ShowAll" /> on the container, instead of individually showing the widgets.
</para>
<para>
Remember that you have to show the containers containing a widget, in addition to the widget itself, before it will appear onscreen. And that when a toplevel container is shown, it is immediately realized and mapped; other shown widgets are realized and mapped when their toplevel container is realized and mapped.
@ -619,13 +622,13 @@
<Parameter Name="vadjustment" Type="Gtk.Adjustment" />
</Parameters>
<Docs>
<summary>For <paramref name="widgets"/> that support scrolling, sets the scroll adjustments.</summary>
<param name="hadjustment">An adjustment for horizontal scrolling, or <see cref="langword:null"/>.</param>
<param name="vadjustment">An adjustment for vertical scrolling, or <see cref="langword:null"/>.</param>
<returns>Returns <see cref="langword:true"/> if the widget supports scrolling.</returns>
<summary>For <paramref name="widgets" /> that support scrolling, sets the scroll adjustments.</summary>
<param name="hadjustment">An adjustment for horizontal scrolling, or <see cref="langword:null" />.</param>
<param name="vadjustment">An adjustment for vertical scrolling, or <see cref="langword:null" />.</param>
<returns>Returns <see cref="langword:true" /> if the widget supports scrolling.</returns>
<remarks>
<para>
For <paramref name="widgets"/> that don't support scrolling, does nothing and returns <see cref="langword:false"/>. <paramref name="Widgets"/> that don't support scrolling can be scrolled by placing them in a <see cref="T:Gtk.ViewPort"/>, which does support scrolling.
For <paramref name="widgets" /> that don't support scrolling, does nothing and returns <see cref="langword:false" />. <paramref name="Widgets" /> that don't support scrolling can be scrolled by placing them in a <see cref="T:Gtk.ViewPort" />, which does support scrolling.
</para>
</remarks>
</Docs>
@ -640,12 +643,12 @@
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Pango.Layout"/> with the appropriate colormap, font description, and base direction for drawing text for <paramref name="widget"/>.</summary>
<param name="text"> text to set on the layout (can be <see cref="langword:null"/>).</param>
<returns>The new <see cref="T:Pango.Layout"/>.</returns>
<summary>Creates a new <see cref="T:Pango.Layout" /> with the appropriate colormap, font description, and base direction for drawing text for <paramref name="widget" />.</summary>
<param name="text"> text to set on the layout (can be <see cref="langword:null" />).</param>
<returns>The new <see cref="T:Pango.Layout" />.</returns>
<remarks>
<para>
If you keep a <see cref="T:Pango.Layout"/> created in this way around, in order notify the layout of changes to the base direction or font of this widget, you must call <see cref="M:Pango.Layout.ContextChanged"/> in response to the <see cref="F:Gtk.Widget.StyleSet"/> and <see cref="F:Gtk-Widget.DirectionChanged"/> signals for the widget.
If you keep a <see cref="T:Pango.Layout" /> created in this way around, in order notify the layout of changes to the base direction or font of this widget, you must call <see cref="M:Pango.Layout.ContextChanged" /> in response to the <see cref="F:Gtk.Widget.StyleSet" /> and <see cref="F:Gtk-Widget.DirectionChanged" /> signals for the widget.
</para>
</remarks>
</Docs>
@ -658,7 +661,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Reset the styles of <paramref name="widget"/> and all descendents, so when they are looked up again, they get the correct values for the currently loaded RC file settings.</summary>
<summary>Reset the styles of <paramref name="widget" /> and all descendents, so when they are looked up again, they get the correct values for the currently loaded RC file settings.</summary>
<remarks>
<para>
This function is not useful for applications.
@ -676,14 +679,14 @@
<Parameter Name="requisition" Type="Gtk.Requisition" />
</Parameters>
<Docs>
<summary>Obtains the preferred size of a <paramref name="widget"/>.</summary>
<param name="requisition">A <see cref="T:Gtk.Requisition"/> to be filled in.</param>
<summary>Obtains the preferred size of a <paramref name="widget" />.</summary>
<param name="requisition">A <see cref="T:Gtk.Requisition" /> to be filled in.</param>
<remarks>
<para>
The container uses this information to arrange its child widgets and decide what size allocations to give them with <see cref="M:Gtk.Widget.SizeAllocate"/>. You can also call this function from an application, with some caveats. Most notably, getting a size request requires the widget to be associated with a screen, because font information may be needed. Multihead-aware applications should keep this in mind.
The container uses this information to arrange its child widgets and decide what size allocations to give them with <see cref="M:Gtk.Widget.SizeAllocate" />. You can also call this function from an application, with some caveats. Most notably, getting a size request requires the widget to be associated with a screen, because font information may be needed. Multihead-aware applications should keep this in mind.
</para>
<para>
This function is typically used when implementing a <see cref="T:Gtk.Container"/> subclass. Also remember that the size request is not necessarily the size a widget will actually be allocated.
This function is typically used when implementing a <see cref="T:Gtk.Container" /> subclass. Also remember that the size request is not necessarily the size a widget will actually be allocated.
</para>
</remarks>
</Docs>
@ -702,13 +705,13 @@
<Parameter Name="dest_y" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Translate coordinates relative to <paramref name="widget"/>'s allocation to coordinates relative to <paramref name="dest_widget"/>'s allocations.</summary>
<param name="dest_widget">A <see cref="T:Gtk.Widget"/>.</param>
<summary>Translate coordinates relative to <paramref name="widget" />'s allocation to coordinates relative to <paramref name="dest_widget" />'s allocations.</summary>
<param name="dest_widget">A <see cref="T:Gtk.Widget" />.</param>
<param name="src_x">X position relative to source widget.</param>
<param name="src_y">Y position relative to source widget.</param>
<param name="dest_x">Location to store X position relative to <paramref name="dest_widget"/>.</param>
<param name="dest_y">Location to store Y position relative to <paramref name="dest_widget"/>.</param>
<returns>Returns <see cref="langword:false"/> if either widget was not realized, or there was no common ancestor. In this case, nothing is stored in <paramref name="*dest_x"/> and <paramref name="*dest_y"/>. Otherwise <see cref="langword:true"/>.</returns>
<param name="dest_x">Location to store X position relative to <paramref name="dest_widget" />.</param>
<param name="dest_y">Location to store Y position relative to <paramref name="dest_widget" />.</param>
<returns>Returns <see cref="langword:false" /> if either widget was not realized, or there was no common ancestor. In this case, nothing is stored in <paramref name="*dest_x" /> and <paramref name="*dest_y" />. Otherwise <see cref="langword:true" />.</returns>
<remarks>
<para>
In order to perform this operation, both widgets must be realized, and must share a common toplevel.
@ -724,11 +727,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>For <paramref name="widgets"/> that can be "activated" (buttons, menu items, etc.) this function activates them.</summary>
<returns>Returns <see cref="langword:true"/> if the widget was activatable.</returns>
<summary>For <paramref name="widgets" /> that can be "activated" (buttons, menu items, etc.) this function activates them.</summary>
<returns>Returns <see cref="langword:true" /> if the widget was activatable.</returns>
<remarks>
<para>
Activation is what happens when you press Enter on a widget during key navigation; clicking a button, selecting a menu item, etc. If the <paramref name="widget"/> isn't activatable, the function returns <see cref="langword:false"/>.
Activation is what happens when you press Enter on a widget during key navigation; clicking a button, selecting a menu item, etc. If the <paramref name="widget" /> isn't activatable, the function returns <see cref="langword:false" />.
</para>
</remarks>
</Docs>
@ -744,12 +747,12 @@
<Parameter Name="color" Type="Gdk.Color" />
</Parameters>
<Docs>
<summary>Sets the background color for a <paramref name="widget"/> in a particular state.</summary>
<summary>Sets the background color for a <paramref name="widget" /> in a particular state.</summary>
<param name="state">The state for which to set the background color.</param>
<param name="color">The color to assign (does not need to be allocated), or <see cref="langword:null"/> to undo the effect of previous calls of <see cref="M:Gtk.Widget.ModifyBg"/>.</param>
<param name="color">The color to assign (does not need to be allocated), or <see cref="langword:null" /> to undo the effect of previous calls of <see cref="M:Gtk.Widget.ModifyBg" />.</param>
<remarks>
<para>
All other style values are left untouched. See also <see cref="M:Gtk.Widget.ModifyStyle"/>.
All other style values are left untouched. See also <see cref="M:Gtk.Widget.ModifyStyle" />.
</para>
</remarks>
</Docs>
@ -764,12 +767,12 @@
<Parameter Name="evnt" Type="Gdk.Event" />
</Parameters>
<Docs>
<summary>Rarely-used function. This function is used to emit the event signals on a <paramref name="widget"/>.</summary>
<param name="evnt">A <see cref="T:Gdk.Event"/>.</param>
<returns>Return from the event signal emission (<see cref="langword:true"/> if the event was handled)</returns>
<summary>Rarely-used function. This function is used to emit the event signals on a <paramref name="widget" />.</summary>
<param name="evnt">A <see cref="T:Gdk.Event" />.</param>
<returns>Return from the event signal emission (<see cref="langword:true" /> if the event was handled)</returns>
<remarks>
<para>
If you want to synthesize an event though, don't use this function; instead, use <see cref="M:Gdk.Windowt.InvalidateRect"/> to invalidate a region of the window.
If you want to synthesize an event though, don't use this function; instead, use <see cref="M:Gdk.Windowt.InvalidateRect" /> to invalidate a region of the window.
</para>
</remarks>
</Docs>
@ -782,10 +785,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Reverses the effects of <see cref="M:Gtk.Widget.Show"/>, causing the <paramref name="widget"/> to be hidden (invisible to the user).</summary>
<summary>Reverses the effects of <see cref="M:Gtk.Widget.Show" />, causing the <paramref name="widget" /> to be hidden (invisible to the user).</summary>
<remarks>
<para>
Reverses the effects of <see cref="M:Gtk.Widget.Show"/>, causing the widget to be hidden (invisible to the user).
Reverses the effects of <see cref="M:Gtk.Widget.Show" />, causing the widget to be hidden (invisible to the user).
</para>
</remarks>
</Docs>
@ -801,12 +804,12 @@
<Parameter Name="color" Type="Gdk.Color" />
</Parameters>
<Docs>
<summary>Sets the base color for a <paramref name="widget"/> in a particular state.</summary>
<summary>Sets the base color for a <paramref name="widget" /> in a particular state.</summary>
<param name="state">The state for which to set the base color.</param>
<param name="color">The color to assign (does not need to be allocated), or <see cref="langword:null"/> to undo the effect of previous calls to of <see cref="M:Gtk.Widget.ModifyBase"/>.</param>
<param name="color">The color to assign (does not need to be allocated), or <see cref="langword:null" /> to undo the effect of previous calls to of <see cref="M:Gtk.Widget.ModifyBase" />.</param>
<remarks>
<para>
All other style values are left untouched. The base color is the background color used along with the text color (see <see cref="M:Gtk.Widget.ModifyText"/>) for widgets such as <see cref="T:Gtk.Entry"/> and <see cref="T:Gtk.TextView"/>. See also <see cref="M:Gtk.Widget.ModifyStyle"/>.
All other style values are left untouched. The base color is the background color used along with the text color (see <see cref="M:Gtk.Widget.ModifyText" />) for widgets such as <see cref="T:Gtk.Entry" /> and <see cref="T:Gtk.TextView" />. See also <see cref="M:Gtk.Widget.ModifyStyle" />.
</para>
</remarks>
</Docs>
@ -821,12 +824,12 @@
<Parameter Name="widget_type" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Gets the first ancestor of <paramref name="widget"/> with type <paramref name="widget_type"/>.</summary>
<summary>Gets the first ancestor of <paramref name="widget" /> with type <paramref name="widget_type" />.</summary>
<param name="widget_type">Ancestor type.</param>
<returns>The ancestor widget, or <see cref="langword:null"/> if not found</returns>
<returns>The ancestor widget, or <see cref="langword:null" /> if not found</returns>
<remarks>
<para>
For example, <see cref="M:Gtk.Widget.GetAncestor"/>(widget, GTK_TYPE_BOX) gets the first <see cref="T:Gtk.Box"/> that's an ancestor of <paramref name="widget"/>. No reference will be added to the returned widget; it should not be unreferenced. See note about checking for a toplevel <see cref="T:Gtk.Window"/> in the docs for <see cref="M:Gtk.Widget.Toplevel"/>. Note that unlike <see cref="M:Gtk.Widget.IsAncestor"/>, <see cref="M:Gtk.Widget.GetAncestor"/> considers <paramref name="widget"/> to be an ancestor of itself.
For example, <see cref="M:Gtk.Widget.GetAncestor" />(widget, GTK_TYPE_BOX) gets the first <see cref="T:Gtk.Box" /> that's an ancestor of <paramref name="widget" />. No reference will be added to the returned widget; it should not be unreferenced. See note about checking for a toplevel <see cref="T:Gtk.Window" /> in the docs for <see cref="M:Gtk.Widget.Toplevel" />. Note that unlike <see cref="M:Gtk.Widget.IsAncestor" />, <see cref="M:Gtk.Widget.GetAncestor" /> considers <paramref name="widget" /> to be an ancestor of itself.
</para>
</remarks>
</Docs>
@ -839,7 +842,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Recursively resets the shape on <paramref name="widget"/> and its descendants.</summary>
<summary>Recursively resets the shape on <paramref name="widget" /> and its descendants.</summary>
<remarks>
<para>
Recursively resets the shape on this widget and its descendants.
@ -857,14 +860,14 @@
<Parameter Name="style" Type="Gtk.RcStyle" />
</Parameters>
<Docs>
<summary>Modifies style values on the <paramref name="widget"/>.</summary>
<param name="style">The <see cref="T:Gtk.RcStyle"/> holding the style modifications.</param>
<summary>Modifies style values on the <paramref name="widget" />.</summary>
<param name="style">The <see cref="T:Gtk.RcStyle" /> holding the style modifications.</param>
<remarks>
<para>
Modifications made using this technique take precedence over style values set via an RC file, however, they will be overriden if a <paramref name="style"/> is explicitely set on the <paramref name="widget"/> using <see cref="M:Gtk.Widget.StyleSet"/>. The <see cref="T:Gtk.RcStyle"/> structure is designed so each field can either be set or unset, so it is possible, using this function, to modify some style values and leave the others unchanged.
Modifications made using this technique take precedence over style values set via an RC file, however, they will be overriden if a <paramref name="style" /> is explicitely set on the <paramref name="widget" /> using <see cref="M:Gtk.Widget.StyleSet" />. The <see cref="T:Gtk.RcStyle" /> structure is designed so each field can either be set or unset, so it is possible, using this function, to modify some style values and leave the others unchanged.
</para>
<para>
Note that modifications made with this function are not cumulative with previous calls to <see cref="M:Gtk.Widget.ModifyStyle"/> or with such functions as <see cref="M:Gtk.Widget.ModifyBg"/>. If you wish to retain previous values, you must first call <see cref="M:Gtk.Widget.ModifierStyle"/>, make your modifications to the returned <paramref name="style"/>, then call <see cref="M:Gtk.Widget.ModifyStyle"/> with that <paramref name="style"/>. On the other hand, if you first call <see cref="M:Gtk.Widget.ModifyStyle"/>, subsequent calls to such functions <see cref="M:Gtk.Widget.ModifyFg"/> will have a cumulative effect with the initial modifications.
Note that modifications made with this function are not cumulative with previous calls to <see cref="M:Gtk.Widget.ModifyStyle" /> or with such functions as <see cref="M:Gtk.Widget.ModifyBg" />. If you wish to retain previous values, you must first call <see cref="M:Gtk.Widget.ModifierStyle" />, make your modifications to the returned <paramref name="style" />, then call <see cref="M:Gtk.Widget.ModifyStyle" /> with that <paramref name="style" />. On the other hand, if you first call <see cref="M:Gtk.Widget.ModifyStyle" />, subsequent calls to such functions <see cref="M:Gtk.Widget.ModifyFg" /> will have a cumulative effect with the initial modifications.
</para>
</remarks>
</Docs>
@ -880,12 +883,12 @@
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Sets the minimum size of a <paramref name="widget"/>; that is, the <paramref name="widget"/>'s size request will be <paramref name="width"/> by <paramref name="height"/>.</summary>
<param name="width">Width <paramref name="widget"/> should request, or -1 to unset.</param>
<param name="height">Weight <paramref name="widget"/> should request, or -1 to unset.</param>
<summary>Sets the minimum size of a <paramref name="widget" />; that is, the <paramref name="widget" />'s size request will be <paramref name="width" /> by <paramref name="height" />.</summary>
<param name="width">Width <paramref name="widget" /> should request, or -1 to unset.</param>
<param name="height">Weight <paramref name="widget" /> should request, or -1 to unset.</param>
<remarks>
<para>
You can use this function to force a widget to be either larger or smaller than it normally would be. In most cases, <see cref="M:Gtk.Window.SetDefaultSize"/> is a better choice for toplevel windows than this function; setting the default size will still allow users to shrink the window. Setting the size request will force them to leave the window at least as large as the size request. When dealing with window sizes, <see cref="M:Gtk.Window.SetGeometryHints"/> can be a useful function as well.
You can use this function to force a widget to be either larger or smaller than it normally would be. In most cases, <see cref="M:Gtk.Window.SetDefaultSize" /> is a better choice for toplevel windows than this function; setting the default size will still allow users to shrink the window. Setting the size request will force them to leave the window at least as large as the size request. When dealing with window sizes, <see cref="M:Gtk.Window.SetGeometryHints" /> can be a useful function as well.
</para>
<para>
Note the inherent danger of setting any fixed size - themes, translations into other languages, different fonts, and user action can all change the appropriate size for a given widget. So, it's basically impossible to hardcode a size that will always be correct. The size request of a widget is the smallest size a widget can accept while still functioning well and drawing itself correctly. However in some strange cases a widget may be allocated less than its requested size, and in many cases a widget may be allocated more space than it requested.
@ -920,12 +923,12 @@
<Parameter Name="height" Type="System.Int32&amp;" />
</Parameters>
<Docs>
<summary>Gets the size request that was explicitly set for the <paramref name="widget"/> using <see cref="M:Gtk.Widget.SetSizeRequest"/>.</summary>
<param name="width">Return location for width, or <see cref="langword:null"/>.</param>
<param name="height">Return location for height, or <see cref="langword:null"/>.</param>
<summary>Gets the size request that was explicitly set for the <paramref name="widget" /> using <see cref="M:Gtk.Widget.SetSizeRequest" />.</summary>
<param name="width">Return location for width, or <see cref="langword:null" />.</param>
<param name="height">Return location for height, or <see cref="langword:null" />.</param>
<remarks>
<para>
A value of -1 stored in <paramref name="width"/> or <paramref name="height"/> indicates that that dimension has not been set explicitly and the natural requisition of the <paramref name="widget"/> will be used intead. See <see cref="M:Gtk.Widget.SetSizeRequest"/>. To get the size a <paramref name="widget"/> will actually use, call <see cref="M:Gtk.Widget.SizeRequest"/> instead of this function.
A value of -1 stored in <paramref name="width" /> or <paramref name="height" /> indicates that that dimension has not been set explicitly and the natural requisition of the <paramref name="widget" /> will be used intead. See <see cref="M:Gtk.Widget.SetSizeRequest" />. To get the size a <paramref name="widget" /> will actually use, call <see cref="M:Gtk.Widget.SizeRequest" /> instead of this function.
</para>
</remarks>
</Docs>
@ -942,14 +945,14 @@
<Parameter Name="accel_mods" Type="Gdk.ModifierType" />
</Parameters>
<Docs>
<summary>Removes an accelerator from <paramref name="widget"/>, previously installed with <see cref="M:Gtk.Widget.AddAccelerator"/>.</summary>
<summary>Removes an accelerator from <paramref name="widget" />, previously installed with <see cref="M:Gtk.Widget.AddAccelerator" />.</summary>
<param name="accel_group">Accel group for this widget.</param>
<param name="accel_key">GDK keyval of the accelerator.</param>
<param name="accel_mods">Modifier key combination of the accelerator.</param>
<returns>Returns whether an accelerator was installed and could be removed.</returns>
<remarks>
<para>
Removes an accelerator from <paramref name="widget"/>, previously installed with <see cref="M:Gtk.Widget.AddAccelerator"/>.
Removes an accelerator from <paramref name="widget" />, previously installed with <see cref="M:Gtk.Widget.AddAccelerator" />.
</para>
</remarks>
</Docs>
@ -966,16 +969,16 @@
<Parameter Name="path_reversed" Type="System.String" />
</Parameters>
<Docs>
<summary>Obtains the full path to <paramref name="widget"/>.</summary>
<param name="path_length">Location to store length of the path, or <see cref="langword:null"/>.</param>
<param name="path">Location to store allocated path string, or <see cref="langword:null"/>.</param>
<param name="path_reversed">Location to store allocated reverse path string, or <see cref="langword:null"/>.</param>
<summary>Obtains the full path to <paramref name="widget" />.</summary>
<param name="path_length">Location to store length of the path, or <see cref="langword:null" />.</param>
<param name="path">Location to store allocated path string, or <see cref="langword:null" />.</param>
<param name="path_reversed">Location to store allocated reverse path string, or <see cref="langword:null" />.</param>
<remarks>
<para>
The path is simply the name of a <paramref name="widget"/> and all its parents in the container hierarchy, separated by periods. The name of a <paramref name="widget"/> comes from <see cref="P:Gtk.Widget.Name"/>. Paths are used to apply styles to a <paramref name="widget"/> in gtkrc configuration files. Widget names are the type of the <paramref name="widget"/> by default (e.g. "<see cref="T:Gtk.Button"/>") or can be set to an application-specific value with <see cref="P:Gtk.Widget.Name"/>.
The path is simply the name of a <paramref name="widget" /> and all its parents in the container hierarchy, separated by periods. The name of a <paramref name="widget" /> comes from <see cref="P:Gtk.Widget.Name" />. Paths are used to apply styles to a <paramref name="widget" /> in gtkrc configuration files. Widget names are the type of the <paramref name="widget" /> by default (e.g. "<see cref="T:Gtk.Button" />") or can be set to an application-specific value with <see cref="P:Gtk.Widget.Name" />.
</para>
<para>
By setting the name of a <paramref name="widget"/>, you allow users or theme authors to apply styles to that specific <paramref name="widget"/> in their gtkrc file. <paramref name="path_reversed_p"/> fills in the path in reverse order, i.e. starting with <paramref name="widget"/>'s name instead of starting with the name of <paramref name="widget"/>'s outermost ancestor.
By setting the name of a <paramref name="widget" />, you allow users or theme authors to apply styles to that specific <paramref name="widget" /> in their gtkrc file. <paramref name="path_reversed_p" /> fills in the path in reverse order, i.e. starting with <paramref name="widget" />'s name instead of starting with the name of <paramref name="widget" />'s outermost ancestor.
</para>
</remarks>
</Docs>
@ -988,7 +991,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Causes a <paramref name="widget"/> to be unmapped if it's currently mapped.</summary>
<summary>Causes a <paramref name="widget" /> to be unmapped if it's currently mapped.</summary>
<remarks>
<para>
This function is only for use in widget implementations.
@ -1004,7 +1007,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Causes a <paramref name="widget"/> to be mapped if it isn't already.</summary>
<summary>Causes a <paramref name="widget" /> to be mapped if it isn't already.</summary>
<remarks>
<para>
This function is only for use in widget implementations.
@ -1022,12 +1025,12 @@
<Parameter Name="region" Type="Gdk.Region" />
</Parameters>
<Docs>
<summary>Computes the intersection of a <paramref name="widget"/>'s area and <paramref name="region"/>, returning the intersection. </summary>
<param name="region">A <see cref="T:Gdk.Region"/>, in the same coordinate system as <paramref name="widget"/>->allocation. That is, relative to <paramref name="widget"/>->window for <see cref="F:Gtk.WidgetFlags.NoWindow"/> widgets; relative to the parent window of <paramref name="widget"/>->window for widgets with their own window.</param>
<returns> A newly allocated region holding the intersection of <paramref name="widget"/> and <paramref name="region"/>. The coordinates of the return value are relative to <paramref name="widget"/>->window for <see cref="F:Gtk.WidgetFlags.NoWindow"/> widgets, and relative to the parent window of <paramref name="widget"/>->window for widgets with their own window.</returns>
<summary>Computes the intersection of a <paramref name="widget" />'s area and <paramref name="region" />, returning the intersection. </summary>
<param name="region">A <see cref="T:Gdk.Region" />, in the same coordinate system as <paramref name="widget" />-&gt;allocation. That is, relative to <paramref name="widget" />-&gt;window for <see cref="F:Gtk.WidgetFlags.NoWindow" /> widgets; relative to the parent window of <paramref name="widget" />-&gt;window for widgets with their own window.</param>
<returns> A newly allocated region holding the intersection of <paramref name="widget" /> and <paramref name="region" />. The coordinates of the return value are relative to <paramref name="widget" />-&gt;window for <see cref="F:Gtk.WidgetFlags.NoWindow" /> widgets, and relative to the parent window of <paramref name="widget" />-&gt;window for widgets with their own window.</returns>
<remarks>
<para>
The result may be empty, use <see cref="M:Gdk.Region.Empty"/> to check.
The result may be empty, use <see cref="M:Gdk.Region.Empty" /> to check.
</para>
</remarks>
</Docs>
@ -1040,10 +1043,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Flags a <paramref name="widget"/> to have its size renegotiated; should be called when a <paramref name="widget"/> for some reason has a new <see cref="M:Gtk.Widget.SizeRequest"/>.</summary>
<summary>Flags a <paramref name="widget" /> to have its size renegotiated; should be called when a <paramref name="widget" /> for some reason has a new <see cref="M:Gtk.Widget.SizeRequest" />.</summary>
<remarks>
<para>
This function is only for use in widget implementations. One example, when you change the text in a <see cref="T:Gtk.Label"/>, it queues a resize to ensure there's enough space for the new text.
This function is only for use in widget implementations. One example, when you change the text in a <see cref="T:Gtk.Label" />, it queues a resize to ensure there's enough space for the new text.
</para>
</remarks>
</Docs>
@ -1058,11 +1061,11 @@
<Parameter Name="font_desc" Type="Pango.FontDescription" />
</Parameters>
<Docs>
<summary>Sets the font to use for a <paramref name="widget"/>.</summary>
<param name="font_desc">The font description to use, or <see cref="langword:null"/> to undo the effect of previous calls to <see cref="M:Gtk.Widget.ModifyFont"/>.</param>
<summary>Sets the font to use for a <paramref name="widget" />.</summary>
<param name="font_desc">The font description to use, or <see cref="langword:null" /> to undo the effect of previous calls to <see cref="M:Gtk.Widget.ModifyFont" />.</param>
<remarks>
<para>
All other style values are left untouched. See also <see cref="M:Gtk.Widget.ModifyStyle"/>.
All other style values are left untouched. See also <see cref="M:Gtk.Widget.ModifyStyle" />.
</para>
</remarks>
</Docs>
@ -1077,12 +1080,12 @@
<Parameter Name="evnt" Type="Gdk.Event" />
</Parameters>
<Docs>
<summary>Very rarely-used function. This function is used to emit an <see cref="F:Gtk.Widget.ExposeEvent"/> signals on a <paramref name="widget"/>.</summary>
<param name="evnt">A <see cref="F:Gtk.Widget.ExposeEvent"/>.</param>
<returns>Return from the event signal emission (<see cref="langword:true"/> if the event was handled).</returns>
<summary>Very rarely-used function. This function is used to emit an <see cref="F:Gtk.Widget.ExposeEvent" /> signals on a <paramref name="widget" />.</summary>
<param name="evnt">A <see cref="F:Gtk.Widget.ExposeEvent" />.</param>
<returns>Return from the event signal emission (<see cref="langword:true" /> if the event was handled).</returns>
<remarks>
<para>
This function is not normally used directly. The only time it is used is when propagating an <see cref="F:Gtk.Widget.ExposeEvent"/> to a child <see cref="F:Gtk.WidgetFlags.NoWindow"/> widget, and that is normally done using <see cref="M:Gtk.Container.PropagateExpose"/>. If you want to force an area of a window to be redrawn, use <see cref="M:Gdk.Window.InvalidateRect"/> or <see cref="M:Gdk.Window.InvalidateRegion"/>. To cause the redraw to be done immediately, follow that call with a call to <see cref="M:Gdk.Window.ProcessUpdates"/>.
This function is not normally used directly. The only time it is used is when propagating an <see cref="F:Gtk.Widget.ExposeEvent" /> to a child <see cref="F:Gtk.WidgetFlags.NoWindow" /> widget, and that is normally done using <see cref="M:Gtk.Container.PropagateExpose" />. If you want to force an area of a window to be redrawn, use <see cref="M:Gdk.Window.InvalidateRect" /> or <see cref="M:Gdk.Window.InvalidateRegion" />. To cause the redraw to be done immediately, follow that call with a call to <see cref="M:Gdk.Window.ProcessUpdates" />.
</para>
</remarks>
</Docs>
@ -1095,7 +1098,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Causes a <paramref name="widget"/> to be unrealized (frees all GDK resources associated with the widget).</summary>
<summary>Causes a <paramref name="widget" /> to be unrealized (frees all GDK resources associated with the widget).</summary>
<remarks>
<para>
This function is only useful in widget implementations.
@ -1111,10 +1114,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Ensures that <paramref name="widget"/> has a style (<paramref name="widget"/>->style).</summary>
<summary>Ensures that <paramref name="widget" /> has a style (<paramref name="widget" />-&gt;style).</summary>
<remarks>
<para>
Not a very useful function; most of the time, if you want the style, the <paramref name="widget"/> is realized, and realized widgets are guaranteed to have a style already.
Not a very useful function; most of the time, if you want the style, the <paramref name="widget" /> is realized, and realized widgets are guaranteed to have a style already.
</para>
</remarks>
</Docs>
@ -1129,12 +1132,12 @@
<Parameter Name="ancestor" Type="Gtk.Widget" />
</Parameters>
<Docs>
<summary>Determines whether <paramref name="widget"/> is somewhere inside <paramref name="ancestor"/>, possibly with intermediate containers.</summary>
<param name="ancestor">Another <see cref="T:Gtk.Widget"/>.</param>
<returns>Returns <see cref="langword:true"/> if ancestor contains widget as a child, grandchild, great grandchild, etc.</returns>
<summary>Determines whether <paramref name="widget" /> is somewhere inside <paramref name="ancestor" />, possibly with intermediate containers.</summary>
<param name="ancestor">Another <see cref="T:Gtk.Widget" />.</param>
<returns>Returns <see cref="langword:true" /> if ancestor contains widget as a child, grandchild, great grandchild, etc.</returns>
<remarks>
<para>
Determines whether <paramref name="widget"/> is somewhere inside <paramref name="ancestor"/>, possibly with intermediate containers.
Determines whether <paramref name="widget" /> is somewhere inside <paramref name="ancestor" />, possibly with intermediate containers.
</para>
</remarks>
</Docs>
@ -1149,11 +1152,11 @@
<Parameter Name="events" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Adds the events in the bitfield <paramref name="events"/> to the event mask for <paramref name="widget"/>.</summary>
<param name="events"></param>
<summary>Adds the events in the bitfield <paramref name="events" /> to the event mask for <paramref name="widget" />.</summary>
<param name="events" />
<remarks>
<para>
Adds the events in the bitfield <paramref name="events"/> to the event mask for <paramref name="widget"/>. See <see cref="M:Gtk.Widget.Events"/> for details.
Adds the events in the bitfield <paramref name="events" /> to the event mask for <paramref name="widget" />. See <see cref="M:Gtk.Widget.Events" /> for details.
</para>
</remarks>
</Docs>
@ -1166,10 +1169,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Recursively hides a <paramref name="widget"/> and any child <paramref name="widgets"/>.</summary>
<summary>Recursively hides a <paramref name="widget" /> and any child <paramref name="widgets" />.</summary>
<remarks>
<para>
Recursively hides a <paramref name="widget"/> and any child <paramref name="widgets"/>.
Recursively hides a <paramref name="widget" /> and any child <paramref name="widgets" />.
</para>
</remarks>
</Docs>
@ -1182,10 +1185,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Reverts the effect of a previous call to <see cref="M:Gtk.Widget.FreezeChildNotify"/>.</summary>
<summary>Reverts the effect of a previous call to <see cref="M:Gtk.Widget.FreezeChildNotify" />.</summary>
<remarks>
<para>
Reverts the effect of a previous call to <see cref="M:Gtk.Widget.FreezeChildNotify"/>. This causes all queued <see cref="F:Gtk.Widget.ChildNotified"/> signals on <paramref name="widget"/> to be emitted.
Reverts the effect of a previous call to <see cref="M:Gtk.Widget.FreezeChildNotify" />. This causes all queued <see cref="F:Gtk.Widget.ChildNotified" /> signals on <paramref name="widget" /> to be emitted.
</para>
</remarks>
</Docs>
@ -1202,13 +1205,13 @@
<Parameter Name="offset_y" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Sets a shape for this <paramref name="widget"/>'s GDK window. This allows for transparent windows etc., see <see cref="M:Gdk.Window.ShapeCombineMask"/> for more information.</summary>
<param name="shape_mask">Shape to be added, or <see cref="langword:null"/> to remove an existing shape.</param>
<summary>Sets a shape for this <paramref name="widget" />'s GDK window. This allows for transparent windows etc., see <see cref="M:Gdk.Window.ShapeCombineMask" /> for more information.</summary>
<param name="shape_mask">Shape to be added, or <see cref="langword:null" /> to remove an existing shape.</param>
<param name="offset_x">X position of shape mask with respect to the window.</param>
<param name="offset_y">Y position of shape mask with respect to the window.</param>
<remarks>
<para>
Sets a shape for this <paramref name="widget"/>'s GDK window. This allows for transparent windows etc., see <see cref="M:Gdk.Window.ShapeCombineMask"/> for more information.
Sets a shape for this <paramref name="widget" />'s GDK window. This allows for transparent windows etc., see <see cref="M:Gdk.Window.ShapeCombineMask" /> for more information.
</para>
</remarks>
</Docs>
@ -1223,11 +1226,11 @@
<Parameter Name="child_property" Type="System.String" />
</Parameters>
<Docs>
<summary>Emits a <see cref="F:Gtk.Widget.ChildNotified"/> signal for the child property on <paramref name="widget"/>.</summary>
<summary>Emits a <see cref="F:Gtk.Widget.ChildNotified" /> signal for the child property on <paramref name="widget" />.</summary>
<param name="child_property">The name of a child property installed on the class of widget's parent.</param>
<remarks>
<para>
Emits a <see cref="F:Gtk.Widget.ChildNotified"/> signal for the child property on <paramref name="widget"/>.
Emits a <see cref="F:Gtk.Widget.ChildNotified" /> signal for the child property on <paramref name="widget" />.
</para>
</remarks>
</Docs>
@ -1244,13 +1247,13 @@
<Parameter Name="path_reversed" Type="System.String" />
</Parameters>
<Docs>
<summary>Same as <see cref="M:Gtk.Widget.Path"/>, but always uses the name of a <paramref name="widget"/>'s type, never uses a custom name set with <see cref="P:Gtk.Widget.Name"/>.</summary>
<param name="path_length">Location to store the length of the class path, or <see cref="langword:null"/>.</param>
<param name="path">Location to store the class path as an allocated string, or <see cref="langword:null"/>.</param>
<param name="path_reversed">Location to store the reverse class path as an allocated string, or <see cref="langword:null"/>.</param>
<summary>Same as <see cref="M:Gtk.Widget.Path" />, but always uses the name of a <paramref name="widget" />'s type, never uses a custom name set with <see cref="P:Gtk.Widget.Name" />.</summary>
<param name="path_length">Location to store the length of the class path, or <see cref="langword:null" />.</param>
<param name="path">Location to store the class path as an allocated string, or <see cref="langword:null" />.</param>
<param name="path_reversed">Location to store the reverse class path as an allocated string, or <see cref="langword:null" />.</param>
<remarks>
<para>
Same as <see cref="M:Gtk.Widget.Path"/>, but always uses the name of a <paramref name="widget"/>'s type, never uses a custom name set with <see cref="P:Gtk.Widget.Name"/>.
Same as <see cref="M:Gtk.Widget.Path" />, but always uses the name of a <paramref name="widget" />'s type, never uses a custom name set with <see cref="P:Gtk.Widget.Name" />.
</para>
</remarks>
</Docs>
@ -1263,13 +1266,13 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Destroys a <paramref name="widget"/>.</summary>
<summary>Destroys a <paramref name="widget" />.</summary>
<remarks>
<para>
Equivalent to <see cref="M:Gtk.Object.Destroy"/>, except that you don't have to cast the <paramref name="widget"/> to <see cref="T:Gtk.Object"/>. When a <paramref name="widget"/> is destroyed, it will break any references it holds to other objects. If the <paramref name="widget"/> is inside a container, the <paramref name="widget"/> will be removed from the container. If the widget is a toplevel (derived from <see cref="T:Gtk.Window"/>), it will be removed from the list of toplevels, and the reference GTK+ holds to it will be removed.
Equivalent to <see cref="M:Gtk.Object.Destroy" />, except that you don't have to cast the <paramref name="widget" /> to <see cref="T:Gtk.Object" />. When a <paramref name="widget" /> is destroyed, it will break any references it holds to other objects. If the <paramref name="widget" /> is inside a container, the <paramref name="widget" /> will be removed from the container. If the widget is a toplevel (derived from <see cref="T:Gtk.Window" />), it will be removed from the list of toplevels, and the reference GTK+ holds to it will be removed.
</para>
<para>
Removing a widget from its container or the list of toplevels results in the <paramref name="widget"/> being finalized, unless you've added additional references to the <paramref name="widget"/> with <see cref="M:Glib.Object.Ref"/>.In most cases, only toplevel widgets (windows) require explicit destruction, because when you destroy a toplevel its children will be destroyed as well.
Removing a widget from its container or the list of toplevels results in the <paramref name="widget" /> being finalized, unless you've added additional references to the <paramref name="widget" /> with <see cref="M:Glib.Object.Ref" />.In most cases, only toplevel widgets (windows) require explicit destruction, because when you destroy a toplevel its children will be destroyed as well.
</para>
</remarks>
</Docs>
@ -1282,10 +1285,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Stops emission of <see cref="F:Gtk.Widget.ChildNotified"/> signals on <paramref name="widget"/>.</summary>
<summary>Stops emission of <see cref="F:Gtk.Widget.ChildNotified" /> signals on <paramref name="widget" />.</summary>
<remarks>
<para>
The signals are queued until <see cref="M:Gtk.Widget.ThawChildNotify"/> is called on <paramref name="widget"/>.
The signals are queued until <see cref="M:Gtk.Widget.ThawChildNotify" /> is called on <paramref name="widget" />.
</para>
</remarks>
</Docs>
@ -1300,11 +1303,11 @@
<Parameter Name="allocation" Type="Gdk.Rectangle" />
</Parameters>
<Docs>
<summary>This function is only used by <see cref="T:Gtk.Container"/> subclasses, to assign a size and position to their child widgets.</summary>
<param name="allocation">A position and size to be allocated to <paramref name="widget"/>.</param>
<summary>This function is only used by <see cref="T:Gtk.Container" /> subclasses, to assign a size and position to their child widgets.</summary>
<param name="allocation">A position and size to be allocated to <paramref name="widget" />.</param>
<remarks>
<para>
This fuction is only used by <see cref="T:Gtk.Container"/> subclasses, to assign a size and position to their child widgets.
This fuction is only used by <see cref="T:Gtk.Container" /> subclasses, to assign a size and position to their child widgets.
</para>
</remarks>
</Docs>
@ -1344,7 +1347,7 @@
<Parameters />
<Docs>
<summary>A coonstructor.</summary>
<returns>An instance of <see cref="T:Gtk.Widget"/>.</returns>
<returns>An instance of <see cref="T:Gtk.Widget" />.</returns>
<remarks />
</Docs>
</Member>
@ -1538,15 +1541,16 @@
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>Sets whether a <paramref name="widget"/> size allocation changes, the entire <paramref name="widget"/> is queued for drawing.</summary>
<param name="value"><see cref="langword:true"/> the entire widget will be redrawn when it is allocated to a new size. <see cref="langword:false"/> only the new portion of the widget will be redrawn.</param>
<returns>Returns <see cref="langword:true"/> because it is on by Default, but returns <see cref="langword:false"/> if you turn it off.</returns>
<summary>Sets whether a <paramref name="widget" /> size allocation changes, the entire <paramref name="widget" /> is queued for drawing.</summary>
<param name="value">
<see cref="langword:true" /> the entire widget will be redrawn when it is allocated to a new size. <see cref="langword:false" /> only the new portion of the widget will be redrawn.</param>
<returns>Returns <see cref="langword:true" /> because it is on by Default, but returns <see cref="langword:false" /> if you turn it off.</returns>
<remarks>
<para>
By default, this setting is <see cref="langword:true"/> and the entire <paramref name="widget"/> is redrawn on every size change. If your widget leaves the upper left are unchanged when made bigger, turning this setting on will improve performance.
By default, this setting is <see cref="langword:true" /> and the entire <paramref name="widget" /> is redrawn on every size change. If your widget leaves the upper left are unchanged when made bigger, turning this setting on will improve performance.
</para>
<para>
Note that for <see cref="F:Gtk.WidgetFlags.NoWindow"/> widgets setting this flag to <see cref="langword:false"/> turns off all allocation on resizing: the widget will not even redraw if its position changes; this is to allow containers that don't draw anything to avoid excess invalidations. If you set this flag on a <see cref="F:Gtk.WidgetFlags.NoWindow"/> widget that does draw on <paramref name="widget"/>->window, you are responsible for invalidating both the old and new allocation of the <paramref name="widget"/> when the widget is moved and responsible for invalidating regions newly when the <paramref name="widget"/> increases size.
Note that for <see cref="F:Gtk.WidgetFlags.NoWindow" /> widgets setting this flag to <see cref="langword:false" /> turns off all allocation on resizing: the widget will not even redraw if its position changes; this is to allow containers that don't draw anything to avoid excess invalidations. If you set this flag on a <see cref="F:Gtk.WidgetFlags.NoWindow" /> widget that does draw on <paramref name="widget" />-&gt;window, you are responsible for invalidating both the old and new allocation of the <paramref name="widget" /> when the widget is moved and responsible for invalidating regions newly when the <paramref name="widget" /> increases size.
</para>
</remarks>
</Docs>
@ -1562,11 +1566,12 @@
</Parameters>
<Docs>
<summary>Use this function to turn off the double buffering.</summary>
<param name="value"><see cref="langword:true"/> is on by Default, <see cref="langword:false"/> if you want to turn off double buffering no use call for true because it is default</param>
<returns>Returns <see cref="langword:true"/> because double buffering is on by Default, but returns <see cref="langword:false"/> if you turn it off.</returns>
<param name="value">
<see cref="langword:true" /> is on by Default, <see cref="langword:false" /> if you want to turn off double buffering no use call for true because it is default</param>
<returns>Returns <see cref="langword:true" /> because double buffering is on by Default, but returns <see cref="langword:false" /> if you turn it off.</returns>
<remarks>
<para>
Widgets are double buffered by default, you can use this function to turn off the buffering. "Double buffered" simply means that <see cref="M:Gdk.Window.BeginPaintRegion"/> and <see cref="M:Gdk.Window.EndPaint"/> are called automatically around <see cref="F:Gtk.Widget.ExposeEvent"/> events sent to the widget. <see cref="M:Gdk.Window.BeginPaint"/> diverts all drawing to a <paramref name="widget"/>'s window to an offscreen buffer, and <see cref="M:Gdk.Window.EndPaint"/> draws the buffer to the screen. The result is that users see the window update in one smooth step, and don't see individual graphics primitives being rendered.
Widgets are double buffered by default, you can use this function to turn off the buffering. "Double buffered" simply means that <see cref="M:Gdk.Window.BeginPaintRegion" /> and <see cref="M:Gdk.Window.EndPaint" /> are called automatically around <see cref="F:Gtk.Widget.ExposeEvent" /> events sent to the widget. <see cref="M:Gdk.Window.BeginPaint" /> diverts all drawing to a <paramref name="widget" />'s window to an offscreen buffer, and <see cref="M:Gdk.Window.EndPaint" /> draws the buffer to the screen. The result is that users see the window update in one smooth step, and don't see individual graphics primitives being rendered.
</para>
<para>
In very simple terms, double buffered widgets don't flicker, so you would only use this function to turn off double buffering if you had special needs and really knew what you were doing.

60
doc/en/Gtk/WidgetFlags.xml
View file

@ -7,7 +7,7 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>Tells about certain properties of the <paramref name="widget"/>.</summary>
<summary>Tells about certain properties of the <paramref name="widget" />.</summary>
<remarks />
</Docs>
<Base>
@ -34,10 +34,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Widgets without a real parent, as there are <see cref="T:Gtk.Window"/>s and <see cref="T:Gtk.Menu"/>s have this flag set throughout their lifetime.</summary>
<summary>Widgets without a real parent, as there are <see cref="T:Gtk.Window" />s and <see cref="T:Gtk.Menu" />s have this flag set throughout their lifetime.</summary>
<remarks>
<para>
Toplevel widgets always contain their own <see cref="T:Gdk.Window"/>.
Toplevel widgets always contain their own <see cref="T:Gdk.Window" />.
</para>
</remarks>
</Docs>
@ -50,10 +50,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Indicative for a <paramref name="widget"/> that does not provide its own <see cref="T:Gdk.Window"/>.</summary>
<summary>Indicative for a <paramref name="widget" /> that does not provide its own <see cref="T:Gdk.Window" />.</summary>
<remarks>
<para>
Visible action (e.g. drawing) is performed on the parent's <see cref="T:Gdk.Window"/>.
Visible action (e.g. drawing) is performed on the parent's <see cref="T:Gdk.Window" />.
</para>
</remarks>
</Docs>
@ -66,10 +66,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary> Set by <see cref="M:Gtk.Widget.Realize"/>, unset by <see cref="M:Gtk.Widget.Unrealize"/>.</summary>
<summary> Set by <see cref="M:Gtk.Widget.Realize" />, unset by <see cref="M:Gtk.Widget.Unrealize" />.</summary>
<remarks>
<para>
A realized <paramref name="widget"/> has an associated <see cref="T:Gdk.Window"/>.
A realized <paramref name="widget" /> has an associated <see cref="T:Gdk.Window" />.
</para>
</remarks>
</Docs>
@ -82,10 +82,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Set by <see cref="M:Gtk.Widget.Map"/>, unset by <see cref="M:Gtk.Widget.Map"/>.</summary>
<summary>Set by <see cref="M:Gtk.Widget.Map" />, unset by <see cref="M:Gtk.Widget.Map" />.</summary>
<remarks>
<para>
Only realized widgets can be mapped. It means that <see cref="M:Gdk.Window.Show"/> has been called on the widgets window(s).
Only realized widgets can be mapped. It means that <see cref="M:Gdk.Window.Show" /> has been called on the widgets window(s).
</para>
</remarks>
</Docs>
@ -98,10 +98,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary> Set by <see cref="M:Gtk.Widget.Show"/>, unset by <see cref="M:Gtk.Widget.Hide"/>. Implies that a <paramref name="widget"/> will be mapped as soon as its parent is mapped.</summary>
<summary> Set by <see cref="M:Gtk.Widget.Show" />, unset by <see cref="M:Gtk.Widget.Hide" />. Implies that a <paramref name="widget" /> will be mapped as soon as its parent is mapped.</summary>
<remarks>
<para>
Implies that a <paramref name="widget"/> will be mapped as soon as its parent is mapped.
Implies that a <paramref name="widget" /> will be mapped as soon as its parent is mapped.
</para>
</remarks>
</Docs>
@ -114,7 +114,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Set and unset by <see cref="P:Gtk.Widget.Sensitive"/>. The sensitivity of a <paramref name="widget"/> determines whether it will receive certain events (e.g. button or key presses).</summary>
<summary>Set and unset by <see cref="P:Gtk.Widget.Sensitive" />. The sensitivity of a <paramref name="widget" /> determines whether it will receive certain events (e.g. button or key presses).</summary>
<remarks>
<para>
One premise for the widgets sensitivity is to have this flag set.
@ -130,10 +130,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Set and unset by <see cref="P:Gtk.Widget.Sensitive"/> operations on the parents of the <paramref name="widget"/>.</summary>
<summary>Set and unset by <see cref="P:Gtk.Widget.Sensitive" /> operations on the parents of the <paramref name="widget" />.</summary>
<remarks>
<para>
This is the second premise for the widgets sensitivity. Once it has <see cref="F:Gtk.WidgetFlags.Sensitive"/> and <see cref="F:Gtk.Widget.ParentSensitive"/> set, its state is effectively sensitive.
This is the second premise for the widgets sensitivity. Once it has <see cref="F:Gtk.WidgetFlags.Sensitive" /> and <see cref="F:Gtk.Widget.ParentSensitive" /> set, its state is effectively sensitive.
</para>
</remarks>
</Docs>
@ -146,10 +146,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Determines whether a <paramref name="widget"/> is able to handle focus grabs.</summary>
<summary>Determines whether a <paramref name="widget" /> is able to handle focus grabs.</summary>
<remarks>
<para>
Determines whether a <paramref name="widget"/> is able to handle focus grabs.
Determines whether a <paramref name="widget" /> is able to handle focus grabs.
</para>
</remarks>
</Docs>
@ -162,7 +162,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary> Set by <see cref="M:Gtk.Widget.GrabFocus"/> for widgets that also have <see cref="F:Gtk.WidgetFlags.CanFocus"/> set.</summary>
<summary> Set by <see cref="M:Gtk.Widget.GrabFocus" /> for widgets that also have <see cref="F:Gtk.WidgetFlags.CanFocus" /> set.</summary>
<remarks>
<para>
The flag will be unset once another widget grabs the focus.
@ -178,10 +178,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>The <paramref name="widget"/> is allowed to receive the default action via <see cref="M:Gtk.Widget.GrabDefault"/>.</summary>
<summary>The <paramref name="widget" /> is allowed to receive the default action via <see cref="M:Gtk.Widget.GrabDefault" />.</summary>
<remarks>
<para>
The <paramref name="widget"/> is allowed to receive the default action via <see cref="M:Gtk.Widget.GrabDefault"/>.
The <paramref name="widget" /> is allowed to receive the default action via <see cref="M:Gtk.Widget.GrabDefault" />.
</para>
</remarks>
</Docs>
@ -194,10 +194,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary> The <paramref name="widget"/> currently is receiving the default action.</summary>
<summary> The <paramref name="widget" /> currently is receiving the default action.</summary>
<remarks>
<para>
The <paramref name="widget"/> currently is receiving the default action.
The <paramref name="widget" /> currently is receiving the default action.
</para>
</remarks>
</Docs>
@ -210,7 +210,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary> Set by <see cref="M:Gtk.Widget.GrabDefault"/>gtk_grab_add(), unset by gtk_grab_remove().</summary>
<summary> Set by <see cref="M:Gtk.Widget.GrabDefault" />gtk_grab_add(), unset by gtk_grab_remove().</summary>
<remarks>
<para>
It means that the widget is in the grab_widgets stack, and will be the preferred one for receiving events other than ones of cosmetic value.
@ -229,7 +229,7 @@
<summary>Indicates that the widgets style has been looked up through the rc mechanism.</summary>
<remarks>
<para>
It does not imply that the <paramref name="widget"/> actually had a style defined through the rc mechanism.
It does not imply that the <paramref name="widget" /> actually had a style defined through the rc mechanism.
</para>
</remarks>
</Docs>
@ -242,10 +242,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Indicates that the <paramref name="widget"/> is a composite child of its parent.</summary>
<summary>Indicates that the <paramref name="widget" /> is a composite child of its parent.</summary>
<remarks>
<para>
See <see cref="M:Gtk.Widget.PushCompositeChild"/>, <see cref="M:Gtk.Widget.PopCompositeChild"/>.
See <see cref="M:Gtk.Widget.PushCompositeChild" />, <see cref="M:Gtk.Widget.PopCompositeChild" />.
</para>
</remarks>
</Docs>
@ -270,7 +270,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Set and unset by <see cref="P:Gtk.Widget.AppPaintable"/>.</summary>
<summary>Set and unset by <see cref="P:Gtk.Widget.AppPaintable" />.</summary>
<remarks>
<para>
Must be set on widgets whose window the application directly draws on, in order to keep GTK+ from overwriting the drawn stuff.
@ -286,10 +286,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>The <paramref name="widget"/> when focused will receive the default action and have <see cref="F:Gtk.WidgetFlags.HasDefault"/> set even if there is a different widget set as default.</summary>
<summary>The <paramref name="widget" /> when focused will receive the default action and have <see cref="F:Gtk.WidgetFlags.HasDefault" /> set even if there is a different widget set as default.</summary>
<remarks>
<para>
The <paramref name="widget"/> when focused will receive the default action and have <see cref="F:Gtk.WidgetFlags.HasDefault"/> set even if there is a different widget set as default.
The <paramref name="widget" /> when focused will receive the default action and have <see cref="F:Gtk.WidgetFlags.HasDefault" /> set even if there is a different widget set as default.
</para>
</remarks>
</Docs>
@ -302,10 +302,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Set and unset by <see cref="P:Gtk.Widget.DoubleBuffered"/>. Indicates that exposes done on the <paramref name="widget"/> should be double-buffered. </summary>
<summary>Set and unset by <see cref="P:Gtk.Widget.DoubleBuffered" />. Indicates that exposes done on the <paramref name="widget" /> should be double-buffered. </summary>
<remarks>
<para>
Indicates that exposes done on the <paramref name="widget"/> should be double-buffered.
Indicates that exposes done on the <paramref name="widget" /> should be double-buffered.
</para>
</remarks>
</Docs>