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

en/Gtk/Accessible.xml: Full doc.

Browse source 
en/Gtk/CellEditable.xml: Full doc.
en/Gtk/Drag.xml: Full doc.
en/Gtk/Widget.xml: Fixes and some updates.
en/Gtk/WidgetFlags.xml: Full doc.

svn path=/trunk/gtk-sharp/; revision=18289
This commit is contained in:
Hector E. Gomez Morales 2003-09-25 05:34:26 +00:00
parent 148694216f
commit 43ffab4a20
7 changed files with 545 additions and 374 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/ChangeLog
View file

@ -1,3 +1,12 @@
2003-09-25 Hector E. Gomez Morales <hgomez_36@flashmail.com>
* en/Gtk/Accessible.xml
* en/Gtk/CellEditable.xml
* en/Gtk/Drag.xml: Full docs.
* en/Gtk/Widget.xml: Fixes and some updates.
* en/Gtk/WidgetFlags.xml: Full doc.
* en/Gtk/Window.xml: Fixes and some updates, still missing to document the properties.
2003-09-23 John Luke <jluke@cfl.rr.com> 2003-09-23 John Luke <jluke@cfl.rr.com>
* en/Art.xml: * en/Art.xml:

18
doc/en/Gtk/Accessible.xml
View file

@ -1,5 +1,5 @@
<Type Name="Accessible" FullName="Gtk.Accessible"> <Type Name="Accessible" FullName="Gtk.Accessible">
<TypeSignature Language="C#" Value="public class Accessible : Atk.Object, IWrapper, IDisposable" Maintainer="auto" /> <TypeSignature Language="C#" Value="public class Accessible : Atk.Object, IWrapper, IDisposable" Maintainer="Hector Gomez M" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>This class requests <see cref="T:Atk.Object" /> instances for the UI components that provide useful information to the user.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Atk.Object</BaseTypeName> <BaseTypeName>Atk.Object</BaseTypeName>
@ -31,8 +31,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>This method specifies the callback function to be called when the <paramref name="widget" /> corresponding to a <see cref="T:Gtk.Accessible" /> is destroyed.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Finalize"> <Member MemberName="Finalize">
@ -69,9 +69,11 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor.</summary>
<returns>To be added: an object of type 'Gtk.Accessible'</returns> <returns>An instance of <see cref="T:Gtk.Accessible" />.</returns>
<remarks>To be added</remarks> <remarks>
<para>This is an internal constructor, and should not be used by user code.</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">

40
doc/en/Gtk/CellEditable.xml
View file

@ -1,5 +1,5 @@
<Type Name="CellEditable" FullName="Gtk.CellEditable"> <Type Name="CellEditable" FullName="Gtk.CellEditable">
<TypeSignature Language="C#" Value="public abstract interface CellEditable;" Maintainer="auto" /> <TypeSignature Language="C#" Value="public abstract interface CellEditable;" Maintainer="Hector Gomez M" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>An object for editing a single cell.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
<Base /> <Base />
<Interfaces> <Interfaces>
@ -28,9 +28,13 @@
<Parameter Name="evnt" Type="Gdk.Event" /> <Parameter Name="evnt" Type="Gdk.Event" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Begins editing on a cell editable.</summary>
<param name="evnt">To be added: an object of type 'Gdk.Event'</param> <param name="evnt">A <see cref="T:Gdk.Event" />, or <see langword="null" />.</param>
<remarks>To be added</remarks> <remarks>
<para>
<paramref name="evnt" /> is the <see cref="T:Gdk.Event" /> that began the editing process. It may be <see langoword="null" />, in the instance that editing was initiated through programatic means.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="FinishEditing"> <Member MemberName="FinishEditing">
@ -41,8 +45,12 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Emits the <see cref="F:Gtk.CellEditable.EditingDone" /> event.</summary>
<remarks>To be added</remarks> <remarks>
<para>
This event is a sign for the cell renderer to update its value from the cell.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RemoveWidget"> <Member MemberName="RemoveWidget">
@ -53,8 +61,12 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Emits the <see cref="F:Gtk.CellEditable.WidgetREmoved" /> event.</summary>
<remarks>To be added</remarks> <remarks>
<para>
This event is meant to indicate that the cell is finished editing, and the <paramref name="widget" /> may now be destroyed.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="WidgetRemoved"> <Member MemberName="WidgetRemoved">
@ -65,8 +77,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Event that indicates that the cell is finished editing, and the <paramref name="widget" /> may now be destroyed.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="EditingDone"> <Member MemberName="EditingDone">
@ -77,8 +89,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Event that indicates to the cell renderer to update its value from the cell.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

290
doc/en/Gtk/Drag.xml
View file

