From ac9699f465d66fcaef25e15554ab80c9e4138ad3 Mon Sep 17 00:00:00 2001 From: Shane Landrum Date: Fri, 13 Aug 2004 16:24:39 +0000 Subject: [PATCH] 2004-08-13 Shane Landrum * en/Gtk/*Args.xml: Documented many handler arguments classes. svn path=/trunk/gtk-sharp/; revision=32311 --- doc/ChangeLog | 4 ++++ doc/en/Gtk/AccelChangedArgs.xml | 4 ++-- doc/en/Gtk/ButtonPressEventArgs.xml | 8 ++++---- doc/en/Gtk/ButtonReleaseEventArgs.xml | 8 ++++---- .../CurrentParagraphAlignmentChangedArgs.xml | 6 +++--- ...CurrentParagraphIndentationChangedArgs.xml | 8 ++++---- doc/en/Gtk/DragDataReceivedArgs.xml | 20 +++++++++---------- doc/en/Gtk/FocusOutEventArgs.xml | 8 ++++---- doc/en/Gtk/HelpShownArgs.xml | 8 ++++---- doc/en/Gtk/IframeCreatedArgs.xml | 8 ++++---- doc/en/Gtk/InsertAtCursorArgs.xml | 8 ++++---- doc/en/Gtk/InsertionColorChangedArgs.xml | 8 ++++---- doc/en/Gtk/InsertionFontStyleChangedArgs.xml | 8 ++++---- doc/en/Gtk/KeyPressEventArgs.xml | 8 ++++---- doc/en/Gtk/KeyReleaseEventArgs.xml | 8 ++++---- doc/en/Gtk/MnemonicActivatedArgs.xml | 8 ++++---- doc/en/Gtk/ScrollArgs.xml | 20 +++++++++---------- doc/en/Gtk/ScrollEventArgs.xml | 8 ++++---- doc/en/Gtk/ToggledArgs.xml | 8 ++++---- doc/en/Gtk/UrlRequestedArgs.xml | 14 ++++++------- 20 files changed, 92 insertions(+), 88 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 8f0bd1ce9..a974657d4 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2004-08-13 Shane Landrum + + * en/Gtk/*Args.xml: Documented many handler arguments classes. + 2004-08-13 Shane Landrum * en/Gtk/HTML.xml diff --git a/doc/en/Gtk/AccelChangedArgs.xml b/doc/en/Gtk/AccelChangedArgs.xml index b9b0e94c2..c280d6664 100644 --- a/doc/en/Gtk/AccelChangedArgs.xml +++ b/doc/en/Gtk/AccelChangedArgs.xml @@ -39,7 +39,7 @@ System.IntPtr - To be added + A pointer to the accelerator that was changed. To be added: an object of type 'IntPtr' To be added @@ -64,7 +64,7 @@ Gets the key value for the accelerator event. - An object of type 'uint' + An integer. diff --git a/doc/en/Gtk/ButtonPressEventArgs.xml b/doc/en/Gtk/ButtonPressEventArgs.xml index 04aced5d7..cf738ae3a 100644 --- a/doc/en/Gtk/ButtonPressEventArgs.xml +++ b/doc/en/Gtk/ButtonPressEventArgs.xml @@ -39,10 +39,10 @@ Gdk.EventButton - To be added - To be added: an object of type 'Gdk.EventButton' - To be added + The button that was pressed. + a + - \ No newline at end of file + diff --git a/doc/en/Gtk/ButtonReleaseEventArgs.xml b/doc/en/Gtk/ButtonReleaseEventArgs.xml index 28d40a533..39f9cdc45 100644 --- a/doc/en/Gtk/ButtonReleaseEventArgs.xml +++ b/doc/en/Gtk/ButtonReleaseEventArgs.xml @@ -39,10 +39,10 @@ Gdk.EventButton - To be added - To be added: an object of type 'Gdk.EventButton' - To be added + The button that was released. + a + - \ No newline at end of file + diff --git a/doc/en/Gtk/CurrentParagraphAlignmentChangedArgs.xml b/doc/en/Gtk/CurrentParagraphAlignmentChangedArgs.xml index 02a0d3b51..cbdc98f2a 100644 --- a/doc/en/Gtk/CurrentParagraphAlignmentChangedArgs.xml +++ b/doc/en/Gtk/CurrentParagraphAlignmentChangedArgs.xml @@ -39,10 +39,10 @@ Gtk.HTMLParagraphAlignment - To be added - To be added: an object of type 'Gtk.HTMLParagraphAlignment' + The new alignment of the paragraph. + a To be added - \ No newline at end of file + diff --git a/doc/en/Gtk/CurrentParagraphIndentationChangedArgs.xml b/doc/en/Gtk/CurrentParagraphIndentationChangedArgs.xml index c7088ffb9..174fe7425 100644 --- a/doc/en/Gtk/CurrentParagraphIndentationChangedArgs.xml +++ b/doc/en/Gtk/CurrentParagraphIndentationChangedArgs.xml @@ -39,10 +39,10 @@ System.UInt32 - To be added - To be added: an object of type 'uint' - To be added + The new indentation level of the paragraph. + An integer, the new indentation level. + - \ No newline at end of file + diff --git a/doc/en/Gtk/DragDataReceivedArgs.xml b/doc/en/Gtk/DragDataReceivedArgs.xml index 35b23e699..f34d456de 100644 --- a/doc/en/Gtk/DragDataReceivedArgs.xml +++ b/doc/en/Gtk/DragDataReceivedArgs.xml @@ -63,9 +63,9 @@ Gtk.SelectionData - To be added - To be added: an object of type 'Gtk.SelectionData' - To be added + The data from the drag-and-drop selection that was dropped as part of the event. + a object. + @@ -75,9 +75,9 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + The Y coordinate where the data was dropped. + An integer. + @@ -87,9 +87,9 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + The X coordinate where the data was dropped. + An integer. + @@ -105,4 +105,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/FocusOutEventArgs.xml b/doc/en/Gtk/FocusOutEventArgs.xml index d90b1dd27..b4e5fabd9 100644 --- a/doc/en/Gtk/FocusOutEventArgs.xml +++ b/doc/en/Gtk/FocusOutEventArgs.xml @@ -39,10 +39,10 @@ Gdk.EventFocus - To be added - To be added: an object of type 'Gdk.EventFocus' - To be added + The change in keyboard focus. + a + - \ No newline at end of file + diff --git a/doc/en/Gtk/HelpShownArgs.xml b/doc/en/Gtk/HelpShownArgs.xml index 90c18cda3..6f248f7f9 100644 --- a/doc/en/Gtk/HelpShownArgs.xml +++ b/doc/en/Gtk/HelpShownArgs.xml @@ -39,10 +39,10 @@ Gtk.WidgetHelpType - To be added - To be added: an object of type 'Gtk.WidgetHelpType' - To be added + The type of help to be shown. + a + - \ No newline at end of file + diff --git a/doc/en/Gtk/IframeCreatedArgs.xml b/doc/en/Gtk/IframeCreatedArgs.xml index 2405dd85c..a15c9f85d 100644 --- a/doc/en/Gtk/IframeCreatedArgs.xml +++ b/doc/en/Gtk/IframeCreatedArgs.xml @@ -39,10 +39,10 @@ Gtk.HTML - To be added - To be added: an object of type 'Gtk.HTML' - To be added + The IFRAME element that was created. + a + - \ No newline at end of file + diff --git a/doc/en/Gtk/InsertAtCursorArgs.xml b/doc/en/Gtk/InsertAtCursorArgs.xml index 4a5d9fac9..d5e735196 100644 --- a/doc/en/Gtk/InsertAtCursorArgs.xml +++ b/doc/en/Gtk/InsertAtCursorArgs.xml @@ -53,10 +53,10 @@ System.String - To be added - To be added: an object of type 'string' - To be added + The text that was inserted. + A + - \ No newline at end of file + diff --git a/doc/en/Gtk/InsertionColorChangedArgs.xml b/doc/en/Gtk/InsertionColorChangedArgs.xml index 43f138ff8..812aa480d 100644 --- a/doc/en/Gtk/InsertionColorChangedArgs.xml +++ b/doc/en/Gtk/InsertionColorChangedArgs.xml @@ -39,10 +39,10 @@ Gdk.Color - To be added - To be added: an object of type 'Gdk.Color' - To be added + The color under the insertion point after the change. + The new color, a + - \ No newline at end of file + diff --git a/doc/en/Gtk/InsertionFontStyleChangedArgs.xml b/doc/en/Gtk/InsertionFontStyleChangedArgs.xml index 92fb30f0a..e9a0527f6 100644 --- a/doc/en/Gtk/InsertionFontStyleChangedArgs.xml +++ b/doc/en/Gtk/InsertionFontStyleChangedArgs.xml @@ -39,10 +39,10 @@ Gtk.HTMLFontStyle - To be added - To be added: an object of type 'Gtk.HTMLFontStyle' - To be added + The style that was set during the change. + a + - \ No newline at end of file + diff --git a/doc/en/Gtk/KeyPressEventArgs.xml b/doc/en/Gtk/KeyPressEventArgs.xml index 37f04153c..7faa78acb 100644 --- a/doc/en/Gtk/KeyPressEventArgs.xml +++ b/doc/en/Gtk/KeyPressEventArgs.xml @@ -39,10 +39,10 @@ Gdk.EventKey - To be added - To be added: an object of type 'Gdk.EventKey' - To be added + The keypress event that happened. + a + - \ No newline at end of file + diff --git a/doc/en/Gtk/KeyReleaseEventArgs.xml b/doc/en/Gtk/KeyReleaseEventArgs.xml index bb09acfb2..4b13af49e 100644 --- a/doc/en/Gtk/KeyReleaseEventArgs.xml +++ b/doc/en/Gtk/KeyReleaseEventArgs.xml @@ -39,10 +39,10 @@ Gdk.EventKey - To be added - To be added: an object of type 'Gdk.EventKey' - To be added + The key-release event that happened. + a + - \ No newline at end of file + diff --git a/doc/en/Gtk/MnemonicActivatedArgs.xml b/doc/en/Gtk/MnemonicActivatedArgs.xml index ed80c7d87..eaaf68d8f 100644 --- a/doc/en/Gtk/MnemonicActivatedArgs.xml +++ b/doc/en/Gtk/MnemonicActivatedArgs.xml @@ -39,10 +39,10 @@ System.Boolean - To be added - To be added: an object of type 'bool' - To be added + Whether or not the mnemonic group acts as a loop. + A boolean, true if the group cycles. + - \ No newline at end of file + diff --git a/doc/en/Gtk/ScrollArgs.xml b/doc/en/Gtk/ScrollArgs.xml index 9c7b5d20d..6ed8a65f2 100644 --- a/doc/en/Gtk/ScrollArgs.xml +++ b/doc/en/Gtk/ScrollArgs.xml @@ -39,9 +39,9 @@ System.Single - To be added - To be added: an object of type 'float' - To be added + The position of the scroller. + a + @@ -51,9 +51,9 @@ Gtk.ScrollType - To be added - To be added: an object of type 'Gtk.ScrollType' - To be added + What kind of scrolling happened in this event. + A + @@ -63,10 +63,10 @@ Gtk.Orientation - To be added - To be added: an object of type 'Gtk.Orientation' - To be added + The orientation of the scroller in question, horizontal or vertical. + A + - \ No newline at end of file + diff --git a/doc/en/Gtk/ScrollEventArgs.xml b/doc/en/Gtk/ScrollEventArgs.xml index db64271be..dfea88b66 100644 --- a/doc/en/Gtk/ScrollEventArgs.xml +++ b/doc/en/Gtk/ScrollEventArgs.xml @@ -39,10 +39,10 @@ Gdk.EventScroll - To be added - To be added: an object of type 'Gdk.EventScroll' - To be added + The scrolling event that happened. + a + - \ No newline at end of file + diff --git a/doc/en/Gtk/ToggledArgs.xml b/doc/en/Gtk/ToggledArgs.xml index d8fe6e30f..653e326fd 100644 --- a/doc/en/Gtk/ToggledArgs.xml +++ b/doc/en/Gtk/ToggledArgs.xml @@ -39,10 +39,10 @@ System.String - To be added - To be added: an object of type 'string' - To be added + The object path of the toggle that was changed. + a + - \ No newline at end of file + diff --git a/doc/en/Gtk/UrlRequestedArgs.xml b/doc/en/Gtk/UrlRequestedArgs.xml index ff26ca9a3..b6075285d 100644 --- a/doc/en/Gtk/UrlRequestedArgs.xml +++ b/doc/en/Gtk/UrlRequestedArgs.xml @@ -39,9 +39,9 @@ Gtk.HTMLStream - To be added - To be added: an object of type 'Gtk.HTMLStream' - To be added + An object for the HTML from the URL as it opens. + a + @@ -51,10 +51,10 @@ System.String - To be added - To be added: an object of type 'string' - To be added + The URL that was requested. + A string containing the URL. + - \ No newline at end of file +