ryujinx/GtkSharp
1
0
Fork 0
mirror of https://github.com/Ryujinx/GtkSharp.git synced 2024-12-25 00:45:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

* en/Gtk/Ctree.xml

Browse source 
* en/Gtk/Style.xml
	* en/Gtk/Tree.xml: First draft.
	* en/Gtk/TODO: updated.
	* en/Gtk/Widget.xml: Documented the remaining methods and properties.
	* en/Gtk/Window.xml: Documented all methods excepts the overloads and all the properties.

svn path=/trunk/gtk-sharp/; revision=21995
This commit is contained in:
Hector E. Gomez Morales 2004-01-13 01:30:01 +00:00
parent 19629688fa
commit fdb11c4cc1
7 changed files with 494 additions and 372 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/ChangeLog
View file

@ -1,3 +1,12 @@
2004-01-12 Hector E. Gomez Morales <hgomez_36@flashmail.com>
* en/Gtk/Ctree.xml
* en/Gtk/Style.xml
* en/Gtk/Tree.xml: First draft.
* en/Gtk/TODO: updated.
* en/Gtk/Widget.xml: Documented the remaining methods and properties.
* en/Gtk/Window.xml: Documented all methods excepts the overloads and all the properties.
2004-01-08 John Luke <jluke@cfl.rr.com>
* en/Gtk/RadioButton.xml:

16
doc/en/Gtk/Ctree.xml
View file

@ -1,5 +1,5 @@
<Type Name="Ctree" FullName="Gtk.Ctree">
<TypeSignature Language="C#" Value="public class Ctree" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class Ctree" Maintainer="Hector Gomez M" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>
@ -10,8 +10,18 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>A <paramref name="widget" /> displaying a hierarchical tree.</summary>
<remarks>
<para>
The <see cref="T:Gtk.Ctree" /> widget is used for showing a hierarchical tree to the user, for example a directory tree. The tree is internally represented as a set of nodes.
</para>
<para>
Positions in the tree are often indicated by two arguments, a parent and a sibling, both node pointers. If the parent is <see langword="null" />, the position is at the root of the tree and if the sibling is <see langword="null" />, it will be the last child of parent, otherwise it wil be inserted just before the sibling.
</para>
<para>
Warning: <see cref="T.Gtk.Ctree" /> is deprecated and should not be used in newly-written code.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>

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

@ -1,5 +1,5 @@
<Type Name="Style" FullName="Gtk.Style">
<TypeSignature Language="C#" Value="public class Style : GLib.Object, IWrapper, IDisposable" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class Style : GLib.Object, IWrapper, IDisposable" Maintainer="Hector Gomez M" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>
@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Methods for drawing widget parts.</summary>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
@ -52,10 +52,10 @@
<Parameter Name="state" Type="Gtk.StateType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="state">To be added: an object of type 'Gtk.StateType'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
<summary>Sets the background of <paramref name="window" /> to the background color or pixmap specified by style for the state.</summary>
<param name="state">A state.</param>
<returns>A color to be used for the background.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="BackgroundGC">

6
doc/en/Gtk/TODO
View file

@ -1,6 +1,6 @@
TODO doc for Gtk namespace.
There are in total 324 xml to document in Gtk. Right now there are 164 xml not documented in any proportion.
There are in total 324 xml to document in Gtk. Right now there are 160 xml not documented in any proportion.
The idea is to have a easy way to know what documentation is missing, if you want to help or are helping please take out the xml that you commit
from the missing list. For documentation that take some time to finish (like HTML, TextBuffer, etc) the best is that you but your name and email
next to the file in this list to acknowledge that you are working in it (is recommendable that you suscribe to the mono-docs mailing list).
@ -24,7 +24,6 @@ ClipboardTestReceivedFunc.xml
ColorSelectionButton.xml
ColorSelectionChangePaletteFunc.xml
ColorSelectionChangePaletteWithScreenFunc.xml
Ctree.xml
DebugFlag.xml
Decorated.xml
DestroyNotify.xml
@ -91,7 +90,6 @@ RBNodeColor.xml
RBTree.xml
RBTreeTraverseFunc.xml
RBTreeView.xml
RadioButton.xml
RadioMenuItem.xml
Rc.xml
RcFlags.xml
@ -111,7 +109,6 @@ SettingsPropertyValue.xml
SettingsValue.xml
SignalFunc.xml
StockManager.xml
Style.xml
Submenu.xml
TargetEntry.xml
TargetFlags.xml
@ -147,7 +144,6 @@ TextWindowType.xml
ThemeEngine.xml
ThreadNotify.xml
TranslateFunc.xml
Tree.xml
TreeCellDataFunc.xml
TreeDataList.xml
TreeDestroyCountFunc.xml

13
doc/en/Gtk/Tree.xml
View file

@ -1,5 +1,5 @@
<Type Name="Tree" FullName="Gtk.Tree">
<TypeSignature Language="C#" Value="public class Tree" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class Tree" Maintainer="Hector Gomez M" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>
@ -10,8 +10,15 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>A tree <paramref name="widget" />.</summary>
<remarks>
<para>
<see cref="T:Gtk.Tree" /> is deprecated and unsupported. It is known to be buggy. To use it, you must define the symbol <paramref name="GTK_ENABLE_BROKEN" /> prior to includng the Gtk# header files. Use <see cref="T:Gtk.Treeview" /> instead.
</para>
<para>
The <see cref="T:Gtk.Tree" /> widget is a container that shows users a list of items, in a tree format complete withbranches and leafnodes. Branches can be expanded to show their child items, or collapsed to hide them.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>

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

