* en/Gnome/Druid.xml:

* en/Gnome/DruidPage.xml:
	* en/Gnome/DruidPageEdge.xml:
	* en/Gnome/DruidPageStandard.xml: documented

svn path=/trunk/gtk-sharp/; revision=20912
This commit is contained in:
John Luke 2003-12-09 01:57:59 +00:00
parent 2b16d16574
commit 2e339f93a1
5 changed files with 314 additions and 270 deletions

View File

@ -1,7 +1,11 @@
2003-12-08 John Luke <jluke@cfl.rr.com>
* 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 <jluke@cfl.rr.com>

View File

@ -1,16 +1,17 @@
<Type Name="Druid" FullName="Gnome.Druid">
<TypeSignature Language="C#" Value="public class Druid : Gtk.Container, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class Druid : Gtk.Container, Implementor, IWrapper, IDisposable" Maintainer="John Luke" />
<AssemblyInfo>
<AssemblyName>gnome-sharp</AssemblyName>
<AssemblyPublicKey></AssemblyPublicKey>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyCulture>neutral</AssemblyCulture>
<Attributes />
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Widget for sequentially stepping through some pages.</summary>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Container</BaseTypeName>
@ -22,9 +23,6 @@
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
@ -41,9 +39,9 @@
<Parameter Name="page" Type="Gnome.DruidPage" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="page">To be added: an object of type 'Gnome.DruidPage'</param>
<remarks>To be added</remarks>
<summary>This will prepend a <see cref="T:Gnome.DruidPage" /> into the internal list of pages of the druid.</summary>
<param name="page">an object of type <see cref="T:Gnome.DruidPage" /></param>
<remarks>Since GnomeDruid is just a container, you will need to also call <see cref="M:Gtk.Widget.Show()" /> on the page, otherwise the page will not be shown.</remarks>
</Docs>
</Member>
<Member MemberName="InsertPage">
@ -57,10 +55,10 @@
<Parameter Name="page" Type="Gnome.DruidPage" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="back_page">To be added: an object of type 'Gnome.DruidPage'</param>
<param name="page">To be added: an object of type 'Gnome.DruidPage'</param>
<remarks>To be added</remarks>
<summary>This will insert <paramref name="page" /> after <paramref name="back_page" /> into the list of internal pages of the druid.</summary>
<param name="back_page">an object of type <see cref="T:Gnome.DruidPage" /></param>
<param name="page">an object of type <see cref="T:Gnome.DruidPage" /></param>
<remarks>If <paramref name="back_page" /> is not present in the list or <see langword="null" />, <paramref name="page" /> will be prepended to the list. Since <see cref="T:Gnome.Druid" /> is just a container, you will need to also call <see cref="M:Gtk.Widget.Show()" /> on the page, otherwise the page will not be shown.</remarks>
</Docs>
</Member>
<Member MemberName="SetButtonsSensitive">
@ -76,12 +74,12 @@
<Parameter Name="help_sensitive" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="back_sensitive">To be added: an object of type 'bool'</param>
<param name="next_sensitive">To be added: an object of type 'bool'</param>
<param name="cancel_sensitive">To be added: an object of type 'bool'</param>
<param name="help_sensitive">To be added: an object of type 'bool'</param>
<remarks>To be added</remarks>
<summary>Sets the sensitivity of of the control-buttons for the <see cref="T:Gnome.Druid" />.</summary>
<param name="back_sensitive">an object of type <see cref="T:System.Boolean" /></param>
<param name="next_sensitive">an object of type <see cref="T:System.Boolean" /></param>
<param name="cancel_sensitive">an object of type <see cref="T:System.Boolean" /></param>
<param name="help_sensitive">an object of type <see cref="T:System.Boolean" /></param>
<remarks>If the variables are <see langword="true" />, then they will be clickable. This function is used primarily by the actual <see cref="T:Gnome.DruidPage" /> widgets.</remarks>
</Docs>
</Member>
<Member MemberName="AppendPage">
@ -94,9 +92,9 @@
<Parameter Name="page" Type="Gnome.DruidPage" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="page">To be added: an object of type 'Gnome.DruidPage'</param>
<remarks>To be added</remarks>
<summary>This will append <paramref name="page" /> onto the end of the internal list of the druid.</summary>
<param name="page">an object of type <see cref="T:Gnome.DruidPage" /></param>
<remarks>Since GnomeDruid is just a container, you will need to also call <see cref="M:Gtk.Widget.Show()" /> on the page, otherwise the page will not be shown.</remarks>
</Docs>
</Member>
<Member MemberName="ConstructWithWindow">
@ -112,12 +110,12 @@
<Parameter Name="window" Type="Gtk.Widget" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="title">To be added: an object of type 'string'</param>
<param name="parent">To be added: an object of type 'Gtk.Window'</param>
<param name="close_on_cancel">To be added: an object of type 'bool'</param>
<param name="window">To be added: an object of type 'Gtk.Widget'</param>
<remarks>To be added</remarks>
<summary>Creates a new toplevel window with the title of <paramref name="title" /> (which can be <see langword="null" />) and a parent of <paramref name="parent" /> (which also can be <see langword="null" />).</summary>
<param name="title">an object of type <see cref="T:System.String" /></param>
<param name="parent">an object of type <see cref="T:Gtk.Window" /></param>
<param name="close_on_cancel">an object of type <see cref="T:System.Boolean" /></param>
<param name="window">an object of type <see cref="T:Gtk.Widget" /></param>
<remarks>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.</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -154,9 +152,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gnome.Druid'</returns>
<remarks>To be added</remarks>
<summary>Default constructor</summary>
<returns>an object of type <see cref="T:Gnome.Druid" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -170,13 +168,13 @@
<Parameter Name="window" Type="Gtk.Widget" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="title">To be added: an object of type 'string'</param>
<param name="parent">To be added: an object of type 'Gtk.Window'</param>
<param name="close_on_cancel">To be added: an object of type 'bool'</param>
<param name="window">To be added: an object of type 'Gtk.Widget'</param>
<returns>To be added: an object of type 'Gnome.Druid'</returns>
<remarks>To be added</remarks>
<summary>Creates a new <see cref="T:Gnome.Druid" /> instance.</summary>
<param name="title">an object of type <see cref="T:System.String" /></param>
<param name="parent">an object of type <see cref="T:Gtk.Window" /></param>
<param name="close_on_cancel">an object of type <see cref="T:System.Boolean" /></param>
<param name="window">an object of type <see cref="T:Gtk.Widget" /></param>
<returns>an object of type <see cref="T:Gnome.Druid" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -186,8 +184,8 @@
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The GLib Type for Gnome.Druid</summary>
<returns>The GLib Type for the Gnome.Druid class.</returns>
<summary>The <see cref="T:GLib.Type" /> for <see cref="T:Gnome.Druid" /></summary>
<returns>The <see cref="T:GLib.Type" /> for the <see cref="T:Gnome.Druid" /> class.</returns>
<remarks />
</Docs>
</Member>
@ -197,12 +195,13 @@
<ReturnValue>
<ReturnType>Gnome.DruidPage</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gnome.DruidPage'</param>
<returns>To be added: an object of type 'Gnome.DruidPage'</returns>
<remarks>To be added</remarks>
<summary>This will make <paramref name="page" /> the currently showing page in the druid.</summary>
<param name="value">an object of type <see cref="T:Gnome.DruidPage" /></param>
<returns>an object of type <see cref="T:Gnome.DruidPage" /></returns>
<remarks><paramref name="page" /> must already be in the druid.</remarks>
</Docs>
</Member>
<Member MemberName="ShowFinish">
@ -211,12 +210,13 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Used to specify if the druid is currently showing the last page of the sequence (and hence should display "Finish", rather than "Next").</summary>
<param name="value">an object of type <see cref="T:System.Boolean" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ShowHelp">
@ -225,12 +225,13 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Sets the "Help" button on the druid to be visible in the lower left corner of the widget, if <see langword="true" />.</summary>
<param name="value">an object of type <see cref="T:System.Boolean" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Help">
@ -241,8 +242,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when the "Help" button of the druid is clicked.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Cancel">
@ -253,8 +254,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when the "Cancel" button of the druid is clicked.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -274,4 +275,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -1,16 +1,17 @@
<Type Name="DruidPage" FullName="Gnome.DruidPage">
<TypeSignature Language="C#" Value="public class DruidPage : Gtk.Bin, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class DruidPage : Gtk.Bin, Implementor, IWrapper, IDisposable" Maintainer="John Luke" />
<AssemblyInfo>
<AssemblyName>gnome-sharp</AssemblyName>
<AssemblyPublicKey></AssemblyPublicKey>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyCulture>neutral</AssemblyCulture>
<Attributes />
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>A widget representing a single page inside a druid.</summary>
<remarks>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).</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Bin</BaseTypeName>
@ -22,9 +23,6 @@
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
@ -39,7 +37,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Emit the <see cref="E:Gnome.DruidPage.Finish" /> event.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -51,9 +49,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Emit the <see cref="E:Gnome.DruidPage.Next" /> event.</summary>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>It is called by gnome-druid exclusively. It is expected that non-linear Druids will override this signal and return <see langword="true" /> if it handles changing pages.</remarks>
</Docs>
</Member>
<Member MemberName="Cancel">
@ -64,9 +62,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Emit the <see cref="E:Gnome.DruidPage.Next" /> event.</summary>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>It is called by gnome-druid exclusively. It is expected that a Druid will override this signal and return <see langword="true" /> if it does not want to exit.</remarks>
</Docs>
</Member>
<Member MemberName="Prepare">
@ -77,8 +75,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emit the <see cref="E:Gnome.DruidPage.Prepare" /> event.</summary>
<remarks>It is called by <see cref="T:Gnome.Druid" /> exclusively. This function is called immediately prior to a druid page being shown so that it can "prepare" for display.</remarks>
</Docs>
</Member>
<Member MemberName="Back">
@ -89,9 +87,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Emit the <see cref="E:Gnome.DruidPage.Back" /> event.</summary>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>It is called by <see cref="T:Gnome.Druid" /> exclusively. It is expected that non-linear Druids will override this signal and return <see langword="true" /> if it handles changing pages.</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -128,9 +126,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gnome.DruidPage'</returns>
<remarks>To be added</remarks>
<summary>Default constructor</summary>
<returns>an object of type <see cref="T:Gnome.DruidPage" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -140,8 +138,8 @@
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The GLib Type for Gnome.DruidPage</summary>
<returns>The GLib Type for the Gnome.DruidPage class.</returns>
<summary>The <see cref="T:GLib.Type" /> for <see cref="T:Gnome.DruidPage" /></summary>
<returns>The <see cref="T:GLib.Type" /> for the <see cref="T:Gnome.DruidPage" /> class.</returns>
<remarks />
</Docs>
</Member>
@ -153,8 +151,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when the "Cancel" button of the page is clicked.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="BackClicked">
@ -165,8 +163,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when the "Back" button of the page is clicked.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="FinishClicked">
@ -177,8 +175,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when the "Finish" button of the page is clicked.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="NextClicked">
@ -189,8 +187,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when the "Next" button of the page is clicked.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Prepared">
@ -201,8 +199,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted immediately prior to a druid page being shown.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -222,4 +220,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -1,16 +1,24 @@
<Type Name="DruidPageEdge" FullName="Gnome.DruidPageEdge">
<TypeSignature Language="C#" Value="public class DruidPageEdge : Gnome.DruidPage, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class DruidPageEdge : Gnome.DruidPage, Implementor, IWrapper, IDisposable" Maintainer="John Luke" />
<AssemblyInfo>
<AssemblyName>gnome-sharp</AssemblyName>
<AssemblyPublicKey></AssemblyPublicKey>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyCulture>neutral</AssemblyCulture>
<Attributes />
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>A widget used to implement first and last pages in the sequence of the <see cref="T:Gnome.Druid" />.</summary>
<remarks>
<para>
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.
</para>
<para>
The <see cref="T:Gnome.DruidPageEdge" /> widget is for the first and last pages in the sequence of pages in the <see cref="T:Gnome.Druid" />. Pages in the "middle" of a sequence should use <see cref="T:Gnome.DruidPageStandard" />.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gnome.DruidPage</BaseTypeName>
@ -22,9 +30,6 @@
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
@ -41,10 +46,10 @@
<Parameter Name="position" Type="Gnome.EdgePosition" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="position">To be added: an object of type 'Gnome.EdgePosition'</param>
<returns>To be added: an object of type 'Gnome.DruidPageEdge'</returns>
<remarks>To be added</remarks>
<summary>Creates a new <see cref="T:Gnome.DruidPageEdge" /> widget.</summary>
<param name="position">an object of type <see cref="T:Gnome.EdgePosition" /></param>
<returns>an object of type <see cref="T:Gnome.DruidPageEdge" /></returns>
<remarks>The internal canvas is created in an antialiased mode.</remarks>
</Docs>
</Member>
<Member MemberName="Construct">
@ -63,15 +68,15 @@
<Parameter Name="top_watermark" Type="Gdk.Pixbuf" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="position">To be added: an object of type 'Gnome.EdgePosition'</param>
<param name="antialiased">To be added: an object of type 'bool'</param>
<param name="title">To be added: an object of type 'string'</param>
<param name="text">To be added: an object of type 'string'</param>
<param name="logo">To be added: an object of type 'Gdk.Pixbuf'</param>
<param name="watermark">To be added: an object of type 'Gdk.Pixbuf'</param>
<param name="top_watermark">To be added: an object of type 'Gdk.Pixbuf'</param>
<remarks>To be added</remarks>
<summary>Constructs a new <see cref="T:Gnome.DruidPageEdge" /> widget.</summary>
<param name="position">an object of type <see cref="T:Gnome.EdgePosition" /></param>
<param name="antialiased">an object of type <see cref="T:System.Boolean" /></param>
<param name="title">an object of type <see cref="T:System.String" /></param>
<param name="text">an object of type <see cref="T:System.String" /></param>
<param name="logo">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<param name="watermark">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<param name="top_watermark">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -110,10 +115,10 @@
<Parameter Name="position" Type="Gnome.EdgePosition" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="position">To be added: an object of type 'Gnome.EdgePosition'</param>
<returns>To be added: an object of type 'Gnome.DruidPageEdge'</returns>
<remarks>To be added</remarks>
<summary>Creates a new <see cref="T:Gnome.DruidPageEdge" /> widget.</summary>
<param name="position">an object of type <see cref="T:Gnome.EdgePosition" /></param>
<returns>an object of type <see cref="T:Gnome.DruidPageEdge" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -130,16 +135,16 @@
<Parameter Name="top_watermark" Type="Gdk.Pixbuf" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="position">To be added: an object of type 'Gnome.EdgePosition'</param>
<param name="antialiased">To be added: an object of type 'bool'</param>
<param name="title">To be added: an object of type 'string'</param>
<param name="text">To be added: an object of type 'string'</param>
<param name="logo">To be added: an object of type 'Gdk.Pixbuf'</param>
<param name="watermark">To be added: an object of type 'Gdk.Pixbuf'</param>
<param name="top_watermark">To be added: an object of type 'Gdk.Pixbuf'</param>
<returns>To be added: an object of type 'Gnome.DruidPageEdge'</returns>
<remarks>To be added</remarks>
<summary>Creates a new <see cref="T:Gnome.DruidPageEdge" /> widget.</summary>
<param name="position">an object of type <see cref="T:Gnome.EdgePosition" /></param>
<param name="antialiased">an object of type <see cref="T:System.Boolean" /></param>
<param name="title">an object of type <see cref="T:System.String" /></param>
<param name="text">an object of type <see cref="T:System.String" /></param>
<param name="logo">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<param name="watermark">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<param name="top_watermark">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<returns>an object of type <see cref="T:Gnome.DruidPageEdge" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -148,9 +153,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gnome.DruidPageEdge'</returns>
<remarks>To be added</remarks>
<summary>Internal constructor</summary>
<returns>an object of type <see cref="T:Gnome.DruidPageEdge" /></returns>
<remarks>This is an internal constructor, and should not be used by user code.</remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -160,8 +165,8 @@
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The GLib Type for Gnome.DruidPageEdge</summary>
<returns>The GLib Type for the Gnome.DruidPageEdge class.</returns>
<summary>The <see cref="T:GLib.Type" /> for <see cref="T:Gnome.DruidPageEdge" /></summary>
<returns>The <see cref="T:GLib.Type" /> for the <see cref="T:Gnome.DruidPageEdge" /> class.</returns>
<remarks />
</Docs>
</Member>
@ -171,12 +176,13 @@
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Color'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
<summary>This will set the background color.</summary>
<param name="value">an object of type <see cref="T:Gdk.Color" /></param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Title">
@ -185,12 +191,13 @@
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>The title text of the page.</summary>
<param name="value">an object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="TextboxColor">
@ -199,12 +206,13 @@
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Color'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
<summary>The color of the background in the main text area of the page.</summary>
<param name="value">an object of type <see cref="T:Gdk.Color" /></param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="TextColor">
@ -213,12 +221,13 @@
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Color'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
<summary>The color of the text in the body of the druid page.</summary>
<param name="value">an object of type <see cref="T:Gdk.Color" /></param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="LogoBgColor">
@ -227,12 +236,13 @@
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Color'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
<summary>The color behind the logo of the druid page.</summary>
<param name="value">an object of type <see cref="T:Gdk.Color" /></param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Watermark">
@ -241,12 +251,13 @@
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Pixbuf'</param>
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns>
<remarks>To be added</remarks>
<summary>Sets a <see cref="T:Gdk.Pixbuf" /> as the watermark on the left strip on the druid.</summary>
<param name="value">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<returns>an object of type <see cref="T:Gdk.Pixbuf" /></returns>
<remarks>If <see langword="null" />, it is reset to the normal color.</remarks>
</Docs>
</Member>
<Member MemberName="TopWatermark">
@ -255,12 +266,13 @@
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Pixbuf'</param>
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns>
<remarks>To be added</remarks>
<summary>Sets a <see cref="T:Gdk.Pixbuf" /> as the watermark on the top strip on the druid.</summary>
<param name="value">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<returns>an object of type <see cref="T:Gdk.Pixbuf" /></returns>
<remarks>If <see langword="null" />, it is reset to the normal color.</remarks>
</Docs>
</Member>
<Member MemberName="TitleColor">
@ -269,12 +281,13 @@
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Color'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
<summary>The color of the title text on the current page.</summary>
<param name="value">an object of type <see cref="T:Gdk.Color" /></param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Logo">
@ -283,12 +296,13 @@
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Pixbuf'</param>
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns>
<remarks>To be added</remarks>
<summary>Sets a <see cref="T:Gdk.Pixbuf" /> as the logo in the top right corner.</summary>
<param name="value">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<returns>an object of type <see cref="T:Gdk.Pixbuf" /></returns>
<remarks>If <see langword ="null" />, then no logo will be displayed.</remarks>
</Docs>
</Member>
<Member MemberName="Text">
@ -297,12 +311,13 @@
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>The contents of the text portion of the druid page.</summary>
<param name="value">an object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -322,4 +337,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -1,16 +1,25 @@
<Type Name="DruidPageStandard" FullName="Gnome.DruidPageStandard">
<TypeSignature Language="C#" Value="public class DruidPageStandard : Gnome.DruidPage, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class DruidPageStandard : Gnome.DruidPage, Implementor, IWrapper, IDisposable" Maintainer="John Luke" />
<AssemblyInfo>
<AssemblyName>gnome-sharp</AssemblyName>
<AssemblyPublicKey></AssemblyPublicKey>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyCulture>neutral</AssemblyCulture>
<Attributes />
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>A widget used to implement the middle pages in a <see cref="T:Gnome.Druid" /> sequence.
</summary>
<remarks>
<para>
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.
</para>
<para>
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 <see cref="T:Gtk.VBox" />), rather than just displaying text (which is the common case for edge pages).
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gnome.DruidPage</BaseTypeName>
@ -22,9 +31,6 @@
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
@ -43,11 +49,18 @@
<Parameter Name="additional_info" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="question">To be added: an object of type 'string'</param>
<param name="item">To be added: an object of type 'Gtk.Widget'</param>
<param name="additional_info">To be added: an object of type 'string'</param>
<remarks>To be added</remarks>
<summary>Convenience function to add a <see cref="T:Gtk.Widget" /> to the <see cref="T:Gnome.DruidPageStandard" /> vbox.</summary>
<param name="question">an object of type <see cref="T:System.String" /></param>
<param name="item">an object of type <see cref="T:Gtk.Widget" /></param>
<param name="additional_info">an object of type <see cref="T:System.String" /></param>
<remarks>
<para>
This function creates a new contents section that has the <paramref name="question" /> text followed by the <paramref name="item" /> widget and then the <paramref name="addition_info" /> text, all stacked vertically from top to bottom.
</para>
<para>
The <paramref name="item" /> widget could be something like a set of radio checkbuttons requesting a choice from the user.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -84,9 +97,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gnome.DruidPageStandard'</returns>
<remarks>To be added</remarks>
<summary>Default constructor</summary>
<returns>an object of type <see cref="T:Gnome.DruidPageStandard" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -99,12 +112,12 @@
<Parameter Name="top_watermark" Type="Gdk.Pixbuf" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="title">To be added: an object of type 'string'</param>
<param name="logo">To be added: an object of type 'Gdk.Pixbuf'</param>
<param name="top_watermark">To be added: an object of type 'Gdk.Pixbuf'</param>
<returns>To be added: an object of type 'Gnome.DruidPageStandard'</returns>
<remarks>To be added</remarks>
<summary>Creates a new <see cref="T:Gnome.DruidPageStandard" /> instance.</summary>
<param name="title">an object of type <see cref="T:System.String" /></param>
<param name="logo">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<param name="top_watermark">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<returns>an object of type <see cref="T:Gnome.DruidPageStandard" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -114,8 +127,8 @@
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The GLib Type for Gnome.DruidPageStandard</summary>
<returns>The GLib Type for the Gnome.DruidPageStandard class.</returns>
<summary>The <see cref="T:GLib.Type" /> for <see cref="T:Gnome.DruidPageStandard" /></summary>
<returns>The <see cref="T:GLib.Type" /> for the <see cref="T:Gnome.DruidPageStandard" /> class.</returns>
<remarks />
</Docs>
</Member>
@ -125,12 +138,13 @@
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Color'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
<summary>The color of the main contents section background.</summary>
<param name="value">an object of type <see cref="T:Gdk.Color" /></param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="TitleForegroundGdk">
@ -139,12 +153,13 @@
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Color'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
<summary>The title text to the specified color.</summary>
<param name="value">an object of type <see cref="T:Gdk.Color" /></param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="LogoBackgroundGdk">
@ -153,12 +168,13 @@
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Color'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
<summary>The background of the logo.</summary>
<param name="value">an object of type <see cref="T:Gdk.Color" /></param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="TitleForegroundSet">
@ -167,11 +183,12 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<param name="value">an object of type <see cref="T:System.Boolean" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -181,12 +198,13 @@
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Pixbuf'</param>
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns>
<remarks>To be added</remarks>
<summary>Sets a <see cref="T:Gdk.Pixbuf" /> as the logo in the top right corner.</summary>
<param name="value">an object of type <see cref="T:Gdk.Color" /></param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks>If <see langword ="null" />, then no logo will be displayed.</remarks>
</Docs>
</Member>
<Member MemberName="TitleForeground">
@ -195,12 +213,13 @@
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Color'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
<summary>The title text to the specified color.</summary>
<param name="value">an object of type <see cref="T:Gdk.Color" /></param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="LogoBackground">
@ -209,12 +228,13 @@
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Color'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
<summary>The background color of the logo</summary>
<param name="value">an object of type <see cref="T:Gdk.Color" /></param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Background">
@ -223,12 +243,13 @@
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Color'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
<summary>The background color of the top section of the druid page.</summary>
<param name="value">an object of type <see cref="T:Gdk.Color" /></param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Title">
@ -237,12 +258,13 @@
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>The title of the druid page.</summary>
<param name="value">an object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="BackgroundGdk">
@ -251,12 +273,13 @@
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Color'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
<summary>The background color of the top section of the druid page.</summary>
<param name="value">an object of type <see cref="T:Gdk.Color" /></param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="TopWatermark">
@ -265,12 +288,13 @@
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Pixbuf'</param>
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns>
<remarks>To be added</remarks>
<summary>Sets a <see cref="T:Gdk.Pixbuf" /> as the watermark on the top strip on the druid.</summary>
<param name="value">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<returns>an object of type <see cref="T:Gdk.Pixbuf" /></returns>
<remarks>If <see langword="null" />, it is reset to the normal color.</remarks>
</Docs>
</Member>
<Member MemberName="LogoBackgroundSet">
@ -279,11 +303,12 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<param name="value">an object of type <see cref="T:System.Boolean" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -293,11 +318,12 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<param name="value">an object of type <see cref="T:System.Boolean" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -318,4 +344,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>