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

* en/Gtk/DeleteFromCursorArgs.xml
	* en/Gtk/DeleteType.xml: Docs for deletion from text widgets.
	* en/Gtk/Widget.xml: Added some event docs.
	* en/Gtk/PopulatePopupArgs.xml: Event data for text widget popups.
	* en/Gtk/TextView.xml: Docs for some events.
	* en/Gtk/HTML.xml: Minor wording change, thanks to Ben Maurer.
	* en/Gtk/Notebook.xml: Documented an event, minor style edits.

svn path=/trunk/gtk-sharp/; revision=32512
This commit is contained in:
Shane Landrum 2004-08-19 04:05:57 +00:00
parent cfee084f8d
commit 3ed97fa33d
8 changed files with 64 additions and 52 deletions

View file

@ -1,3 +1,13 @@
2004-08-19 Shane Landrum <epicene@pobox.com>
* en/Gtk/DeleteFromCursorArgs.xml
* en/Gtk/DeleteType.xml: Docs for deletion from text widgets.
* en/Gtk/Widget.xml: Added some event docs.
* en/Gtk/PopulatePopupArgs.xml: Event data for text widget popups.
* en/Gtk/TextView.xml: Docs for some events.
* en/Gtk/HTML.xml: Minor wording change, thanks to Ben Maurer.
* en/Gtk/Notebook.xml: Documented an event, minor style edits.
2004-08-19 Shane Landrum <epicene@pobox.com> 2004-08-19 Shane Landrum <epicene@pobox.com>
* en/Gtk/ClipboardReceivedFunc.xml: Added docs for classes related * en/Gtk/ClipboardReceivedFunc.xml: Added docs for classes related

View file

@ -53,9 +53,9 @@
<ReturnType>System.Int32</ReturnType> <ReturnType>System.Int32</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>How many units of the specified <see cref="T:Gtk.DeleteType" /> to delete.</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>
<Member MemberName="Type"> <Member MemberName="Type">
@ -65,9 +65,9 @@
<ReturnType>Gtk.DeleteType</ReturnType> <ReturnType>Gtk.DeleteType</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The kind/length of text to delete. </summary>
<returns>To be added: an object of type 'Gtk.DeleteType'</returns> <returns><see cref="T:Gtk.DeleteType" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -106,7 +106,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Delete words.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -120,7 +120,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Delete lines from the display (i.e., not lines as measured by carriage returns.)</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -134,7 +134,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Delete from the cursor to the end of the line.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -148,7 +148,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Delete to the end of the paragraph.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>

View file

@ -246,7 +246,7 @@ namespace HtmlTest
<Parameter Name="style" Type="Gtk.HTMLFontStyle" /> <Parameter Name="style" Type="Gtk.HTMLFontStyle" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Changes the font style by flipping toggle bits: from bold to regular or vice-versa. For a full list of toggle bits, see <see cref="T:Gtk.HTMLFontStyle" />. </summary> <summary>Changes the font style by adjusting flags from bold to regular or vice-versa. For a full list of possible flags, see <see cref="T:Gtk.HTMLFontStyle" />. </summary>
<param name="style">a <see cref="T:Gtk.HTMLFontStyle" /></param> <param name="style">a <see cref="T:Gtk.HTMLFontStyle" /></param>
<remarks /> <remarks />
</Docs> </Docs>

View file

@ -10,7 +10,7 @@
</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>Notebook widget container</summary> <summary>Notebook widget container.</summary>
<remarks> <remarks>
<para> <para>
The Notebook widget is a <see cref="T:Gtk.Container" /> whose The Notebook widget is a <see cref="T:Gtk.Container" /> whose
@ -70,6 +70,8 @@ class NotebookSample
} }
</code> </code>
</example> </example>
(FIXME: all methods in this class should specify types in their param
elements, and this doc needs a good proofreading.)
</remarks> </remarks>
</Docs> </Docs>
<Base> <Base>
@ -506,10 +508,10 @@ Don't forget to call the Show method on the widget or else the new page will not
<Parameter Name="menu_label" Type="Gtk.Widget" /> <Parameter Name="menu_label" Type="Gtk.Widget" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>sets the menulabel of a page.</summary> <summary>Sets the menu label of a page.</summary>
<param name="child">the page</param> <param name="child">the page</param>
<param name="menu_label">the <see cref="T:Gtk.Widget" /> to use as menu label. use null to get the same label as the tab label, this only works if the tab label is a <see cref="T:Gtk.Label" /></param> <param name="menu_label">the <see cref="T:Gtk.Widget" /> to use as menu label. use null to get the same label as the tab label, this only works if the tab label is a <see cref="T:Gtk.Label" /></param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetTabLabelPacking"> <Member MemberName="SetTabLabelPacking">
@ -525,12 +527,12 @@ Don't forget to call the Show method on the widget or else the new page will not
<Parameter Name="pack_type" Type="Gtk.PackType" /> <Parameter Name="pack_type" Type="Gtk.PackType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>sets the packing of the tab label of a page.</summary> <summary>Sets the packing of the tab label of a page.</summary>
<param name="child">a page.</param> <param name="child">a page.</param>
<param name="expand">sets true to expand the label.</param> <param name="expand">sets true to expand the label.</param>
<param name="fill">sets true to fill to fill the allocated area.</param> <param name="fill">sets true to fill to fill the allocated area.</param>
<param name="pack_type">sets <see cref="T:Gtk.PackType" /> of the label.</param> <param name="pack_type">sets <see cref="T:Gtk.PackType" /> of the label.</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Finalize"> <Member MemberName="Finalize">
@ -746,8 +748,8 @@ Don't forget to call the Show method on the widget or else the new page will not
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired when a page of the notebook is selected.</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SwitchPage"> <Member MemberName="SwitchPage">

