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

Changed the incorrect tag <see cref="langword:null" /> to the correct one <see langword="null" />.

Browse source 
svn path=/trunk/gtk-sharp/; revision=13886
This commit is contained in:
Hector E. Gomez Morales 2003-04-22 10:15:35 +00:00
parent a4d3692c04
commit 775e610a14
12 changed files with 96 additions and 100 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/en/Gtk/AccelGroup.xml
View file

@ -42,7 +42,7 @@
<Docs>
<summary>Finds the <see cref="T:Gtk.AccelGroup" /> to which closure is connected.</summary>
<param name="closure">A GClosure (<see cref="T:System.IntPtr" />)</param>
<returns>The <see cref="T:Gtk.AccelGroup" /> to which 'closure' is connected, or <see cref="langword:null" />.</returns>
<returns>The <see cref="T:Gtk.AccelGroup" /> to which 'closure' is connected, or <see langword="null" />.</returns>
<remarks />
</Docs>
</Member>
@ -71,7 +71,7 @@
<summary>Removes an accelerator previously installed through <see cref="M:Gtk.AccelGroup.Connect ()" />.</summary>
<param name="closure">The closure to remove from this accelerator group.</param>
<returns>
<see cref="langword:true" /> if the closure was found and got disconnected</returns>
<see langword="true" /> if the closure was found and got disconnected</returns>
<remarks />
</Docs>
</Member>
@ -122,7 +122,7 @@
<param name="accel_key">Key value of the accelerator.</param>
<param name="accel_mods">Modifier combination of the accelerator.</param>
<returns>
<see cref="langword:true" /> if there was an accelerator which could be removed, <see cref="langword:false" /> otherwise.</returns>
<see langword="true" /> if there was an accelerator which could be removed, <see langword="false" /> otherwise.</returns>
</Docs>
</Member>
<Member MemberName="Query">
@ -140,8 +140,8 @@
<summary>Queries an accelerator group for all entries matching accel_key and accel_mods.</summary>
<param name="accel_key">Key value of the accelerator.</param>
<param name="accel_mods">Modifier combination of the accelerator.</param>
<param name="n_entries">Location to return the number of entries found, or <see cref="langword:null" />.</param>
<returns>An array of n_entries <see cref="T:Gtk.AccelGroupEntry" /> elements, or <see cref="langword:null" />.</returns>
<param name="n_entries">Location to return the number of entries found, or <see langword="null" />.</param>
<returns>An array of n_entries <see cref="T:Gtk.AccelGroupEntry" /> elements, or <see langword="null" />.</returns>
</Docs>
</Member>
<Member MemberName="Lock">

4
doc/en/Gtk/AccelLabel.xml
View file

@ -46,7 +46,7 @@
<Docs>
<summary>Recreates the string representing the accelerator keys.</summary>
<returns>
<see cref="langword:false" /> Default, since the strings are updated this is not needed</returns>
<see langword="false" /> Default, since the strings are updated this is not needed</returns>
<remarks>
<para>
Recreates the string representing the accelerator keys. This should not be needed since the string is automatically updated whenever accelerators are added or removed from the associated widget.
@ -170,7 +170,7 @@
<Docs>
<summary>Fetches the widget monitored by this acceleretaor label.</summary>
<param name="value">The widget to be monitored</param>
<returns>The object monitored by the accelerator label, or <see cref="langword:null" /></returns>
<returns>The object monitored by the accelerator label, or <see langword="null" /></returns>
<remarks>
<para>
Fetches the widget monitored by this acceleretaor label.

2
doc/en/Gtk/Entry.xml
View file

@ -198,7 +198,7 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<param name="end">output variable for the character index of the end of the selection</param>
<returns>
<para>
<see cref="langword:true" /> if there is a selection, <see cref="langword:false" /> otherwise.</para>
<see langword="true" /> if there is a selection, <see cref="langword:false" /> otherwise.</para>
</returns>
<remarks />
</Docs>

4
doc/en/Gtk/HScrollbar.xml
View file

@ -9,7 +9,7 @@
<Docs>
<summary>A horizontal scrollbar</summary>
<remarks>
<para>The <see cref="T:Gtk.HScrollbar" /> widget is a widget arranged horizontally creating a scrollbar. See <see cref="T:Gtk.Scrollbar" /> for details on scrollbars. <see cref="T:Gtk.Adjustment" /> pointers may be added to handle the adjustment of the scrollbar or it may be left <see cref="langword:null" /> in which case one will be created for you. See <see cref="T:Gtk.Adjustment" /> for details.
<para>The <see cref="T:Gtk.HScrollbar" /> widget is a widget arranged horizontally creating a scrollbar. See <see cref="T:Gtk.Scrollbar" /> for details on scrollbars. <see cref="T:Gtk.Adjustment" /> pointers may be added to handle the adjustment of the scrollbar or it may be left <see langword="null" /> in which case one will be created for you. See <see cref="T:Gtk.Adjustment" /> for details.
</para>
</remarks>
</Docs>
@ -69,7 +69,7 @@
</Parameters>
<Docs>
<summary>Creates a new horizontal scrollbar.</summary>
<param name="adjustment">The <see cref="T:Gtk.Adjustment" /> to use, or <see cref="langword:null" /> to create a new adjustment.</param>
<param name="adjustment">The <see cref="T:Gtk.Adjustment" /> to use, or <see langword="null" /> to create a new adjustment.</param>
<returns>The new <see cref="T:Gtk.HScrollbar" /></returns>
<remarks>To be added</remarks>
</Docs>