@ -50,7 +50,7 @@
<summary>Makes all newly-created <paramref name="widgets" /> as composite children until the corresponding <see cref="M:Gtk.Widget.PopCompositeChild" /> call.</summary>
<remarks>
<para>
A composite child is a child that's an implementation detail of the container it's inside and should not be visible to people using the container. Composite children aren't treated differently by GTK (but see <see cref="M:Gtk.Container.Foreach" /> vs. <see cref="M:GtkContainer.Forall" />), but e.g. GUI builders might want to treat them in a different way.
A composite child is a child that's an implementation detail of the container it's inside and should not be visible to people using the container. Composite children aren't treated differently by GTK# (but see <see cref="M:Gtk.Container.Foreach" /> vs. <see cref="M:GtkContainer.Forall" />), but e.g. GUI builders might want to treat them in a different way.
</para>
</remarks>
</Docs>
@ -190,7 +190,7 @@
<see langword="true" /> if focus ended up inside <paramref name="widget" />.</returns>
<remarks>
<para>
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.
This method is used by custom <paramref name="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>
<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.
@ -256,7 +256,7 @@
<param name="height">Height of region to draw.</param>
<remarks>
<para>
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.
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 <paramref name="widget" />'s window and all its child windows. Once the main loop becomes idle (after the current batch of events has been processed, roughly), the window will receive <see cref="F:Gtk.Widget.ExposeEvent" /> events for the union of all regions that have been invalidated.
</para>
<para>
Normally you would only use this 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.
@ -726,10 +726,10 @@
<Parameter Name="group_cycling" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Activates the targets associated with the mnemonic.</summary>
<param name="group_cycling">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<returns><see langword="true" /> if the activation is done.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GetSizeRequest">
@ -950,7 +950,7 @@
<param name="events" />
<remarks>
<para>
Adds the events in the bitfield <paramref name="events" /> to the event mask for <paramref name="widget" />. See <see cref="M:Gtk.Widget.Events" /> for details.
See <see cref="M:Gtk.Widget.Events" /> for details.
</para>
</remarks>
</Docs>
@ -1488,10 +1488,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Whether the <paramref name="widget" /> is visible.</summary>
<param name="value">If <see langword="true" /> the widget is set to be visible.</param>
<returns><see langword="true" /> if the widget is meant to be visible.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="WidthRequest">
@ -1503,10 +1503,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Override for the width request for the <paramref name="widget" />.</summary>
<param name="value">The width to be set for the <paramref name="widget" />.</param>
<returns>The width of the <paramref name="widget" />.</returns>
<remarks>Or -1 if natural request should be used.</remarks>
</Docs>
</Member>
<Member MemberName="Sensitive">
@ -1518,10 +1518,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Whether the <paramref name="widget" /> responds to input.</summary>
<param name="value">If <see langword="true" /> the <paramref name="widget" /> is set to respond to input.</param>
<returns><see langword="true" /> if the <paramref name="widget" /> responds to input.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Events">
@ -1533,10 +1533,23 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Obtains or sets the event mask for the <paramref name="widget" /> (a bitfield containing flags from <see cref="T:Gdk.EventMask" />).</summary>
<param name="value">Event mask.</param>
<returns>Event mask for <paramref name="widget" />.</returns>
<remarks>
<para>
The event mask determines which events a <paramref name="widget" /> will receive. Keep in mind that different widgets have different default event masks, and by changing the event mask you may disrupt a <paramref name="widget" />'s fuctionalit, so be careful.
</para>
<para>
This property must be called while a <paramref name="widget" /> is unrealized. Consider <see cref="M:Gtk.Widget.AddEvents" /> for widgets that are already realized, or if you want to preserve the existing event mask.
</para>
<para>
This property can't be used with <see cref="F:Gtk.WidgetFlags.NoWindow" /> widgets; to get events on those events, place them inside a <see cref="T:Gtk.EventBox" /> and receive events on the event box.
</para>
<para>
These are the events that the <paramref name="widget" /> will receive.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ReceivesDefault">
@ -1548,10 +1561,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Whether to make the <paramref name="widget" /> receive the default action when it is focused.</summary>
<param name="value">If <see langword="true" /> the <paramref name="widget" /> will receive the default action when is focused.</param>
<returns><see langword="true" /> if the <paramref name="true" /> will receive the default action when is focused.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="HasFocus">
@ -1563,10 +1576,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Whether the <paramref name="widget" /> has the input focus.</summary>
<param name="value">If <see langword="true" /> the <paramref name="widget" /> has the input focus.</param>
<returns><see langword="true" /> if the <paramref name="widget" /> has the input focus.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="ExtensionEvents">
@ -1578,10 +1591,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.ExtensionMode'</param>
<returns>To be added: an object of type 'Gdk.ExtensionMode'</returns>
<remarks>To be added</remarks>
<summary>The mask that decides what kind of extension events the <paramref name="widget" /> gets.</summary>
<param name="value">A Gdk.ExtensionMode.</param>
<returns>A Gdk.ExtensionMode.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="HasDefault">
@ -1593,10 +1606,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Whether the <paramref name="widget" /> is the default <paramref name="widget" />.</summary>
<param name="value">If <paramref name="true" /> the <paramref name="widget" /> is the default <paramref name="widget" />.</param>
<returns><see langword="true" /> if the <paramref name="widget" /> is the default <paramref name="widget" />.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="CompositeChild">
@ -1606,9 +1619,9 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Whether the <paramref name="widget" /> is part of a composite widget.</summary>
<returns><see langword="true" /> if the <paramref name="widget" /> is part of a composite widget.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="CanDefault">
@ -1620,10 +1633,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Whether the <paramref name="widget" /> can be the default widget.</summary>
<param name="value">If <see langword="true" /> the <paramref name="widget" /> can be the default widget.</param>
<returns><see langoword="true" /> if the <paramref name="widget" /> can be the default widget.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="CanFocus">
@ -1635,10 +1648,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Whether the <paramref name="widget" /> can accept the input focus.</summary>
<param name="value">If <see langword="true" /> the <paramref name="widget" /> can accept the input focus.</param>
<returns><see langword="true" /> if the <paramref name="widget" /> can accept the input focus.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="HeightRequest">
@ -1650,10 +1663,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Override for the height request for the <paramref name="widget" />.</summary>
<param name="value">The height to be set for the <paramref name="widget" />.</param>
<returns>The height of the <paramref name="widget" />.</returns>
<remarks>Or -1 if natural request should be used.</remarks>
</Docs>
</Member>
<Member MemberName="AppPaintable">
@ -1665,10 +1678,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Whether the application will paint directly on the <paramref name="widget" />.</summary>
<param name="value">If <see langword="true" /> the application will paint directly on the <paramref name="widget" />.</param>
<returns><see langword="true" /> if the application will paint directly on the <paramref name="widget" />.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Parent">
@ -1680,10 +1693,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.Widget'</param>
<returns>To be added: an object of type 'Gtk.Widget'</returns>
<remarks>To be added</remarks>
<summary>The parent widget of this <paramref name="widget" />.</summary>
<param name="value">The parent widget.</param>
<returns>The parent widget.</returns>
<remarks>Must be a Container <paramref name="widget" />,</remarks>
</Docs>
</Member>
<Member MemberName="Name">
@ -1695,10 +1708,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>The name of the <paramref name="widget" />.</summary>
<param name="value">The name to be set for the <paramref name="widget" />.</param>
<returns>The name of the <paramref name="widget" />.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Style">
@ -1710,10 +1723,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.Style'</param>
<returns>To be added: an object of type 'Gtk.Style'</returns>
<remarks>To be added</remarks>
<summary>The style of the <paramref name="widget" />.</summary>
<param name="value">A style.</param>
<returns>A style.</returns>
<remarks>Which contains information about how it will look (colors etc).</remarks>
</Docs>
</Member>
<Member MemberName="UnmapEvent">
@ -2422,9 +2435,16 @@
<ReturnType>Gdk.Display</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Display" /></returns>
<remarks>To be added</remarks>
<summary>Obtains the <see cref="T:Gdk.Display" /> for the toplevel window associated with this <paramref name="widget" />.</summary>
<returns>The <see cref="T:Gdk.Display" /> for the toplevel for this <paramref name="widget" />.</returns>
<remarks>
<para>
This method can only be called after the <paramref name="widget" /> has been added to a widget hierarchy with a <see cref="T:Gtk.Window" /> at the top.
</para>
<para>
In general, you should only create display specific resources when a <paramref name="widget" /> has been realized, and you should free those resources when the <paramref name="widget" /> is unrealized.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Screen">
@ -2434,9 +2454,16 @@
<ReturnType>Gdk.Screen</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Screen" /></returns>
<remarks>To be added</remarks>
<summary>Obtains the <see cref="T:Gdk.Screen" /> from the toplevel window associated with this <paramref name="widget" />.</summary>
<returns>The <see cref="T:Gdk.Screen" /> for the toplevel for this <paramref name="widget" />.</returns>
<remarks>
<para>
This method can only be called after the <paramref name="widget" /> has been added to a widget hierarchy with a <see cref="T:Gtk.Window" /> at the top.
</para>
<para>
In general, you should only create screen specific resources when a <paramref name="widget" /> has been realized, and you should free those resources when the <paramref name="widget" /> is unrealized.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="IsFocus">
@ -2504,7 +2531,7 @@
</Parameters>
<Docs>
<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" /> 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>
<param name="selection">A <see cref="T:Gdk.Atom" /> which identifies the clipboard to use. <see cref="F:Gdk.Selection.Clipboard" /> gives the default clipboard, another common value is <see cref="F:Gdk.Selection.Primary" />, which gives the primary X selection.</param>
<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>
<para>
@ -2629,9 +2656,19 @@
<Parameter Name="requisition" Type="Gtk.Requisition&amp;" RefType="ref" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="requisition">a <see cref="T:Gtk.Requisition&amp;" /></param>
<remarks>To be added</remarks>
<summary>Obtains the preferred size of a <paramref name="widget" />.</summary>
<param name="requisition">A <see cref="T:Gtk.Requisition" />.</param>
<remarks>
<para>
The container uses this information to arrange its child widgets and decide what size allocations to give them with <see cref="M:Gtk.Widget.SizeAllocate" />.
</para>
<para>
You can also call this method from an application, with some caveats. Most notably, getting a size request requieres 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>
Also remember that the size request is not necessarily the size a <paramref name="widget" /> will actually be allocated.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="StyleGetProperty">
@ -2645,10 +2682,10 @@
<Parameter Name="value" Type="GLib.Value" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="property_name">a <see cref="T:System.String" /></param>
<param name="value">a <see cref="T:GLib.Value" /></param>
<remarks>To be added</remarks>
<summary>Obtains the value of a style property of <paramref name="widget" />.</summary>
<param name="property_name">The name of a style property.</param>
<param name="value">Location to return the property value.</param>
<remarks />
</Docs>
</Member>
<Member MemberName="HasScreen">
@ -4472,10 +4509,14 @@
<Parameter Name="widget_type" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="widget_type">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks>To be added</remarks>
<summary>Obtains the first ancestor of <paramref name="widget" />.</summary>
<param name="widget_type">Ancestor type.</param>
<returns>The ancesor <paramref name="widget" />, or see <see langword="null" /> if not found.</returns>
<remarks>
<para>
For example sending <paramref name="GTK_TYPE_BOX" /> gets the first <see cref="T:Gtk.Box" /> that's an ancstor of <paramref name="widget" />. No reference will be added to the retured <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>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">

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

