From 5a116de32ac799fe2888d827579a749da8163bfe Mon Sep 17 00:00:00 2001 From: Shane Landrum Date: Mon, 6 Sep 2004 14:51:09 +0000 Subject: [PATCH] 2004-09-06 Shane Landrum * en/Gtk/Adjustment.xml * en/Gtk/Callback.xml * en/Gtk/Clipboard.xml * en/Gtk/Quit.xml * en/Gtk/ReadyEvent.xml * en/Gtk/ImageStockData.xml * en/Gtk/MovementStep.xml * en/Gtk/RulerMetric.xml * en/Gtk/Selection.xml * en/Gtk/ThreadNotify.xml: Docs for assorted helper classes. svn path=/trunk/gtk-sharp/; revision=33413 --- doc/ChangeLog | 13 ++++++++ doc/en/Gtk/Adjustment.xml | 6 ++-- doc/en/Gtk/Callback.xml | 6 ++-- doc/en/Gtk/Clipboard.xml | 18 ++++++----- doc/en/Gtk/ImageStockData.xml | 6 ++-- doc/en/Gtk/MovementStep.xml | 10 ++---- doc/en/Gtk/Quit.xml | 2 +- doc/en/Gtk/ReadyEvent.xml | 6 ++-- doc/en/Gtk/RulerMetric.xml | 20 ++++++------ doc/en/Gtk/Selection.xml | 58 +++++++++++++++++++---------------- doc/en/Gtk/ThreadNotify.xml | 2 +- 11 files changed, 81 insertions(+), 66 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 381b0f699..49c71e3af 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,16 @@ +2004-09-06 Shane Landrum + + * en/Gtk/Adjustment.xml + * en/Gtk/Callback.xml + * en/Gtk/Clipboard.xml + * en/Gtk/Quit.xml + * en/Gtk/ReadyEvent.xml + * en/Gtk/ImageStockData.xml + * en/Gtk/MovementStep.xml + * en/Gtk/RulerMetric.xml + * en/Gtk/Selection.xml + * en/Gtk/ThreadNotify.xml: Docs for assorted helper classes. + 2004-09-06 Shane Landrum * en/Gtk/ProgressBar.xml diff --git a/doc/en/Gtk/Adjustment.xml b/doc/en/Gtk/Adjustment.xml index 7b659de6b..b7f792e8c 100644 --- a/doc/en/Gtk/Adjustment.xml +++ b/doc/en/Gtk/Adjustment.xml @@ -339,10 +339,10 @@ - To be added + Default constructor. a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/Callback.xml b/doc/en/Gtk/Callback.xml index 59c6f5691..7bc3b6f65 100644 --- a/doc/en/Gtk/Callback.xml +++ b/doc/en/Gtk/Callback.xml @@ -7,8 +7,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A delegate that can be run over a series of widgets. + Invoked by . System.Delegate @@ -29,4 +29,4 @@ System.Void - \ No newline at end of file + diff --git a/doc/en/Gtk/Clipboard.xml b/doc/en/Gtk/Clipboard.xml index b778f40f0..885ebb108 100644 --- a/doc/en/Gtk/Clipboard.xml +++ b/doc/en/Gtk/Clipboard.xml @@ -261,10 +261,12 @@ - To be added - a - a - To be added + Requests the contents of clipboard as the given target. + When the results of the result are later received the supplied + callback will be called. + a representing the form into which the clipboard-owning program should convert the selection. + a , a function to call when the clipboard results are received. + @@ -277,9 +279,9 @@ - To be added + Fetch the clipboard's text and fire the function on it. a - To be added + @@ -302,9 +304,9 @@ - To be added + Proctected constructor. a - To be added + diff --git a/doc/en/Gtk/ImageStockData.xml b/doc/en/Gtk/ImageStockData.xml index fd61a1714..361d53258 100644 --- a/doc/en/Gtk/ImageStockData.xml +++ b/doc/en/Gtk/ImageStockData.xml @@ -56,9 +56,9 @@ - To be added - To be added + An identifier for this stock image. + - \ No newline at end of file + diff --git a/doc/en/Gtk/MovementStep.xml b/doc/en/Gtk/MovementStep.xml index 9d79fdeda..6cdfda37e 100644 --- a/doc/en/Gtk/MovementStep.xml +++ b/doc/en/Gtk/MovementStep.xml @@ -10,12 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - An enumeration used by Label. - - - This enumeration is used by to decide how the cursor will move. - - + An enumeration used by to decide how the cursor will move. + System.Enum @@ -191,4 +187,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/Quit.xml b/doc/en/Gtk/Quit.xml index 842f8ea28..6f1d59015 100644 --- a/doc/en/Gtk/Quit.xml +++ b/doc/en/Gtk/Quit.xml @@ -10,7 +10,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added + Object to encapsulate code for running at the end of program execution. diff --git a/doc/en/Gtk/ReadyEvent.xml b/doc/en/Gtk/ReadyEvent.xml index 894c56c6c..c0a4c3a69 100644 --- a/doc/en/Gtk/ReadyEvent.xml +++ b/doc/en/Gtk/ReadyEvent.xml @@ -9,8 +9,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Delegate specifying a signature for functions that run whenever is invoked. + See . System.Delegate @@ -30,4 +30,4 @@ System.Void - \ No newline at end of file + diff --git a/doc/en/Gtk/RulerMetric.xml b/doc/en/Gtk/RulerMetric.xml index 97ef04b41..f1742919c 100644 --- a/doc/en/Gtk/RulerMetric.xml +++ b/doc/en/Gtk/RulerMetric.xml @@ -41,10 +41,10 @@ - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Gtk.RulerMetric' - + Default constructor. + A , pointer to the underlying C object. + A + For internal use only. @@ -56,7 +56,7 @@ - To be added + The name of the units this ruler measures: one of Pixels, Inches, or Centimeters. @@ -69,8 +69,8 @@ - To be added - + The abbreviations for this metric's units: "Pi" for pixels, "In" for inches, "Cn" for centimeters. + "Cn" isn't a typo; that's how it's defined in Gtk+. See bugzilla.gnome.org bug 151944. @@ -82,7 +82,7 @@ - To be added + The conversion factor between pixels and the given unit for the ruler. @@ -95,7 +95,7 @@ - To be added + An array of possible scales for the ruler, dependent on the units chosen. @@ -108,7 +108,7 @@ - To be added + How many sub-units to break up each ruler unit into. diff --git a/doc/en/Gtk/Selection.xml b/doc/en/Gtk/Selection.xml index 75caa3f0f..7cd755dab 100644 --- a/doc/en/Gtk/Selection.xml +++ b/doc/en/Gtk/Selection.xml @@ -51,9 +51,9 @@ - To be added + Remove all targets registered for the given selection for the widget. a - a + a representing the selection. @@ -67,7 +67,9 @@ - To be added + Removes all handlers and unsets ownership of all + selections for a widget. Called when widget is being + destroyed. a @@ -83,11 +85,11 @@ - To be added + The default handler for the event. Instead of calling this function, chain up from your . Calling this function from any other context is illegal. a a - a - + a , true if the event was handled, otherwise false + This function will be deprecated in future versions of GTK+ and GTK#. @@ -103,12 +105,14 @@ - To be added - a - a - a - a - a + Request the contents of a selection. When received, + a event will + be generated. + a , the requesting widget + a , the selection to get + a , the form of the information ("STRING" for example) (TODO: elaborate possible options) + a , the time the request is being made + a , true if the request succeeded, false if it couldn't be processed. @@ -125,12 +129,12 @@ - To be added - a - a + Add the specified target to the list of supported targets for this selection. + a , the widget for which this target applies + a , the selection data a a - + TODO: this could be better-explained. @@ -145,11 +149,11 @@ - To be added - a - a - a - a + Claims ownership of a given selection for a particular widget, or if is , release ownership of the selection. + a or + a representing the selection to claim. + a , a timestamp to use in claiming the selection. + a , true if the operation succeeded. @@ -166,12 +170,12 @@ - To be added - a - a - a - a - a + Claims ownership of a given selection on a given display for a particular widget, or if is , release ownership of the selection. + a , the display where the selection is set. + a or + a representing the selection to claim. + a , a timestamp to use in claiming the selection. + a , true if the operation succeeded. diff --git a/doc/en/Gtk/ThreadNotify.xml b/doc/en/Gtk/ThreadNotify.xml index 563f94a8a..3895e6b9c 100644 --- a/doc/en/Gtk/ThreadNotify.xml +++ b/doc/en/Gtk/ThreadNotify.xml @@ -121,4 +121,4 @@ class Demo { - \ No newline at end of file +