23
doc/en/Gtk/Label.xml
View file

@ -167,7 +167,7 @@
<Docs>
<summary>
Creates a new label with the given text inside it. You can
pass <see cref="langword:null" /> to get an empty label
pass <see langword="null" /> to get an empty label
widget.
</summary>
<param name="str">The text of the label</param>
@ -175,7 +175,7 @@
<remarks>
<para>
Creates a new label with the given text inside it. You can
pass <see cref="langword:null" /> to get an empty label
pass <see langword="null" /> to get an empty label
widget.
</para>
</remarks>
@ -264,11 +264,10 @@
<Docs>
<summary>Toggles line wrapping within the GtkLabel widget.</summary>
<param name="value">
<see cref="langword:true" /> makes it
break lines if text exceeds the widget's size. <see cref="langword:false" /> lets the text get cut off by the edge
of the widget if it exceeds the widget size.
<see langword="true" /> makes it
break lines if text exceeds the widget's size. <see langoword="false" /> lets the text get cut off by the edge of the widget if it exceeds the widget size.
</param>
<returns><see cref="langword:true" /> if the lines of the label are automatically wrapped.</returns>
<returns><see langword="true" /> if the lines of the label are automatically wrapped.</returns>
<remarks />
</Docs>
</Member>
@ -358,12 +357,12 @@
<Docs>
<summary>Toggle whether or not the label allow the user to select text from the label, for copy-and-paste.</summary>
<param name="value">
<see cref="langword:true" /> to allow selecting text in the
label, and <see cref="langword:false" /> to disallow.
<see langword="true" /> to allow selecting text in the
label, and <see langword="false" /> to disallow.
</param>
<returns>
<see cref="langword:true" /> if the label is selectable, and
<see cref="langword:false" /> if not.
<see langword="true" /> if the label is selectable, and
<see langword="false" /> if not.
</returns>
<remarks />
</Docs>
@ -522,8 +521,8 @@
</Parameters>
<Docs>
<summary>Whether the label's text is interpreted as marked up with the Pango text markup language.</summary>
<param name="value"><see cref="langword:true" /> to parse the
text as Pango markup, <see cref="langword:false" /> as plain-text</param>
<param name="value"><see langword="true" /> to parse the
text as Pango markup, <see langword="false" /> as plain-text</param>
<returns />
<remarks />
</Docs>

8
doc/en/Gtk/MenuItem.xml
View file

@ -202,7 +202,7 @@
<Docs>
<summary>Sets or obtains the widget submenu.</summary>
<param name="value">The submenu.</param>
<returns>A submenu for this menu item, or <see cref="langword:null" /> if none.</returns>
<returns>A submenu for this menu item, or <see langword="null" /> if none.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -218,7 +218,7 @@
</Parameters>
<Docs>
<summary>Sets the accelerator path.</summary>
<param name="value">An accelerator path, corresponding to this menu item's functionality, or <see cref="langword:null" /> to unset the current path.</param>
<param name="value">An accelerator path, corresponding to this menu item's functionality, or <see langword="null" /> to unset the current path.</param>
<returns>The accelerator path of the menu item.</returns>
<remarks>
<para>
@ -239,8 +239,8 @@
</Parameters>
<Docs>
<summary>Sets or obtains whether the menu item appears justified at the right side of a menu bar.</summary>
<param name="value">If <see cref="langword:true" /> the menu item will appear at the far right if added to a menu bar.</param>
<returns>Returns <see cref="langword:true" /> if the menu item will appear at the far right if added to a menu bar.</returns>
<param name="value">If <see langword="true" /> the menu item will appear at the far right if added to a menu bar.</param>
<returns>Returns <see langword="true" /> if the menu item will appear at the far right if added to a menu bar.</returns>
<remarks />
</Docs>
</Member>

2
doc/en/Gtk/MenuShell.xml
View file

@ -81,7 +81,7 @@
<Docs>
<summary>Activates the menu item within the menu shell.</summary>
<param name="menu_item">The <see cref="T:Gtk.MenuItem" /> to activate.</param>
<param name="force_deactivate">If <see cref="langword:true" />, force the deactivation of the menu shell after the menu item is activated.</param>
<param name="force_deactivate">If <see langword="true" />, force the deactivation of the menu shell after the menu item is activated.</param>
<remarks>
<para>
Activates the menu item within the menu shell.

8
doc/en/Gtk/Misc.xml
View file

@ -83,8 +83,8 @@
</Parameters>
<Docs>
<summary>Gets the X and Y alignment of the widget within its allocation. See <see cref="M:Gtk.Misc.SetAlignment" />.</summary>
<param name="xalign">Location to store X alignment of misc, or <see cref="langword:null" />.</param>
<param name="yalign">Location to store Y alignment of misc, or <See cref="langword:null" />.</param>
<param name="xalign">Location to store X alignment of misc, or <see langword="null" />.</param>
<param name="yalign">Location to store Y alignment of misc, or <See langword="null" />.</param>
</Docs>
</Member>
<Member MemberName="GetPadding">
@ -99,8 +99,8 @@
</Parameters>
<Docs>
<summary>iGets the padding in the X and Y directions of the widget. See <see cref="M:Gtk.Misc.SetPadding" />).</summary>
<param name="xpad">Location to store padding in the X direction, or <see cref="langword:null" />.</param>
<param name="ypad">Location to store padding in the Y direction, or <see cref="langword:null" />.</param>
<param name="xpad">Location to store padding in the X direction, or <see langword="null" />.</param>
<param name="ypad">Location to store padding in the Y direction, or <see langword="null" />.</param>
</Docs>
</Member>
<Member MemberName="Finalize">

