diff --git a/doc/ChangeLog b/doc/ChangeLog index 7d134a35c..47125f7dd 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,10 @@ +2003-09-20 John Luke + + * en/Gnome/AppBar.xml: documented + * en/Gnome/App.xml: half documented + * en/Gnome/Entry.xml: half documented + * en/Gnome/Window.xml: add some info + 2003-09-17 John Luke * en/*/*.xml: run the updater diff --git a/doc/en/Gnome/App.xml b/doc/en/Gnome/App.xml index 290a7dc67..50a23eeb2 100644 --- a/doc/en/Gnome/App.xml +++ b/doc/en/Gnome/App.xml @@ -1,5 +1,5 @@ - + gnome-sharp 0.0.0.0 @@ -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 + The main application widget. + The widget and associated functions provides the easiest way to create an almost complete Gnome# application. Simply create an instance of the widget, append any menus, toolbar(s) and a statusbar, as required (this will probably be done with some functions from the following pages). Then fill in the main contents with a call to and start the main loop (with ). Gtk.Window @@ -43,10 +43,10 @@ To be added - To be added: an object of type 'Gtk.Toolbar' - To be added: an object of type 'Gnome.UIInfo' - To be added: an object of type 'Gtk.AccelGroup' - To be added: an object of type 'IntPtr' + an object of type + an object of type + an object of type + an object of type To be added @@ -61,7 +61,7 @@ To be added - To be added: an object of type 'Gnome.UIInfo' + an object of type To be added @@ -78,9 +78,9 @@ To be added - To be added: an object of type 'Gtk.Toolbar' - To be added: an object of type 'Gnome.UIInfo' - To be added: an object of type 'Gtk.AccelGroup' + an object of type + an object of type + an object of type To be added @@ -99,11 +99,11 @@ To be added - To be added: an object of type 'Gtk.MenuShell' - To be added: an object of type 'Gnome.UIInfo' - To be added: an object of type 'Gtk.AccelGroup' - To be added: an object of type 'bool' - To be added: an object of type 'int' + an object of type + an object of type + an object of type + an object of type + an object of type To be added @@ -119,8 +119,8 @@ To be added - To be added: an object of type 'Gtk.Statusbar' - To be added: an object of type 'Gnome.UIInfo' + an object of type + an object of type To be added @@ -140,12 +140,12 @@ To be added - To be added: an object of type 'Gtk.MenuShell' - To be added: an object of type 'Gnome.UIInfo' - To be added: an object of type 'Gtk.AccelGroup' - To be added: an object of type 'bool' - To be added: an object of type 'int' - To be added: an object of type 'IntPtr' + an object of type + an object of type + an object of type + an object of type + an object of type + an object of type To be added @@ -163,10 +163,10 @@ To be added - To be added: an object of type 'Gtk.Toolbar' - To be added: an object of type 'Gnome.UIInfo' - To be added: an object of type 'Gnome.UIBuilderData' - To be added: an object of type 'Gtk.AccelGroup' + an object of type + an object of type + an object of type + an object of type To be added @@ -183,10 +183,10 @@ To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'string' - To be added: an object of type 'int' - To be added: an object of type 'Gtk.Widget' + an object of type + an object of type + an object of type + an object of type To be added @@ -201,8 +201,8 @@ To be added - To be added: an object of type 'string' - To be added: an object of type 'string' + an object of type + an object of type To be added @@ -218,8 +218,8 @@ To be added - To be added: an object of type 'Gnome.AppBar' - To be added: an object of type 'Gnome.UIInfo' + an object of type + an object of type To be added @@ -239,12 +239,12 @@ To be added - To be added: an object of type 'Gtk.MenuShell' - To be added: an object of type 'Gnome.UIInfo' - To be added: an object of type 'Gnome.UIBuilderData' - To be added: an object of type 'Gtk.AccelGroup' - To be added: an object of type 'bool' - To be added: an object of type 'int' + an object of type + an object of type + an object of type + an object of type + an object of type + an object of type To be added @@ -260,8 +260,8 @@ To be added - To be added: an object of type 'Gnome.UIInfo' - To be added: an object of type 'IntPtr' + an object of type + an object of type To be added @@ -279,10 +279,10 @@ To be added - To be added: an object of type 'Gnome.UIInfo' - To be added: an object of type 'Gtk.CallbackMarshal' - To be added: an object of type 'IntPtr' - To be added: an object of type 'Gtk.DestroyNotify' + an object of type + an object of type + an object of type + an object of type To be added @@ -299,9 +299,9 @@ To be added - To be added: an object of type 'string' - To be added: an object of type 'int' - To be added: an object of type 'int' + an object of type + an object of type + an object of type To be added @@ -316,7 +316,7 @@ To be added - To be added: an object of type 'Gnome.UIInfo' + an object of type To be added @@ -331,7 +331,7 @@ To be added - To be added: an object of type 'Gnome.UIInfo' + an object of type To be added @@ -347,8 +347,8 @@ To be added - To be added: an object of type 'Gnome.UIInfo' - To be added: an object of type 'IntPtr' + an object of type + an object of type To be added @@ -364,8 +364,8 @@ To be added - To be added: an object of type 'string' - To be added: an object of type 'string' + an object of type + an object of type To be added @@ -381,8 +381,8 @@ To be added - To be added: an object of type 'string' - To be added: an object of type 'int' + an object of type + an object of type To be added @@ -398,8 +398,8 @@ To be added - To be added: an object of type 'Gnome.UIInfo' - To be added: an object of type 'Gnome.UIBuilderData' + an object of type + an object of type To be added @@ -416,9 +416,9 @@ To be added - To be added: an object of type 'string' - To be added: an object of type 'Gnome.UIInfo' - To be added: an object of type 'Gnome.UIBuilderData' + an object of type + an object of type + an object of type To be added @@ -434,8 +434,8 @@ To be added - To be added: an object of type 'string' - To be added: an object of type 'Gnome.UIInfo' + an object of type + an object of type To be added @@ -450,10 +450,10 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'Gtk.Widget' - To be added + Sets the of the application window, but uses as its container. + an object of type + an object of type + @@ -468,8 +468,8 @@ To be added - To be added: an object of type 'Gnome.UIInfo' - To be added: an object of type 'Gnome.UIBuilderData' + an object of type + an object of type To be added @@ -488,11 +488,11 @@ To be added - To be added: an object of type 'string' - To be added: an object of type 'Gnome.UIInfo' - To be added: an object of type 'Gtk.CallbackMarshal' - To be added: an object of type 'IntPtr' - To be added: an object of type 'Gtk.DestroyNotify' + an object of type + an object of type + an object of type + an object of type + an object of type To be added @@ -507,7 +507,7 @@ To be added - To be added: an object of type 'Gnome.UIInfo' + an object of type To be added @@ -525,10 +525,10 @@ To be added - To be added: an object of type 'Gnome.UIInfo' - To be added: an object of type 'Gtk.CallbackMarshal' - To be added: an object of type 'IntPtr' - To be added: an object of type 'Gtk.DestroyNotify' + an object of type + an object of type + an object of type + an object of type To be added @@ -542,8 +542,8 @@ - To be added - To be added: an object of type 'bool' + Specify whether should automatically save the dock's layout configuration via gnome-config whenever it changes or not. + an object of type To be added @@ -560,9 +560,9 @@ To be added - To be added: an object of type 'string' - To be added: an object of type 'Gnome.UIInfo' - To be added: an object of type 'IntPtr' + an object of type + an object of type + an object of type To be added @@ -588,7 +588,7 @@ Internal constructor Pointer to the C object. - An instance of App, wrapping the C object. + An instance of , wrapping the C object. This is an internal constructor, and should not be used by user code. @@ -603,11 +603,11 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added: an object of type 'Gnome.App' - To be added + Creates a new instance. + an object of type + an object of type + an object of type + @@ -616,9 +616,9 @@ - To be added - To be added: an object of type 'Gnome.App' - To be added + Internal constructor + an object of type + This is a constructor used by derivative types of that would have their own GLib type assigned to it. This is not typically used by C# code. @@ -628,8 +628,8 @@ System.UInt32 - The GLib Type for Gnome.App - The GLib Type for the Gnome.App class. + The for + The for the class. @@ -641,10 +641,10 @@ - To be added - To be added: an object of type 'Gtk.Toolbar' - To be added: an object of type 'Gtk.Toolbar' - To be added + Sets the main toolbar of the application window. + an object of type + an object of type + @@ -655,10 +655,10 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'Gtk.Widget' - To be added + Sets the content area of the main window of . + an object of type + an object of type + @@ -669,10 +669,10 @@ - To be added - To be added: an object of type 'Gtk.MenuBar' - To be added: an object of type 'Gtk.MenuBar' - To be added + Sets the of the application window. + an object of type + an object of type + @@ -683,10 +683,10 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'Gtk.Widget' - To be added + Sets the status bar of the application window. + an object of type + an object of type + @@ -699,7 +699,7 @@ Internal constructor GLib type for the type - Creates a new instance of App, using the GLib-provided type + Creates a new instance of , using the GLib-provided type This is a constructor used by derivative types of that would have their own GLib type assigned to it. This is not typically used by C# code. diff --git a/doc/en/Gnome/AppBar.xml b/doc/en/Gnome/AppBar.xml index bc11a44b1..4809d9544 100644 --- a/doc/en/Gnome/AppBar.xml +++ b/doc/en/Gnome/AppBar.xml @@ -1,5 +1,5 @@ - + gnome-sharp 0.0.0.0 @@ -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 + An application status and progress widget. + An widget sits (usually) at the bottom of an application window and contains a (for indicating time consuming tasks and their completion status) and/or a for sending short one-line message to the user. It is also possible (in theory) for the user to edit the contents of the status bar, should the application developer choose to allow that. However, note that this is not really working in the present implementation, so developers are recommended to avoid using interactive s and use proper editable widgets instead. Gtk.HBox @@ -37,8 +37,8 @@ - To be added - To be added + Remove all status messages from , and display default status message (if present). + @@ -49,8 +49,8 @@ - To be added - To be added + Remove current status message, and display previous status message, if any. + It is fine to call this with an empty stack. @@ -61,8 +61,8 @@ - To be added - To be added + Remove any prompt from the . + @@ -75,9 +75,9 @@ - To be added - To be added: an object of type 'string' - To be added + Push a new status message onto the stack and display it. + an object of type + @@ -88,8 +88,8 @@ - To be added - To be added + Refresh the by redrawing the item on the top of the stack, or the default value if the stack is empty. + Useful to force the message from a previous call to to disappear. @@ -103,10 +103,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'bool' - To be added + Put a prompt in the appbar and wait for a response. + an object of type + an object of type + When the user responds or cancels, a signal is emitted. @@ -120,7 +120,7 @@ To be added - To be added: an object of type 'string' + an object of type To be added @@ -162,12 +162,12 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added: an object of type 'Gnome.PreferencesType' - To be added: an object of type 'Gnome.AppBar' - To be added + Creates a new instance. + an object of type + an object of type + an object of type + an object of type + @@ -176,9 +176,9 @@ - To be added - To be added: an object of type 'Gnome.AppBar' - To be added + Creates a new instance. + an object of type + @@ -188,8 +188,8 @@ System.UInt32 - The GLib Type for Gnome.AppBar - The GLib Type for the Gnome.AppBar class. + The for + The for the class. @@ -200,9 +200,9 @@ System.String - To be added - To be added: an object of type 'string' - To be added + Get the response to the prompt, if any. + an object of type + @@ -212,9 +212,9 @@ Gtk.Widget - To be added - To be added: an object of type 'Gtk.Widget' - To be added + Retrieves the widget. + an object of type + @@ -224,9 +224,9 @@ Gtk.ProgressBar - To be added - To be added: an object of type 'Gtk.ProgressBar' - To be added + Retrieves the widget for further manipulation. + an object of type + @@ -237,10 +237,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + What to show when showing nothing else is on the stack; defaults to the empty string. + an object of type + an object of type + @@ -251,10 +251,10 @@ - To be added - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added + Sets progress bar to . + an object of type + an object of type + @@ -264,9 +264,9 @@ Gnome.PreferencesType - To be added - To be added: an object of type 'Gnome.PreferencesType' - To be added + Whether or not the user can edit the text in the portion of a instance. + an object of type + @@ -276,9 +276,9 @@ System.Boolean - To be added - To be added: an object of type 'bool' - To be added + Whether or not the contains a . + an object of type + @@ -288,9 +288,9 @@ System.Boolean - To be added - To be added: an object of type 'bool' - To be added + Whether or not the contains a . + an object of type + @@ -301,8 +301,8 @@ - To be added - To be added + Emitted when the prompt is cleared. + @@ -313,8 +313,8 @@ - To be added - To be added + Emitted when the user responds to an that is interactive. + @@ -327,7 +327,7 @@ Internal constructor GLib type for the type - Creates a new instance of AppBar, using the GLib-provided type + Creates a new instance of , using the GLib-provided type This is a constructor used by derivative types of that would have their own GLib type assigned to it. This is not typically used by C# code. diff --git a/doc/en/Gnome/Entry.xml b/doc/en/Gnome/Entry.xml index 69ac57410..942604e84 100644 --- a/doc/en/Gnome/Entry.xml +++ b/doc/en/Gnome/Entry.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 single-line text entry widget. + Gtk.Combo @@ -46,10 +46,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Select the text between and . + an object of type + an object of type + @@ -63,11 +63,11 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'string' - To be added + Gets the text between and . + an object of type + an object of type + an object of type + @@ -81,10 +81,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Delete the text between and . + an object of type + an object of type + @@ -107,8 +107,8 @@ - To be added - To be added + Delete the text contained in the selection. + @@ -122,11 +122,11 @@ - To be added - To be added: an object of type 'int&' - To be added: an object of type 'int&' - To be added: an object of type 'bool' - To be added + Determines the position of the beggining and end of a selection. + an object of type + an object of type + an object of type + @@ -164,10 +164,10 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'string' - To be added + Adds a history item of the given text to the head of the history list. + an object of type + an object of type + If save is , the history item will be saved in the config file (assuming that is not ). Duplicates are automatically removed from the history list. The history list is automatically saved if needed. @@ -181,7 +181,7 @@ To be added - To be added: an object of type 'string' + an object of type To be added @@ -193,8 +193,8 @@ - To be added - To be added + Clears the history. + @@ -208,10 +208,10 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'string' - To be added + Adds a history item of the given text to the tail of the history list. + an object of type + an object of type + If save is , the history item will be saved in the config file (assuming that is not ). Duplicates are automatically removed from the history list. The history list is automatically saved if needed. @@ -250,10 +250,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gnome.Entry' - To be added + Creates a new instance. + an object of type + an object of type + @@ -262,9 +262,9 @@ - To be added - To be added: an object of type 'Gnome.Entry' - To be added + Internal constructor + an object of type + This is a constructor used by derivative types of that would have their own GLib type assigned to it. This is not typically used by C# code. @@ -274,8 +274,8 @@ System.UInt32 - The GLib Type for Gnome.Entry - The GLib Type for the Gnome.Entry class. + The for + The for the class. @@ -287,10 +287,10 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Whether the is editable by the user. + an object of type + an object of type + @@ -301,10 +301,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + The position of the cursor in the entry. + an object of type + an object of type + @@ -315,10 +315,10 @@ - To be added - To be added: an object of type 'uint' - To be added: an object of type 'uint' - To be added + Internal limit on number of history items saved to the config file. + an object of type + an object of type + Zero is an acceptable value, but the same thing is accomplished by setting the to . @@ -328,9 +328,9 @@ Gtk.Entry - To be added - To be added: an object of type 'Gtk.Entry' - To be added + The internal of the . + an object of type + @@ -341,10 +341,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + The history id of the widget. + an object of type + an object of type + @@ -355,8 +355,8 @@ - To be added - To be added + Emitted when text is inserted into the entry. + @@ -367,8 +367,8 @@ - To be added - To be added + Emitted when text is deleted from the entry. + @@ -379,8 +379,8 @@ - To be added - To be added + Emitted when the text is changed. + @@ -391,8 +391,8 @@ - To be added - To be added + Emitted when the is activated. + This usually occurs when the user presses the "enter" or "return" key. @@ -407,8 +407,8 @@ To be added - To be added: an object of type 'string' - To be added: an object of type 'int&' + an object of type + an object of type To be added @@ -422,7 +422,7 @@ Internal constructor GLib type for the type - Creates a new instance of Entry, using the GLib-provided type + Creates a new instance of , using the GLib-provided type This is a constructor used by derivative types of that would have their own GLib type assigned to it. This is not typically used by C# code. diff --git a/doc/en/Gnome/Window.xml b/doc/en/Gnome/Window.xml index 70e73fa16..b28d98340 100644 --- a/doc/en/Gnome/Window.xml +++ b/doc/en/Gnome/Window.xml @@ -1,5 +1,5 @@ - + gnome-sharp @@ -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 + Convenience functions for setting window attributes. + This module is a convenience wrapper for some similar functions in Gtk. This allows all Gnome applications to have a consistent way of setting their window and dialog titles. It is possible that in the future, a configurable way of setting window titles may be added. System.Object @@ -31,12 +31,15 @@ - To be added + Set the title of a toplevel window. a a a a - To be added + + This is done by appending the window-specific name (less the extension, if any) to the application name. So it appears as "<appname> : <docname>". + The parameters to this function are appropriate in that it identifies application windows as containing certain files that are being worked on at the time (for example, a word processor file, a spreadsheet or an image). + diff --git a/doc/makefile b/doc/makefile index 819f780a9..2837bd600 100644 --- a/doc/makefile +++ b/doc/makefile @@ -1,8 +1,8 @@ prefix=/usr BROWSER=../../monodoc/browser/browser.exe ASSEMBLER=../../monodoc/browser/assembler.exe -GENERATOR=../../monodoc/generator/generator.exe UPDATER=../../monodoc/generator/updater.exe +DIRS=glib pango atk gdk gtk glade art gnome gda gnomedb gconf/GConf gconf/GConf.PropertyEditors rsvg all: gtk-sharp-docs.zip gtk-sharp-docs.tree @@ -12,6 +12,11 @@ b: gtk-sharp-docs.zip gtk-sharp-docs.tree: en/*/*.xml mono $(ASSEMBLER) --ecma en -o gtk-sharp-docs +update: + for i in $(DIRS); do \ + mono $(UPDATER) ../$$i/*.dll -o ./en -f || exit 1; \ + done + install: gtk-sharp-docs.zip gtk-sharp-docs.tree install -m 644 gtk-sharp-docs.zip gtk-sharp-docs.tree `monodoc --get-sourcesdir` install -m 644 gtk-sharp-docs.source `monodoc --get-sourcesdir`