View file

@ -10,7 +10,7 @@
</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>Event data.</summary> <summary>Event data for populating a popup.</summary>
<remarks> <remarks>
<para>The following events invoke <see cref="T:Gtk.PopulatePopupHandler" /> delegates which pass event data via this class:</para> <para>The following events invoke <see cref="T:Gtk.PopulatePopupHandler" /> delegates which pass event data via this class:</para>
<para> <para>
@ -58,9 +58,9 @@
<ReturnType>Gtk.Menu</ReturnType> <ReturnType>Gtk.Menu</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Data for populating the popup menu.</summary>
<returns>To be added: an object of type 'Gtk.Menu'</returns> <returns>a <see cref="Gtk.Menu"/></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -220,7 +220,7 @@ class TextViewSample
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>Moves the cursor to the currently visible region of the buffer, it it isn't there already.</summary> <summary>Moves the cursor to the currently visible region of the buffer if it isn't there already.</summary>
<returns> <returns>
<see langword="true" /> if the cursor had to be moved</returns> <see langword="true" /> if the cursor had to be moved</returns>
<remarks /> <remarks />
@ -943,8 +943,8 @@ class TextViewSample
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired when the popup dialog on this object needs to be filled with data.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DeleteFromCursor"> <Member MemberName="DeleteFromCursor">
@ -955,8 +955,8 @@ class TextViewSample
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired when text is deleted from the cursor (usually by hitting Backspace or Delete).</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CopyClipboard"> <Member MemberName="CopyClipboard">
@ -967,8 +967,8 @@ class TextViewSample
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired when text is copied to the clipboard.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="MoveFocus"> <Member MemberName="MoveFocus">
@ -979,8 +979,8 @@ class TextViewSample
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired when the keyboard focus changes.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PageHorizontally"> <Member MemberName="PageHorizontally">
@ -991,8 +991,8 @@ class TextViewSample
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired when the user scrolls horizontally in this widget.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ToggleOverwrite"> <Member MemberName="ToggleOverwrite">
@ -1015,8 +1015,8 @@ class TextViewSample
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired whenever a selection is cut to the clipboard.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="InsertAtCursor"> <Member MemberName="InsertAtCursor">
@ -1027,8 +1027,8 @@ class TextViewSample
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired whenever text is inserted at the cursor.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PasteClipboard"> <Member MemberName="PasteClipboard">
@ -1039,8 +1039,8 @@ class TextViewSample
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired whenever text is pasted from the clipboard.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetLineAtY"> <Member MemberName="GetLineAtY">

View file

@ -1874,7 +1874,7 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired on a source widget when the user begins a drag.</summary>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="HierarchyChanged"> <Member MemberName="HierarchyChanged">
@ -2185,7 +2185,7 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired when the drag-and-drop process gets data from a source widget.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -2209,7 +2209,7 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired on a destination widget when it receives dragged data.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -2221,7 +2221,7 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired on a source widget when the user is moving a dragged selection.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -2305,7 +2305,7 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired on a source widget when a drag operation is completed.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -2341,7 +2341,7 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired on a source widget when dragged data is dropped.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -2389,7 +2389,7 @@ handle focus grabs.</returns>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fired on a source widget when dragged data is deleted.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -3783,7 +3783,7 @@ xs <Member MemberName="OnMapEvent">
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Protected constructor.</summary>
<returns>a <see cref="T:Gtk.Widget" /></returns> <returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks /> <remarks />
</Docs> </Docs>