2004-08-28 Shane Landrum <epicene@pobox.com>

* en/Gtk/Widget.xml: Added docs.
	* en/Gtk/ExposeEventArgs.xml
	* en/Gtk/AddedArgs.xml
	* en/Gtk/ActivateCurrentArgs.xml
	* en/Gtk/AdjustBoundsArgs.xml
	* en/Gtk/ChangeCurrentPageArgs.xml
	* en/Gtk/ChangeValueArgs.xml
	* en/Gtk/ChildAnchorInsertedArgs.xml
	* en/Gtk/ChildAttachedArgs.xml
	* en/Gtk/ChildDetachedArgs.xml
	* en/Gtk/ConfigureEventArgs.xml
	* en/Gtk/CycleHandleFocusArgs.xml
	* en/Gtk/EditedArgs.xml
	* en/Gtk/EnableDeviceArgs.xml
	* en/Gtk/DisableDeviceArgs.xml
	* en/Gtk/FocusedArgs.xml
	* en/Gtk/LinkClickedArgs.xml
	* en/Gtk/ExpandCollapseCursorRow.xml
	* en/Gtk/FocusInEventArgs.xml
	* en/Gtk/MoveFocusOutArgs.xml
	* en/Gtk/OnUrlArgs.xml: Event data.

svn path=/trunk/gtk-sharp/; revision=32973
This commit is contained in:
Shane Landrum 2004-08-28 21:17:07 +00:00
parent 8f2aa18cb0
commit 2463e58d90
22 changed files with 139 additions and 115 deletions

View file

@ -1,3 +1,27 @@
2004-08-28 Shane Landrum <epicene@pobox.com>
* en/Gtk/Widget.xml: Added docs.
* en/Gtk/ExposeEventArgs.xml
* en/Gtk/AddedArgs.xml
* en/Gtk/ActivateCurrentArgs.xml
* en/Gtk/AdjustBoundsArgs.xml
* en/Gtk/ChangeCurrentPageArgs.xml
* en/Gtk/ChangeValueArgs.xml
* en/Gtk/ChildAnchorInsertedArgs.xml
* en/Gtk/ChildAttachedArgs.xml
* en/Gtk/ChildDetachedArgs.xml
* en/Gtk/ConfigureEventArgs.xml
* en/Gtk/CycleHandleFocusArgs.xml
* en/Gtk/EditedArgs.xml
* en/Gtk/EnableDeviceArgs.xml
* en/Gtk/DisableDeviceArgs.xml
* en/Gtk/FocusedArgs.xml
* en/Gtk/LinkClickedArgs.xml
* en/Gtk/ExpandCollapseCursorRow.xml
* en/Gtk/FocusInEventArgs.xml
* en/Gtk/MoveFocusOutArgs.xml
* en/Gtk/OnUrlArgs.xml: Event data.
2004-08-28 Shane Landrum <epicene@pobox.com> 2004-08-28 Shane Landrum <epicene@pobox.com>
* en/Gtk/TranslateFunc.xml: delegate docs. * en/Gtk/TranslateFunc.xml: delegate docs.

View file

