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

First draft Window.xml.

Browse source 
svn path=/trunk/gtk-sharp/; revision=15339
This commit is contained in:
Hector E. Gomez Morales 2003-06-12 13:26:21 +00:00
parent ad11cfb128
commit cafac6fcde
2 changed files with 80 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -13,7 +13,7 @@
Style properties are set in resource files. This mechanism is used for configuring such things as the location of the scrollbar arrows through the theme, giving theme authors more control over the look of applications without the need to write a theme engine in C. Style properties are set in resource files. This mechanism is used for configuring such things as the location of the scrollbar arrows through the theme, giving theme authors more control over the look of applications without the need to write a theme engine in C.
</para> </para>
<para> <para>
Use <see cref="M:Gtk.Widget.StyleGetProperty" />, <see cref="M:Gtk.Widget.Style" /> or <see cref="M:Gtk.Widget.StyleGetValist" /> to obtain the value of a style property. Use <see cref="M:Gtk.Widget.StyleGetProperty" />, <see cref="P:Gtk.Widget.Style" /> or <see cref="M:Gtk.Widget.StyleGetValist" /> to obtain the value of a style property.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>

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

@ -1,5 +1,5 @@
<Type Name="Window" FullName="Gtk.Window"> <Type Name="Window" FullName="Gtk.Window">
<TypeSignature Language="C#" Value="public class Window : Gtk.Bin, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" /> <TypeSignature Language="C#" Value="public class Window : Gtk.Bin, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Hector Gomez M" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,8 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>Toplevel widget that can contain other widgets</summary> <summary>Toplevel widget which can contain other widgets.</summary>
<remarks>Toplevel widget that can contain other widgets</remarks> <remarks>Toplevel widget which can contain other widgets.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.Bin</BaseTypeName> <BaseTypeName>Gtk.Bin</BaseTypeName>
@ -37,9 +37,13 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Returns a list of all existing toplevel windows.</summary>
<returns>an object of type <see cref="T:GLib.List"/></returns> <returns>List of toplevel widgets.</returns>
<remarks>To be added</remarks> <remarks>
<para>
The widgets in the list are not individually referenced. If you want to iterate through the list and perform actions involving callbacks that might destroy the widgets, you must call g_list_foreach (result, (GFunc)g_object_ref, <see langword="null" />) first, and then unref all the widgets afterwards.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="BeginMoveDrag"> <Member MemberName="BeginMoveDrag">
@ -55,12 +59,16 @@
<Parameter Name="timestamp" Type="System.UInt32" /> <Parameter Name="timestamp" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Starts moving a window.</summary>
<param name="button">an object of type <see cref="T:System.Int32"/></param> <param name="button">Mouse button that initiated the drag.</param>
<param name="root_x">an object of type <see cref="T:System.Int32"/></param> <param name="root_x">X position where the user clicked to initiate the drag, in root window coordinates.</param>
<param name="root_y">an object of type <see cref="T:System.Int32"/></param> <param name="root_y">Y position where the user clicked to initiate the drag.</param>
<param name="timestamp">an object of type <see cref="T:System.UInt32"/></param> <param name="timestamp">Timestamp from the click event that initiated the drag.</param>
<remarks>To be added</remarks> <remarks>
<para>
This method is used if an application has window movement grips. When GDK can support it, the window movement will be done using the standard mechanism for the window manager or windowing system. Otherwise, GDK will try to emulate window movement, potentially not all that well, depending on the windowing system.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetFrameDimensions"> <Member MemberName="GetFrameDimensions">
@ -76,12 +84,19 @@
<Parameter Name="bottom" Type="System.Int32&amp;" /> <Parameter Name="bottom" Type="System.Int32&amp;" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Retrieves the dimensions of the frame window for this toplevel.</summary>
<param name="left">an object of type <see cref="T:System.Int32"/></param> <param name="left">Location to store the width of the frame at the left, or <see langword="null" />.</param>
<param name="top">an object of type <see cref="T:System.Int32"/></param> <param name="top">Location to store the height of the frame at the top, or <see langword="null" />.</param>
<param name="right">an object of type <see cref="T:System.Int32"/></param> <param name="right">Location to store the width of the frame at the returns, or <see langword="null" />.</param>
<param name="bottom">an object of type <see cref="T:System.Int32"/></param> <param name="bottom">Location to store the height of the frame at the bottom, or <see langword="null" />.</param>
<remarks>To be added</remarks> <remarks>
<para>
It will not return the size of the window border drawn by the window manager, which is the normal case when using a windowing system. See <see cref="M:Gdk.Window.GetFrameExtents" /> to get the standard window border extents.) See also <see cref="P:Gtk.Window.HasFrame" />, <see cref="M:Gtk.Window.SetFrameDimensions" />.
</para>
<para>
Note: this is a special-purpose function intended for the framebuffer port; see <see cref="M:Gtk.Window.SetFrameDimensions" />.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Iconify"> <Member MemberName="Iconify">
@ -92,8 +107,15 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Asks to iconify (i.e. minimize) the specified <paramref name="window" />.</summary>
<remarks>To be added</remarks> <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.
</para>
<para>
You can track iconification via the <see cref="F:Gtk.Widget.WindowStateEvent" /> signal on <see cref="T:Gtk.Widget" />.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Unstick"> <Member MemberName="Unstick">
@ -104,8 +126,15 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Asks to unstick window, which means that it will appear on only one of the user's desktops.</summary>
<remarks>To be added</remarks> <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.
</para>
<para>
You can track stickiness via the <see cref="F:Gtk.Widget.WindowStateEvent" /> signal on <see cref="T:Gtk.Widget" />.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Unmaximize"> <Member MemberName="Unmaximize">
@ -116,8 +145,15 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Asks to unmaximize <paramref name="window" />.</summary>
<remarks>To be added</remarks> <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.
</para>
<para>
You can track maximization via the <see cref="F:Gtk.Widget.WindowStateEvent" /> signal on <see cref="T:Gtk.Widget" />.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetSize"> <Member MemberName="GetSize">
@ -131,10 +167,17 @@
<Parameter Name="height" Type="System.Int32&amp;" /> <Parameter Name="height" Type="System.Int32&amp;" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Obtains the current size of <paramref name="window" />.</summary>
<param name="width">an object of type <see cref="T:System.Int32"/></param> <param name="width">Return location for width, or <see langword="null" />.</param>
<param name="height">an object of type <see cref="T:System.Int32"/></param> <param name="height">Return location for height, or <see langword="null" />.</param>
<remarks>To be added</remarks> <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.
</para>
<para>
Note 1: Nearly any use of this function creates a race condition, because the size of the window may change between the time that you get the size and the time that you perform some action assuming that size is the current size. To avoid race conditions, connect to <see cref="F:Gtk.Widget.ConfigureEvent" /> on the window and adjust your size-dependent state to match the size delivered in the GdkEventConfigure.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetDefaultSize"> <Member MemberName="GetDefaultSize">
@ -148,10 +191,14 @@
<Parameter Name="height" Type="System.Int32&amp;" /> <Parameter Name="height" Type="System.Int32&amp;" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Gets the default size of the window.</summary>
<param name="width">an object of type <see cref="T:System.Int32"/></param> <param name="width">Location to store the default width, or <see langword="null" />.</param>
<param name="height">an object of type <see cref="T:System.Int32"/></param> <param name="height">Location to store the default height, or <see langword="null" />.</param>
<remarks>To be added</remarks> <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.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Resize"> <Member MemberName="Resize">