diff --git a/doc/ChangeLog b/doc/ChangeLog index 202c24611..757fb2bbb 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,14 +1,10 @@ -2003-07-16 Duncan Mak - - * All enumerations: Fixed the TypeSignature and MemberSignature in all - documentation files for Enumerations. - 2003-07-16 John Luke * en/Gtk/CellRendererText.xml: documented, except one event and method * en/Gtk/CellRendererToggle.xml: documented * en/Gtk/CellRendererPixbuf.xml: documented * en/GConf/Client.xml: documented + * en/Gnome/About.xml: documented 2003-07-15 Duncan Mak diff --git a/doc/en/Gnome/About.xml b/doc/en/Gnome/About.xml index 64b1704b7..17e7b28f2 100644 --- a/doc/en/Gnome/About.xml +++ b/doc/en/Gnome/About.xml @@ -1,5 +1,5 @@ - + gnome-sharp 0.0.0.0 @@ -7,8 +7,77 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Display author, documenter and translator credits for an application. + + The widget is used as the standard way of displaying credits in an application. + Typically, it will be called when a user selects the About... option from the Help menu. + With one simple function call, the application can then display all of the appropriate information. + Compile the following example with: mcs GnomeAboutSample.cs -r gtk-sharp -r gnome-sharp -r gdk-sharp + + + +using System; +using Gtk; +using GtkSharp; +using Gnome; + +class GnomeAboutSample +{ + About ab; + Program program; + + static void Main(string[] args) + { + new GnomeAboutSample(args); + } + + GnomeAboutSample (string[] args) + { + program = + new Program("GnomeAboutSample", "0.1", Gnome.Modules.UI , args); + + App app = new App("sample", "sample"); + app.SetDefaultSize (250, 250); + app.DeleteEvent += new DeleteEventHandler (on_app_delete); + + Button btn = new Button ("Show About"); + btn.Clicked += new EventHandler (on_btn_clicked); + app.Contents = btn; + + app.ShowAll(); + program.Run(); + } + + private void on_btn_clicked (object obj, EventArgs args) + { + string[] authors = {"The Author", "Co-Author"}; + string[] documenters = {"The Documenters", "Another Documenter"}; + Gdk.Pixbuf pixbuf = new Gdk.Pixbuf ("MonoIcon.png"); + + ab = new Gnome.About ("GnomeAboutTest", "0.1", "Copyright", "Comments", + authors, documenters, "translator", pixbuf); + ab.Close += new EventHandler (OnAboutClose); + ab.Response += new ResponseHandler (OnAboutResponse); + ab.Run (); + } + + private void OnAboutClose (object o, EventArgs args) + { + Console.WriteLine ("Close Event"); + } + + private void OnAboutResponse(object o, ResponseArgs args) + { + Console.WriteLine (args.ResponseId); + } + + private void on_app_delete (object o, DeleteEventArgs args) + { + program.Quit (); + } +} + + Gtk.Dialog @@ -46,16 +115,16 @@ - 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 'string' - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added: an object of type 'Gdk.Pixbuf' - To be added + Construct a credits box for an . + an object of type + an object of type + an object of type + an object of type + an object of type + an object of type + an object of type + an object of type + The array cannot be empty. @@ -101,17 +170,17 @@ - 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 'string' - To be added: an object of type 'string' - To be added: an object of type 'string []' - To be added: an object of type 'string []' - To be added: an object of type 'string' - To be added: an object of type 'Gdk.Pixbuf' - To be added: an object of type 'Gnome.About' - To be added + Creates a new instance of . + an object of type + an object of type + an object of type + an object of type + an object of type + an object of type + an object of type + an object of type + an object of type + @@ -120,9 +189,9 @@ - To be added - To be added: an object of type 'Gnome.About' - To be added + Creates a new instance of + an object of type + This is an internal constructor, and should not be used by user code. @@ -132,8 +201,8 @@ System.UInt32 - The GLib Type for Gnome.About - The GLib Type for the Gnome.About class. + The for + The for the class. @@ -147,10 +216,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + The name of the application. + an object of type + an object of type + @@ -163,10 +232,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + The translator for the current locale. + an object of type + an object of type + @@ -179,10 +248,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + The copyright statement of the application. + an object of type + an object of type + @@ -195,10 +264,10 @@ - To be added - To be added: an object of type 'Gdk.Pixbuf' - To be added: an object of type 'Gdk.Pixbuf' - To be added + The logo for the application. + an object of type + an object of type + @@ -211,10 +280,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + The version string of the application. + an object of type + an object of type + @@ -227,10 +296,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + A short miscellaneous string. + an object of type + an object of type + @@ -250,4 +319,4 @@ - \ No newline at end of file +