[Mono-docs-list] Gtk.Widget.Sensitive document patch

[Gustavo Ramos]

This is a multi-part message in MIME format.

------=_NextPart_000_001C_01C368DF.239021F0
Content-Type: text/plain;
	charset="iso-8859-1"
Content-Transfer-Encoding: 7bit


Hello list,

I've posted the here-inlined message, but unfortunately from a
non-subscribed account (sorry moderators) and is not yet approved. Well,
please don't check in it yet, I'm working on more properties of the same
file. When I am done, I'll post it again. In the meanwhile, I hope comments
on the posted file for xml/style/spell issues.

BTW, is nobody working on these Gtk.Widget properties ?
+ CanDefault
+ CanFocus
+ HasDefault
+ HasFocus
+ IsFocus (can I extend the doc?)
+ ReceivesDefault
+ Sensitive

also, the events
+ Focused
+ FocusGrabbed
+ FocusInEvent
+ FocusOutEvent
+ GrabNotify

also, the methods
+ Activate (can I extend the doc?)
+ GrabDefault (can I extend the doc?)
+ GrabFocus (can I extend the doc?)

If anyone has been working in any of these, please tell me to stop writing.
I'll wait the approval to write the members marked as "can I extend the
doc?".

Regards,

Gustavo


-----Mensaje original-----
De: Gustavo Ramos [mailto:gustavo.ramos@grmexico.com.mx]
Enviado el: Viernes, 22 de Agosto de 2003 05:34 p.m.
Para: mono-docs-list
Asunto: Gtk.Widget.Sensitive document patch


Hello list,

I have two news for you. The good one is that I've written the documentation
for the property Gtk.Widget.Sensitive. The bad is -sorry Ben- i don't have
aspell, neither a working xmllint neither tidy, because some things in my
box are broken :(

I've diff'ed my file against Widget.xml from gtk-sharp-0.10, with
  diff -u Widget.xml MyWidgetDoc.xml > Widget.xml.diff

Hope it is elegible for checking in :)

Regards,
Gustavo Ramos

------=_NextPart_000_001C_01C368DF.239021F0
Content-Type: application/octet-stream;
	name="Widget.xml.diff"
Content-Transfer-Encoding: quoted-printable
Content-Disposition: attachment;
	filename="Widget.xml.diff"

--- ./Widget.xml	2003-06-12 08:26:21.000000000 -0500=0A=
+++ /cygdrive/c/Temp/Widget.xml	2003-08-22 17:30:06.000000000 -0500=0A=
@@ -1765,10 +1765,33 @@=0A=
         <Parameter Name=3D"value" Type=3D"System.Boolean" />=0A=
       </Parameters>=0A=
       <Docs>=0A=
-        <summary>To be added</summary>=0A=
-        <param name=3D"value">To be added: an object of type =
'bool'</param>=0A=
-        <returns>To be added: an object of type 'bool'</returns>=0A=
-        <remarks>To be added</remarks>=0A=
+        <summary>
+		Sets the sensitivity of a <see cref=3D"T:Gtk.Widget" />. A widget is
+		sensitive if the user can interact with it, otherwise, it is =
grayed.</summary>=0A=
+        <param name=3D"value">A bool value. Set to true to enable the =
widget
+		sensitivity.</param>=0A=
+        <returns>A bool value that indicates whether the control is
+		sensitive (enabled).</returns>=0A=
+        <remarks>
+		<para>Insensitive widgets are "grayed out" and the user can't
+		  interact with them. Insensitive widgets are known as
+		  "inactive", "disabled", or "ghosted" in some other toolkits.
+		  The sensitivity of a widget determines whether it will receive
+		  certain events (e.g. button or key presses).</para>
+		<para>
+		  If the ancestor (parent) widget sesitivity is set to false,
+		  it does not matter what the sensitivity property have,
+		  the widget will not be sensitive. Use
+		  <c>widget.Parent.Sensitive</c>
+		  to check whether the ancestor widget is sensitive or not.
+		</para>
+		<seealso cref=3D"P:Gtk.Widget.Parent" />
+		<seealso cref=3D"M:Gtk.Widget.GetAncestor(uint)" />
+		<para>
+		  When the sensitive property is set to false, the widget
+		  property <see cref=3D"P:Gtk.Widget.CanDefault" /> will return =
false.
+		</para>
+		</remarks>=0A=
       </Docs>=0A=
     </Member>=0A=
     <Member MemberName=3D"Events">=0A=

------=_NextPart_000_001C_01C368DF.239021F0--