2
doc/en/Gtk/ScrolledWindow.xml
View file

@ -149,7 +149,7 @@
<returns>To be added: an object of type 'Gtk.ScrolledWindow'</returns>
<remarks>
<para>
Creates a new scrolled window. The two arguments are the scrolled window's adjustments; these will be shared with the scrollbars and the child widget to keep the bars in sync with the child. Usually you want to pass <see cref="langword:null" /> for the adjustments, which will cause the scrolled window to create them for you.
Creates a new scrolled window. The two arguments are the scrolled window's adjustments; these will be shared with the scrollbars and the child widget to keep the bars in sync with the child. Usually you want to pass <see langword="null" /> for the adjustments, which will cause the scrolled window to create them for you.
</para>
</remarks>
</Docs>

14
doc/en/Gtk/Toolbar.xml
View file

@ -58,7 +58,7 @@
<Docs>
<summary>Adds a new element to the end of a toolbar.</summary>
<param name="type">A value of type <see cref="T:Gtk.ToolbarChildType" /> that determines what widget will be.</param>
<param name="widget">a <see cref="T:Gtk.Widget" />, or <see cref="langword:null" />.</param>
<param name="widget">a <see cref="T:Gtk.Widget" />, or <see langword="null" />.</param>
<param name="text">The element's label.</param>
<param name="tooltip_text">The element's tooltip.</param>
<param name="tooltip_private_text">Text used for context-sensitive help about this toolbar element.</param>
@ -66,7 +66,7 @@
<param name="callback">The function to be executed when the button is pressed.</param>
<returns>The new toolbar element as a <see cref="T:Gtk.Widget" /></returns>
<remarks>
<para>If <paramref name="type" /> is <see cref="T:Gtk.ToolbarChildType.Widget" />, <paramref name="widget" /> is used as the new element. If <paramref name="type" /> is <see cref="T:Gtk.ToolbarChild.Radiobutton" />,<paramref name="widget" /> is used to determine the radio group for the new element. In all other cases, widget must be <see cref="langword:null" />.</para>
<para>If <paramref name="type" /> is <see cref="T:Gtk.ToolbarChildType.Widget" />, <paramref name="widget" /> is used as the new element. If <paramref name="type" /> is <see cref="T:Gtk.ToolbarChild.Radiobutton" />,<paramref name="widget" /> is used to determine the radio group for the new element. In all other cases, widget must be <see langword="null" />.</para>
</remarks>
</Docs>
</Member>
@ -315,7 +315,7 @@
<Docs>
<summary>Inserts a new element in the toolbar at the given position.</summary>
<param name="type">A value of type <see cref="T:Gtk.ToolbarChildType" /> that determines what widget will be.</param>
<param name="widget">a <see cref="T:Gtk.Widget" />, or <see cref="langword:null" />.</param>
<param name="widget">a <see cref="T:Gtk.Widget" />, or <see langword="null" />.</param>
<param name="text">The element's label.</param>
<param name="tooltip_text">The element's tooltip.</param>
<param name="tooltip_private_text">Text used for context-sensitive help about this toolbar element.</param>
@ -326,7 +326,7 @@
<returns>The new toolbar element as a <see cref="T:Gtk.Widget" /></returns>
<remarks>
<para>
If <paramref name="type" /> is <see cref="T:Gtk.ToolbarChildType.Widget" />, <paramref name="widget" /> is used as the new element. If <paramref name="type" /> is <see cref="T:Gtk.ToolbarChild.Radiobutton" />,<paramref name="widget" /> is used to determine the radio group for the new element. In all other cases, widget must be <see cref="langword:null" />.
If <paramref name="type" /> is <see cref="T:Gtk.ToolbarChildType.Widget" />, <paramref name="widget" /> is used as the new element. If <paramref name="type" /> is <see cref="T:Gtk.ToolbarChild.Radiobutton" />,<paramref name="widget" /> is used to determine the radio group for the new element. In all other cases, widget must be <see langword="null" />.
</para>
</remarks>
</Docs>
@ -349,7 +349,7 @@
<Docs>
<summary>Adds a new element to the beginning of a toolbar.</summary>
<param name="type">A value of type <see cref="T:Gtk.ToolbarChildType" /> that determines what widget will be.</param>
<param name="widget">a <see cref="T:Gtk.Widget" />, or <see cref="langword:null" />.</param>
<param name="widget">a <see cref="T:Gtk.Widget" />, or <see langword="null" />.</param>
<param name="text">The element's label.</param>
<param name="tooltip_text">The element's tooltip.</param>
<param name="tooltip_private_text">Text used for context-sensitive help about this toolbar element.</param>
@ -357,7 +357,7 @@
<param name="callback">The function to be executed when the button is pressed.</param>
<returns>The new toolbar element as a <see cref="T:Gtk.Widget" /></returns>
<remarks>
<para>If <paramref name="type" /> is <see cref="T:Gtk.ToolbarChildType.Widget" />, <paramref name="widget" /> is used as the new element. If <paramref name="type" /> is <see cref="T:Gtk.ToolbarChild.Radiobutton" />,<paramref name="widget" /> is used to determine the radio group for the new element. In all other cases, widget must be <see cref="langword:null" />.</para>
<para>If <paramref name="type" /> is <see cref="T:Gtk.ToolbarChildType.Widget" />, <paramref name="widget" /> is used as the new element. If <paramref name="type" /> is <see cref="T:Gtk.ToolbarChild.Radiobutton" />,<paramref name="widget" /> is used to determine the radio group for the new element. In all other cases, widget must be <see langword="null" />.</para>
</remarks>
</Docs>
</Member>
@ -454,7 +454,7 @@
</Parameters>
<Docs>
<summary>Sets if the tooltips of a toolbar should be active or not.</summary>
<param name="value">set to <see cref="langword:false" /> to disable the tooltips, or <see cref="langword:true" /> to enable them.</param>
<param name="value">set to <see langword="false" /> to disable the tooltips, or <see langword="true" /> to enable them.</param>
<returns>Whether tooltips are enabled.</returns>
<remarks>To be added</remarks>
</Docs>