@ -39,9 +39,9 @@
<ReturnType>System.Boolean</ReturnType> <ReturnType>System.Boolean</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Whether to hide the current menu item or not.</summary>
<returns>To be added: an object of type 'bool'</returns> <returns>a <see cref="T:System.Boolean"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -39,9 +39,9 @@
<ReturnType>Gtk.Widget</ReturnType> <ReturnType>Gtk.Widget</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The widget that was added to the container.</summary>
<returns>To be added: an object of type 'Gtk.Widget'</returns> <returns>A <see cref="T:Gtk.Widget"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -39,9 +39,9 @@
<ReturnType>System.Double</ReturnType> <ReturnType>System.Double</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The new value for the bounds of the range.</summary>
<returns>To be added: an object of type 'double'</returns> <returns>A <see cref="T:System.Double"/>.</returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -39,9 +39,9 @@
<ReturnType>System.Int32</ReturnType> <ReturnType>System.Int32</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The offset of the notebook page to display.</summary>
<returns>To be added: an object of type 'int'</returns> <returns>A <see cref="T:System.Int32"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -39,9 +39,9 @@
<ReturnType>Gtk.ScrollType</ReturnType> <ReturnType>Gtk.ScrollType</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The type of incrementation or decrementation to perform.</summary>
<returns>To be added: an object of type 'Gtk.ScrollType'</returns> <returns>A <see cref="T:Gtk.ScrollType"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -39,9 +39,9 @@
<ReturnType>Gtk.TextChildAnchor</ReturnType> <ReturnType>Gtk.TextChildAnchor</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The anchor that was inserted.</summary>
<returns>To be added: an object of type 'Gtk.TextChildAnchor'</returns> <returns>A <see cref="T:Gtk.TextChildAnchor"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Pos"> <Member MemberName="Pos">
@ -51,9 +51,9 @@
<ReturnType>Gtk.TextIter</ReturnType> <ReturnType>Gtk.TextIter</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The position where the anchor was inserted.</summary>
<returns>To be added: an object of type 'Gtk.TextIter'</returns> <returns>A <see cref="T:Gtk.TextIter"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -39,9 +39,9 @@
<ReturnType>Gtk.Widget</ReturnType> <ReturnType>Gtk.Widget</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The child widget that was attached.</summary>
<returns>To be added: an object of type 'Gtk.Widget'</returns> <returns>A <see cref="T:Gtk.Widget"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -39,9 +39,9 @@
<ReturnType>Gtk.Widget</ReturnType> <ReturnType>Gtk.Widget</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The child widget that was detached.</summary>
<returns>To be added: an object of type 'Gtk.Widget'</returns> <returns>A <see cref="T:Gtk.Widget"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -39,9 +39,9 @@
<ReturnType>System.Boolean</ReturnType> <ReturnType>System.Boolean</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Whether or not to reverse the cycle direction.</summary>
<returns>To be added: an object of type 'bool'</returns> <returns>a <see cref="T:System.Boolean"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -39,9 +39,9 @@
<ReturnType>Gdk.Device</ReturnType> <ReturnType>Gdk.Device</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The device to enable.</summary>
<returns>To be added: an object of type 'Gdk.Device'</returns> <returns>A <see cref="T:Gdk.Device"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -39,9 +39,9 @@
<ReturnType>System.String</ReturnType> <ReturnType>System.String</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The new text for the cell.</summary>
<returns>To be added: an object of type 'string'</returns> <returns>A <see cref="T:System.String"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Path"> <Member MemberName="Path">
@ -51,9 +51,9 @@
<ReturnType>System.String</ReturnType> <ReturnType>System.String</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The path string of the edited cell.</summary>
<returns>To be added: an object of type 'string'</returns> <returns>A <see cref="T:System.String"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -39,9 +39,9 @@
<ReturnType>Gdk.Device</ReturnType> <ReturnType>Gdk.Device</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The device to enable.</summary>
<returns>To be added: an object of type 'Gdk.Device'</returns> <returns>A <see cref="T:Gdk.Device"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -39,9 +39,9 @@
<ReturnType>System.Boolean</ReturnType> <ReturnType>System.Boolean</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Whether or not to open all children of this cursor row.</summary>
<returns>To be added: an object of type 'bool'</returns> <returns>A <see cref="T:System.Boolean"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Expand"> <Member MemberName="Expand">
@ -51,9 +51,9 @@
<ReturnType>System.Boolean</ReturnType> <ReturnType>System.Boolean</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Whether to expand (true) or collapse(false) the row.</summary>
<returns>To be added: an object of type 'bool'</returns> <returns>A <see cref="T:System.Boolean"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Logical"> <Member MemberName="Logical">

View file