@ -1,5 +1,5 @@
<Type Name="Drag" FullName="Gtk.Drag"> <Type Name="Drag" FullName="Gtk.Drag">
<TypeSignature Language="C#" Value="public class Drag" Maintainer="auto" /> <TypeSignature Language="C#" Value="public class Drag" Maintainer="Hector Gomez M" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey /> <AssemblyPublicKey />
@ -9,8 +9,12 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Methods for controlling drag and drop handling.</summary>
<remarks>To be added</remarks> <remarks>
<para>
GTK+ has a rich set of methods for doing inter-process communication via the drag-and-drop metaphor. GTK+ can do drag-and-drop (DND) via multiple protocols. The currently supported protocols are the Xdnd and Motif protocols. As well as the methods listed here, applications may need to use some facilities provided for <see cref="T:Gtk.Selection" />. Also, the Drag and Drop API makes use of events in the <see cref="T:Gtk.Widget" /> class.
</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Object</BaseTypeName> <BaseTypeName>System.Object</BaseTypeName>
@ -28,9 +32,13 @@
<Parameter Name="widget" Type="Gtk.Widget" /> <Parameter Name="widget" Type="Gtk.Widget" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Clears information about a drop destinantion set with <see cref="M:Gtk.Drag.Fixme" />.</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param> <param name="widget">A <see cref="T:Gtk.Widget" />.</param>
<remarks>To be added</remarks> <remarks>
<para>
The <paramref name="widget" /> will no longer receive notification of drags.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetSourceWidget"> <Member MemberName="GetSourceWidget">
@ -43,10 +51,10 @@
<Parameter Name="context" Type="Gdk.DragContext" /> <Parameter Name="context" Type="Gdk.DragContext" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Determines the source <paramref name="widget" /> for a drag.</summary>
<param name="context">a <see cref="T:Gdk.DragContext" /></param> <param name="context">A (destination side) drag context.</param>
<returns>a <see cref="T:Gtk.Widget" /></returns> <returns>If the drag is occurring within a single application, a pointer to the source <paramref name="widget" />. Otherwise, <see langword="null" />.</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DestSetProxy"> <Member MemberName="DestSetProxy">
@ -62,12 +70,12 @@
<Parameter Name="use_coordinates" Type="System.Boolean" /> <Parameter Name="use_coordinates" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets this <paramref name="widget" /> as a proxy for drops to another window.</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param> <param name="widget">A <see cref="T:Gtk.Widget" />.</param>
<param name="proxy_window">a <see cref="T:Gdk.Window" /></param> <param name="proxy_window">The window to which to foward drag events.</param>
<param name="protocol">a <see cref="T:Gdk.DragProtocol" /></param> <param name="protocol">The drag protocol which the <paramref name="proxy_window" /> accepts (You can use <see cref="M:Gdk.Drag.GetProtocol" />to determine this).</param>
<param name="use_coordinates">a <see cref="T:System.Boolean" /></param> <param name="use_coordinates">If <see langword="true" />, send the same coordinates to the destination, because it is an embedded subwindow.</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Finish"> <Member MemberName="Finish">
@ -83,12 +91,12 @@
<Parameter Name="time_" Type="System.UInt32" /> <Parameter Name="time_" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Informs the drag sourcre that the drop is finished, and that the data of the drag will no longer be repaired.</summary>
<param name="context">a <see cref="T:Gdk.DragContext" /></param> <param name="context">The drag context.</param>
<param name="success">a <see cref="T:System.Boolean" /></param> <param name="success">A flag indicating whether the drop was successful.</param>
<param name="del">a <see cref="T:System.Boolean" /></param> <param name="del">A flag indicating whether the source should delete the original data (this should be <see langword="true" /> for a move).</param>
<param name="time_">a <see cref="T:System.UInt32" /></param> <param name="time_">The timestamp from the <see cref="F:Gtk.Widget.DragDrop" /> event.</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DestSetTargetList"> <Member MemberName="DestSetTargetList">
@ -102,10 +110,14 @@
<Parameter Name="target_list" Type="Gtk.TargetList" /> <Parameter Name="target_list" Type="Gtk.TargetList" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the target types that this <paramref name="widget" /> can accept from drag and drop.</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param> <param name="widget">A <see cref="T:Gtk.Widget" /> that's a drag destination.</param>
<param name="target_list">a <see cref="T:Gtk.TargetList" /></param> <param name="target_list">List of droppable targets, or <see langword="null" /> for none.</param>
<remarks>To be added</remarks> <remarks>
<para>
The <paramref name="widget" /> must first be made into a drag destination with <see cref="M:Drag.Fixme" />.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SourceSet"> <Member MemberName="SourceSet">
@ -122,13 +134,17 @@
<Parameter Name="actions" Type="Gdk.DragAction" /> <Parameter Name="actions" Type="Gdk.DragAction" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets up a <paramref name="widget" /> so that GTK+ will start a drag operation when the user clicks and drags on the <paramref name="widget" />.</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param> <param name="widget">A <see cref="T:Gtk.Widget" />.</param>
<param name="start_button_mask">a <see cref="T:Gdk.ModifierType" /></param> <param name="start_button_mask">The bitmask of buttons that can start the drag.</param>
<param name="targets">a <see cref="T:Gtk.TargetEntry" /></param> <param name="targets">The table of targets that the drag will support.</param>
<param name="n_targets">a <see cref="T:System.Int32" /></param> <param name="n_targets">The number of items in <paramref name="targets" />.</param>
<param name="actions">a <see cref="T:Gdk.DragAction" /></param> <param name="actions">the bitmask of possible actions for a drag from this <paramref name="widget" />.</param>
<remarks>To be added</remarks> <remarks>
<para>
The <paramref name="widget" /> must have a window.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DestFindTarget"> <Member MemberName="DestFindTarget">
@ -143,12 +159,16 @@
<Parameter Name="target_list" Type="Gtk.TargetList" /> <Parameter Name="target_list" Type="Gtk.TargetList" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Looks for a match between <paramref name="context" />->targets and the <paramref name="dest_target_list" />, returning the first matching target, otherwise returning GDK_NONE.</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param> <param name="widget">Drag destination <paramref name="widget" />.</param>
<param name="context">a <see cref="T:Gdk.DragContext" /></param> <param name="context">Drag context.</param>
<param name="target_list">a <see cref="T:Gtk.TargetList" /></param> <param name="target_list">List of droppable targets, or <see langword="null" /> to use <see cref="M:Gtk.Drag.DestGetTargetList" />.</param>
<returns>a <see cref="T:Gdk.Atom" /></returns> <returns>First target that the source offers and the dest can accept. or GDK_NONE.</returns>
<remarks>To be added</remarks> <remarks>
<para>
<paramref name="dest_target_list" /> should usually be the return value from <see cref="M:Gtk.Drag.DestGetTargetList" /> but some widgets may have different valid targets for different parts of the <paramref name="widget" />; in that case, they will have to implement a drag_motion handler that passes the correct target list to this method.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CheckThreshold"> <Member MemberName="CheckThreshold">
@ -165,14 +185,14 @@
<Parameter Name="current_y" Type="System.Int32" /> <Parameter Name="current_y" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Checks to see if a mouse drag starting at (<paramref name="start_x" />, <paramref name="start_y" />) and ending at (<paramref name="current_x" />, <paramref name="current_y" />) has passed the GTK+ drag threshold, and this should trigger the beginning of a drag-and-drog operation.</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param> <param name="widget">A <see cref="T:Gtk.Widget" />.</param>
<param name="start_x">a <see cref="T:System.Int32" /></param> <param name="start_x">X coordinate of a start of drag.</param>
<param name="start_y">a <see cref="T:System.Int32" /></param> <param name="start_y">Y coordinate of a start of drag.</param>
<param name="current_x">a <see cref="T:System.Int32" /></param> <param name="current_x">Current X coordinate.</param>
<param name="current_y">a <see cref="T:System.Int32" /></param> <param name="current_y">Current Y coordinate.</param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns><see langword="true" /> if the drag threshold has been passed.</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SourceSetIconStock"> <Member MemberName="SourceSetIconStock">
@ -186,10 +206,10 @@
<Parameter Name="stock_id" Type="System.String" /> <Parameter Name="stock_id" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the icon that will be used for drags from a particular source to a stock icon.</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param> <param name="widget">A <see cref="T:Gtk.Widget" />.</param>
<param name="stock_id">a <see cref="T:System.String" /></param> <param name="stock_id">The ID of the stock icon to use.</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Unhighlight"> <Member MemberName="Unhighlight">
@ -202,9 +222,9 @@
<Parameter Name="widget" Type="Gtk.Widget" /> <Parameter Name="widget" Type="Gtk.Widget" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Removes a highlight set by <see cref="M:Gtk.Drag.Highlight" /> from a <paramref name="widget" />.</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param> <param name="widget">A <see cref="T:Gtk.Widget" />.</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Highlight"> <Member MemberName="Highlight">
@ -217,9 +237,13 @@
<Parameter Name="widget" Type="Gtk.Widget" /> <Parameter Name="widget" Type="Gtk.Widget" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Draws a highlight around a <paramref name="widget" />.</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param> <param name="widget">A <paramref name="widget" /> to highlight.</param>
<remarks>To be added</remarks> <remarks>
<para>
This will attach handlers to <see cref="F:Gtk.Widget.ExposeEvent" /> and <see cref="F:Gtk.Widget.QueueDraw" />, so the highlight will continue to be displayed until <see cref="M:Gtk.Drag.Unhighlight" /> is called.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SourceSetIconPixbuf"> <Member MemberName="SourceSetIconPixbuf">
@ -233,10 +257,14 @@
<Parameter Name="pixbuf" Type="Gdk.Pixbuf" /> <Parameter Name="pixbuf" Type="Gdk.Pixbuf" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the icon that will be used for drags from a particular <paramref name="widget" /> from a <see cref="T:Gdk.Pixbuf" />.</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param> <param name="widget">A <see cref="T:Gtk.Widget" />.</param>
<param name="pixbuf">a <see cref="T:Gdk.Pixbuf" /></param> <param name="pixbuf">The <see cref="T:Gdk.Pixbuf" /> for the drag icon.</param>
<remarks>To be added</remarks> <remarks>
<para>
GTK+ retains a reference for <paramref name="pixbuf" /> and will release it when it is no longer needed.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Begin"> <Member MemberName="Begin">
@ -253,14 +281,18 @@
<Parameter Name="evnt" Type="Gdk.Event" /> <Parameter Name="evnt" Type="Gdk.Event" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Initates a drag on the source side.</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param> <param name="widget">The source <paramref name="widget" />.</param>
<param name="targets">a <see cref="T:Gtk.TargetList" /></param> <param name="targets">The targets (data formats) in which the source can provide the data.</param>
<param name="actions">a <see cref="T:Gdk.DragAction" /></param> <param name="actions">A bitmask of the allowed drag actions for this drag.</param>
<param name="button">a <see cref="T:System.Int32" /></param> <param name="button">The button the user clicked to start the drag.</param>
<param name="evnt">a <see cref="T:Gdk.Event" /></param> <param name="evnt">The event that triggered the start of the drag.</param>
<returns>a <see cref="T:Gdk.DragContext" /></returns> <returns>The context fot this drag.</returns>
<remarks>To be added</remarks> <remarks>
<para>
The method only needs to be used when the application is starting drags itself, and is not needed when <see cref="M:Gtk.Drag.SourceSset" /> is used.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetIconStock"> <Member MemberName="SetIconStock">
@ -276,12 +308,12 @@
<Parameter Name="hot_y" Type="System.Int32" /> <Parameter Name="hot_y" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the icon for a given drag from a stock ID.</summary>
<param name="context">a <see cref="T:Gdk.DragContext" /></param> <param name="context">The context of the drag (this must be called with a context for the source side of a drag).</param>
<param name="stock_id">a <see cref="T:System.String" /></param> <param name="stock_id">The ID of the stock icon to use for the drag.</param>
<param name="hot_x">a <see cref="T:System.Int32" /></param> <param name="hot_x">The X offset within the icon of the hotspot.</param>
<param name="hot_y">a <see cref="T:System.Int32" /></param> <param name="hot_y">The Y offset within the icon of the hotspot.</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetData"> <Member MemberName="GetData">
@ -297,12 +329,16 @@
<Parameter Name="time_" Type="System.UInt32" /> <Parameter Name="time_" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Obtains the data associated with a drag.</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param> <param name="widget">The <paramref name="widget" /> that will receive the <see cref="F:Gtk.Widget.DragDataReceived" /> event.</param>
<param name="context">a <see cref="T:Gdk.DragContext" /></param> <param name="context">The drag context.</param>
<param name="target">a <see cref="T:Gdk.Atom" /></param> <param name="target">The target (form of the data) to retrieve.</param>
<param name="time_">a <see cref="T:System.UInt32" /></param> <param name="time_">A timestamp for retrieving the data. This will generally be the time received in a <see cref="F:Gtk.Widget.DragMotion" /> or <see cref="F:Gtk.Widget.DragDrop" /> event.</param>
<remarks>To be added</remarks> <remarks>
<para>
When the data is received or the retrieval fails, GTK+ will emit a <see cref="F:Gtk.Widget.DragDataReceived" /> event. Failure of the retrieval is indicated by the length field of the <paramref name="selection_data" /> signal parameter being negative. However, when <see cref="M:Gtk.Drag.GetData" /> is called implicitely because the <see cref="F:Gtk.DestDefaults.Drop" /> was set, then the <paramref name="widget" /> will not receive notification of failed drops.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetIconPixmap"> <Member MemberName="SetIconPixmap">
@ -320,14 +356,18 @@
<Parameter Name="hot_y" Type="System.Int32" /> <Parameter Name="hot_y" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets <paramref name="pixmap" /> as the icon for a given drag.</summary>
<param name="context">a <see cref="T:Gdk.DragContext" /></param> <param name="context">The context for a drag (this must be called with a context for the source side of a drag).</param>
<param name="colormap">a <see cref="T:Gdk.Colormap" /></param> <param name="colormap">The colormap of the icon.</param>
<param name="pixmap">a <see cref="T:Gdk.Pixmap" /></param> <param name="pixmap">The image data for the icon.</param>
<param name="mask">a <see cref="T:Gdk.Bitmap" /></param> <param name="mask">The transparency mask for the icon.</param>
<param name="hot_x">a <see cref="T:System.Int32" /></param> <param name="hot_x">The X offset with <paramref name="pixmap" /> of the hotspot.</param>
<param name="hot_y">a <see cref="T:System.Int32" /></param> <param name="hot_y">The Y offset with <paramref name="pixmap" /> of the hotspot.</param>
<remarks>To be added</remarks> <remarks>
<para>
GTK+ retains references for the arguments, and will release them when they are no longer needed. In general, <see cref="M:Gtk.Drag.SetIconPixbuf" /> will be more convenient to use.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetIconPixbuf"> <Member MemberName="SetIconPixbuf">
@ -343,12 +383,12 @@
<Parameter Name="hot_y" Type="System.Int32" /> <Parameter Name="hot_y" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets <paramref name="pixbuf" /> as the icon for a given drag.</summary>
<param name="context">a <see cref="T:Gdk.DragContext" /></param> <param name="context">The context for a drag (this must be called with a context for the source side of a drag).</param>
<param name="pixbuf">a <see cref="T:Gdk.Pixbuf" /></param> <param name="pixbuf">The <see cref="T:Gdk.Pixbuf" /> to use as the drag icon.</param>
<param name="hot_x">a <see cref="T:System.Int32" /></param> <param name="hot_x">The X offset within <paramref name="widget" /> of the hotspot.</param>
<param name="hot_y">a <see cref="T:System.Int32" /></param> <param name="hot_y">The Y offset within <paramref name="widget" /> of the hotspot.</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DestGetTargetList"> <Member MemberName="DestGetTargetList">
@ -361,10 +401,10 @@
<Parameter Name="widget" Type="Gtk.Widget" /> <Parameter Name="widget" Type="Gtk.Widget" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Returns the list of targets this <paramref name="widget" /> can accept from drag-and-drop.</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param> <param name="widget">A <see cref="T:Gtk.Widget" />.</param>
<returns>a <see cref="T:Gtk.TargetList" /></returns> <returns>The <see cref="T:Gtk.TargetList" />, or <see langword="null" /> if none.</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SourceUnset"> <Member MemberName="SourceUnset">
@ -377,9 +417,9 @@
<Parameter Name="widget" Type="Gtk.Widget" /> <Parameter Name="widget" Type="Gtk.Widget" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Undoes the effects of <see cref="M:Gtk.Drag.SourceSet" />.</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param> <param name="widget">A <see cref="T:Gtk.Widget" />.</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SourceSetIcon"> <Member MemberName="SourceSetIcon">
@ -395,12 +435,16 @@
<Parameter Name="mask" Type="Gdk.Bitmap" /> <Parameter Name="mask" Type="Gdk.Bitmap" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the icon that will be used for drags from a particular <paramref name="widget" /> from a pixmap/mask.</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param> <param name="widget">A <see cref="T:Gtk.Widget" />.</param>
<param name="colormap">a <see cref="T:Gdk.Colormap" /></param> <param name="colormap">The colormap of the icon.</param>
<param name="pixmap">a <see cref="T:Gdk.Pixmap" /></param> <param name="pixmap">The image data for the icon.</param>
<param name="mask">a <see cref="T:Gdk.Bitmap" /></param> <param name="mask">The transparency mask for an image.</param>
<remarks>To be added</remarks> <remarks>
<para>
GTK+ retains references for the arguments, and will release them when they are no longer needed. Use <see cref="M:Gtk.Drag.SourceSetIconPixbuf" /> instead.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetIconWidget"> <Member MemberName="SetIconWidget">
@ -416,12 +460,16 @@
<Parameter Name="hot_y" Type="System.Int32" /> <Parameter Name="hot_y" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Changes the icon for a <paramref name="widget" /> to a given <paramref name="widget" />.</summary>
<param name="context">a <see cref="T:Gdk.DragContext" /></param> <param name="context">The context for a drag (this must be called with a context for the source side of a drag.</param>
<param name="widget">a <see cref="T:Gtk.Widget" /></param> <param name="widget">A toplevel window to use as an icon.</param>
<param name="hot_x">a <see cref="T:System.Int32" /></param> <param name="hot_x">The X offset within <paramref name="widget" /> of the hotspot.</param>
<param name="hot_y">a <see cref="T:System.Int32" /></param> <param name="hot_y">The Y offset within <paramref name="widget" /> of the hotspot.</param>
<remarks>To be added</remarks> <remarks>
<para>
GTK+ will not destroy the icon, so if you don't want it to persist, you should connect to the <see cref="F:Gtk.Widgart.DragEnd" /> event and destroy it yourself.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -430,9 +478,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>A constructor.</summary>
<returns>a <see cref="T:Gtk.Drag" /></returns> <returns>Creates a new instance of <see cref="T:Gtk.Drag" />.</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="IconDefault"> <Member MemberName="IconDefault">
@ -443,10 +491,10 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the icon for a particular drag to the default icon.</summary>
<param name="value">a <see cref="T:Gdk.DragContext" /></param> <param name="value">The context for a drag (this must be called with a context for the source side of a drag).</param>
<returns>a <see cref="T:Gdk.DragContext" /></returns> <returns><see langword="true" /> if the icon has been made the default.</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

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

@ -7,7 +7,7 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>GtkWidget introduces style properties - these are basically object properties that are stored in the style object associated to the widget.</summary> <summary>GtkWidget introduces style properties - these are basically object properties that are stored in the style object associated to the <paramref name="widget" />.</summary>
<remarks> <remarks>
<para> <para>
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. 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.
@ -66,7 +66,7 @@
<param name="cmap">Colormap that is pushed by <see cref="T:Gdk.Colormap" />.</param> <param name="cmap">Colormap that is pushed by <see cref="T:Gdk.Colormap" />.</param>
<remarks> <remarks>
<para> <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 <paramref name="widgets" />. Remove <paramref name="cmap" /> with <see cref="M:Gtk.Widget.PopColormap" />. There's little reason to use this method.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -131,7 +131,7 @@
<summary>Shows a <paramref name="widget" />.</summary> <summary>Shows a <paramref name="widget" />.</summary>
<remarks> <remarks>
<para> <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 <paramref name="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 method.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -147,7 +147,7 @@
<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> <remarks>
<para> <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 <paramref name="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> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -162,11 +162,11 @@
<Parameter Name="new_parent" Type="Gtk.Widget" /> <Parameter Name="new_parent" Type="Gtk.Widget" />
</Parameters> </Parameters>
<Docs> <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> <summary>Moves a <paramref name="widget" /> from one <see cref="T:Gtk.Container" /> to another, handling reference count issues to avoid destroying the <paramref name="widget" />.</summary>
<param name="new_parent">A <see cref="T:Gtk.Container" /> to move the widget into.</param> <param name="new_parent">A <see cref="T:Gtk.Container" /> to move the <paramref name="widget" /> into.</param>
<remarks> <remarks>
<para> <para>
Moves a widget from one <see cref="T:Gtk.Container" /> to another, handling reference count issues to avoid destroying the widget. Moves a <paramref name="widget" /> from one <see cref="T:Gtk.Container" /> to another, handling reference count issues to avoid destroying the <paramref name="widget" />.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -184,16 +184,16 @@
<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> <param name="direction">Direction of focus movement.</param>
<returns> <returns>
<see langword="true" /> if focus ended up inside widget.</returns> <see langword="true" /> if focus ended up inside <paramref name="widget"/>.</returns>
<remarks> <remarks>
<para> <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 method 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 <paramref name="widget" />, and <see cref="M:Gtk.Container.SetFocusChain" /> to change the focus tab order. So you may want to investigate those methods instead.
</para> </para>
<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 <see cref="F:Gtk.Window.FocusActivated" /> event on <see cref="T:Gtk.Widget" />; <paramref name="widgets" /> override the default handler for this event in order to implement appropriate focus behavior.
</para> </para>
<para> <para>
The "focus" default handler for a widget should return <see langword="true" /> if moving in direction left the focus on a focusable location inside that widget, and <see langword="false" /> if moving in direction moved the focus outside the widget. If returning <see langword="true" />, widgets normally call <see cref="M:Gtk.Widget.GrabFocus" /> to place the focus accordingly; if returning <see langword="false" />, they don't modify the current focus location. The "focus" default handler for a <paramref name="widget" /> should return <see langword="true" /> if moving in direction left the focus on a focusable location inside that <paramref name="widget" />, and <see langword="false" /> if moving in direction moved the focus outside the <paramref name="widget" />. If returning <see langword="true" />, <paramref name="widgets" /> normally call <see cref="M:Gtk.Widget.GrabFocus" /> to place the focus accordingly; if returning <see langword="false" />, they don't modify the current focus location.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -209,7 +209,7 @@
<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> <remarks>
<para> <para>
This function is only for use in widget implementations. This method is only for use in widget implementations.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -225,10 +225,10 @@
<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> <remarks>
<para> <para>
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. For example, <paramref name="widget" />-&gt;window will be created when a <paramref name="widget" /> is realized. Normally realization happens implicitly; if you show a <paramref name="widget" /> and all its parent containers, then it will be realized and mapped automatically. Realizing a <paramref name="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 <paramref name="widget" /> itself. If a <paramref name="widget" /> is not yet inside a toplevel window when you realize it, bad things will happen.
</para> </para>
<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 method 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 event that will be called after the <paramref name="widget" /> is realized automatically, such as <see cref="F:Gtk.Widget.ExposeEvent" />. Or simply <see cref="M:Glib.SignalAttr.ConnectAfter" /> to the realize event.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -253,10 +253,10 @@
<param name="height">Height of region to draw.</param> <param name="height">Height of region to draw.</param>
<remarks> <remarks>
<para> <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 <paramref name="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>
<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 method 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 method. Those methods will invalidate only a single window, instead of the <paramref name="widget" /> and all its children.
</para> </para>
<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. 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.
@ -297,14 +297,14 @@
<Parameter Name="detail" Type="System.String" /> <Parameter Name="detail" Type="System.String" />
</Parameters> </Parameters>
<Docs> <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 method 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="stock_id">A stock ID.</param>
<param name="size">A stock size.</param> <param name="size">A stock size.</param>
<param name="detail">Render detail to pass to theme engine.</param> <param name="detail">Render detail to pass to theme engine.</param>
<returns>A new <see cref="T:Gdk.Pixbuf" />, or <see langword="null" /> if the <paramref name="stock_id" /> wasn't known.</returns> <returns>A new <see cref="T:Gdk.Pixbuf" />, or <see langword="null" /> if the <paramref name="stock_id" /> wasn't known.</returns>
<remarks> <remarks>
<para> <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 <paramref name="widget" /> or code doing the rendering, so that theme engines can special-case rendering for that <paramref name="widget" /> or code.
</para> </para>
<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" />.
@ -365,7 +365,7 @@
<param name="color">The color to assign (does not need to be allocated), or <see 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 langword="null" /> to undo the effect of previous calls to of <see cref="M:Gtk.Widget.ModifyText" />.</param>
<remarks> <remarks>
<para> <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 <paramref name="widgets" /> such as <see cref="T:Gtk.Entry" /> and <see cref="T:Gtk.TextView" />. See also <see cref="M:Gtk.Widget.ModifyStyle" />.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -395,11 +395,11 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <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> <summary>Utility method; intended to be connected to the <see cref="F:Gtk.Widget.DeleteEvent" /> event on a <see cref="T:Gtk.Window" />.</summary>
<returns>Returns <see langword="true" />.</returns> <returns>Returns <see langword="true" />.</returns>
<remarks> <remarks>
<para> <para>
The function calls <see cref="M:Gtk.Widget.Hide" /> on its argument, then returns <see 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 method calls <see cref="M:Gtk.Widget.Hide" /> on its argument, then returns <see 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> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -418,7 +418,7 @@
<param name="requisition">A <see cref="T:Gtk.Requisition" /> to be filled in.</param> <param name="requisition">A <see cref="T:Gtk.Requisition" /> to be filled in.</param>
<remarks> <remarks>
<para> <para>
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" />. Obtains <paramref name="widget" />-&gt;<paramref name="requisition" />, unless someone has forced a particular geometry, in which case it returns that geometry instead of the widget's <paramref name="requisition" />. This method 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> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -434,7 +434,7 @@
<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> <remarks>
<para> <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 <paramref name="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> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -474,7 +474,7 @@
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>
<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 is a low level method 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> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -495,16 +495,16 @@
<Docs> <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_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_group">Accel group for this <paramref name="widget"/>, added to its toplevel.</param>
<param name="accel_key">GDK keyval of the accelerator.</param> <param name="accel_key">GDK keyval of the accelerator.</param>
<param name="accel_mods">Modifier key combination of the accelerator.</param> <param name="accel_mods">Modifier key combination of the accelerator.</param>
<param name="accel_flags">Flag accelerators.</param> <param name="accel_flags">Flag accelerators.</param>
<remarks> <remarks>
<para> <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 method are not user changeable during runtime.
</para> </para>
<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 method 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> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -520,10 +520,10 @@
<summary>Flags a <paramref name="widget" /> to be displayed.</summary> <summary>Flags a <paramref name="widget" /> to be displayed.</summary>
<remarks> <remarks>
<para> <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 <paramref name="widget" /> that isn't shown will not appear on the screen. If you want to show all the <paramref name="widgets" /> in a container, it's easier to call <see cref="M:Gtk.Widget.ShowAll" /> on the container, instead of individually showing the <paramref name="widgets" />.
</para> </para>
<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. Remember that you have to show the containers containing a <paramref name="widget" />, in addition to the <paramref name="widget" /> itself, before it will appear onscreen. And that when a toplevel container is shown, it is immediately realized and mapped; other shown <paramref name="widgets" /> are realized and mapped when their toplevel container is realized and mapped.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -542,7 +542,7 @@
<summary>For <paramref name="widgets" /> that support scrolling, sets the scroll adjustments.</summary> <summary>For <paramref name="widgets" /> that support scrolling, sets the scroll adjustments.</summary>
<param name="hadjustment">An adjustment for horizontal scrolling, or <see langword="null" />.</param> <param name="hadjustment">An adjustment for horizontal scrolling, or <see langword="null" />.</param>
<param name="vadjustment">An adjustment for vertical scrolling, or <see langword="null" />.</param> <param name="vadjustment">An adjustment for vertical scrolling, or <see langword="null" />.</param>
<returns>Returns <see langword="true" /> if the widget supports scrolling.</returns> <returns>Returns <see langword="true" /> if the <paramref name="widget" /> supports scrolling.</returns>
<remarks> <remarks>
<para> <para>
For <paramref name="widgets" /> that don't support scrolling, does nothing and returns <see 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 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.
@ -565,7 +565,7 @@
<returns>The new <see cref="T:Pango.Layout" />.</returns> <returns>The new <see cref="T:Pango.Layout" />.</returns>
<remarks> <remarks>
<para> <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 <paramref name="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" /> events for the <paramref name="widget" />.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -581,7 +581,7 @@
<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> <remarks>
<para> <para>
This function is not useful for applications. This method is not useful for applications.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -594,11 +594,11 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>For <paramref name="widgets" /> that can be "activated" (buttons, menu items, etc.) this function activates them.</summary> <summary>For <paramref name="widgets" /> that can be "activated" (buttons, menu items, etc.) this method activates them.</summary>
<returns>Returns <see langword="true" /> if the widget was activatable.</returns> <returns>Returns <see langword="true" /> if the <paramref name="widget" /> was activatable.</returns>
<remarks> <remarks>
<para> <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 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 method returns <see langword="false" />.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -634,12 +634,12 @@
<Parameter Name="evnt" Type="Gdk.Event" /> <Parameter Name="evnt" Type="Gdk.Event" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Rarely-used function. This function is used to emit the event signals on a <paramref name="widget" />.</summary> <summary>Rarely-used method. This method is used to emit the events on a <paramref name="widget" />.</summary>
<param name="evnt">A <see cref="T:Gdk.Event" />.</param> <param name="evnt">A <see cref="T:Gdk.Event" />.</param>
<returns>Return from the event signal emission (<see langword="true" /> if the event was handled)</returns> <returns>Return from the event emission (<see langword="true" /> if the event was handled)</returns>
<remarks> <remarks>
<para> <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 method; instead, use <see cref="M:Gdk.Windowt.InvalidateRect" /> to invalidate a region of the window.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -655,7 +655,7 @@
<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> <remarks>
<para> <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 <paramref name="widget" /> to be hidden (invisible to the user).
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -676,7 +676,7 @@
<param name="color">The color to assign (does not need to be allocated), or <see 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 langword="null" /> to undo the effect of previous calls to of <see cref="M:Gtk.Widget.ModifyBase" />.</param>
<remarks> <remarks>
<para> <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 <paramref name="widgets" /> such as <see cref="T:Gtk.Entry" /> and <see cref="T:Gtk.TextView" />. See also <see cref="M:Gtk.Widget.ModifyStyle" />.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -693,10 +693,10 @@
<Docs> <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> <param name="widget_type">Ancestor type.</param>
<returns>The ancestor widget, or <see langword="null" /> if not found</returns> <returns>The ancestor <paramref name="widget" />, or <see langword="null" /> if not found</returns>
<remarks> <remarks>
<para> <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 <paramref name="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> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -712,7 +712,7 @@
<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> <remarks>
<para> <para>
Recursively resets the shape on this widget and its descendants. Recursively resets the shape on this <paramref name="widget" /> and its descendants.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -731,10 +731,10 @@
<param name="style">The <see cref="T:Gtk.RcStyle" /> holding the style modifications.</param> <param name="style">The <see cref="T:Gtk.RcStyle" /> holding the style modifications.</param>
<remarks> <remarks>
<para> <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 method, to modify some style values and leave the others unchanged.
</para> </para>
<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 method are not cumulative with previous calls to <see cref="M:Gtk.Widget.ModifyStyle" /> or with such methods 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 methods <see cref="M:Gtk.Widget.ModifyFg" /> will have a cumulative effect with the initial modifications.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -755,10 +755,10 @@
<param name="height">Weight <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> <remarks>
<para> <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 method to force a <paramref name="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 method; 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 method as well.
</para> </para>
<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. 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 <paramref name="widget" />. So, it's basically impossible to hardcode a size that will always be correct. The size request of a <paramref name="widget" /> is the smallest size a <paramref name="widget" /> can accept while still methoding well and drawing itself correctly. However in some strange cases a <paramref name="widget" /> may be allocated less than its requested size, and in many cases a <paramref name="widget" /> may be allocated more space than it requested.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -795,7 +795,7 @@
<param name="height">Return location for height, or <see langword="null" />.</param> <param name="height">Return location for height, or <see langword="null" />.</param>
<remarks> <remarks>
<para> <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 method.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -813,7 +813,7 @@
</Parameters> </Parameters>
<Docs> <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_group">Accel group for this <paramref name="widget" />.</param>
<param name="accel_key">GDK keyval of the accelerator.</param> <param name="accel_key">GDK keyval of the accelerator.</param>
<param name="accel_mods">Modifier key combination 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> <returns>Returns whether an accelerator was installed and could be removed.</returns>
@ -835,7 +835,7 @@
<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> <remarks>
<para> <para>
This function is only for use in widget implementations. This method is only for use in widget implementations.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -851,7 +851,7 @@
<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> <remarks>
<para> <para>
This function is only for use in widget implementations. This method is only for use in widget implementations.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -867,8 +867,8 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Computes the intersection of a <paramref name="widget" />'s area and <paramref name="region" />, returning the intersection. </summary> <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> <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" /> <paramref name="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> <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" /> <paramref name="widgets" />, and relative to the parent window of <paramref name="widget" />-&gt;window for widgets with their own window.</returns>
<remarks> <remarks>
<para> <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.
@ -887,7 +887,7 @@
<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> <remarks>
<para> <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 method 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> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -921,12 +921,12 @@
<Parameter Name="evnt" Type="Gdk.Event" /> <Parameter Name="evnt" Type="Gdk.Event" />
</Parameters> </Parameters>
<Docs> <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> <summary>Very rarely-used method. This method is used to emit an <see cref="F:Gtk.Widget.ExposeEvent" /> events on a <paramref name="widget" />.</summary>
<param name="evnt">A <see cref="F:Gtk.Widget.ExposeEvent" />.</param> <param name="evnt">A <see cref="F:Gtk.Widget.ExposeEvent" />.</param>
<returns>Return from the event signal emission (<see langword="true" /> if the event was handled).</returns> <returns>Return from the event emission (<see langword="true" /> if the event was handled).</returns>
<remarks> <remarks>
<para> <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 method 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" /> <paramref name="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> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -942,7 +942,7 @@
<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> <remarks>
<para> <para>
This function is only useful in widget implementations. This method is only useful in widget implementations.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -958,7 +958,7 @@
<summary>Ensures that <paramref name="widget" /> has a style (<paramref name="widget" />-&gt;style).</summary> <summary>Ensures that <paramref name="widget" /> has a style (<paramref name="widget" />-&gt;style).</summary>
<remarks> <remarks>
<para> <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 method; most of the time, if you want the style, the <paramref name="widget" /> is realized, and realized <paramref name="widgets" /> are guaranteed to have a style already.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -975,7 +975,7 @@
<Docs> <Docs>
<summary>Determines whether <paramref name="widget" /> is somewhere inside <paramref name="ancestor" />, possibly with intermediate containers.</summary> <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> <param name="ancestor">Another <see cref="T:Gtk.Widget" />.</param>
<returns>Returns <see langword="true" /> if ancestor contains widget as a child, grandchild, great grandchild, etc.</returns> <returns>Returns <see langword="true" /> if ancestor contains <paramref name="widget" /> as a child, grandchild, great grandchild, etc.</returns>
<remarks> <remarks>
<para> <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.
@ -1029,7 +1029,7 @@
<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> <remarks>
<para> <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" /> events on <paramref name="widget" /> to be emitted.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -1067,11 +1067,11 @@
<Parameter Name="child_property" Type="System.String" /> <Parameter Name="child_property" Type="System.String" />
</Parameters> </Parameters>
<Docs> <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" /> event 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> <param name="child_property">The name of a child property installed on the class of widget's parent.</param>
<remarks> <remarks>
<para> <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" /> event for the child property on <paramref name="widget" />.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -1087,10 +1087,10 @@
<summary>Destroys a <paramref name="widget" />.</summary> <summary>Destroys a <paramref name="widget" />.</summary>
<remarks> <remarks>
<para> <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 <paramref name="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>
<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 <paramref name="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> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -1103,10 +1103,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <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" /> events on <paramref name="widget" />.</summary>
<remarks> <remarks>
<para> <para>
The signals are queued until <see cref="M:Gtk.Widget.ThawChildNotify" /> is called on <paramref name="widget" />. The events are queued until <see cref="M:Gtk.Widget.ThawChildNotify" /> is called on <paramref name="widget" />.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -1121,11 +1121,11 @@
<Parameter Name="allocation" Type="Gdk.Rectangle" /> <Parameter Name="allocation" Type="Gdk.Rectangle" />
</Parameters> </Parameters>
<Docs> <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> <summary>This method is only used by <see cref="T:Gtk.Container" /> subclasses, to assign a size and position to their child <paramref name="widgets" />.</summary>
<param name="allocation">A position and size to be allocated to <paramref name="widget" />.</param> <param name="allocation">A position and size to be allocated to <paramref name="widget" />.</param>
<remarks> <remarks>
<para> <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 <paramref name="widgets" />.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -1164,9 +1164,11 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>A constructor.</summary> <summary>Internal constructor.</summary>
<returns>An instance of <see cref="T:Gtk.Widget" />.</returns> <returns>An instance of <see cref="T:Gtk.Widget" />.</returns>
<remarks /> <remarks>
<para>This is an internal constructor, and should not be used by user code.</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DefaultVisual"> <Member MemberName="DefaultVisual">
@ -1192,11 +1194,11 @@
<ReturnType>Gtk.Style</ReturnType> <ReturnType>Gtk.Style</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>Obtains the default style used by all widgets initially.</summary> <summary>Obtains the default style used by all <paramref name="widgets" /> initially.</summary>
<returns>Returns the default style. This <see cref="T:Gtk.Style" /> object is owned by GTK+ and should not be modified or freed.</returns> <returns>Returns the default style. This <see cref="T:Gtk.Style" /> object is owned by GTK+ and should not be modified or freed.</returns>
<remarks> <remarks>
<para> <para>
Returns the default style used by all widgets initially. Returns the default style used by all <paramref name="widgets" /> initially.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -1209,12 +1211,12 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>Sets or obtains the default colormap to use when creating widgets.</summary> <summary>Sets or obtains the default colormap to use when creating <paramref name="widgets" />.</summary>
<param name="value">A colormap (see <see cref="T:Gdk.Colormap" />).</param> <param name="value">A colormap (see <see cref="T:Gdk.Colormap" />).</param>
<returns>A <see cref="T:Gdk.Colormap" />.</returns> <returns>A <see cref="T:Gdk.Colormap" />.</returns>
<remarks> <remarks>
<para> <para>
<see cref="M:Gtk.Widget.PushColormap" /> is a better function to use if you only want to affect a few widgets, rather than all widgets. <see cref="M:Gtk.Widget.PushColormap" /> is a better method to use if you only want to affect a few widgets, rather than all widgets.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -1227,7 +1229,7 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>Sets or obtains the default reading direction for widgets.</summary> <summary>Sets or obtains the default reading direction for <paramref name="widgets" />.</summary>
<param name="value">A <see cref="P:Gtk.Widget.TextDirection" />.</param> <param name="value">A <see cref="P:Gtk.Widget.TextDirection" />.</param>
<returns>A <see cref="P:Gtk.Widget.TextDirection" />.</returns> <returns>A <see cref="P:Gtk.Widget.TextDirection" />.</returns>
<remarks> <remarks>
@ -1280,9 +1282,9 @@
<ReturnType>Atk.Object</ReturnType> <ReturnType>Atk.Object</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>Obtains the default reading direction for widgets.</summary> <summary>Obtains the default reading direction for <paramref name="widgets" />.</summary>
<returns>A <see cref="T:Atk.Object" />.</returns> <returns>A <see cref="T:Atk.Object" />.</returns>
<remarks>Obtains the default reading direction for widgets.</remarks> <remarks>Obtains the default reading direction for <paramref name="widgets" />.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Direction"> <Member MemberName="Direction">
@ -1295,10 +1297,10 @@
<Docs> <Docs>
<summary>Sets or obtains the reading direction on a particular <paramref name="widget" />.</summary> <summary>Sets or obtains the reading direction on a particular <paramref name="widget" />.</summary>
<param name="value">A <see cref="T:Gtk.TextDirection" />.</param> <param name="value">A <see cref="T:Gtk.TextDirection" />.</param>
<returns>The reading direction for the widget.</returns> <returns>The reading direction for the <paramref name="widget" />.</returns>
<remarks> <remarks>
<para> <para>
This direction controls the primary direction for widgets containing text, and also the direction in which the children of a container are packed. The ability to set the direction is present in order so that correct localization into languages with right-to-left reading directions can be done. Generally, applications will let the default reading direction present, except for containers where the containers are arranged in an order that is explicitely visual rather than logical (such as buttons for text justification). If the direction is set none, then the value set by <see cref="P:Gtk.Widget.DefaultDirection" /> will be used. This direction controls the primary direction for <paramref name="widgets" /> containing text, and also the direction in which the children of a container are packed. The ability to set the direction is present in order so that correct localization into languages with right-to-left reading directions can be done. Generally, applications will let the default reading direction present, except for containers where the containers are arranged in an order that is explicitely visual rather than logical (such as buttons for text justification). If the direction is set none, then the value set by <see cref="P:Gtk.Widget.DefaultDirection" /> will be used.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -1331,13 +1333,13 @@
<Docs> <Docs>
<summary>Sets or obtains whether <paramref name="widget" /> should be mapped along with its when its parent is mapped and <paramref name="widget" /> has been shown with <see cref="M:Gtk.Widget.Show" />.</summary> <summary>Sets or obtains whether <paramref name="widget" /> should be mapped along with its when its parent is mapped and <paramref name="widget" /> has been shown with <see cref="M:Gtk.Widget.Show" />.</summary>
<param name="value">If <see langword="true" />, <paramref name="widget" /> should be mapped along with its parent.</param> <param name="value">If <see langword="true" />, <paramref name="widget" /> should be mapped along with its parent.</param>
<returns>Returns <see langword="true" /> if the widget is mapped with the parent.</returns> <returns>Returns <see langword="true" /> if the <paramref name="widget" /> is mapped with the parent.</returns>
<remarks> <remarks>
<para> <para>
The child visibility can be set for widget before it is added to a container with <see cref="P:Gtk.Widget.Parent" />, to avoid mapping children unnecessary before immediately unmapping them. However it will be reset to its default state of <see langword="true" /> when the widget is removed from a container. The child visibility can be set for <paramref name="widget" /> before it is added to a container with <see cref="P:Gtk.Widget.Parent" />, to avoid mapping children unnecessary before immediately unmapping them. However it will be reset to its default state of <see langword="true" /> when the <paramref name="widget" /> is removed from a container.
</para> </para>
<para> <para>
Note that changing the child visibility of a widget does not queue a resize on the widget. Most of the time, the size of a widget is computed from all visible children, whether or not they are mapped. If this is not the case, the container can queue a resize itself. This function is only useful for container implementations and never should be called by an application. Note that changing the child visibility of a <paramref name="widget" /> does not queue a resize on the <paramref name="widget" />. Most of the time, the size of a <paramref name="widget" /> is computed from all visible children, whether or not they are mapped. If this is not the case, the container can queue a resize itself. This property is only useful for container implementations and never should be called by an application.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -1355,7 +1357,7 @@
<returns>The composite name of <paramref name="widget" />, or <see langword="null" /> if <paramref name="widget" /> is not a composite child. The string should not be freed when it is no longer needed.</returns> <returns>The composite name of <paramref name="widget" />, or <see langword="null" /> if <paramref name="widget" /> is not a composite child. The string should not be freed when it is no longer needed.</returns>
<remarks> <remarks>
<para> <para>
The widget must be a composite child of its parent; see <see cref="M:Gtk.Widget.PushCompositeChild" />. The <paramref name="widget" /> must be a composite child of its parent; see <see cref="M:Gtk.Widget.PushCompositeChild" />.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -1367,11 +1369,11 @@
<ReturnType>Gtk.Widget</ReturnType> <ReturnType>Gtk.Widget</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>Obtains the topmost widget in the container hierarchy <paramref name="widget" /> is a part of.</summary> <summary>Obtains the topmost <paramref name="widget" /> in the container hierarchy <paramref name="widget" /> is a part of.</summary>
<returns>The topmost ancestor of <paramref name="widget" />, or <paramref name="widget" /> itself if there's no ancestor.</returns> <returns>The topmost ancestor of <paramref name="widget" />, or <paramref name="widget" /> itself if there's no ancestor.</returns>
<remarks> <remarks>
<para> <para>
Note the difference in behavior against <see cref="P:Gtk.Widget.GetAncestor" />, would return <see langwod="null" /> if <paramref name="widget" /> wasn't inside a toplevel window, and if the window was inside a GtkWindow-derived widget which was in turn inside the toplevel <see cref="T:Gtk.Window" />. While the second case may seem unlikely, it actually happens when a <see cref="T:Gtk.Plug" /> is embedded inside a <see cref="T:Gtk.Socket" /> within the same application. To reliably find the toplevel <see cref="T:Gtk.Window" />, use <see cref="P:Gtk.Widget.TopLevel" /> and check if the <see cref="F:Gtk.WidgetFlags.TopLevel" /> flag is set on the result. Note the difference in behavior against <see cref="P:Gtk.Widget.GetAncestor" />, would return <see langwod="null" /> if <paramref name="widget" /> wasn't inside a toplevel window, and if the window was inside a GtkWindow-derived <paramref name="widget" /> which was in turn inside the toplevel <see cref="T:Gtk.Window" />. While the second case may seem unlikely, it actually happens when a <see cref="T:Gtk.Plug" /> is embedded inside a <see cref="T:Gtk.Socket" /> within the same application. To reliably find the toplevel <see cref="T:Gtk.Window" />, use <see cref="P:Gtk.Widget.TopLevel" /> and check if the <see cref="F:Gtk.WidgetFlags.TopLevel" /> flag is set on the result.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -1386,14 +1388,14 @@
<Docs> <Docs>
<summary>Sets whether a <paramref name="widget" /> size allocation changes, the entire <paramref name="widget" /> is queued for drawing.</summary> <summary>Sets whether a <paramref name="widget" /> size allocation changes, the entire <paramref name="widget" /> is queued for drawing.</summary>
<param name="value"> <param name="value">
<see langword="true" /> the entire widget will be redrawn when it is allocated to a new size. <see langword="false" /> only the new portion of the widget will be redrawn.</param> <see langword="true" /> the entire <paramref name="widget" /> will be redrawn when it is allocated to a new size. <see langword="false" /> only the new portion of the <paramref name="widget" /> will be redrawn.</param>
<returns>Returns <see langword="true" /> because it is on by Default, but returns <see langword="false" /> if you turn it off.</returns> <returns>Returns <see langword="true" /> because it is on by Default, but returns <see langword="false" /> if you turn it off.</returns>
<remarks> <remarks>
<para> <para>
By default, this setting is <see 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 langword="true" /> and the entire <paramref name="widget" /> is redrawn on every size change. If your <paramref name="widget" /> leaves the upper left are unchanged when made bigger, turning this setting on will improve performance.
</para> </para>
<para> <para>
Note that for <see cref="F:Gtk.WidgetFlags.NoWindow" /> widgets setting this flag to <see 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. Note that for <see cref="F:Gtk.WidgetFlags.NoWindow" /> <paramref name="widgets" /> setting this flag to <see langword="false" /> turns off all allocation on resizing: the <paramref name="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" /> <paramref name="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 <paramref name="widget" /> is moved and responsible for invalidating regions newly when the <paramref name="widget" /> increases size.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -1406,16 +1408,16 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>Use this function to turn off the double buffering.</summary> <summary>Use this property to turn off the double buffering.</summary>
<param name="value"> <param name="value">
<see langword="true" /> is on by Default, <see langword="false" /> if you want to turn off double buffering no use call for true because it is default.</param> <see langword="true" /> is on by Default, <see langword="false" /> if you want to turn off double buffering no use call for true because it is default.</param>
<returns>Returns <see langword="true" /> because double buffering is on by Default, but returns <see langword="false" /> if you turn it off.</returns> <returns>Returns <see langword="true" /> because double buffering is on by Default, but returns <see langword="false" /> if you turn it off.</returns>
<remarks> <remarks>
<para> <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 property 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 <paramref name="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>
<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. In very simple terms, double buffered <paramref name="widgets" /> don't flicker, so you would only use this property to turn off double buffering if you had special needs and really knew what you were doing.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -1431,7 +1433,7 @@
<returns>The relevant <see cref="T:Gtk.Settings" /> object.</returns> <returns>The relevant <see cref="T:Gtk.Settings" /> object.</returns>
<remarks> <remarks>
<para> <para>
Note that this function can only be called when the <see cref="T:Gtk.Widget" /> is attached to a toplevel, since the settings object is specific to a particular <see cref="T:Gdk.Screen" />. Note that this property can only be called when the <see cref="T:Gtk.Widget" /> is attached to a toplevel, since the settings object is specific to a particular <see cref="T:Gdk.Screen" />.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -1465,10 +1467,10 @@
<returns /> <returns />
<remarks> <remarks>
<para> <para>
Unlike the context returned by <see cref="M:Gtk.Widget.CreatePangoContext" />, this context is owned by the <paramref name="widget" /> (it can be used until the screen for the widget changes or the widget is removed from its toplevel), and will be updated to match any changes to the <paramref name="widget" />'s attributes. Unlike the context returned by <see cref="M:Gtk.Widget.CreatePangoContext" />, this context is owned by the <paramref name="widget" /> (it can be used until the screen for the <paramref name="widget" /> changes or the <paramref name="widget" /> is removed from its toplevel), and will be updated to match any changes to the <paramref name="widget" />'s attributes.
</para> </para>
<para> <para>
If you create and keep a <see cref="T:Pango.Layout" /> using this context, you must deal with changes to the context by calling <see cref="T:Pango.Layout.ContextChanged" /> on the layout in response to the <see cref="F:Gtk.Widget.StyleSet" /> and <see cref="F:Gtk.Widget.DirectionChanged" /> signals for the <paramref name="widget" />. If you create and keep a <see cref="T:Pango.Layout" /> using this context, you must deal with changes to the context by calling <see cref="T:Pango.Layout.ContextChanged" /> on the layout in response to the <see cref="F:Gtk.Widget.StyleSet" /> and <see cref="F:Gtk.Widget.DirectionChanged" /> events for the <paramref name="widget" />.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -1486,7 +1488,7 @@
<returns>The <see cref="T:Gtk.StateType" /> of the <paramref name="widget" />.</returns> <returns>The <see cref="T:Gtk.StateType" /> of the <paramref name="widget" />.</returns>
<remarks> <remarks>
<para> <para>
Usually you should set the state using wrapper functions such as <see cref="P:Gtk.Widget.Sensitive" />. This function is for use in widget implementations. Usually you should set the state using wrapper fuctions such as <see cref="P:Gtk.Widget.Sensitive" />. This property is for use in widget implementations.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -1514,11 +1516,11 @@
<ReturnType>Gtk.RcStyle</ReturnType> <ReturnType>Gtk.RcStyle</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>Obtains the current modifier style for the widget.(As set by <see cref="M:Gtk.Widget.ModifyStyle" />)</summary> <summary>Obtains the current modifier style for the <paramref name="widget" />.(As set by <see cref="M:Gtk.Widget.ModifyStyle" />)</summary>
<returns>The modifier style for the widget. This rc style is owned by the widget.</returns> <returns>The modifier style for the <paramref name="widget" />. This rc style is owned by the <paramref name="widget" />.</returns>
<remarks> <remarks>
<para> <para>
If no style has previously set, a new <see cref="T:Gtk.RcStyle" /> will be created with all values unset, and set as the modifier style for the widget. If you make changes to this rc style, you must call <see cref="M:Gtk.Widget.ModifyStyle" />, passing in the returned rc style, to make sure that your changes take effect. If no style has previously set, a new <see cref="T:Gtk.RcStyle" /> will be created with all values unset, and set as the modifier style for the <paramref name="widget" />. If you make changes to this rc style, you must call <see cref="M:Gtk.Widget.ModifyStyle" />, passing in the returned rc style, to make sure that your changes take effect.
</para> </para>
<para> <para>
Caution: passing the style back to <see cref="M:Gtk.Widget.ModifyStyle" /> will normally end up destroying it, because <see cref="M:Gtk.Widget.ModifyStyle" /> copies the passed-in style and sets the copy as the new modifier style, thus dropping any reference to the old modifier style. Add a reference to the modifier style if you want to keep it alive. Caution: passing the style back to <see cref="M:Gtk.Widget.ModifyStyle" /> will normally end up destroying it, because <see cref="M:Gtk.Widget.ModifyStyle" /> copies the passed-in style and sets the copy as the new modifier style, thus dropping any reference to the old modifier style. Add a reference to the modifier style if you want to keep it alive.
@ -2508,10 +2510,10 @@
<Docs> <Docs>
<summary>Determines if the <paramref name="widget" /> is the focus widget within its toplevel.</summary> <summary>Determines if the <paramref name="widget" /> is the focus widget within its toplevel.</summary>
<returns> <returns>
<see langword="true" /> if the widget is the focus widget.</returns> <see langword="true" /> if the <paramref name="widget" /> is the focus widget.</returns>
<remarks> <remarks>
<para> <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 <paramref name="widget" /> additionally has the global input focus.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -2566,9 +2568,9 @@
<param name="property_name">The name of a style property.</param> <param name="property_name">The name of a style property.</param>
<param name="value">Location to return the property value.</param> <param name="value">Location to return the property value.</param>
<remarks> <remarks>
<para> <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> </para>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
@ -2582,10 +2584,14 @@
<Parameter Name="selection" Type="Gdk.Atom" /> <Parameter Name="selection" Type="Gdk.Atom" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Returns the clipboard object for the given selection to be used with <paramref name="widget" />.</summary>
<param name="selection">a <see cref="T:Gdk.Atom" /></param> <param name="selection">A <see cref="T:Gdk.Atom" /> which identifies the clipboard to use. GDK_SELECTION_CLIPBOARD gives the default clipboard, another common value is GDK_SELECTION_PRIMARY, which gives the primary X selection.</param>
<returns>a <see cref="T:Gtk.Clipboard" /></returns> <returns>The appropiate clipboard object. If no clipboard already exists, a new one will be created. Once a clipboard object has been created, it is persistent for all time.</returns>
<remarks>To be added</remarks> <remarks>
<para>
<paramref name="widget" /> must have a <see cref="T:Gdk.Display" /> associated with it, so must be attached to a toplevel window.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetPointer"> <Member MemberName="GetPointer">
@ -2603,9 +2609,9 @@
<param name="x">Return location for the X coordinate, or <see langword="null" />.</param> <param name="x">Return location for the X coordinate, or <see langword="null" />.</param>
<param name="y">Return location for the Y coordinate, or <see langword="null" />.</param> <param name="y">Return location for the Y coordinate, or <see langword="null" />.</param>
<remarks> <remarks>
<para> <para>
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. 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" /> <paramref name="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" /> <paramref name="widgets" />.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
@ -2625,15 +2631,15 @@
<Docs> <Docs>
<summary>Translate coordinates relative to <paramref name="widget" />'s allocation to coordinates relative to <paramref name="dest_widget" />'s allocations.</summary> <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="dest_widget">A <see cref="T:Gtk.Widget" />.</param>
<param name="src_x">X position relative to source widget.</param> <param name="src_x">X position relative to source <paramref name="widget" />.</param>
<param name="src_y">Y position relative to source widget.</param> <param name="src_y">Y position relative to source <paramref name="widget" />.</param>
<param name="dest_x">Location to store X position relative to <paramref name="dest_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> <param name="dest_y">Location to store Y position relative to <paramref name="dest_widget" />.</param>
<returns>Returns <see 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 langword="true" />.</returns> <returns>Returns <see langword="false" /> if either <paramref name="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 langword="true" />.</returns>
<remarks> <remarks>
<para> <para>
In order to perform this operation, both widgets must be realized, and must share a common toplevel. In order to perform this operation, both widgets must be realized, and must share a common toplevel.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
@ -2654,12 +2660,12 @@
<param name="path">Location to store allocated path string, or <see langword="null" />.</param> <param name="path">Location to store allocated path string, or <see langword="null" />.</param>
<param name="path_reversed">Location to store allocated reverse path string, or <see langword="null" />.</param> <param name="path_reversed">Location to store allocated reverse path string, or <see langword="null" />.</param>
<remarks> <remarks>
<para> <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>
<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> </para>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
@ -2671,9 +2677,13 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Checks whether there is a <see cref="T:Gdk.Screen" /> is associated with this <paramref name="widget" />,</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns><see langword="true" /> if there is a <see cref="T:Gdk.Screen" /> associated with the <paramref name="widget" />.</returns>
<remarks>To be added</remarks> <remarks>
<para>
All toplevel <paramref name="widgets" /> have an associated screen, and all <paramref name="widgets" /> added into a heirarchy with a toplevel window at the top.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ClassPath"> <Member MemberName="ClassPath">
@ -2688,11 +2698,11 @@
<Parameter Name="path_reversed" Type="System.String&amp;" RefType="out" /> <Parameter Name="path_reversed" Type="System.String&amp;" RefType="out" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <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">a <see cref="T:System.UInt32&amp;" /></param> <param name="path_length">Location to store the length of the class path. or <see langword="null" />.</param>
<param name="path">a <see cref="T:System.String&amp;" /></param> <param name="path">Location to store the class path as an allocated string, or <see langword="null" />.</param>
<param name="path_reversed">a <see cref="T:System.String&amp;" /></param> <param name="path_reversed">Location to store the reverse class path as an allocated string, or <see langword="null" />.</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SizeRequest"> <Member MemberName="SizeRequest">
@ -2708,12 +2718,12 @@
<summary>Obtains the preferred size of a <paramref name="widget" />.</summary> <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> <param name="requisition">A <see cref="T:Gtk.Requisition" /> to be filled in.</param>
<remarks> <remarks>
<para> <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 <paramref name="widgets" /> and decide what size allocations to give them with <see cref="M:Gtk.Widget.SizeAllocate" />. You can also call this method from an application, with some caveats. Most notably, getting a size request requires the <paramref name="widget" /> to be associated with a screen, because font information may be needed. Multihead-aware applications should keep this in mind.
</para> </para>
<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 method is typically used when implementing a <see cref="T:Gtk.Container" /> subclass. Also remember that the size request is not necessarily the size a <paramref name="widget" /> will actually be allocated.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>

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

@ -1,5 +1,5 @@
<Type Name="WidgetFlags" FullName="Gtk.WidgetFlags"> <Type Name="WidgetFlags" FullName="Gtk.WidgetFlags">
<TypeSignature Language="C#" Value="public enum WidgetFlags" Maintainer="auto" /> <TypeSignature Language="C#" Value="public enum WidgetFlags" Maintainer="Hector Gomez M" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey></AssemblyPublicKey> <AssemblyPublicKey></AssemblyPublicKey>
@ -9,8 +9,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Tells about certain properties of the <paramref name="widget" />.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Enum</BaseTypeName> <BaseTypeName>System.Enum</BaseTypeName>
@ -40,8 +40,12 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>To be added</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>To be added</remarks> <remarks>
<para>
Toplevel widgets always contain their own <see cref="T:Gdk.Window" />.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="NoWindow"> <Member MemberName="NoWindow">
@ -52,8 +56,12 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Indicative for a <paramref name="widget" /> that does not provide its own <see cref="T:Gdk.Window" />.</summary>
<remarks>To be added</remarks> <remarks>
<para>
Visible action (e.g. drawing) is performed on the parent's <see cref="T:Gdk.Window" />.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Realized"> <Member MemberName="Realized">
@ -64,8 +72,12 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary> Set by <see cref="M:Gtk.Widget.Realize" />, unset by <see cref="M:Gtk.Widget.Unrealize" />.</summary>
<remarks>To be added</remarks> <remarks>
<para>
A realized <paramref name="widget" /> has an associated <see cref="T:Gdk.Window" />.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Mapped"> <Member MemberName="Mapped">
@ -76,8 +88,12 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Set by <see cref="M:Gtk.Widget.Map" />, unset by <see cref="M:Gtk.Widget.Map" />.</summary>
<remarks>To be added</remarks> <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).
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Visible"> <Member MemberName="Visible">
@ -88,8 +104,12 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>To be added</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>To be added</remarks> <remarks>
<para>
Implies that a <paramref name="widget" /> will be mapped as soon as its parent is mapped.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Sensitive"> <Member MemberName="Sensitive">
@ -100,8 +120,12 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>To be added</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>To be added</remarks> <remarks>
<para>
One premise for the widgets sensitivity is to have this flag set.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ParentSensitive"> <Member MemberName="ParentSensitive">
@ -112,8 +136,12 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Set and unset by <see cref="P:Gtk.Widget.Sensitive" /> operations on the parents of the <paramref name="widget" />.</summary>
<remarks>To be added</remarks> <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.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CanFocus"> <Member MemberName="CanFocus">
@ -124,8 +152,12 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Determines whether a <paramref name="widget" /> is able to handle focus grabs.</summary>
<remarks>To be added</remarks> <remarks>
<para>
Determines whether a <paramref name="widget" /> is able to handle focus grabs.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="HasFocus"> <Member MemberName="HasFocus">
@ -136,8 +168,12 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary> Set by <see cref="M:Gtk.Widget.GrabFocus" /> for widgets that also have <see cref="F:Gtk.WidgetFlags.CanFocus" /> set.</summary>
<remarks>To be added</remarks> <remarks>
<para>
The flag will be unset once another widget grabs the focus.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CanDefault"> <Member MemberName="CanDefault">
@ -148,8 +184,12 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The <paramref name="widget" /> is allowed to receive the default action via <see cref="M:Gtk.Widget.GrabDefault" />.</summary>
<remarks>To be added</remarks> <remarks>
<para>
The <paramref name="widget" /> is allowed to receive the default action via <see cref="M:Gtk.Widget.GrabDefault" />.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="HasDefault"> <Member MemberName="HasDefault">
@ -160,8 +200,12 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary> The <paramref name="widget" /> currently is receiving the default action.</summary>
<remarks>To be added</remarks> <remarks>
<para>
The <paramref name="widget" /> currently is receiving the default action.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="HasGrab"> <Member MemberName="HasGrab">
@ -172,8 +216,12 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary> Set by <see cref="M:Gtk.Widget.GrabDefault" />gtk_grab_add(), unset by gtk_grab_remove().</summary>
<remarks>To be added</remarks> <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.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RcStyle"> <Member MemberName="RcStyle">
@ -184,8 +232,12 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Indicates that the widgets style has been looked up through the rc mechanism.</summary>
<remarks>To be added</remarks> <remarks>
<para>
It does not imply that the <paramref name="widget" /> actually had a style defined through the rc mechanism.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CompositeChild"> <Member MemberName="CompositeChild">
@ -196,8 +248,12 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Indicates that the <paramref name="widget" /> is a composite child of its parent.</summary>
<remarks>To be added</remarks> <remarks>
<para>
See <see cref="M:Gtk.Widget.PushCompositeChild" />, <see cref="M:Gtk.Widget.PopCompositeChild" />.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="NoReparent"> <Member MemberName="NoReparent">
@ -208,8 +264,8 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Unused since before GTK+ 1.2, will be removed in a future version.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="AppPaintable"> <Member MemberName="AppPaintable">
@ -220,8 +276,12 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Set and unset by <see cref="P:Gtk.Widget.AppPaintable" />.</summary>
<remarks>To be added</remarks> <remarks>
<para>
Must be set on widgets whose window the application directly draws on, in order to keep GTK+ from overwriting the drawn stuff.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ReceivesDefault"> <Member MemberName="ReceivesDefault">
@ -232,8 +292,12 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>To be added</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>To be added</remarks> <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.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DoubleBuffered"> <Member MemberName="DoubleBuffered">
@ -244,8 +308,12 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>To be added</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>To be added</remarks> <remarks>
<para>
Indicates that exposes done on the <paramref name="widget" /> should be double-buffered.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="value__"> <Member MemberName="value__">
@ -256,8 +324,8 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added.</summary>
<remarks>To be added</remarks> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

