diff --git a/doc/ChangeLog b/doc/ChangeLog index c019ce15e..e77a616bc 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,7 +1,11 @@ 2003-12-08 John Luke * en/Art/Rgba.xml: update - * en/Gnome/FileEntry.xml: documented + * en/Gnome/FileEntry.xml: + * en/Gnome/Druid.xml: + * en/Gnome/DruidPage.xml: + * en/Gnome/DruidPageEdge.xml: + * en/Gnome/DruidPageStandard.xml: documented 2003-12-04 John Luke diff --git a/doc/en/Gnome/Druid.xml b/doc/en/Gnome/Druid.xml index 443b8784a..961169995 100644 --- a/doc/en/Gnome/Druid.xml +++ b/doc/en/Gnome/Druid.xml @@ -1,16 +1,17 @@ - + gnome-sharp - + + 0.0.0.0 neutral Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Widget for sequentially stepping through some pages. + Gtk.Container @@ -22,9 +23,6 @@ GLib.IWrapper - - GLib.IWrapper - System.IDisposable @@ -41,9 +39,9 @@ - To be added - To be added: an object of type 'Gnome.DruidPage' - To be added + This will prepend a into the internal list of pages of the druid. + an object of type + Since GnomeDruid is just a container, you will need to also call on the page, otherwise the page will not be shown. @@ -57,10 +55,10 @@ - To be added - To be added: an object of type 'Gnome.DruidPage' - To be added: an object of type 'Gnome.DruidPage' - To be added + This will insert after into the list of internal pages of the druid. + an object of type + an object of type + If is not present in the list or , will be prepended to the list. Since is just a container, you will need to also call on the page, otherwise the page will not be shown. @@ -76,12 +74,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 'bool' - To be added: an object of type 'bool' - To be added + Sets the sensitivity of of the control-buttons for the . + an object of type + an object of type + an object of type + an object of type + If the variables are , then they will be clickable. This function is used primarily by the actual widgets. @@ -94,9 +92,9 @@ - To be added - To be added: an object of type 'Gnome.DruidPage' - To be added + This will append onto the end of the internal list of the druid. + an object of type + Since GnomeDruid is just a container, you will need to also call on the page, otherwise the page will not be shown. @@ -112,12 +110,12 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.Window' - To be added: an object of type 'bool' - To be added: an object of type 'Gtk.Widget' - To be added + Creates a new toplevel window with the title of (which can be ) and a parent of (which also can be ). + an object of type + an object of type + an object of type + an object of type + The druid will be placed inside this window. The window and the druid will both be shown. If you need the window widget pointer you can optionally get it through the last argument. When the druid gets destroyed, so will the window that is created here. @@ -154,9 +152,9 @@ - To be added - To be added: an object of type 'Gnome.Druid' - To be added + Default constructor + an object of type + @@ -170,13 +168,13 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.Window' - To be added: an object of type 'bool' - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'Gnome.Druid' - To be added + Creates a new instance. + an object of type + an object of type + an object of type + an object of type + an object of type + @@ -186,8 +184,8 @@ System.UInt32 - The GLib Type for Gnome.Druid - The GLib Type for the Gnome.Druid class. + The for + The for the class. @@ -197,12 +195,13 @@ Gnome.DruidPage - + + - To be added - To be added: an object of type 'Gnome.DruidPage' - To be added: an object of type 'Gnome.DruidPage' - To be added + This will make the currently showing page in the druid. + an object of type + an object of type + must already be in the druid. @@ -211,12 +210,13 @@ System.Boolean - + + - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Used to specify if the druid is currently showing the last page of the sequence (and hence should display "Finish", rather than "Next"). + an object of type + an object of type + @@ -225,12 +225,13 @@ System.Boolean - + + - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Sets the "Help" button on the druid to be visible in the lower left corner of the widget, if . + an object of type + an object of type + @@ -241,8 +242,8 @@ - To be added - To be added + Emitted when the "Help" button of the druid is clicked. + @@ -253,8 +254,8 @@ - To be added - To be added + Emitted when the "Cancel" button of the druid is clicked. + @@ -274,4 +275,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gnome/DruidPage.xml b/doc/en/Gnome/DruidPage.xml index 6aa99f356..b87152e41 100644 --- a/doc/en/Gnome/DruidPage.xml +++ b/doc/en/Gnome/DruidPage.xml @@ -1,16 +1,17 @@ - + gnome-sharp - + + 0.0.0.0 neutral Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A widget representing a single page inside a druid. + The functions in this page are mostly only for the information of developers -- they should never need to call them directly. Typically, a druid will connect to the various signals described here as a way of controlling the behaviour of druids that do not just proceed in a front-to-back fashion (for example, where the subsequent pages depend upon the choice made at some point). Gtk.Bin @@ -22,9 +23,6 @@ GLib.IWrapper - - GLib.IWrapper - System.IDisposable @@ -39,7 +37,7 @@ - To be added + Emit the event. To be added @@ -51,9 +49,9 @@ - To be added - To be added: an object of type 'bool' - To be added + Emit the event. + an object of type + It is called by gnome-druid exclusively. It is expected that non-linear Druids will override this signal and return if it handles changing pages. @@ -64,9 +62,9 @@ - To be added - To be added: an object of type 'bool' - To be added + Emit the event. + an object of type + It is called by gnome-druid exclusively. It is expected that a Druid will override this signal and return if it does not want to exit. @@ -77,8 +75,8 @@ - To be added - To be added + Emit the event. + It is called by exclusively. This function is called immediately prior to a druid page being shown so that it can "prepare" for display. @@ -89,9 +87,9 @@ - To be added - To be added: an object of type 'bool' - To be added + Emit the event. + an object of type + It is called by exclusively. It is expected that non-linear Druids will override this signal and return if it handles changing pages. @@ -128,9 +126,9 @@ - To be added - To be added: an object of type 'Gnome.DruidPage' - To be added + Default constructor + an object of type + @@ -140,8 +138,8 @@ System.UInt32 - The GLib Type for Gnome.DruidPage - The GLib Type for the Gnome.DruidPage class. + The for + The for the class. @@ -153,8 +151,8 @@ - To be added - To be added + Emitted when the "Cancel" button of the page is clicked. + @@ -165,8 +163,8 @@ - To be added - To be added + Emitted when the "Back" button of the page is clicked. + @@ -177,8 +175,8 @@ - To be added - To be added + Emitted when the "Finish" button of the page is clicked. + @@ -189,8 +187,8 @@ - To be added - To be added + Emitted when the "Next" button of the page is clicked. + @@ -201,8 +199,8 @@ - To be added - To be added + Emitted immediately prior to a druid page being shown. + @@ -222,4 +220,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gnome/DruidPageEdge.xml b/doc/en/Gnome/DruidPageEdge.xml index 9dd31d285..d0d07f7d9 100644 --- a/doc/en/Gnome/DruidPageEdge.xml +++ b/doc/en/Gnome/DruidPageEdge.xml @@ -1,16 +1,24 @@ - + gnome-sharp - + + 0.0.0.0 neutral Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A widget used to implement first and last pages in the sequence of the . + + + A druid can be thought of as having a page that starts the sequence, one or more pages that end the sequences (there can be multiple end pages if the flow of pages diverges at some point) and some pages that are in between the start and end pages. + + + The widget is for the first and last pages in the sequence of pages in the . Pages in the "middle" of a sequence should use . + + Gnome.DruidPage @@ -22,9 +30,6 @@ GLib.IWrapper - - GLib.IWrapper - System.IDisposable @@ -41,10 +46,10 @@ - To be added - To be added: an object of type 'Gnome.EdgePosition' - To be added: an object of type 'Gnome.DruidPageEdge' - To be added + Creates a new widget. + an object of type + an object of type + The internal canvas is created in an antialiased mode. @@ -63,15 +68,15 @@ - To be added - To be added: an object of type 'Gnome.EdgePosition' - To be added: an object of type 'bool' - 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 'Gdk.Pixbuf' - To be added: an object of type 'Gdk.Pixbuf' - To be added + Constructs a new widget. + 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 + @@ -110,10 +115,10 @@ - To be added - To be added: an object of type 'Gnome.EdgePosition' - To be added: an object of type 'Gnome.DruidPageEdge' - To be added + Creates a new widget. + an object of type + an object of type + @@ -130,16 +135,16 @@ - To be added - To be added: an object of type 'Gnome.EdgePosition' - To be added: an object of type 'bool' - 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 'Gdk.Pixbuf' - To be added: an object of type 'Gdk.Pixbuf' - To be added: an object of type 'Gnome.DruidPageEdge' - To be added + Creates a new widget. + 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 + @@ -148,9 +153,9 @@ - To be added - To be added: an object of type 'Gnome.DruidPageEdge' - To be added + Internal constructor + an object of type + This is an internal constructor, and should not be used by user code. @@ -160,8 +165,8 @@ System.UInt32 - The GLib Type for Gnome.DruidPageEdge - The GLib Type for the Gnome.DruidPageEdge class. + The for + The for the class. @@ -171,12 +176,13 @@ Gdk.Color - + + - To be added - To be added: an object of type 'Gdk.Color' - To be added: an object of type 'Gdk.Color' - To be added + This will set the background color. + an object of type + an object of type + @@ -185,12 +191,13 @@ System.String - + + - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + The title text of the page. + an object of type + an object of type + @@ -199,12 +206,13 @@ Gdk.Color - + + - To be added - To be added: an object of type 'Gdk.Color' - To be added: an object of type 'Gdk.Color' - To be added + The color of the background in the main text area of the page. + an object of type + an object of type + @@ -213,12 +221,13 @@ Gdk.Color - + + - To be added - To be added: an object of type 'Gdk.Color' - To be added: an object of type 'Gdk.Color' - To be added + The color of the text in the body of the druid page. + an object of type + an object of type + @@ -227,12 +236,13 @@ Gdk.Color - + + - To be added - To be added: an object of type 'Gdk.Color' - To be added: an object of type 'Gdk.Color' - To be added + The color behind the logo of the druid page. + an object of type + an object of type + @@ -241,12 +251,13 @@ Gdk.Pixbuf - + + - To be added - To be added: an object of type 'Gdk.Pixbuf' - To be added: an object of type 'Gdk.Pixbuf' - To be added + Sets a as the watermark on the left strip on the druid. + an object of type + an object of type + If , it is reset to the normal color. @@ -255,12 +266,13 @@ Gdk.Pixbuf - + + - To be added - To be added: an object of type 'Gdk.Pixbuf' - To be added: an object of type 'Gdk.Pixbuf' - To be added + Sets a as the watermark on the top strip on the druid. + an object of type + an object of type + If , it is reset to the normal color. @@ -269,12 +281,13 @@ Gdk.Color - + + - To be added - To be added: an object of type 'Gdk.Color' - To be added: an object of type 'Gdk.Color' - To be added + The color of the title text on the current page. + an object of type + an object of type + @@ -283,12 +296,13 @@ Gdk.Pixbuf - + + - To be added - To be added: an object of type 'Gdk.Pixbuf' - To be added: an object of type 'Gdk.Pixbuf' - To be added + Sets a as the logo in the top right corner. + an object of type + an object of type + If , then no logo will be displayed. @@ -297,12 +311,13 @@ System.String - + + - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + The contents of the text portion of the druid page. + an object of type + an object of type + @@ -322,4 +337,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gnome/DruidPageStandard.xml b/doc/en/Gnome/DruidPageStandard.xml index ea3576780..28acd4664 100644 --- a/doc/en/Gnome/DruidPageStandard.xml +++ b/doc/en/Gnome/DruidPageStandard.xml @@ -1,16 +1,25 @@ - + gnome-sharp - + + 0.0.0.0 neutral Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A widget used to implement the middle pages in a sequence. + + + + This widget provides similar functionality to that in GnomeDruidPageEdge. It is used for pages that are not the initial or terminal pages of a druid. + + + The main difference between an edge and a standard druid page (in a display sense) is that standard pages do not have a left-side watermark and the body of the contents section is a bit more arbitrary (it is a ), rather than just displaying text (which is the common case for edge pages). + + Gnome.DruidPage @@ -22,9 +31,6 @@ GLib.IWrapper - - GLib.IWrapper - System.IDisposable @@ -43,11 +49,18 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'string' - To be added + Convenience function to add a to the vbox. + an object of type + an object of type + an object of type + + + This function creates a new contents section that has the text followed by the widget and then the text, all stacked vertically from top to bottom. + + + The widget could be something like a set of radio checkbuttons requesting a choice from the user. + + @@ -84,9 +97,9 @@ - To be added - To be added: an object of type 'Gnome.DruidPageStandard' - To be added + Default constructor + an object of type + @@ -99,12 +112,12 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gdk.Pixbuf' - To be added: an object of type 'Gdk.Pixbuf' - To be added: an object of type 'Gnome.DruidPageStandard' - To be added + Creates a new instance. + an object of type + an object of type + an object of type + an object of type + @@ -114,8 +127,8 @@ System.UInt32 - The GLib Type for Gnome.DruidPageStandard - The GLib Type for the Gnome.DruidPageStandard class. + The for + The for the class. @@ -125,12 +138,13 @@ Gdk.Color - + + - To be added - To be added: an object of type 'Gdk.Color' - To be added: an object of type 'Gdk.Color' - To be added + The color of the main contents section background. + an object of type + an object of type + @@ -139,12 +153,13 @@ Gdk.Color - + + - To be added - To be added: an object of type 'Gdk.Color' - To be added: an object of type 'Gdk.Color' - To be added + The title text to the specified color. + an object of type + an object of type + @@ -153,12 +168,13 @@ Gdk.Color - + + - To be added - To be added: an object of type 'Gdk.Color' - To be added: an object of type 'Gdk.Color' - To be added + The background of the logo. + an object of type + an object of type + @@ -167,11 +183,12 @@ System.Boolean - + + To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' + an object of type + an object of type To be added @@ -181,12 +198,13 @@ Gdk.Pixbuf - + + - To be added - To be added: an object of type 'Gdk.Pixbuf' - To be added: an object of type 'Gdk.Pixbuf' - To be added + Sets a as the logo in the top right corner. + an object of type + an object of type + If , then no logo will be displayed. @@ -195,12 +213,13 @@ Gdk.Color - + + - To be added - To be added: an object of type 'Gdk.Color' - To be added: an object of type 'Gdk.Color' - To be added + The title text to the specified color. + an object of type + an object of type + @@ -209,12 +228,13 @@ Gdk.Color - + + - To be added - To be added: an object of type 'Gdk.Color' - To be added: an object of type 'Gdk.Color' - To be added + The background color of the logo + an object of type + an object of type + @@ -223,12 +243,13 @@ Gdk.Color - + + - To be added - To be added: an object of type 'Gdk.Color' - To be added: an object of type 'Gdk.Color' - To be added + The background color of the top section of the druid page. + an object of type + an object of type + @@ -237,12 +258,13 @@ System.String - + + - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + The title of the druid page. + an object of type + an object of type + @@ -251,12 +273,13 @@ Gdk.Color - + + - To be added - To be added: an object of type 'Gdk.Color' - To be added: an object of type 'Gdk.Color' - To be added + The background color of the top section of the druid page. + an object of type + an object of type + @@ -265,12 +288,13 @@ Gdk.Pixbuf - + + - To be added - To be added: an object of type 'Gdk.Pixbuf' - To be added: an object of type 'Gdk.Pixbuf' - To be added + Sets a as the watermark on the top strip on the druid. + an object of type + an object of type + If , it is reset to the normal color. @@ -279,11 +303,12 @@ System.Boolean - + + To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' + an object of type + an object of type To be added @@ -293,11 +318,12 @@ System.Boolean - + + To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' + an object of type + an object of type To be added @@ -318,4 +344,4 @@ - \ No newline at end of file +