@ -39,9 +39,9 @@
<ReturnType>Gdk.EventExpose</ReturnType> <ReturnType>Gdk.EventExpose</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The event that caused the widget to be exposed.</summary>
<returns>To be added: an object of type 'Gdk.EventExpose'</returns> <returns>A <see cref="E:Gdk.EventExpose"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -39,9 +39,9 @@
<ReturnType>Gdk.EventFocus</ReturnType> <ReturnType>Gdk.EventFocus</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The focus event.</summary>
<returns>To be added: an object of type 'Gdk.EventFocus'</returns> <returns>A <see cref="T:Gdk.EventFocus"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -39,9 +39,9 @@
<ReturnType>Gtk.DirectionType</ReturnType> <ReturnType>Gtk.DirectionType</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>How the focus on this widget behaves.</summary>
<returns>To be added: an object of type 'Gtk.DirectionType'</returns> <returns><see cref="T:Gtk.DirectionType"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -39,9 +39,9 @@
<ReturnType>System.String</ReturnType> <ReturnType>System.String</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The URL the user clicked on.</summary>
<returns>To be added: an object of type 'string'</returns> <returns>A <see cref="T:System.String"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -53,9 +53,9 @@
<ReturnType>Gtk.DirectionType</ReturnType> <ReturnType>Gtk.DirectionType</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The direction the focus is moving on its way out.</summary>
<returns>To be added: an object of type 'Gtk.DirectionType'</returns> <returns>A <see cref="T:Gtk.DirectionType"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -39,9 +39,9 @@
<ReturnType>System.String</ReturnType> <ReturnType>System.String</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The URL to act on.</summary>
<returns>To be added: an object of type 'string'</returns> <returns>A <see cref="T:System.String"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -1730,7 +1730,7 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>Fired whenever this widget's window is told to hide itself.</summary> <summary>Fired whenever this widget (or its parent, if <see cref="M:Gtk.Widget.ChildVisible"/> is true for the parent) is told to hide itself.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -1791,7 +1791,7 @@ handle focus grabs.</returns>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>Fired whenever the widget receives a request for a selection.</summary> <summary>Fired whenever the widget receives a request for a selection.</summary>
<remarks>To be added: explain more about the X selection model </remarks> <remarks>TODO: explain more about the X selection model </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DirectionChanged"> <Member MemberName="DirectionChanged">
@ -1814,8 +1814,8 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired when a drag action leaves this widget.</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ScrollEvent"> <Member MemberName="ScrollEvent">
@ -1838,8 +1838,8 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired whenever the visibility state of the widget changes--- partially visible or fully visible, for example.</summary>
<remarks /> <remarks>It may be preferable to handle a <see cref="T:Gtk.Widget.ExposeEvent"/>instead.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="WindowStateEvent"> <Member MemberName="WindowStateEvent">
@ -1862,7 +1862,7 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired when this widget is mapped.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -1897,7 +1897,7 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired when the configuration of the window has changed (it has been moved or resized).</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -1921,7 +1921,7 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired just after the widget is mapped.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -1933,7 +1933,7 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired when this widget grabs the keyboard focus.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -1945,7 +1945,7 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired when the pointer moves within this widget.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -1957,8 +1957,8 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired when the state of the widget changes.</summary>
<remarks /> <remarks>See <see cref="T:Gtk.StateType"/> for the possible states of a widget.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="NoExposeEvent"> <Member MemberName="NoExposeEvent">
@ -2041,8 +2041,8 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired when the widget needs to be (fully or partially) redrawn.</summary>
<remarks /> <remarks>See <see cref="T:Gtk.ExposeEventArgs"/>, <see cref="T:Gtk.ExposeEventHandler"/>. </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Shown"> <Member MemberName="Shown">
@ -2053,7 +2053,7 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired when the widget is shown.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -2077,7 +2077,7 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired when the widget has just gained the focus.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -2197,8 +2197,8 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The pointer has just entered the widget.</summary>
<remarks /> <remarks>If the <see cref="P:Gtk.Widget.CanFocus" /> flag is set, Widget will gain the focus, and the widget might be drawn differently. If the handler returns False, the event might be passed to the parent of widget (if no other handler of widget has returned True).</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DragDataReceived"> <Member MemberName="DragDataReceived">
@ -2233,7 +2233,7 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired when this widget needs to notify another object of its preferred size.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -2245,7 +2245,7 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -2257,7 +2257,7 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired when a <see cref="T:Gtk.Style"/> is set for this widget.t</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -2293,7 +2293,7 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired when the widget is unmapped on the screen.</summary>
<remarks/> <remarks/>
</Docs> </Docs>
</Member> </Member>
@ -2365,8 +2365,8 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired when the user has clicked on the "close" button in the window's frame (the button that is automatically set by the window manager).</summary>
<remarks /> <remarks>If the handler returns False, the widget will be destroyed (and the window closed), but if the handler returns True, nothing will be done. This is a good way to prevent the user from closing your application's window if there should be some cleanups first (like saving the document).</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Realized"> <Member MemberName="Realized">
@ -2377,8 +2377,8 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Emitted when a widget is realized.</summary>
<remarks /> <remarks>The default handler creates the Gdk window associated with the widget, and its ancestors.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DragDataDelete"> <Member MemberName="DragDataDelete">
@ -2400,7 +2400,7 @@ handle focus grabs.</returns>
<ReturnType>Gdk.Window</ReturnType> <ReturnType>Gdk.Window</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The root window this Widget is attached to.</summary>
<returns>a <see cref="T:Gdk.Window" /></returns> <returns>a <see cref="T:Gdk.Window" /></returns>
<remarks /> <remarks />
</Docs> </Docs>