4
doc/en/Gtk/VScrollbar.xml
View file

@ -9,7 +9,7 @@
<Docs>
<summary>A vertical scrollbar</summary>
<remarks>
<para>The <see cref="T:Gtk.HScrollbar" /> widget is a widget arranged horizontally creating a scrollbar. See <see cref="T:Gtk.Scrollbar" /> for details on scrollbars. <see cref="T:Gtk.Adjustment" /> pointers may be added to handle the adjustment of the scrollbar or it may be left <see cref="langword:null" /> in which case one will be created for you. See <see cref="T:Gtk.Adjustment" /> for details.
<para>The <see cref="T:Gtk.HScrollbar" /> widget is a widget arranged horizontally creating a scrollbar. See <see cref="T:Gtk.Scrollbar" /> for details on scrollbars. <see cref="T:Gtk.Adjustment" /> pointers may be added to handle the adjustment of the scrollbar or it may be left <see langword="null" /> in which case one will be created for you. See <see cref="T:Gtk.Adjustment" /> for details.
</para>
</remarks>
</Docs>
@ -69,7 +69,7 @@
</Parameters>
<Docs>
<summary>Creates a new vertical scrollbar.</summary>
<param name="adjustment">The <see cref="T:Gtk.Adjustment" /> to use, or <see cref="langword:null" /> to create a new adjustment.</param>
<param name="adjustment">The <see cref="T:Gtk.Adjustment" /> to use, or <see langword="null" /> to create a new adjustment.</param>
<returns>The new <see cref="T:Gtk.VScrollbar" /></returns>
<remarks>To be added</remarks>
</Docs>

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