120
doc/en/Gtk/Window.xml
View file

@ -7,8 +7,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>Toplevel widget which can contain other widgets.</summary> <summary>Toplevel <paramref name="widget" /> which can contain other widgets.</summary>
<remarks>Toplevel widget which can contain other widgets.</remarks> <remarks>Toplevel <paramref name="widget" /> which can contain other widgets.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.Bin</BaseTypeName> <BaseTypeName>Gtk.Bin</BaseTypeName>
@ -59,7 +59,7 @@
<Parameter Name="timestamp" Type="System.UInt32" /> <Parameter Name="timestamp" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Starts moving a window.</summary> <summary>Starts moving a <paramref name="window" />.</summary>
<param name="button">Mouse button that initiated the drag.</param> <param name="button">Mouse button that initiated the drag.</param>
<param name="root_x">X position where the user clicked to initiate the drag, in root window coordinates.</param> <param name="root_x">X position where the user clicked to initiate the drag, in root window coordinates.</param>
<param name="root_y">Y position where the user clicked to initiate the drag.</param> <param name="root_y">Y position where the user clicked to initiate the drag.</param>
@ -94,7 +94,7 @@
It will not return the size of the window border drawn by the window manager, which is the normal case when using a windowing system. See <see cref="M:Gdk.Window.GetFrameExtents" /> to get the standard window border extents.) See also <see cref="P:Gtk.Window.HasFrame" />, <see cref="M:Gtk.Window.SetFrameDimensions" />. It will not return the size of the window border drawn by the window manager, which is the normal case when using a windowing system. See <see cref="M:Gdk.Window.GetFrameExtents" /> to get the standard window border extents.) See also <see cref="P:Gtk.Window.HasFrame" />, <see cref="M:Gtk.Window.SetFrameDimensions" />.
</para> </para>
<para> <para>
Note: this is a special-purpose function intended for the framebuffer port; see <see cref="M:Gtk.Window.SetFrameDimensions" />. Note: this is a special-purpose method intended for the framebuffer port; see <see cref="M:Gtk.Window.SetFrameDimensions" />.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -113,7 +113,7 @@
Note that you shouldn't assume the window is definitely iconified afterward, because other entities (e.g. the user or window manager) could deiconify it again, or there may not be a window manager in which case iconification isn't possible, etc. But normally the window will end up iconified. Just do not write code that crashes if not. Note that you shouldn't assume the window is definitely iconified afterward, because other entities (e.g. the user or window manager) could deiconify it again, or there may not be a window manager in which case iconification isn't possible, etc. But normally the window will end up iconified. Just do not write code that crashes if not.
</para> </para>
<para> <para>
You can track iconification via the <see cref="F:Gtk.Widget.WindowStateEvent" /> signal on <see cref="T:Gtk.Widget" />. You can track iconification via the <see cref="F:Gtk.Widget.WindowStateEvent" /> event on <see cref="T:Gtk.Widget" />.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -126,13 +126,13 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>Asks to unstick window, which means that it will appear on only one of the user's desktops.</summary> <summary>Asks to unstick <paramref name="window" />, which means that it will appear on only one of the user's desktops.</summary>
<remarks> <remarks>
<para> <para>
Note that you shouldn't assume the window is definitely unstuck afterward, because other entities (e.g. the user or window manager) could stick it again. But normally the window will end up stuck. Just do not write code that crashes if not. Note that you shouldn't assume the window is definitely unstuck afterward, because other entities (e.g. the user or window manager) could stick it again. But normally the window will end up stuck. Just do not write code that crashes if not.
</para> </para>
<para> <para>
You can track stickiness via the <see cref="F:Gtk.Widget.WindowStateEvent" /> signal on <see cref="T:Gtk.Widget" />. You can track stickiness via the <see cref="F:Gtk.Widget.WindowStateEvent" /> event on <see cref="T:Gtk.Widget" />.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -151,7 +151,7 @@
Note that you shouldn't assume the window is definitely unmaximized afterward, because other entities (e.g. the user or window manager) could maximize it again, and not all window managers honor requests to unmaximize. But normally the window will end up unmaximized. Just don't write code that crashes if not. Note that you shouldn't assume the window is definitely unmaximized afterward, because other entities (e.g. the user or window manager) could maximize it again, and not all window managers honor requests to unmaximize. But normally the window will end up unmaximized. Just don't write code that crashes if not.
</para> </para>
<para> <para>
You can track maximization via the <see cref="F:Gtk.Widget.WindowStateEvent" /> signal on <see cref="T:Gtk.Widget" /> You can track maximization via the <see cref="F:Gtk.Widget.WindowStateEvent" /> event on <see cref="T:Gtk.Widget" />
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -175,7 +175,7 @@
If window is not onscreen, it returns the size GTK+ will suggest to the window manager for the initial window size (but this is not reliably the same as the size the window manager will actually select). The size obtained by <see cref="M:Gtk.Window.GetSize" /> is the last size received in a GdkEventConfigure, that is, GTK+ uses its locally-stored size, rather than querying the X server for the size. As a result, if you call <see cref="M:Gtk.Window.Resize" /> then immediately call <see cref="M:Gtk.Window.GetSize" />, the size would not have taken effect yet. After the window manager processes the resize request, GTK+ receives notification that the size has changed via a configure event, and the size of the window gets updated. If window is not onscreen, it returns the size GTK+ will suggest to the window manager for the initial window size (but this is not reliably the same as the size the window manager will actually select). The size obtained by <see cref="M:Gtk.Window.GetSize" /> is the last size received in a GdkEventConfigure, that is, GTK+ uses its locally-stored size, rather than querying the X server for the size. As a result, if you call <see cref="M:Gtk.Window.Resize" /> then immediately call <see cref="M:Gtk.Window.GetSize" />, the size would not have taken effect yet. After the window manager processes the resize request, GTK+ receives notification that the size has changed via a configure event, and the size of the window gets updated.
</para> </para>
<para> <para>
Note 1: Nearly any use of this function creates a race condition, because the size of the window may change between the time that you get the size and the time that you perform some action assuming that size is the current size. To avoid race conditions, connect to <see cref="F:Gtk.Widget.ConfigureEvent" /> on the window and adjust your size-dependent state to match the size delivered in the GdkEventConfigure. Note 1: Nearly any use of this method creates a race condition, because the size of the window may change between the time that you get the size and the time that you perform some action assuming that size is the current size. To avoid race conditions, connect to <see cref="F:Gtk.Widget.ConfigureEvent" /> on the window and adjust your size-dependent state to match the size delivered in the GdkEventConfigure.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -191,7 +191,7 @@
<Parameter Name="height" Type="System.Int32&amp;" RefType="out" /> <Parameter Name="height" Type="System.Int32&amp;" RefType="out" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Gets the default size of the window.</summary> <summary>Gets the default size of the <paramref name="window" />.</summary>
<param name="width">Location to store the default width, or <see langword="null" />.</param> <param name="width">Location to store the default width, or <see langword="null" />.</param>
<param name="height">Location to store the default height, or <see langword="null" />.</param> <param name="height">Location to store the default height, or <see langword="null" />.</param>
<remarks> <remarks>
@ -212,7 +212,7 @@
<Parameter Name="height" Type="System.Int32" /> <Parameter Name="height" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Resizes the window as if the user had done so, obeying geometry constraints.</summary> <summary>Resizes the <paramref name="window" /> as if the user had done so, obeying geometry constraints.</summary>
<param name="width">Width in pixels to resize the window to.</param> <param name="width">Width in pixels to resize the window to.</param>
<param name="height">Height in pixels to resize the window to.</param> <param name="height">Height in pixels to resize the window to.</param>
<remarks> <remarks>
@ -233,8 +233,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>Activates the current focused widget within the window.</summary> <summary>Activates the current focused <paramref name="widget" /> within the <paramref name="window" />.</summary>
<returns><see langword="true" /> if a widget got activated.</returns> <returns><see langword="true" /> if a <paramref name="widget" /> got activated.</returns>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -296,7 +296,7 @@
Note that you shouldn't assume the window is definitely stuck afterward, because other entities (e.g. the user or window manager) could unstick it again, and some window managers do not support sticking windows. But normally the window will end up stuck. Just don't write code that crashes if not. Note that you shouldn't assume the window is definitely stuck afterward, because other entities (e.g. the user or window manager) could unstick it again, and some window managers do not support sticking windows. But normally the window will end up stuck. Just don't write code that crashes if not.
</para> </para>
<para> <para>
You can track stickiness via the <see cref="F:Gtk.Widget.WindowStateEvent" /> signal on GtkWidget. It's permitted to call this function before showing a window. You can track stickiness via the <see cref="F:Gtk.Widget.WindowStateEvent" /> event on GtkWidget. It's permitted to call this method before showing a window.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -314,14 +314,14 @@
<Parameter Name="bottom" Type="System.Int32" /> <Parameter Name="bottom" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>For windows with frames (see <see cref="P:Gtk.Window.HasFrame" />) this function can be used to change the size of the frame border.</summary> <summary>For windows with frames (see <see cref="P:Gtk.Window.HasFrame" />) this method can be used to change the size of the frame border.</summary>
<param name="left">The width of the left border.</param> <param name="left">The width of the left border.</param>
<param name="top">The height of the top border.</param> <param name="top">The height of the top border.</param>
<param name="right">The width of the right border.</param> <param name="right">The width of the right border.</param>
<param name="bottom">The height of the bottom border.</param> <param name="bottom">The height of the bottom border.</param>
<remarks> <remarks>
<para> <para>
Note: this is a special-purpose function intended for the framebuffer port; see <see cref="P:Gtk.Window.HasFrame" />. It will have no effect on the window border drawn by the window manager, which is the normal case when using the X Window system. Note: this is a special-purpose method intended for the framebuffer port; see <see cref="P:Gtk.Window.HasFrame" />. It will have no effect on the window border drawn by the window manager, which is the normal case when using the X Window system.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -339,7 +339,7 @@
<Docs> <Docs>
<summary>Adds a mnemonic to this <paramref name="window" />.</summary> <summary>Adds a mnemonic to this <paramref name="window" />.</summary>
<param name="keyval">The mnemonic.</param> <param name="keyval">The mnemonic.</param>
<param name="target">The widget that gets activated by the mnemonic.</param> <param name="target">The <paramref name="widget" /> that gets activated by the mnemonic.</param>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -365,7 +365,7 @@
<param name="timestamp">Timestamp from the click event that initiated the drag.</param> <param name="timestamp">Timestamp from the click event that initiated the drag.</param>
<remarks> <remarks>
<para> <para>
This function is used if an application has window resizing controls. When GDK can support it, the resize will be done using the standard mechanism for the window manager or windowing system. Otherwise, GDK will try to emulate window resizing, potentially not all that well, depending on the windowing system. This method is used if an application has window resizing controls. When GDK can support it, the resize will be done using the standard mechanism for the window manager or windowing system. Otherwise, GDK will try to emulate window resizing, potentially not all that well, depending on the windowing system.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -381,7 +381,7 @@
<Parameter Name="root_y" Type="System.Int32&amp;" RefType="out" /> <Parameter Name="root_y" Type="System.Int32&amp;" RefType="out" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>This function returns the position you need to pass to <see cref="M:Gtk.Window.Move" /> to keep <paramref name="window" /> in its current position.</summary> <summary>This method returns the position you need to pass to <see cref="M:Gtk.Window.Move" /> to keep <paramref name="window" /> in its current position.</summary>
<param name="root_x">Return location for X coordinate of gravity-determined reference point.</param> <param name="root_x">Return location for X coordinate of gravity-determined reference point.</param>
<param name="root_y">Return location for Y coordinate of gravity-determined reference point.</param> <param name="root_y">Return location for Y coordinate of gravity-determined reference point.</param>
<remarks> <remarks>
@ -417,7 +417,7 @@
Note that you shouldn't assume the window is definitely deiconified afterward, because other entities (e.g. the user or window manager) could iconify it again before your code which assumes deiconification gets to run. Note that you shouldn't assume the window is definitely deiconified afterward, because other entities (e.g. the user or window manager) could iconify it again before your code which assumes deiconification gets to run.
</para> </para>
<para> <para>
You can track iconification via the <see cref="F:Gtk.Widget.WindowStateEvent" /> signal on GtkWidget. You can track iconification via the <see cref="F:Gtk.Widget.WindowStateEvent" /> event on GtkWidget.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -449,10 +449,10 @@
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>Activates the default <paramref name="widget" /> for the <paramref name="window" />.</summary> <summary>Activates the default <paramref name="widget" /> for the <paramref name="window" />.</summary>
<returns><see langword="true" /> if a widget is activated.</returns> <returns><see langword="true" /> if a <paramref name="widget" /> is activated.</returns>
<remarks> <remarks>
<para> <para>
That is unless the current focused widget has been configured to receive the default (see <see cref="F:Gtk.WidgetFlags.ReceivesDefault" />) action in which case the case the focused widget is activated. That is unless the current focused <paramref name="widget" /> has been configured to receive the default (see <see cref="F:Gtk.WidgetFlags.ReceivesDefault" />) action in which case the case the focused <paramref name="widget" /> is activated.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -471,7 +471,7 @@
Note that you shouldn't assume the window is definitely maximized afterward, because other entities (e.g. the user or window manager) could unmaximize it again, and not all window managers support maximization. But normally the window will end up maximized. Just don't write code that crashes if not. Note that you shouldn't assume the window is definitely maximized afterward, because other entities (e.g. the user or window manager) could unmaximize it again, and not all window managers support maximization. But normally the window will end up maximized. Just don't write code that crashes if not.
</para> </para>
<para> <para>
You can track maximization via the <see cref="F:Gtk.Widget.WindowStateEvent" /> signal on GtkWidget. It's permitted to call this function before showing a window, in which case the window will be maximized when it appears onscreen initially. You can track maximization via the <see cref="F:Gtk.Widget.WindowStateEvent" /> event on GtkWidget. It's permitted to call this method before showing a window, in which case the window will be maximized when it appears onscreen initially.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -489,7 +489,7 @@
<Docs> <Docs>
<summary>Removes a mnemonic from this <paramref name="window" />.</summary> <summary>Removes a mnemonic from this <paramref name="window" />.</summary>
<param name="keyval">The mnemonic.</param> <param name="keyval">The mnemonic.</param>
<param name="target">The widget that gets activated by the mnemonic.</param> <param name="target">The <paramref name="widget" /> that gets activated by the mnemonic.</param>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -519,12 +519,12 @@
<Parameter Name="wmclass_class" Type="System.String" /> <Parameter Name="wmclass_class" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>It sets the X Window System "class" and "name" hints for a <paramref name="window" />. (Don't use this function.)</summary> <summary>It sets the X Window System "class" and "name" hints for a <paramref name="window" />. (Don't use this method.)</summary>
<param name="wmclass_name">Window name hint.</param> <param name="wmclass_name">Window name hint.</param>
<param name="wmclass_class">Window class hint.</param> <param name="wmclass_class">Window class hint.</param>
<remarks> <remarks>
<para> <para>
According to the ICCCM, you should always set these to the same value for all windows in an application, and GTK+ sets them to that value by default, so calling this function is sort of pointless. However, you may want to call <see cref="P:Gtk.Window.Role" /> on each window in your application, for the benefit of the session manager. Setting the role allows the window manager to restore window positions when loading a saved session. According to the ICCCM, you should always set these to the same value for all windows in an application, and GTK+ sets them to that value by default, so calling this method is sort of pointless. However, you may want to call <see cref="P:Gtk.Window.Role" /> on each window in your application, for the benefit of the session manager. Setting the role allows the window manager to restore window positions when loading a saved session.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -563,13 +563,13 @@
If the window's "natural" size (its size request) is larger than the default, the default will be ignored. More generally, if the default size does not obey the geometry hints for the window (<see cref="M:Gtk.Window.SetGeometryHints" /> can be used to set these explicitly), the default size will be clamped to the nearest permitted size. If the window's "natural" size (its size request) is larger than the default, the default will be ignored. More generally, if the default size does not obey the geometry hints for the window (<see cref="M:Gtk.Window.SetGeometryHints" /> can be used to set these explicitly), the default size will be clamped to the nearest permitted size.
</para> </para>
<para> <para>
Unlike <see cref="M:Gtk.Widget.SetSizeRequest" /> which sets a size request for a widget and thus would keep users from shrinking the window, this function only sets the initial size, just as if the user had resized the window themselves. Users can still shrink the window again as they normally would. Setting a default size of -1 means to use the "natural" default size (the size request of the window). Unlike <see cref="M:Gtk.Widget.SetSizeRequest" /> which sets a size request for a <paramref name="widget" /> and thus would keep users from shrinking the window, this method only sets the initial size, just as if the user had resized the window themselves. Users can still shrink the window again as they normally would. Setting a default size of -1 means to use the "natural" default size (the size request of the window).
</para> </para>
<para> <para>
For more control over a window's initial size and how resizing works, investigate <see cref="M:Gtk.Window.SetGeometryHints" />. For more control over a window's initial size and how resizing works, investigate <see cref="M:Gtk.Window.SetGeometryHints" />.
</para> </para>
<para> <para>
For some uses, <see cref="M:Gtk.Window.Resize" /> is a more appropriate function. <see cref="M:Gtk.Window.Resize" /> changes the current size of the window, rather than the size to be used on initial display. <see cref="M:Gtk.Window.Resize" /> always affects the window itself, not the geometry widget. For some uses, <see cref="M:Gtk.Window.Resize" /> is a more appropriate method. <see cref="M:Gtk.Window.Resize" /> changes the current size of the window, rather than the size to be used on initial display. <see cref="M:Gtk.Window.Resize" /> always affects the window itself, not the geometry widget.
</para> </para>
<para> <para>
The default size of a window only affects the first time a window is shown; if a window is hidden and re-shown, it will remember the size it had prior to hiding, rather than using the default size. The default size of a window only affects the first time a window is shown; if a window is hidden and re-shown, it will remember the size it had prior to hiding, rather than using the default size.
@ -588,10 +588,10 @@
<summary>Presents a <paramref name="window" /> to the user.</summary> <summary>Presents a <paramref name="window" /> to the user.</summary>
<remarks> <remarks>
<para> <para>
This may mean raising the window in the stacking order, deiconifying it, moving it to the current desktop, and/or giving it the keyboard focus, possibly dependent on the user's platform, window manager, and preferences. If window is hidden, this function calls <see cref="M:Gtk.Widget.Show" /> as well. This may mean raising the window in the stacking order, deiconifying it, moving it to the current desktop, and/or giving it the keyboard focus, possibly dependent on the user's platform, window manager, and preferences. If window is hidden, this method calls <see cref="M:Gtk.Widget.Show" /> as well.
</para> </para>
<para> <para>
This function should be used when the user tries to open a window that's already open. Say for example the preferences dialog is currently open, and the user chooses Preferences from the menu a second time; use <see cref="M:Gtk.Window.Present" /> to move the already-open dialog where the user can see it. This method should be used when the user tries to open a window that's already open. Say for example the preferences dialog is currently open, and the user chooses Preferences from the menu a second time; use <see cref="M:Gtk.Window.Present" /> to move the already-open dialog where the user can see it.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -604,7 +604,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>Hides <paramref name="window" />, then reshows it, resetting the default size and position of the window.</summary> <summary>Hides <paramref name="window" />, then reshows it, resetting the default size and position of the <paramref name="window" />.</summary>
<remarks> <remarks>
<para> <para>
Used by GUI builders only. Used by GUI builders only.
@ -786,10 +786,14 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets or obtains the icon list to be used as fallback for windows that haven't had <see cref="M:Gtk.Window.IconList" /> called on them to set up a window-specific icon list.</summary>
<param name="value">an object of type <see cref="T:GLib.List" /></param> <param name="value">A list of <see cref="T:Gdk.Pixbuf" />.</param>
<returns>an object of type <see cref="T:GLib.List" /></returns> <returns>A copy of default icon list.</returns>
<remarks>To be added</remarks> <remarks>
<para>
This method allows you to set up the icon for all windows in your app at once.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -812,10 +816,14 @@
</ReturnValue> </ReturnValue>
<Parameters></Parameters> <Parameters></Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets or unsets the default <paramref name="widget" /> for a <see cref="T:Gtk.Window" /> about.</summary>
<param name="value">an object of type <see cref="T:Gtk.Widget" /></param> <param name="value">Widget to be the default, or <see langword="null" /> to unset the default <paramref name="widget" /> for the toplevel.</param>
<returns>an object of type <see cref="T:Gtk.Windget" /></returns> <returns>A <see cref="T:Gtk.Widget" />.</returns>
<remarks>To be added</remarks> <remarks>
<para>
The default <paramref name="widget" /> is the widget that's activated when the user presses Enter in a dialog (for example). When setting (rather than unsetting) the default <paramref name="widget" /> it's generally easier to call <see cref="M:Gtk.Widget.GrabFocus" /> on the <paramref name="widget" />. Before making a default <paramref name="widget" />, you must set the <see cref="F:Gtk.WidgetFlags.CanDefault" /> flag on the <paramref name="widget" /> you'd like to make the default.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="HasFrame"> <Member MemberName="HasFrame">
@ -1337,10 +1345,10 @@
<Parameter Name="filename" Type="System.String" /> <Parameter Name="filename" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets an icon to be used as fallback for windows that haven't had <see cref="P:Gtk.Window.IconList" /> called on them from a file on disk.</summary>
<param name="filename">a <see cref="T:System.String" /></param> <param name="filename">Location of icon file.</param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns><see langword="true" /> if setting the icon succeded.</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Fullscreen"> <Member MemberName="Fullscreen">
@ -1351,8 +1359,15 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Asks to place <paramref name="window" /> in the fullscreen state.</summary>
<remarks>To be added</remarks> <remarks>
<para>
Note that you shouldn't assume the window is definitely full screen afterward, because other entities (e.g. the user or window manager) could unfullscreen it again, and not all window managers honor requests to fullscreen windows. But normally the window will end up restored to its normal state. Just don't write code that crashes if not.
</para>
<para>
You can track the fullscreen state via the <see cref="F:Gtk.Widget.WindowStateEvent" /> event on <see cref="T:Gtk.Widget" />.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetIconFromFile"> <Member MemberName="SetIconFromFile">
@ -1365,10 +1380,14 @@
<Parameter Name="filename" Type="System.String" /> <Parameter Name="filename" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the icon for <paramref name="window" />.</summary>
<param name="filename">a <see cref="T:System.String" /></param> <param name="filename">Location of icon file.</param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns><see langword="true" /> if setting the icon succeded.</returns>
<remarks>To be added</remarks> <remarks>
<para>
This method is equivalent to calling <see cref="M:Gtk.Window.ParseGeometry" /> with pixbuf created by loading the image from <paramref name="filename" />.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Unfullscreen"> <Member MemberName="Unfullscreen">
@ -1384,6 +1403,9 @@
<para> <para>
Note that you shouldn't assume the window is definitely not full screen afterward, because other entities (e.g. the user or window manager) could fullscreen it again, and not all window managers honor requests to unfullscreen windows. But normally the window will end up restored to its normal state. Just don't write code that crashes if not. Note that you shouldn't assume the window is definitely not full screen afterward, because other entities (e.g. the user or window manager) could fullscreen it again, and not all window managers honor requests to unfullscreen windows. But normally the window will end up restored to its normal state. Just don't write code that crashes if not.
</para> </para>
<para>
You can track the fullscreen state via the <see cref="F:Gtk.Widget.WindowStateEvent" /> event on <see cref="T:Gtk.Widget" />.
</para>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>