[Mono-docs-list] Window class
Carlos Alberto Cortez
is118149@mail.udlap.mx
16 Mar 2003 15:25:24 -0600
--=-yOs/PoXUSQxoSor8eml/
Content-Type: text/plain
Content-Transfer-Encoding: 7bit
A little piece of work ... I hope write some more ina few days ;)
Regards,
Carlos.
--
--------------------------------------------------
/* The definition of myself */
using Cortez;
using GeniusIntelligence;
public class Carlos : Human, IGenius, ILinuxUser {
static void Main () {
Me.Born();
}
}
--------------------------------------------------
--=-yOs/PoXUSQxoSor8eml/
Content-Disposition: attachment; filename=window3.diff
Content-Transfer-Encoding: quoted-printable
Content-Type: text/plain; name=window3.diff; charset=ISO-8859-1
? Window.xml.new
? Window2.xml
? window.diff
? window2.diff
? window3.diff
Index: Window.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /cvs/public/gtk-sharp/doc/en/Gtk/Window.xml,v
retrieving revision 1.6
diff -u -r1.6 Window.xml
--- Window.xml 8 Mar 2003 06:28:10 -0000 1.6
+++ Window.xml 16 Mar 2003 21:28:13 -0000
@@ -92,8 +92,14 @@
</ReturnValue>
<Parameters />
<Docs>
- <summary>To be added</summary>
- <remarks>To be added</remarks>
+ <summary>Asks to iconify the Window.</summary>
+ <remarks>
+ <para>
+ Asks to iconify the Window. Note that you shouldn't assume the Window=
is definitely iconified=20
+ afterward, because other entities ( such the user or the window manag=
er ) could deiconify it before your code
+ which assumes iconification gets to run.
+ </para>
+ </remarks>
</Docs>
</Member>
<Member MemberName=3D"Unstick">
@@ -131,10 +137,21 @@
<Parameter Name=3D"height" Type=3D"System.Int32&" />
</Parameters>
<Docs>
- <summary>To be added</summary>
+ <summary>
+ Obtains the current size ( width and height ) of the Window.
+ </summary>
<param name=3D"width">To be added: an object of type 'int&'</p=
aram>
<param name=3D"height">To be added: an object of type 'int&'</=
param>
- <remarks>To be added</remarks>
+ <remarks>
+ <para>
+ Obtains the current size of the Window. If the Window is not on scree=
n, it returns th size Gtk# will suggest to the
+ window manager for the initial window size. Note that we use out type=
parameters.
+ </para>
+ <para>
+ Note: The returned size does not include the size of the window manag=
er decorations ( the window border, for example),
+ because those are not drawn by Gtk#, so Gtk# has no a reliable method=
for determining their size.
+ </para>
+ </remarks>
</Docs>
</Member>
<Member MemberName=3D"GetDefaultSize">
@@ -148,10 +165,19 @@
<Parameter Name=3D"height" Type=3D"System.Int32&" />
</Parameters>
<Docs>
- <summary>To be added</summary>
+ <summary>Obtains the default size of the window ( width and height=
). </summary>
<param name=3D"width">To be added: an object of type 'int&'</p=
aram>
<param name=3D"height">To be added: an object of type 'int&'</=
param>
- <remarks>To be added</remarks>
+ <remarks>
+ <para>
+ Obtains the default size of the window. A value of -1 for the width o=
r height indicates that a default size has
+ not been explicitly set for that dimention, so the "natural" size of =
the Window will be used.
+ </para>
+ <para>
+ Note: The returned size does not include the size of the window manag=
er decorations ( the window border, for example),
+ because those are not drawn by Gtk#, so Gtk# has no a reliable method=
for determining their size.
+ </para>
+ </remarks>
</Docs>
</Member>
<Member MemberName=3D"Resize">
@@ -165,10 +191,15 @@
<Parameter Name=3D"height" Type=3D"System.Int32" />
</Parameters>
<Docs>
- <summary>To be added</summary>
+ <summary>Resizes the Window as if the user had done so.</summary>
<param name=3D"width">To be added: an object of type 'int'</param>
<param name=3D"height">To be added: an object of type 'int'</param=
>
- <remarks>To be added</remarks>
+ <remarks>
+ <para>
+ Resizes the Window as if the user had done so. If it is called before=
showing a Window for the first time,
+ it overrides any default size set with <see cref=3D"T:Gtk.Window.SetD=
efaultSize" />Gtk.Window.SetDefaultSize().
+ </para>
+ </remarks>
</Docs>
</Member>
<Member MemberName=3D"ActivateFocus">
@@ -313,8 +344,14 @@
</ReturnValue>
<Parameters />
<Docs>
- <summary>To be added</summary>
- <remarks>To be added</remarks>
+ <summary>Asks to deiconify the Window.</summary>
+ <remarks>
+ <para>
+ Asks to deiconify (unminimize) the Window. Note that you shouldn't as=
sume the Window is definitely deiconified=20
+ afterward, because other entities ( such the user or the window manag=
er ) could iconify it again before your code
+ which assumes deiconification gets to run.
+ </para>
+ </remarks>
</Docs>
</Member>
<Member MemberName=3D"MnemonicActivate">
@@ -506,7 +543,8 @@
<param name=3D"position">To be added: an object of type 'Gtk.Windo=
wPosition'</param>
<remarks>
<para>
- Is is used for placing the Window in some area, depending on t=
he Gtk.WindowPosition position argument.
+ Is is used for placing the Window in some area, depending on t=
he <see cref=3D"T:Gtk.WindowPosition"/>Gtk.WindowPosition=20
+ position argument.
</para>
</remarks>
</Docs>
@@ -893,10 +931,16 @@
<Parameter Name=3D"value" Type=3D"System.Boolean" />
</Parameters>
<Docs>
- <summary>To be added</summary>
+ <summary>Property used for setting if a Window must be destroyed w=
hen its parent does.</summary>
<param name=3D"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>
+ <remarks>
+ <para>
+ If this property has the false value, then destroying the transient p=
arent of our Window will destroy
+ the window itself. This is useful for dialogs that shouldn't persist =
beyond the lifetime of the main Window
+ they're associated with.
+ </para>
+ </remarks>
</Docs>
</Member>
<Member MemberName=3D"Modal">
@@ -909,10 +953,15 @@
<Parameter Name=3D"value" Type=3D"System.Boolean" />
</Parameters>
<Docs>
- <summary>To be added</summary>
+ <summary>Property used for setting if a Window must be or not moda=
l.<</summary>
<param name=3D"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>
+ <remarks>
+ <para>
+ This property defines if a Window is modal or non-modal. Modal Window=
s prevent interaction with other Windows
+ in the same application.
+ </para>
+ </remarks>
</Docs>
</Member>
<Member MemberName=3D"AllowGrow">
@@ -962,9 +1011,14 @@
<ReturnType>Gtk.WindowType</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added</summary>
+ <summary>Read only property (accesor) used for getting the WindowT=
ype of a specified Window.</summary>
<returns>To be added: an object of type 'Gtk.WindowType'</returns>
- <remarks>To be added</remarks>
+ <remarks>
+ <para>
+ This read-only property will let you know the <see cref=3D"T:Gtk.Wind=
owType"/>Gtk.WindowType of the=20
+ specified Window; this is, the type the Window is.
+ </para>
+ </remarks>
</Docs>
</Member>
<Member MemberName=3D"DefaultWidth">
@@ -977,10 +1031,16 @@
<Parameter Name=3D"value" Type=3D"System.Int32" />
</Parameters>
<Docs>
- <summary>To be added</summary>
+ <summary>Property used for defining the deafult width of a Window.=
</summary>
<param name=3D"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>
+ <remarks>
+ <para>
+ This property will allow you to define the default width for your Win=
dow.
+ It only define the default one, so if the Window is resized, i=
t won't be able to do
+ anything.
+ </para>
+ </remarks>
</Docs>
</Member>
<Member MemberName=3D"Icon">
@@ -1132,4 +1192,4 @@
</Docs>
</Member>
</Members>
-</Type>
\ No newline at end of file
+</Type>
--=-yOs/PoXUSQxoSor8eml/--