@ -185,11 +185,10 @@
<summary>Computes the intersection of a <paramref name="widget" />'s area and <paramref name="area" />.</summary>
<param name="area"> A rectangle.</param>
<param name="intersection"> A rectangle to store intersection of <paramref name="widget" /> and <paramref name="area" />.</param>
<returns>
<see cref="langword:true" /> if there was an intersection.</returns>
<returns><see langword="true" /> if there was an intersection.</returns>
<remarks>
<para>
Computes the intersection of a <paramref name="widget" />'s area and <paramref name="area" />, storing the intersection in <paramref name="intersection" />, and returns <see cref="langword:true" /> if there was an intersection. <paramref name="intersection" /> may be <see cref="langword:null" /> if you're only interested in whether there was an intersection.
Computes the intersection of a <paramref name="widget" />'s area and <paramref name="area" />, storing the intersection in <paramref name="intersection" />, and returns <see langword="true" /> if there was an intersection. <paramref name="intersection" /> may be <see langword="null" /> if you're only interested in whether there was an intersection.
</para>
</remarks>
</Docs>
@ -206,8 +205,7 @@
<Docs>
<summary>Move focus to particular <paramref name="widget" />.</summary>
<param name="direction">Direction of focus movement.</param>
<returns>
<see cref="langword:true" /> if focus ended up inside widget.</returns>
<returns><see langword="true" /> if focus ended up inside widget.</returns>
<remarks>
<para>
This function is used by custom widget implementations; if you're writing an app, you'd use <see cref="M:Gtk.Widget.GrabFocus" /> to move the focus to a particular widget, and <see cref="M:Gtk.Container.SetFocusChain" /> to change the focus tab order. So you may want to investigate those functions instead.
@ -216,7 +214,7 @@
<see cref="M:Gtk.Widget.ChildFocus" /> is called by containers as the user moves around the window using keyboard shortcuts. <paramref name="direction" /> indicates what kind of motion is taking place (up, down, left, right, tab forward, tab backward). <see cref="M:Gtk.Widget.ChildFocus" /> invokes the "focus" signal on <see cref="T:Gtk.Widget" />; widgets override the default handler for this signal in order to implement appropriate focus behavior.
</para>
<para>
The "focus" default handler for a widget should return <see cref="langword:true" /> if moving in direction left the focus on a focusable location inside that widget, and <see cref="langword:false" /> if moving in direction moved the focus outside the widget. If returning <see cref="langword:true" />, widgets normally call <see cref="M:Gtk.Widget.GrabFocus" /> to place the focus accordingly; if returning <see cref="langword:false" />, they don't modify the current focus location.
The "focus" default handler for a widget should return <see 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.
</para>
</remarks>
</Docs>
@ -300,7 +298,7 @@
<Docs>
<summary>Sets the foreground <paramref name="color" /> for a <paramref name="widget" /> in a particular <paramref name="state" />.</summary>
<param name="state">The state for which to set the background color.</param>
<param name="color">The color to assign (does not need to be allocated), or <see cref="langword:null" /> to undo the effect of previous calls to of <see cref="M:Gtk.Widget.ModifyFg" />.</param>
<param name="color">The color to assign (does not need to be allocated), or <see langword="null" /> to undo the effect of previous calls to of <see cref="M:Gtk.Widget.ModifyFg" />.</param>
<remarks>
<para>
All other style values are left untouched. See also <see cref="M:Gdk.Widget.ModifyStyle" />.
@ -324,7 +322,7 @@
<param name="stock_id">A stock ID.</param>
<param name="size">A stock size.</param>
<param name="detail">Render detail to pass to theme engine.</param>
<returns>A new <see cref="T:Gdk.Pixbuf" />, or <see cref="langword:null" /> if the <paramref name="stock_id" /> wasn't known.</returns>
<returns>A new <see cref="T:Gdk.Pixbuf" />, or <see langword="null" /> if the <paramref name="stock_id" /> wasn't known.</returns>
<remarks>
<para>
The <paramref name="stock_id" /> should be a stock icon ID such as <see cref="P:Gtk.Stock.Open" /> or <see cref="P:Gtk.Stock.Ok" />. <paramref name="size" /> should be a size such as <see cref="F:Gtk.IconSize.Menu" />. <paramref name="detail" /> should be a string that identifies the widget or code doing the rendering, so that theme engines can special-case rendering for that widget or code.
@ -406,7 +404,7 @@
<Docs>
<summary>Sets the text <paramref name="color" /> for a <paramref name="widget" /> in a particular state.</summary>
<param name="state">The state for which to set the text color.</param>
<param name="color">The color to assign (does not need to be allocated), or <see cref="langword:null" /> to undo the effect of previous calls to of <see cref="M:Gtk.Widget.ModifyText" />.</param>
<param name="color">The color to assign (does not need to be allocated), or <see langword="null" /> to undo the effect of previous calls to of <see cref="M:Gtk.Widget.ModifyText" />.</param>
<remarks>
<para>
All other style values are left untouched. The text color is the foreground color used along with the base color (see <see cref="M:Gtk.Widget.ModifyBase" />) for widgets such as <see cref="T:Gtk.Entry" /> and <see cref="T:Gtk.TextView" />. See also <see cref="M:Gtk.Widget.ModifyStyle" />.
@ -440,10 +438,10 @@
<Parameters />
<Docs>
<summary>Utility function; intended to be connected to the <see cref="F:Gtk.Widget.DeleteEvent" /> signal on a <see cref="T:Gtk.Window" />.</summary>
<returns>Returns <see cref="langword:true" />.</returns>
<returns>Returns <see langword="true" />.</returns>
<remarks>
<para>
The function calls <see cref="M:Gtk.Widget.Hide" /> on its argument, then returns <see cref="langword:true" />. If connected to <see cref="F:Gtk.Widget.DeleteEvent" />, the result is that clicking the close button for a window (on the window frame, top right corner usually) will hide but not destroy the window. By default, GTK+ destroys windows when <see cref="F:Gtk.Widget.DeleteEvent" /> is received.
The function calls <see cref="M:Gtk.Widget.Hide" /> on its argument, then returns <see langword="true" />. If connected to <see cref="F:Gtk.Widget.DeleteEvent" />, the result is that clicking the close button for a window (on the window frame, top right corner usually) will hide but not destroy the window. By default, GTK+ destroys windows when <see cref="F:Gtk.Widget.DeleteEvent" /> is received.
</para>
</remarks>
</Docs>
@ -479,8 +477,8 @@
</Parameters>
<Docs>
<summary>Obtains the location of the mouse pointer in <paramref name="widget" /> coordinates.</summary>
<param name="x">Return location for the X coordinate, or <see cref="langword:null" />.</param>
<param name="y">Return location for the Y coordinate, or <see cref="langword:null" />.</param>
<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>
<remarks>
<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.
@ -529,8 +527,7 @@
<Parameters />
<Docs>
<summary>Determines if the <paramref name="widget" /> is the focus widget within its toplevel.</summary>
<returns>
<see cref="langword:true" /> if the widget is the focus widget.</returns>
<returns><see langword="true" /> if the widget is the focus widget.</returns>
<remarks>
<para>
This does not mean that the <see cref="P:Gtk.Widget.HasFocus" /> flag is necessarily set; <see cref="P:Gtk.Widget.HasFocus" /> will only be set if the toplevel widget additionally has the global input focus.
@ -623,12 +620,12 @@
</Parameters>
<Docs>
<summary>For <paramref name="widgets" /> that support scrolling, sets the scroll adjustments.</summary>
<param name="hadjustment">An adjustment for horizontal scrolling, or <see cref="langword:null" />.</param>
<param name="vadjustment">An adjustment for vertical scrolling, or <see cref="langword:null" />.</param>
<returns>Returns <see cref="langword:true" /> if the widget supports scrolling.</returns>
<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>
<returns>Returns <see langword="true" /> if the widget supports scrolling.</returns>
<remarks>
<para>
For <paramref name="widgets" /> that don't support scrolling, does nothing and returns <see cref="langword:false" />. <paramref name="Widgets" /> that don't support scrolling can be scrolled by placing them in a <see cref="T:Gtk.ViewPort" />, which does support scrolling.
For <paramref name="widgets" /> that don't support scrolling, does nothing and returns <see langword="false" />. <paramref name="Widgets" /> that don't support scrolling can be scrolled by placing them in a <see cref="T:Gtk.ViewPort" />, which does support scrolling.
</para>
</remarks>
</Docs>
@ -644,7 +641,7 @@
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Pango.Layout" /> with the appropriate colormap, font description, and base direction for drawing text for <paramref name="widget" />.</summary>
<param name="text"> text to set on the layout (can be <see cref="langword:null" />).</param>
<param name="text"> text to set on the layout (can be <see langword="null" />).</param>
<returns>The new <see cref="T:Pango.Layout" />.</returns>
<remarks>
<para>
@ -711,7 +708,7 @@
<param name="src_y">Y position relative to source widget.</param>
<param name="dest_x">Location to store X position relative to <paramref name="dest_widget" />.</param>
<param name="dest_y">Location to store Y position relative to <paramref name="dest_widget" />.</param>
<returns>Returns <see cref="langword:false" /> if either widget was not realized, or there was no common ancestor. In this case, nothing is stored in <paramref name="*dest_x" /> and <paramref name="*dest_y" />. Otherwise <see cref="langword:true" />.</returns>
<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>
<remarks>
<para>
In order to perform this operation, both widgets must be realized, and must share a common toplevel.
@ -728,10 +725,10 @@
<Parameters />
<Docs>
<summary>For <paramref name="widgets" /> that can be "activated" (buttons, menu items, etc.) this function activates them.</summary>
<returns>Returns <see cref="langword:true" /> if the widget was activatable.</returns>
<returns>Returns <see langword="true" /> if the widget was activatable.</returns>
<remarks>
<para>
Activation is what happens when you press Enter on a widget during key navigation; clicking a button, selecting a menu item, etc. If the <paramref name="widget" /> isn't activatable, the function returns <see cref="langword:false" />.
Activation is what happens when you press Enter on a widget during key navigation; clicking a button, selecting a menu item, etc. If the <paramref name="widget" /> isn't activatable, the function returns <see langword="false" />.
</para>
</remarks>
</Docs>
@ -749,7 +746,7 @@
<Docs>
<summary>Sets the background color for a <paramref name="widget" /> in a particular state.</summary>
<param name="state">The state for which to set the background color.</param>
<param name="color">The color to assign (does not need to be allocated), or <see cref="langword:null" /> to undo the effect of previous calls of <see cref="M:Gtk.Widget.ModifyBg" />.</param>
<param name="color">The color to assign (does not need to be allocated), or <see langword="null" /> to undo the effect of previous calls of <see cref="M:Gtk.Widget.ModifyBg" />.</param>
<remarks>
<para>
All other style values are left untouched. See also <see cref="M:Gtk.Widget.ModifyStyle" />.
@ -769,7 +766,7 @@
<Docs>
<summary>Rarely-used function. This function is used to emit the event signals on a <paramref name="widget" />.</summary>
<param name="evnt">A <see cref="T:Gdk.Event" />.</param>
<returns>Return from the event signal emission (<see cref="langword:true" /> if the event was handled)</returns>
<returns>Return from the event signal emission (<see langword="true" /> if the event was handled)</returns>
<remarks>
<para>
If you want to synthesize an event though, don't use this function; instead, use <see cref="M:Gdk.Windowt.InvalidateRect" /> to invalidate a region of the window.
@ -806,7 +803,7 @@
<Docs>
<summary>Sets the base color for a <paramref name="widget" /> in a particular state.</summary>
<param name="state">The state for which to set the base color.</param>
<param name="color">The color to assign (does not need to be allocated), or <see cref="langword:null" /> to undo the effect of previous calls to of <see cref="M:Gtk.Widget.ModifyBase" />.</param>
<param name="color">The color to assign (does not need to be allocated), or <see langword="null" /> to undo the effect of previous calls to of <see cref="M:Gtk.Widget.ModifyBase" />.</param>
<remarks>
<para>
All other style values are left untouched. The base color is the background color used along with the text color (see <see cref="M:Gtk.Widget.ModifyText" />) for widgets such as <see cref="T:Gtk.Entry" /> and <see cref="T:Gtk.TextView" />. See also <see cref="M:Gtk.Widget.ModifyStyle" />.
@ -826,7 +823,7 @@
<Docs>
<summary>Gets the first ancestor of <paramref name="widget" /> with type <paramref name="widget_type" />.</summary>
<param name="widget_type">Ancestor type.</param>
<returns>The ancestor widget, or <see cref="langword:null" /> if not found</returns>
<returns>The ancestor widget, or <see langword="null" /> if not found</returns>
<remarks>
<para>
For example, <see cref="M:Gtk.Widget.GetAncestor" />(widget, GTK_TYPE_BOX) gets the first <see cref="T:Gtk.Box" /> that's an ancestor of <paramref name="widget" />. No reference will be added to the returned widget; it should not be unreferenced. See note about checking for a toplevel <see cref="T:Gtk.Window" /> in the docs for <see cref="M:Gtk.Widget.Toplevel" />. Note that unlike <see cref="M:Gtk.Widget.IsAncestor" />, <see cref="M:Gtk.Widget.GetAncestor" /> considers <paramref name="widget" /> to be an ancestor of itself.
@ -924,8 +921,8 @@
</Parameters>
<Docs>
<summary>Gets the size request that was explicitly set for the <paramref name="widget" /> using <see cref="M:Gtk.Widget.SetSizeRequest" />.</summary>
<param name="width">Return location for width, or <see cref="langword:null" />.</param>
<param name="height">Return location for height, or <see cref="langword:null" />.</param>
<param name="width">Return location for width, or <see langword="null" />.</param>
<param name="height">Return location for height, or <see langword="null" />.</param>
<remarks>
<para>
A value of -1 stored in <paramref name="width" /> or <paramref name="height" /> indicates that that dimension has not been set explicitly and the natural requisition of the <paramref name="widget" /> will be used intead. See <see cref="M:Gtk.Widget.SetSizeRequest" />. To get the size a <paramref name="widget" /> will actually use, call <see cref="M:Gtk.Widget.SizeRequest" /> instead of this function.
@ -970,9 +967,9 @@
</Parameters>
<Docs>
<summary>Obtains the full path to <paramref name="widget" />.</summary>
<param name="path_length">Location to store length of the path, or <see cref="langword:null" />.</param>
<param name="path">Location to store allocated path string, or <see cref="langword:null" />.</param>
<param name="path_reversed">Location to store allocated reverse path string, or <see cref="langword:null" />.</param>
<param name="path_length">Location to store length of the path, 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>
<remarks>
<para>
The path is simply the name of a <paramref name="widget" /> and all its parents in the container hierarchy, separated by periods. The name of a <paramref name="widget" /> comes from <see cref="P:Gtk.Widget.Name" />. Paths are used to apply styles to a <paramref name="widget" /> in gtkrc configuration files. Widget names are the type of the <paramref name="widget" /> by default (e.g. "<see cref="T:Gtk.Button" />") or can be set to an application-specific value with <see cref="P:Gtk.Widget.Name" />.
@ -1062,7 +1059,7 @@
</Parameters>
<Docs>
<summary>Sets the font to use for a <paramref name="widget" />.</summary>
<param name="font_desc">The font description to use, or <see cref="langword:null" /> to undo the effect of previous calls to <see cref="M:Gtk.Widget.ModifyFont" />.</param>
<param name="font_desc">The font description to use, or <see langword="null" /> to undo the effect of previous calls to <see cref="M:Gtk.Widget.ModifyFont" />.</param>
<remarks>
<para>
All other style values are left untouched. See also <see cref="M:Gtk.Widget.ModifyStyle" />.
@ -1082,7 +1079,7 @@
<Docs>
<summary>Very rarely-used function. This function is used to emit an <see cref="F:Gtk.Widget.ExposeEvent" /> signals on a <paramref name="widget" />.</summary>
<param name="evnt">A <see cref="F:Gtk.Widget.ExposeEvent" />.</param>
<returns>Return from the event signal emission (<see cref="langword:true" /> if the event was handled).</returns>
<returns>Return from the event signal emission (<see langword="true" /> if the event was handled).</returns>
<remarks>
<para>
This function is not normally used directly. The only time it is used is when propagating an <see cref="F:Gtk.Widget.ExposeEvent" /> to a child <see cref="F:Gtk.WidgetFlags.NoWindow" /> widget, and that is normally done using <see cref="M:Gtk.Container.PropagateExpose" />. If you want to force an area of a window to be redrawn, use <see cref="M:Gdk.Window.InvalidateRect" /> or <see cref="M:Gdk.Window.InvalidateRegion" />. To cause the redraw to be done immediately, follow that call with a call to <see cref="M:Gdk.Window.ProcessUpdates" />.
@ -1134,7 +1131,7 @@
<Docs>
<summary>Determines whether <paramref name="widget" /> is somewhere inside <paramref name="ancestor" />, possibly with intermediate containers.</summary>
<param name="ancestor">Another <see cref="T:Gtk.Widget" />.</param>
<returns>Returns <see cref="langword:true" /> if ancestor contains widget as a child, grandchild, great grandchild, etc.</returns>
<returns>Returns <see langword="true" /> if ancestor contains widget as a child, grandchild, great grandchild, etc.</returns>
<remarks>
<para>
Determines whether <paramref name="widget" /> is somewhere inside <paramref name="ancestor" />, possibly with intermediate containers.
@ -1206,7 +1203,7 @@
</Parameters>
<Docs>
<summary>Sets a shape for this <paramref name="widget" />'s GDK window. This allows for transparent windows etc., see <see cref="M:Gdk.Window.ShapeCombineMask" /> for more information.</summary>
<param name="shape_mask">Shape to be added, or <see cref="langword:null" /> to remove an existing shape.</param>
<param name="shape_mask">Shape to be added, or <see langword="null" /> to remove an existing shape.</param>
<param name="offset_x">X position of shape mask with respect to the window.</param>
<param name="offset_y">Y position of shape mask with respect to the window.</param>
<remarks>
@ -1248,9 +1245,9 @@
</Parameters>
<Docs>
<summary>Same as <see cref="M:Gtk.Widget.Path" />, but always uses the name of a <paramref name="widget" />'s type, never uses a custom name set with <see cref="P:Gtk.Widget.Name" />.</summary>
<param name="path_length">Location to store the length of the class path, or <see cref="langword:null" />.</param>
<param name="path">Location to store the class path as an allocated string, or <see cref="langword:null" />.</param>
<param name="path_reversed">Location to store the reverse class path as an allocated string, or <see cref="langword:null" />.</param>
<param name="path_length">Location to store the length of the class path, or <see langword="null" />.</param>
<param name="path">Location to store the class path as an allocated string, or <see langword="null" />.</param>
<param name="path_reversed">Location to store the reverse class path as an allocated string, or <see langword="null" />.</param>
<remarks>
<para>
Same as <see cref="M:Gtk.Widget.Path" />, but always uses the name of a <paramref name="widget" />'s type, never uses a custom name set with <see cref="P:Gtk.Widget.Name" />.
@ -1522,11 +1519,11 @@
</Parameters>
<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>
<param name="value">If <see cref="langword:true" />, <paramref name="widget" /> should be mapped along with its parent.</param>
<returns>Returns <see cref="langword:true" /> if the widget is mapped with the parent.</returns>
<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>
<remarks>
<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 cref="langword:true" /> when the widget is removed from a container.
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.
</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.
@ -1546,7 +1543,7 @@
<Docs>
<summary>Sets or obtains a <paramref name="widget" /> composite name.</summary>
<param name="value">The name to set.</param>
<returns>The composite name of <paramref name="widget" />, or <see cref="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>
<para>
The widget must be a composite child of its parent; see <see cref="M:Gtk.Widget.PushCompositeChild" />.
@ -1565,7 +1562,7 @@
<returns>The topmost ancestor of <paramref name="widget" />, or <paramref name="widget" /> itself if there's no ancestor.</returns>
<remarks>
<para>
Note the difference in behavior against <see cref="P:Gtk.Widget.GetAncestor" />, would return <see cref="langword: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 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>
</remarks>
</Docs>
@ -1581,14 +1578,14 @@
</Parameters>
<Docs>
<summary>Sets whether a <paramref name="widget" /> size allocation changes, the entire <paramref name="widget" /> is queued for drawing.</summary>
<param name="value"><see cref="langword:true" /> the entire widget will be redrawn when it is allocated to a new size. <see cref="langword:false" /> only the new portion of the widget will be redrawn.</param>
<returns>Returns <see cref="langword:true" /> because it is on by Default, but returns <see cref="langword:false" /> if you turn it off.</returns>
<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>
<returns>Returns <see langword="true" /> because it is on by Default, but returns <see langword="false" /> if you turn it off.</returns>
<remarks>
<para>
By default, this setting is <see cref="langword:true" /> and the entire <paramref name="widget" /> is redrawn on every size change. If your widget leaves the upper left are unchanged when made bigger, turning this setting on will improve performance.
By default, this setting is <see langword="true" /> and the entire <paramref name="widget" /> is redrawn on every size change. If your widget leaves the upper left are unchanged when made bigger, turning this setting on will improve performance.
</para>
<para>
Note that for <see cref="F:Gtk.WidgetFlags.NoWindow" /> widgets setting this flag to <see cref="langword:false" /> turns off all allocation on resizing: the widget will not even redraw if its position changes; this is to allow containers that don't draw anything to avoid excess invalidations. If you set this flag on a <see cref="F:Gtk.WidgetFlags.NoWindow" /> widget that does draw on <paramref name="widget" />-&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" /> 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.
</para>
</remarks>
</Docs>
@ -1604,8 +1601,8 @@
</Parameters>
<Docs>
<summary>Use this function to turn off the double buffering.</summary>
<param name="value"><see cref="langword:true" /> is on by Default, <see cref="langword:false" /> if you want to turn off double buffering no use call for true because it is default.</param>
<returns>Returns <see cref="langword:true" /> because double buffering is on by Default, but returns <see cref="langword:false" /> if you turn it off.</returns>
<param name="value"><see 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>
<remarks>
<para>
Widgets are double buffered by default, you can use this function to turn off the buffering. "Double buffered" simply means that <see cref="M:Gdk.Window.BeginPaintRegion" /> and <see cref="M:Gdk.Window.EndPaint" /> are called automatically around <see cref="F:Gtk.Widget.ExposeEvent" /> events sent to the widget. <see cref="M:Gdk.Window.BeginPaint" /> diverts all drawing to a <paramref name="widget" />'s window to an offscreen buffer, and <see cref="M:Gdk.Window.EndPaint" /> draws the buffer to the screen. The result is that users see the window update in one smooth step, and don't see individual graphics primitives being rendered.