@ -113,7 +113,7 @@
<summary>Asks to iconify (i.e. minimize) the specified <paramref name="window" />.</summary>
<remarks>
<para>
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 <paramref name="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 <paramref name="window" /> will end up iconified. Just do not write code that crashes if not.
</para>
<para>
You can track iconification via the <see cref="F:Gtk.Widget.WindowStateEvent" /> event on <see cref="T:Gtk.Widget" />.
@ -132,7 +132,7 @@
<summary>Asks to unstick <paramref name="window" />, which means that it will appear on only one of the user's desktops.</summary>
<remarks>
<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 <paramref name="window" /> is definitely unstuck afterward, because other entities (e.g. the user or window manager) could stick it again. But normally the <paramref name="window" /> will end up stuck. Just do not write code that crashes if not.
</para>
<para>
You can track stickiness via the <see cref="F:Gtk.Widget.WindowStateEvent" /> event on <see cref="T:Gtk.Widget" />.
@ -151,10 +151,11 @@
<summary>Asks to unmaximize <paramref name="window" />.</summary>
<remarks>
<para>
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 <paramref name="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 <paramref name="window" /> will end up unmaximized. Just don't write code that crashes if not.
</para>
<para>
You can track maximization via the <see cref="F:Gtk.Widget.WindowStateEvent" /> event on <see cref="T:Gtk.Widget" /></para>
You can track maximization via the <see cref="F:Gtk.Widget.WindowStateEvent" /> event on <see cref="T:Gtk.Widget" />
</para>
</remarks>
</Docs>
</Member>
@ -174,10 +175,10 @@
<param name="height">Return location for height, or <see langword="null" />.</param>
<remarks>
<para>
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 <paramref name="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 <paramref name="window" /> gets updated.
</para>
<para>
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.
Note 1: Nearly any use of this method creates a race condition, because the size of the <paramref name="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 <paramref name="window" /> and adjust your size-dependent state to match the size delivered in the GdkEventConfigure.
</para>
</remarks>
</Docs>
@ -198,7 +199,7 @@
<param name="height">Location to store the default height, or <see langword="null" />.</param>
<remarks>
<para>
A value of -1 for the width or height indicates that a default size has not been explicitly set for that dimension, so the "natural" size of the window will be used.
A value of -1 for the width or height indicates that a default size has not been explicitly set for that dimension, so the "natural" size of the <paramref name="window" /> will be used.
</para>
</remarks>
</Docs>
@ -215,14 +216,14 @@
</Parameters>
<Docs>
<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="height">Height in pixels to resize the window to.</param>
<param name="width">Width in pixels to resize the <paramref name="window" /> to.</param>
<param name="height">Height in pixels to resize the <paramref name="window" /> to.</param>
<remarks>
<para>
The default geometry constraint is that windows may not be smaller than their size request; to override this constraint, call <see cref="M:Gtk.Widget.SetSizeRequest" /> to set the window's request to a smaller value.
The default geometry constraint is that windows may not be smaller than their size request; to override this constraint, call <see cref="M:Gtk.Widget.SetSizeRequest" /> to set the <paramref name="window" />'s request to a smaller value.
</para>
<para>
If <see cref="M:Gtk.Window.Resize" /> is called before showing a window for the first time, it overrides any default size set with <see cref="M:Gtk.Window.SetDefaultSize" />. Windows may not be resized smaller than 1 by 1 pixels.
If <see cref="M:Gtk.Window.Resize" /> is called before showing a <paramref name="window" /> for the first time, it overrides any default size set with <see cref="M:Gtk.Window.SetDefaultSize" />. Windows may not be resized smaller than 1 by 1 pixels.
</para>
</remarks>
</Docs>
@ -236,8 +237,7 @@
<Parameters />
<Docs>
<summary>Activates the current focused <paramref name="widget" /> within the <paramref name="window" />.</summary>
<returns>
<see langword="true" /> if a <paramref name="widget" /> got activated.</returns>
<returns><see langword="true" /> if a <paramref name="widget" /> got activated.</returns>
<remarks />
</Docs>
</Member>
@ -261,13 +261,13 @@
<see cref="M:Gtk.Window.ParseGeometry" /> does work on all GTK# ports including Win32 but is primarily intended for an X environment.
</para>
<para>
If either a size or a position can be extracted from the geometry string, <see cref="M:Gtk.Window.ParseGeometry" /> returns <see langword="true" /> and calls <see cref="M:Gtk.Window.SetDefaultSize" /> and/or <see cref="M:Gtk.Window.Move" /> to resize/move the window.
If either a size or a position can be extracted from the geometry string, <see cref="M:Gtk.Window.ParseGeometry" /> returns <see langword="true" /> and calls <see cref="M:Gtk.Window.SetDefaultSize" /> and/or <see cref="M:Gtk.Window.Move" /> to resize/move the <paramref name="window" />.
</para>
<para>
If <see cref="M:Gtk.Window.ParseGeometry" /> returns <see langword="true" />, it will also set the GDK_HINT_USER_POS and/or GDK_HINT_USER_SIZE hints indicating to the window manager that the size/position of the window was user-specified. This causes most window managers to honor the geometry.
If <see cref="M:Gtk.Window.ParseGeometry" /> returns <see langword="true" />, it will also set the <paramref name="F:Gdk.WindowHints.UserPos" /> and/or <see cref="F:Gdk.WindowHints.UserSize" /> hints indicating to the window manager that the size/position of the <paramref name="window" /> was user-specified. This causes most window managers to honor the geometry.
</para>
<para>
Note that for <see cref="M:Gtk.Window.ParseGeometry" /> to work as expected, it has to be called when the window has its "final" size, i.e. after calling <see cref="M:Gtk.Widget.ShowAll" /> on the contents and <see cref="M:Gtk.Window.SetGeometryHints" /> on the window.
Note that for <see cref="M:Gtk.Window.ParseGeometry" /> to work as expected, it has to be called when the <paramref name="window" /> has its "final" size, i.e. after calling <see cref="M:Gtk.Widget.ShowAll" /> on the contents and <see cref="M:Gtk.Window.SetGeometryHints" /> on the <paramref nmae="window" />.
</para>
</remarks>
</Docs>
@ -298,10 +298,10 @@
<summary>Asks to stick <paramref name="window" />, which means that it will appear on all user desktops.</summary>
<remarks>
<para>
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 <paramref name="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 <paramref name="window" /> will end up stuck. Just don't write code that crashes if not.
</para>
<para>
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.
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 <paramref name="window" />.
</para>
</remarks>
</Docs>
@ -391,19 +391,19 @@
<param name="root_y">Return location for Y coordinate of gravity-determined reference point.</param>
<remarks>
<para>
If you haven't changed the window gravity, its gravity will be GDK_GRAVITY_NORTH_WEST. This means that <see cref="M:Gtk.Window.GetPosition" /> gets the position of the top-left corner of the window manager frame for the window. <see cref="M:Gtk.Window.Move" /> sets the position of this same top-left corner.
If you haven't changed the window gravity, its gravity will be <see cref="F:Gdk.Gravity.NorthWest" />. This means that <see cref="M:Gtk.Window.GetPosition" /> gets the position of the top-left corner of the window manager frame for the <paramref name="window" />. <see cref="M:Gtk.Window.Move" /> sets the position of this same top-left corner.
</para>
<para>
<see cref="M:Gtk.Window.GetPosition" /> is not 100% reliable because the X Window System does not specify a way to obtain the geometry of the decorations placed on a window by the window manager. Thus GTK# is using a "best guess" that works with most window managers.
<see cref="M:Gtk.Window.GetPosition" /> is not 100% reliable because the X Window System does not specify a way to obtain the geometry of the decorations placed on a <paramref name="window" /> by the window manager. Thus GTK# is using a "best guess" that works with most window managers.
</para>
<para>
Moreover, nearly all window managers are historically broken with respect to their handling of window gravity. So moving a window to its current position as returned by <see cref="M:Gtk.Window.GetPostion" /> tends to result in moving the window slightly. Window managers are slowly getting better over time.
Moreover, nearly all window managers are historically broken with respect to their handling of window gravity. So moving a <paramref name="window" /> to its current position as returned by <see cref="M:Gtk.Window.GetPostion" /> tends to result in moving the <paramef name="window" /> slightly. Window managers are slowly getting better over time.
</para>
<para>
If a window has gravity GDK_GRAVITY_STATIC the window manager frame is not relevant, and thus <see cref="M:Gtk.Window.GetPosition" /> will always produce accurate results. However you can't use static gravity to do things like place a window in a corner of the screen, because static gravity ignores the window manager decorations.
If a <paramef name="window" /> has gravity <see cref="F.Gdk.Gravity.Static" /> the window manager frame is not relevant, and thus <see cref="M:Gtk.Window.GetPosition" /> will always produce accurate results. However you can't use static gravity to do things like place a <paramef name="window" /> in a corner of the screen, because static gravity ignores the window manager decorations.
</para>
<para>
If you are saving and restoring your application's window positions, you should know that it's impossible for applications to do this without getting it somewhat wrong because applications do not have sufficient knowledge of window manager state. The Correct Mechanism is to support the session management protocol (see the "GnomeClient" object in the GNOME libraries for example) and allow the window manager to save your window sizes and positions.
If you are saving and restoring your application's <paramef name="window" /> positions, you should know that it's impossible for applications to do this without getting it somewhat wrong because applications do not have sufficient knowledge of window manager state. The Correct Mechanism is to support the session management protocol (see the "GnomeClient" object in the GNOME libraries for example) and allow the window manager to save your <paramef name="window" /> sizes and positions.
</para>
</remarks>
</Docs>
@ -419,7 +419,7 @@
<summary>Asks to deiconify (i.e. unminimizw) the specified <paramref name="window" />.</summary>
<remarks>
<para>
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 <paramef name="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>
You can track iconification via the <see cref="F:Gtk.Widget.WindowStateEvent" /> event on GtkWidget.
@ -441,8 +441,7 @@
<summary>Activates the targets associated with the mnemonic.</summary>
<param name="keyval">The mnemonic.</param>
<param name="modifier">The modifiers.</param>
<returns>
<see langword="true" /> if the activation is done.</returns>
<returns><see langword="true" /> if the activation is done.</returns>
<remarks />
</Docs>
</Member>
@ -455,8 +454,7 @@
<Parameters />
<Docs>
<summary>Activates the default <paramref name="widget" /> for the <paramref name="window" />.</summary>
<returns>
<see langword="true" /> if a <paramref name="widget" /> is activated.</returns>
<returns><see langword="true" /> if a <paramref name="widget" /> is activated.</returns>
<remarks>
<para>
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.
@ -475,10 +473,10 @@
<summary>Asks to maximize <paramref name="window" />, so that it becomes full-screen.</summary>
<remarks>
<para>
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 <paramef name="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 <paramef name="window" /> will end up maximized. Just don't write code that crashes if not.
</para>
<para>
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.
You can track maximization via the <see cref="F:Gtk.Widget.WindowStateEvent" /> event on <see cref="T.Gtk.Widget" />. It's permitted to call this method before showing a <paramref name="window" />, in which case the <pramref name="window" /> will be maximized when it appears onscreen initially.
</para>
</remarks>
</Docs>
@ -531,7 +529,7 @@
<param name="wmclass_class">Window class hint.</param>
<remarks>
<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 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.
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 <paramref name="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>
</remarks>
</Docs>
@ -567,19 +565,19 @@
<param name="height">Height in pixels, or -1 to unset the default height.</param>
<remarks>
<para>
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 <paramref name="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 <paramref name="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>
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).
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 <paramref name="window" />, this method only sets the initial size, just as if the user had resized the <paramref name="window" /> themselves. Users can still shrink the <paramref name="window" /> again as they normally would. Setting a default size of -1 means to use the "natural" default size (the size request of the <paramref name="window" />).
</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 <paramref name="window" />'s initial size and how resizing works, investigate <see cref="M:Gtk.Window.SetGeometryHints" />.
</para>
<para>
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.
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 <parmref name="window" />, rather than the size to be used on initial display. <see cref="M:Gtk.Window.Resize" /> always affects the <paramref name="window" /> itself, not the geometry widget.
</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 <pamaref name="window" /> only affects the first time a <paramref name="window" /> is shown; if a <paramref name="window" /> is hidden and re-shown, it will remember the size it had prior to hiding, rather than using the default size.
</para>
</remarks>
</Docs>
@ -595,10 +593,10 @@
<summary>Presents a <paramref name="window" /> to the user.</summary>
<remarks>
<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 method calls <see cref="M:Gtk.Widget.Show" /> as well.
This may mean raising the <paramref name="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 <paramef name="window" /> is hidden, this method calls <see cref="M:Gtk.Widget.Show" /> as well.
</para>
<para>
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.
This method should be used when the user tries to open a <paramef name="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>
</remarks>
</Docs>
@ -631,20 +629,20 @@
</Parameters>
<Docs>
<summary>Asks the window manager to move <paramref name="window" /> to the given position.</summary>
<param name="x">X coordinate to move window to.</param>
<param name="y">Y coordinate to move window to.</param>
<param name="x">X coordinate to move <paramref name="window" /> to.</param>
<param name="y">Y coordinate to move <paramref name="window" /> to.</param>
<remarks>
<para>
Window managers are free to ignore this; most window managers ignore requests for initial window positions (instead using a user-defined placement algorithm) and honor requests after the window has already been shown.
Window managers are free to ignore this; most window managers ignore requests for initial window positions (instead using a user-defined placement algorithm) and honor requests after the <paramef name="window" /> has already been shown.
</para>
<para>
Note: the position is the position of the gravity-determined reference point for the window. The gravity determines two things: first, the location of the reference point in root window coordinates; and second, which point on the window is positioned at the reference point.
Note: the position is the position of the gravity-determined reference point for the <paramref name="window" />. The gravity determines two things: first, the location of the reference point in root <paramref name="window" /> coordinates; and second, which point on the <paramref name="window" /> is positioned at the reference point.
</para>
<para>
By default the gravity is GDK_GRAVITY_NORTH_WEST, so the reference point is simply the x, y supplied to <see cref="M:Gtk.Window.Move" />. The top-left corner of the window decorations (aka window frame or border) will be placed at <paramref name="x" />, <paramref name="y" />. Therefore, to position a window at the top left of the screen, you want to use the default gravity (which is GDK_GRAVITY_NORTH_WEST) and move the window to 0,0.
By default the gravity is <see cref="F:Gdk.Gravity.NorthWest" /> so the reference point is simply the x, y supplied to <see cref="M:Gtk.Window.Move" />. The top-left corner of the <paramref name="window" /> decorations (aka window frame or border) will be placed at <paramref name="x" />, <paramref name="y" />. Therefore, to position a <paramref name="window" /> at the top left of the screen, you want to use the default gravity (which is <see cref="F:Gdk.Gravity.NorthWest" />) and move the <paramref name="window" /> to 0,0.
</para>
<para>
To position a window at the bottom right corner of the screen, you would set GDK_GRAVITY_SOUTH_EAST, which means that the reference point is at x + the window width and y + the window height, and the bottom-right corner of the window border will be placed at that reference point.
To position a <paramref name="window" /> at the bottom right corner of the screen, you would set <see cref="F:Gdk.Gravity.SouthEast" />, which means that the reference point is at x + the <paramref name="window" /> width and y + the <paramref name="window" /> height, and the bottom-right corner of the window border will be placed at that reference point.
</para>
</remarks>
</Docs>
@ -663,7 +661,7 @@
<param name="position">A position constraint.</param>
<remarks>
<para>
Is is used for placing the window in some area, depending on the <paramref name="position" /> constraint.
Is is used for placing the <paramref name="window" /> in some area, depending on the <paramref name="position" /> constraint.
</para>
</remarks>
</Docs>
@ -730,7 +728,7 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<summary>Internal constructor.</summary>
<param name="raw">Pointer to the C object.</param>
<returns>An instance of Window, wrapping the C object.</returns>
<remarks>
@ -762,8 +760,8 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>Internal constructor</summary>
<returns>an object of type <see cref="T:Gtk.Window" /></returns>
<summary>Internal constructor.</summary>
<returns>An object of type <see cref="T:Gtk.Window" />.</returns>
<remarks>This is an internal constructor, and should not be used by user code.</remarks>
</Docs>
</Member>
@ -832,10 +830,9 @@
<Parameters>
</Parameters>
<Docs>
<summary>If this function is called on a window with setting of <see langword="true" />, before it is realized or showed, it will have a "frame" window around widget-&gt;window, accessible in window-&gt;frame. Or it access the "frame" window exterior to widget-&gt;window.</summary>
<summary>If this function is called on a <paramref name="window" /> with setting of <see langword="true" />, before it is realized or showed, it will have a "frame" <paramref name="window" /> around widget->window, accessible in window->frame. Or it access the "frame" <paramref name="window" /> exterior to widget->window.</summary>
<param name="value">A <see langword="boolean" />.</param>
<returns>
<see langword="true" /> if a frame has been added to the window via <see cref="P:Gtk.Window.HasFrame" />.</returns>
<returns><see langword="true" /> if a frame has been added to the <paramref name="window" /> via <see cref="P:Gtk.Window.HasFrame" />.</returns>
<remarks>
<para>
Using the event <see cref="F:Gtk.WIndow.FrameEvent" /> you can receive all events targeted at the frame. This method is used by the linux-fb port to implement managed windows, but it could concievably be used by X-programs that want to do their own window decorations.
@ -876,7 +873,7 @@
<Docs>
<summary>Sets or obtains the mnemonic modifier for this <paramref name="window" />.</summary>
<param name="value">The modfier mask.</param>
<returns>The modifier mask used to activate mnemonics on this window.</returns>
<returns>The modifier mask used to activate mnemonics on this <paramref name="window" />.</returns>
<remarks />
</Docs>
</Member>
@ -891,10 +888,10 @@
<Docs>
<summary>Sets or obtains the type hint for <paramref name="window" />.</summary>
<param name="value">The window type.</param>
<returns>The ttype hint for <paramref name="window" />.</returns>
<returns>The type hint for <paramref name="window" />.</returns>
<remarks>
<para>
By setting the type hint for the window, you allow the window manager to decorate and handle the window in a way which is suitable to the function of the window in your application. This property should be called before the window becomes visible.
By setting the type hint for the <paramref name="window" />, you allow the window manager to decorate and handle the <paramref name="window" /> in a way which is suitable to the function of the <paramref name="window" /> in your application. This property should be called before the <paramref name="window" /> becomes visible.
</para>
</remarks>
</Docs>
@ -909,15 +906,15 @@
</Parameters>
<Docs>
<summary>Sets ot obtains the transient parent.</summary>
<param name="value">Parent window.</param>
<param name="value">Parent <paramref name="window" />.</param>
<returns>
</returns>
<remarks>
<para>
Dialog windows should be transient for the main window they were spawned from, this allows windows managers to e.g. keep the dialog on top of the main window, or center the dialog over the main window.
Dialog windows should be transient for the main <paramref name="window" /> they were spawned from, this allows windows managers to e.g. keep the dialog on top of the main <paramref name="window" />, or center the dialog over the main <paramref name="window" />.
</para>
<para>
On Windows(tm), this function will and put the child window on top of the parent, much as the window would have done in X.
On Windows(tm), this function will and put the child <paramref name="window" /> on top of the parent, much as the <paramref name="window" /> would have done in X.
</para>
</remarks>
</Docs>
@ -931,16 +928,15 @@
<Parameters>
</Parameters>
<Docs>
<summary>Sets a <paramref name="widget" /> to be the focus widget for the window if it is not the current focus widget, and its focusable, or retrieves the current focused <paramref name="widget" /> within the window.</summary>
<param name="value">
<paramref name="Widget" /> to be the new focus widget, or <see langword="null" /> to unset any focus widget for the toplevel window.</param>
<summary>Sets a <paramref name="widget" /> to be the focus widget for the <paramref name="window" /> if it is not the current focus widget, and its focusable, or retrieves the current focused <paramref name="widget" /> within the <paramref name="window" />.</summary>
<param name="value"><paramref name="Widget" /> to be the new focus widget, or <see langword="null" /> to unset any focus widget for the toplevel window.</param>
<returns>The currently focused <paramref name="widget" />, or <see langword="null" /> if there is none.</returns>
<remarks>
<para>
To set the focus to a particular <paramref name="widget" /> in the toplevel, it is usually more convenient to use <see cref="M:Gtk.Widget.GrabFocus" />.
</para>
<para>
Note: when retrieving the current focused <paramref name="widget" /> is the <paramref name="widget" /> that would have the focus if the toplevel focused; if the toplevel window is not focused then <see cref="P:Gtk.Widget.HasFocus" /> will not be <see langword="true" /> for the <paramref name="widget" />.
Note: when retrieving the current focused <paramref name="widget" /> is the <paramref name="widget" /> that would have the focus if the toplevel focused; if the toplevel <paramref name="window" /> is not focused then <see cref="P:Gtk.Widget.HasFocus" /> will not be <see langword="true" /> for the <paramref name="widget" />.
</para>
</remarks>
</Docs>
@ -959,7 +955,9 @@
<returns>Copy of window's icon list.</returns>
<remarks>
<para>
The icon is used when window is minimized (also known as iconified). Some window managers or desktop environments may also place it in the window framw, or display it in other contexts.
The icon is used when <paramref name="window" /> is minimized (also known as iconified). Some window managers or desktop environments may also place it in the window frame, or display it in other contexts.
</para>
<para>
<see cref="M:Gtk.Window.IconList" /> allows you to pass the same icon in several hand-drawn sizes. The list should contain the natural sizes your icon is available in; that is, don't scale the image before passing it to GTK#. Scaling is postponed unitl the last minute, when the desired final size is known, to allow best quality. By passing several sizes, you may improve the final image quality of the icon, by reducing or eliminating automatic image scaling.
@ -968,7 +966,7 @@
Recommended sizes to provide: 16x16, 32x32, 48x48 at minimum, and larger images (64x64, 128x128) if you have them).
</para>
<para>
Note that transient windows (those who have been set transient for another window using <see cref="P:Gtk.Window.TransientFor" /> will inherit their icon from their transient parent. So there's no need to explicity set the icon on transient windows.
Note that transient windows (those who have been set transient for another <paramref name="window" /> using <see cref="P:Gtk.Window.TransientFor" /> will inherit their icon from their transient parent. So there's no need to explicity set the icon on transient windows.
</para>
<para>
When retrieving the list is copied, but the reference count on each won't be incremented.
@ -985,17 +983,18 @@
<Parameters>
</Parameters>
<Docs>
<summary>Sets or obtains the role of the window.</summary>
<param name="value">Unique identifier for the window to be used when restoring a session.</param>
<returns>The role of the window if set, or <see langword="null" />. The returned is owned by the widget and must not be modified or freed.</returns>
<summary>Sets or obtains the role of the <paramref name="window" />.</summary>
<param name="value">Unique identifier for the <paramref name="window" /> to be used when restoring a session.</param>
<returns>The role of the <paramref name="window" /> if set, or <see langword="null" />. The returned is owned by the widget and must not be modified or freed.</returns>
<remarks>
<para>
This property is only useful on X11, not with other GTK# targets.
</para>
In combination with the window title, the window role allows a window manager to identify "the same" window when an application is restarted. So for example you might set the "toolbox" role on your app's toolbox window, so that when the user restarts their session, the session manager can put the toolbox back in the same place.
In combination with the <paramref name="window" /> title, the <paramref name="window" /> role allows a window manager to identify "the same" <paramref name="window" /> when an application is restarted. So for example you might set the "toolbox" role on your app's toolbox <paramref name="window" />, so that when the user restarts their session, the session manager can put the toolbox back in the same place.
<para>
If a window already has a unique title, you don't need to set the role, since the WM can use the title to identigy the window when restoring the session.
</para></remarks>
If a <paramref name="window" /> already has a unique title, you don't need to set the role, since the WM can use the title to identigy the <paramref name="window" /> when restoring the session.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Decorated">
@ -1007,17 +1006,15 @@
<Parameters>
</Parameters>
<Docs>
<summary>Sets or obtains whether the window has been set to have decorations.</summary>
<param name="value">
<see langword="true" /> to decorate the window.</param>
<returns>
<see langword="true" /> if the window has been set to have decorations.</returns>
<summary>Sets or obtains whether the <paramref name="window" /> has been set to have decorations.</summary>
<param name="value"><see langword="true" /> to decorate the <paramref name="window" />.</param>
<returns><see langword="true" /> if the <paramref name="window" /> has been set to have decorations.</returns>
<remarks>
<para>
With this property you control if a window will be decorated or not.
With this property you control if a <paramref name="window" /> will be decorated or not.
</para>
<para>
By default, windows are decorated with a title bar and resize controls. Some window managers allow to disable these decorations, creating a borderless Window. If you set this property as false, Gtk# will try to convince the window manager not to decorate the window.
By default, windows are decorated with a title bar and resize controls. Some window managers allow to disable these decorations, creating a borderless Window. If you set this property as false, Gtk# will try to convince the window manager not to decorate the <paramref name="window" />.
</para>
</remarks>
</Docs>
@ -1031,14 +1028,12 @@
<Parameters>
</Parameters>
<Docs>
<summary>Sets or obtains whether a window will be resizable by the user or not.</summary>
<param name="value">
<see langword="true" /> if the user can resize this window.</param>
<returns>
<see langword="true" /> if the user can resize the window.</returns>
<summary>Sets or obtains whether a <paramref name="window" /> will be resizable by the user or not.</summary>
<param name="value"><see langword="true" /> if the user can resize this <paramref name="window" />.</param>
<returns><see langword="true" /> if the user can resize the <paramref name="window" />.</returns>
<remarks>
<para>
By default, windows are resizable, so you can change the size of them. But if you set this property to false, the user won't be able to change the size of them.
By default, the <paramref name="window" /> are resizable, so you can change the size of them. But if you set this property to false, the user won't be able to change the size of them.
</para>
</remarks>
</Docs>
@ -1052,12 +1047,12 @@
<Parameters>
</Parameters>
<Docs>
<summary>Property used for setting/getting the window position.</summary>
<param name="value">An object of type <see cref="T:Gtk.WindowPosition" />.</param>
<returns>An object of type <see cref="T:Gtk.WindowPosition" />.</returns>
<summary>Property used for setting/getting the <paramref name="window" /> position.</summary>
<param name="value">A <paramref name="window" /> position. See also <see cref="T:Gtk.WindowPosition" />.</param>
<returns>The <paramref name="window" /> position. See also <see cref="T:Gtk.WindowPosition" />.</returns>
<remarks>
<para>
This property will alow you to define where a Window must be displayed on the screen. It work with the Gtk.WindowPosition enum, so maybe you should check it before use it.
This property will alow you to define where a <paramref name="window" /> must be displayed on the screen. It work with the <see cref="T:Gtk.WindowPosition" /> enum, so maybe you should check it before use it.
</para>
</remarks>
</Docs>
@ -1071,12 +1066,12 @@
<Parameters>
</Parameters>
<Docs>
<summary>Property used for defining the default height of a window.</summary>
<param name="value">An object of type <see cref="T:System.Int32" />.</param>
<returns>An object of type <see cref="T:System.Int32" />.</returns>
<summary>Property used for setting or obtaining the default height of a <paramref name="window" />.</summary>
<param name="value">A <paramref name="window" /> height.</param>
<returns>The default height of the <paramref name="window" />.</returns>
<remarks>
<para>
This property will allow you to define the default height for your Window. It only define the default one, so if the Window is resized, it won't be able to do anything.
This property will allow you to define the default height for your <paramref name="window" />. It only define the default one, so if the <paramref name="window" /> is resized, it won't be able to do anything.
</para>
</remarks>
</Docs>
@ -1095,7 +1090,7 @@
<returns>an object of type <see cref="T:System.Int32" /></returns>
<remarks>
<para>
This is useful for dialogs that shouldn't persist beyond the livefime of the main window they're associated with, for example.
This is useful for dialogs that shouldn't persist beyond the livefime of the main <paramref name="window" /> they're associated with, for example.
</para>
</remarks>
</Docs>
@ -1110,9 +1105,8 @@
</Parameters>
<Docs>
<summary>Sets or obtains the modal status of <paramref name="window" />.</summary>
<param name="value">Whether the window is modal.</param>
<returns>
<see langword="true" /> if the window is set to be modal and establishes a grab when shown.</returns>
<param name="value">Whether the <paramref name="window" /> is modal.</param>
<returns><see langword="true" /> if the <paramref name="window" /> is set to be modal and establishes a grab when shown.</returns>
<remarks>
<para>
Modal windows prevent interaction with other windows in the same application. To keep modal dialogs on top of main application windows, use <see cref="P:Gtk.Window.TransientFor" /> to make the dialog transient for the parent; most window managers will then disallow lowering the dialog below the parent.
@ -1133,9 +1127,8 @@
</Parameters>
<Docs>
<summary>Sets or obtains if the <paramref name="window" /> can be resized to a larger size by the user.</summary>
<param name="value">if <see langword="true" /> the <paramref name="window" /> can be resized.</param>
<returns>
<see langword="true" /> if the <paramref name="window" /> can be resized.</returns>
<param name="value">If <see langword="true" /> the <paramref name="window" /> can be resized.</param>
<returns><see langword="true" /> if the <paramref name="window" /> can be resized.</returns>
<remarks />
</Docs>
</Member>
@ -1148,12 +1141,12 @@
<Parameters>
</Parameters>
<Docs>
<summary>Property used for setting the window title.</summary>
<summary>Property used for setting the <paramref name="window" /> title.</summary>
<param name="value">Title of the <paramref name="window" />.</param>
<returns>The title of the <paramref name="window" />, or <see langword="null" /> if none has been set explicitely. The returned string is owned by the <paramref name="widget" /> and must not be modified or freed.</returns>
<remarks>
<para>
This property will allow you to set the window title. The title of a <paramref name="window" /> will be displayed in its title bar. Since the title bar is rendered by the window managers on X Window System, the way it appears will depend on the user preferences. This title should help the users to distinguish a window from others opened. A good title will have the application name an the actual document, for example.
This property will allow you to set the <paramref name="window" /> title. The title of a <paramref name="window" /> will be displayed in its title bar. Since the title bar is rendered by the window managers on X Window System, the way it appears will depend on the user preferences. This title should help the users to distinguish a <paramref name="window" /> from others opened. A good title will have the application name an the actual document, for example.
</para>
</remarks>
</Docs>
@ -1165,9 +1158,13 @@
<ReturnType>Gtk.WindowType</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>an object of type <see cref="T:Gtk.WindowType" /></returns>
<remarks>To be added</remarks>
<summary>The type of <paramref name="window" />.</summary>
<returns>The <paramref name="window" /> type.</returns>
<remarks>
<para>
See also <see cref="T:Gtk.WindowType" />.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="DefaultWidth">
@ -1179,10 +1176,14 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">an object of type <see cref="T:System.Int32" /></param>
<returns>an object of type <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<summary>Property used for setting or obtaining the default width of a <paramref name="window" />.</summary>
<param name="value">A <paramref name="window" />.</param>
<returns>The default width of the <paramref name="window" />.</returns>
<remarks>
<para>
This property will allow you to define the default width for <paramref name="window" />. It only define the default one, so if the <paramref name="window" /> is resized, it won't be able to do anything.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Icon">
@ -1194,10 +1195,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<returns>an object of type <see cref="T:Gdk.Pixbuf" /></returns>
<remarks>To be added</remarks>
<summary>Property used for setting the icon for a <paramref name="window" />.</summary>
<param name="value">An icon.</param>
<returns>The default icon for <paramref name="window" />.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="AllowShrink">
@ -1209,10 +1210,14 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">an object of type <see cref="T:System.Boolean" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<summary>Sets or obtains if the <paramref name="window" /> has no mininum size.</summary>
<param name="value">If <see langword="true" /> the <paramref name="window" /> has no minimum size.</param>
<returns><see langword="true" /> if the <paramref name="window" /> has no minimum size.</returns>
<remarks>
<para>
Setting this to <pararemf name="true" /> is 99% of the time a bad idea.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="KeysChanged">
@ -1296,10 +1301,17 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<summary>Property used for setting the automatic startup notification.</summary>
<param name="value">If <see langword="true" /> automatically do startup notification.</param>
<returns><see langword="true" /> if set to automatically do startup notification.</returns>
<remarks>
<para>
By default, after showing the first <see cref="T:Gtk.Window" /> for each <see cref="T:Gdk.Screen" />, GTK# calls <see cref="M:Gdk.Global.NotifyStartupComplete" />. Use this property to disable the automatic startup notification.
</para>
<para>
You might do this if your first <paramref name="window" /> is a splash screen, and you want to delay notification until after your real main <paramref name="window" /> has been shown, for example. In that example, you would disable startup notification temporarily, show your splash screen, then re-enable it so that showing the main <paramref name="window" /> would automatically result in notification.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Size">
@ -1309,9 +1321,13 @@
<ReturnType>System.Drawing.Size</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Drawing.Size" /></returns>
<remarks>To be added</remarks>
<summary>Property that obtains the current size of <paramref name="window" />.</summary>
<returns>The width and height of <paramref name="window" />, a <see cref="T:System.Drawing.Size" />.</returns>
<remarks>
<para>
If <paramref name="window" /> is not onscreen, it returns the size GTK# will suggest to the window manager for the initial <paramref name="window" /> size (but this is not reliably the same as the size the window manager will actually select). The size obtained by <see cref="P:Gtk.Window.Size" /> is the last size received, 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="P:Gtk:Window.Size" />, the size won't 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 <paramref name="window" /> gets updated.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Position">
@ -1321,9 +1337,28 @@
<ReturnType>System.Drawing.Size</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>Property that obtains the position you need to pass to <see cref="M:Gtk.Window.Move" /> to keep <paramref name="window" /> in its current position.</summary>
<returns>a <see cref="T:System.Drawing.Size" /></returns>
<remarks>To be added</remarks>
<remarks>
<para>
This means that the meaning of the returned value varies with window gravity. See <see cref="M:Gtk.Window:Move" /> for more details.
</para>
<para>
If you haven't changed the window gravity, its gravity will be <see cref="F:Gdk.Gravity.NorthWest" />. This means that <see cref="P:Gtk.Window.Posion" /> gets the position of the top-left corner of the window manager frame for the <paramref name="window" />. <see cref="M:Gtk.Window.Move" /> sets the position of this same top-left corner.
</para>
<para>
This property is not 100% reliable because the X Window System does not specify a way to obtain the geometry of the decorations placed on a <paramref name="window" /> by the window manager. Thus GTK# is using a "best guess" that works with most window managers.
</para>
<para>
Moreover, nearly all window managers are historically broken with respect to their handling of window gravity. So moving a <paramref name="window" /> to its current position as returned by <see cref="P:Gtk.Window.Position" /> tends to result in moving the <paramref name="window" /> slightly. Window managers are slowly getting better over time.
</para>
<para>
If a <paramref name="window" /> has gravity <see cref="F:Gdk.Gravity.Static" /> the window manager frame is not relevant, and thus <see cref="P:Gtk.Window.Position" /> will always produce accurate results. However you can't use static gravity to do things like place a <paramref name="window" /> in a corner of the screen, because static gravity ignores the window manager decorations.
</para>
<para>
If you are saving and restoring your application's window positions, you should know that it's impossible for applications to do this without getting it somewhat wrong because applications do not have sufficient knowledge of window manager state. The Correct Mechanism is to support the session management protocol (see the "GnomeClient" object in the GNOME libraries for example) and allow the window manager to save your window sizes and positions.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="DefaultSize">
@ -1335,10 +1370,32 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Sets or obtains the default size of <paramref name="window" />.</summary>
<param name="value">a <see cref="T:System.Drawing.Size" /></param>
<returns>a <see cref="T:System.Drawing.Size" /></returns>
<remarks>To be added</remarks>
<remarks>
<para>
A value of -1 for the size indicates that a default size has not been explicitly set for that dimension, so the "natural" size of the <paramref name="window" /> will be used.
</para>
<para>
If the <paramref name="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 <paramref name="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>
Unlike <see cref="M:Gtk.Widget.SizeRequest" />, which sets a size request for a <paramref name="widget" /> and thus would keep users from shrinking the <paramref name="window" />, this method only sets the initial size, just as if the user had resized the <paramref name="window" /> themselves. Users can still shrink the <paramref name="window" /> again as they normally would. Setting a default size of -1 means to use the "natural" default size (the size request of the <paramref name="window" />).
</para>
<para>
For more control over a <paramref name="window" />'s initial size and how resizing works, read <see cref="M:Gtk.Window.SetGeometryHints" />.
</para>
<para>
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 <paramref name="window" />, rather than the size to be used on initial display. <see cref="M:Gtk.Window.Resize" /> always affects the <paramref name="window" /> itself, not the geometry widget.
</para>
<para>
The default size of a <paramref name="window" /> only affects the first time a <paramref name="window" /> is shown; if a <paramref name="window" /> is hidden and re-shown, it will remember the size it had prior to hiding, rather than using the default size.
</para>
<para>
Windows can't actually be 0x0 in size, they must be at least 1x1, but passing 0 is OK, resulting in a 1x1 default size.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Screen">
@ -1350,10 +1407,14 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">a <see cref="T:Gdk.Screen" /></param>
<returns>a <see cref="T:Gdk.Screen" /></returns>
<remarks>To be added</remarks>
<summary>Sets or obtains the <see cref="T:Gdk.Screen" /> where the <paramref name="window" /> is displayed.</summary>
<param name="value">A <see cref="T:Gdk.Screen" />.</param>
<returns>A <see cref="T:Gdk.Screen" />.</returns>
<remarks>
<para>
If the <paramref name="window" /> is already mapped, it will be unmapped, and then remapped on the new screen.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="IsActive">
@ -1363,9 +1424,9 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<summary>Whether the toplevel is the current active <paramref name="window" />.</summary>
<returns><see langword="true" /> if the <paramref name="window" /> is the toplevel.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="HasToplevelFocus">
@ -1375,9 +1436,9 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<summary>Whether the input focus is within this <paramref name="window" />.</summary>
<returns><see langword="true" /> if the <paramref name="window" /> has the input focus.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SkipPagerHint">
@ -1389,10 +1450,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<summary>Whether the <paramref name="window" /> should not be in the pager.</summary>
<param name="value">If <see langwoed="true" /> then the <paramref name="window" /> will not be in the pager.</param>
<returns><see langword="true" /> if the <paramref name="window" /> should not be in the pager.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SkipTaskbarHint">
@ -1404,10 +1465,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<summary>Whether the <paramref name="window" /> should not be in the taskbar.</summary>
<param name="value">If <see langword="true" /> then the <see paramref="window" /> will not be in the taskbar.</param>
<returns><see langword="true" /> if the <paramref name="window" /> should not be in the taskbar.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SetDefaultIconFromFile">
@ -1422,8 +1483,7 @@
<Docs>
<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">Location of icon file.</param>
<returns>
<see langword="true" /> if setting the icon succeded.</returns>
<returns><see langword="true" /> if setting the icon succeded.</returns>
<remarks />
</Docs>
</Member>
@ -1438,7 +1498,7 @@
<summary>Asks to place <paramref name="window" /> in the fullscreen state.</summary>
<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.
Note that you shouldn't assume the <paramref name="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 <paramref name="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" />.
@ -1458,8 +1518,7 @@
<Docs>
<summary>Sets the icon for <paramref name="window" />.</summary>
<param name="filename">Location of icon file.</param>
<returns>
<see langword="true" /> if setting the icon succeded.</returns>
<returns><see langword="true" /> if setting the icon succeded.</returns>
<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" />.
@ -1478,7 +1537,7 @@
<summary>Asks to toggle off the fullscreen state for <paramref name="window" />.</summary>
<remarks>
<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 <paramref name="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 <paramref name="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" />.