From e4b716e18c2909b0e6893a26ce5e8e7ef7b38f6e Mon Sep 17 00:00:00 2001 From: Shane Landrum Date: Mon, 13 Sep 2004 05:48:17 +0000 Subject: [PATCH] 2004-09-13 Shane Landrum * en/Gtk/Accelerator.xml * en/Gtk/Arg.xml * en/Gtk/CallbackInvoker.xml * en/Gtk/CellRendererState.xml * en/Gtk/ColorSelectionButton.xml * en/Gtk/Combo.xml * en/Gtk/Container.xml * en/Gtk/Decorated.xml * en/Gtk/Dialog.xml * en/Gtk/Drag.xml * en/Gtk/FSButton.xml * en/Gtk/FileSelection.xml * en/Gtk/Function.xml * en/Gtk/Gc.xml * en/Gtk/Grab.xml * en/Gtk/HandleBox.xml * en/Gtk/Input.xml * en/Gtk/InputDialog.xml * en/Gtk/Widget.xml * en/Gtk/Window.xml: Miscellaneous class docs. svn path=/trunk/gtk-sharp/; revision=33798 --- doc/ChangeLog | 23 +++++++++++++++++++++++ doc/en/Gtk/Accelerator.xml | 23 ++++++++++++++++------- doc/en/Gtk/Arg.xml | 10 +++++----- doc/en/Gtk/CallbackInvoker.xml | 10 +++++----- doc/en/Gtk/CellRendererState.xml | 4 ++-- doc/en/Gtk/ColorSelectionButton.xml | 22 +++++++++++----------- doc/en/Gtk/Combo.xml | 18 +++++++++--------- doc/en/Gtk/Container.xml | 4 ++-- doc/en/Gtk/Decorated.xml | 26 +++++++++++++------------- doc/en/Gtk/Dialog.xml | 4 ++-- doc/en/Gtk/Drag.xml | 12 ++++++------ doc/en/Gtk/FSButton.xml | 6 +++--- doc/en/Gtk/FileSelection.xml | 14 +++++++------- doc/en/Gtk/Function.xml | 6 +++--- doc/en/Gtk/Gc.xml | 14 +++++++------- doc/en/Gtk/Grab.xml | 22 +++++++++++----------- doc/en/Gtk/HandleBox.xml | 8 ++++---- doc/en/Gtk/Input.xml | 12 ++++++------ doc/en/Gtk/InputDialog.xml | 10 +++++----- doc/en/Gtk/Widget.xml | 4 ++-- doc/en/Gtk/Window.xml | 2 +- 21 files changed, 143 insertions(+), 111 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index ab19ac510..814a0dfb8 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,26 @@ +2004-09-13 Shane Landrum + + * en/Gtk/Accelerator.xml + * en/Gtk/Arg.xml + * en/Gtk/CallbackInvoker.xml + * en/Gtk/CellRendererState.xml + * en/Gtk/ColorSelectionButton.xml + * en/Gtk/Combo.xml + * en/Gtk/Container.xml + * en/Gtk/Decorated.xml + * en/Gtk/Dialog.xml + * en/Gtk/Drag.xml + * en/Gtk/FSButton.xml + * en/Gtk/FileSelection.xml + * en/Gtk/Function.xml + * en/Gtk/Gc.xml + * en/Gtk/Grab.xml + * en/Gtk/HandleBox.xml + * en/Gtk/Input.xml + * en/Gtk/InputDialog.xml + * en/Gtk/Widget.xml + * en/Gtk/Window.xml: Miscellaneous class docs. + 2004-09-13 Shane Landrum * en/Gtk/ClipboardClearFunc.xml diff --git a/doc/en/Gtk/Accelerator.xml b/doc/en/Gtk/Accelerator.xml index 087c4236f..98332d480 100644 --- a/doc/en/Gtk/Accelerator.xml +++ b/doc/en/Gtk/Accelerator.xml @@ -30,11 +30,15 @@ - To be added - a + Determines whether a given keyval and modifier mask constitute + a valid keyboard accelerator. For example, + keyval plus is valid; + this is a "Ctrl+a" accelerator. However, you can't use the + keyval as an accelerator. + a , see for useful values a a - To be added + @@ -48,11 +52,16 @@ - To be added + Converts an accelerator keyval and modifier mask into + a string parseable by . + For example, if you pass in and + , + this function returns "<Control>q". + a a a - To be added + In Gtk+, the return value must be freed by the caller, but not in Gtk#. @@ -61,9 +70,9 @@ - To be added + Basic constructor. a - To be added + diff --git a/doc/en/Gtk/Arg.xml b/doc/en/Gtk/Arg.xml index ddd679e42..78e09538b 100644 --- a/doc/en/Gtk/Arg.xml +++ b/doc/en/Gtk/Arg.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Do not use. + This class's C version is only used internally by gtkobject.c. GLib.Opaque @@ -47,10 +47,10 @@ - To be added + Do not use. a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/CallbackInvoker.xml b/doc/en/Gtk/CallbackInvoker.xml index 03bef753a..882797157 100644 --- a/doc/en/Gtk/CallbackInvoker.xml +++ b/doc/en/Gtk/CallbackInvoker.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 + An class to invoke callback methods; mostly internal. Used by . + Offer an example here. System.ValueType @@ -28,10 +28,10 @@ - To be added + Do not use. a - To be added + Do not use. - \ No newline at end of file + diff --git a/doc/en/Gtk/CellRendererState.xml b/doc/en/Gtk/CellRendererState.xml index 3963d1f5d..c09c452e9 100644 --- a/doc/en/Gtk/CellRendererState.xml +++ b/doc/en/Gtk/CellRendererState.xml @@ -86,7 +86,7 @@ - To be added + The cell currently has the keyboard focus. @@ -105,4 +105,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/ColorSelectionButton.xml b/doc/en/Gtk/ColorSelectionButton.xml index d5f42214d..b638f0cab 100644 --- a/doc/en/Gtk/ColorSelectionButton.xml +++ b/doc/en/Gtk/ColorSelectionButton.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details. - To be added - To be added + For internal use. + A button used in ; not needed by developers. Gtk.Button @@ -41,11 +41,11 @@ - To be added - To be added: an object of type 'Gtk.ColorSelectionDialog' - To be added: an object of type 'IntPtr' - To be added: an object of type 'Gtk.ColorSelectionDialog+ColorSelectionButton' - To be added + Constructor. + A this button belongs to + A , pointer to underlying C color data. + A + @@ -55,10 +55,10 @@ Gtk.ColorSelectionDialog - To be added - To be added: an object of type 'Gtk.ColorSelectionDialog' - To be added + The color selection dialog this button belongs to. + A this button belongs to + - \ No newline at end of file + diff --git a/doc/en/Gtk/Combo.xml b/doc/en/Gtk/Combo.xml index 3e54b5e38..338f5c0fb 100644 --- a/doc/en/Gtk/Combo.xml +++ b/doc/en/Gtk/Combo.xml @@ -204,9 +204,9 @@ class ComboSample Does nothing. ---- REMOVE ---- See EnableArrowKeys. - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + A . + a + @@ -234,10 +234,10 @@ class ComboSample - See EnableArrowKeys - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + See + a + a + @@ -271,7 +271,7 @@ class ComboSample if an empty value is considered valid. if an empty value is considered valid. - To be added + @@ -348,4 +348,4 @@ class ComboSample - \ No newline at end of file + diff --git a/doc/en/Gtk/Container.xml b/doc/en/Gtk/Container.xml index 1b82ba475..2d272ee9f 100644 --- a/doc/en/Gtk/Container.xml +++ b/doc/en/Gtk/Container.xml @@ -584,8 +584,8 @@ - To be added - a + Run a given callback for every object inside this container. + a , whether to include this container's children's children when running the callback. a diff --git a/doc/en/Gtk/Decorated.xml b/doc/en/Gtk/Decorated.xml index 6786d2429..434c2ee75 100644 --- a/doc/en/Gtk/Decorated.xml +++ b/doc/en/Gtk/Decorated.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A decorated window--- that is, a window with a frame. + System.Object @@ -29,9 +29,9 @@ - To be added + Does math to determine the appropriate frame size for the given . a - To be added + @@ -44,9 +44,9 @@ - To be added + Sets up the displayed window, starting from the given . a - To be added + @@ -60,10 +60,10 @@ - To be added + Sets the window title. a a - To be added + @@ -80,13 +80,13 @@ - To be added + Moves this Decorated object to (, ) with the given width and height. a a a a a - To be added + @@ -95,10 +95,10 @@ - To be added + Simple constructor. a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/Dialog.xml b/doc/en/Gtk/Dialog.xml index 6cf237d92..cf894a2c8 100644 --- a/doc/en/Gtk/Dialog.xml +++ b/doc/en/Gtk/Dialog.xml @@ -259,9 +259,9 @@ namespace GtkDialogSample Gtk.VBox - To be added + The that contains other widgets in this dialog. an object of type . - To be added + diff --git a/doc/en/Gtk/Drag.xml b/doc/en/Gtk/Drag.xml index e4163f8a1..cac561071 100644 --- a/doc/en/Gtk/Drag.xml +++ b/doc/en/Gtk/Drag.xml @@ -487,12 +487,12 @@ - To be added + Register a drop site and possibly add default behaviors. a - a - a - a - To be added + a , which types of default drag behavior to use + a , table of targets that can be accepted + a , default behaviors + @@ -517,4 +517,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/FSButton.xml b/doc/en/Gtk/FSButton.xml index 1a36c815e..d115145db 100644 --- a/doc/en/Gtk/FSButton.xml +++ b/doc/en/Gtk/FSButton.xml @@ -8,7 +8,7 @@ neutral - To be added + Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. Helper class for s embedded inside a @@ -51,7 +51,7 @@ The parent - This class is only used to by + This class is only used by s embedded inside a . From the , you can use @@ -61,4 +61,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/FileSelection.xml b/doc/en/Gtk/FileSelection.xml index 9ab62e884..5efd3a873 100644 --- a/doc/en/Gtk/FileSelection.xml +++ b/doc/en/Gtk/FileSelection.xml @@ -245,9 +245,9 @@ class FileSelectionSample System.String - To be added + The filename selected by this . an object of type - To be added + @@ -269,9 +269,9 @@ class FileSelectionSample Gtk.MessageDialog - To be added + The dialog box for confirming actions, if necessary. an object of type - To be added + @@ -347,7 +347,7 @@ class FileSelectionSample To be added an object of type - To be added + @@ -359,7 +359,7 @@ class FileSelectionSample To be added an object of type - To be added + @@ -477,4 +477,4 @@ class FileSelectionSample - \ No newline at end of file + diff --git a/doc/en/Gtk/Function.xml b/doc/en/Gtk/Function.xml index 876a4c015..8d9e06d89 100644 --- a/doc/en/Gtk/Function.xml +++ b/doc/en/Gtk/Function.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 for representing a function with a boolean return value. + System.Delegate @@ -28,4 +28,4 @@ System.Boolean - \ No newline at end of file + diff --git a/doc/en/Gtk/Gc.xml b/doc/en/Gtk/Gc.xml index 63684ef29..8d9350acc 100644 --- a/doc/en/Gtk/Gc.xml +++ b/doc/en/Gtk/Gc.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A shell around ; represents a graphics context. + TODO: add examples. System.Object @@ -31,7 +31,7 @@ Releases the that is passed in. a - To be added + @@ -53,7 +53,7 @@ a a a - To be added + @@ -62,10 +62,10 @@ - To be added + Basic constructor. a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/Grab.xml b/doc/en/Gtk/Grab.xml index 43c347821..8757222b0 100644 --- a/doc/en/Gtk/Grab.xml +++ b/doc/en/Gtk/Grab.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Represents a Grab--- the part of a widget that can be dragged with the mouse. + System.Object @@ -29,9 +29,9 @@ - To be added + Adds a Grab to the widget. a - To be added + @@ -44,9 +44,9 @@ - To be added + Removes a Grab from the widget. a - To be added + @@ -55,9 +55,9 @@ - To be added + Basic constructor. a - To be added + @@ -67,10 +67,10 @@ Gtk.Widget - To be added + Gets the current Widget for this Grab object. a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/HandleBox.xml b/doc/en/Gtk/HandleBox.xml index b4757dcf5..9818f3f90 100644 --- a/doc/en/Gtk/HandleBox.xml +++ b/doc/en/Gtk/HandleBox.xml @@ -176,10 +176,10 @@ - To be added - a + Whether to use the value from the snap_edge property or a value derived from handle_position. + a , true to use the snap_edge property a - To be added + @@ -240,4 +240,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/Input.xml b/doc/en/Gtk/Input.xml index 25386aeec..dd5a0bfb0 100644 --- a/doc/en/Gtk/Input.xml +++ b/doc/en/Gtk/Input.xml @@ -11,7 +11,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. To be added - To be added + System.Object @@ -42,7 +42,7 @@ a , callback data passed to the function. a , the callback function to call with "data" when the input handler is removed, or null. a , a unique id for the event source; to be used with . - To be added + @@ -57,7 +57,7 @@ Removes the function with the given id. a identifying the function to remove, provided by . - To be added + @@ -66,10 +66,10 @@ - To be added + Basic constructor. a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/InputDialog.xml b/doc/en/Gtk/InputDialog.xml index d08fda4bd..1bc1b8e56 100644 --- a/doc/en/Gtk/InputDialog.xml +++ b/doc/en/Gtk/InputDialog.xml @@ -179,9 +179,9 @@ - To be added + The save button in this dialog. a - To be added + @@ -192,10 +192,10 @@ - To be added + The "close window" button in this dialog. a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/Widget.xml b/doc/en/Gtk/Widget.xml index 736a9d483..a58d80429 100644 --- a/doc/en/Gtk/Widget.xml +++ b/doc/en/Gtk/Widget.xml @@ -8,7 +8,7 @@ neutral - Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. + Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details.$ GtkWidget introduces style properties - these are basically object properties that are stored in the style object associated to the . @@ -2125,7 +2125,7 @@ handle focus grabs. - To be added + Fired when a message is received from another application. diff --git a/doc/en/Gtk/Window.xml b/doc/en/Gtk/Window.xml index 8ae70c3de..a4f9b3fb5 100644 --- a/doc/en/Gtk/Window.xml +++ b/doc/en/Gtk/Window.xml @@ -801,7 +801,7 @@ Console.WriteLine("Width: {0}, Height: {1}" , width , height); Using the event you can receive all events targeted at the frame. This method is used by the linux-fb port to implement managed windows, but it could concievably be used by X-programs that want to do their own window decorations. - Note: This is a special-purpose method for the framebuffer port, this caues to GTK# to draw its own window border. For most applications you want instead, which tells the window manager whether to draw the window border. + Note: This is a special-purpose method for the framebuffer port, this causes GTK# to draw its own window border. For most applications you want instead, which tells the window manager whether to draw the window border.