Ryujinx-GtkSharp/doc/en/Gnome/DruidPageEdge.xml
Mike Kestner 704726109a 2004-06-21 Mike Kestner <mkestner@ximian.com>
* en/*/*.xml : document ctor(GType) members via script-fu. 476 TBAs.

svn path=/trunk/gtk-sharp/; revision=30068
2004-06-21 20:33:11 +00:00

326 lines
14 KiB
XML

<Type Name="DruidPageEdge" FullName="Gnome.DruidPageEdge">
<TypeSignature Language="C#" Value="public class DruidPageEdge : Gnome.DruidPage, Implementor, IWrapper, IDisposable" Maintainer="John Luke" />
<AssemblyInfo>
<AssemblyName>gnome-sharp</AssemblyName>
<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>A widget used to implement first and last pages in a druid's sequence.</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 a druid's sequence of pages. Pages in the "middle" of a sequence should use <see cref="T:Gnome.DruidPageStandard" />.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gnome.DruidPage</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Atk.Implementor</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="Construct">
<MemberSignature Language="C#" Value="public void Construct (Gnome.EdgePosition position, bool antialiased, string title, string text, Gdk.Pixbuf logo, Gdk.Pixbuf watermark, Gdk.Pixbuf top_watermark);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="position" Type="Gnome.EdgePosition" />
<Parameter Name="antialiased" Type="System.Boolean" />
<Parameter Name="title" Type="System.String" />
<Parameter Name="text" Type="System.String" />
<Parameter Name="logo" Type="Gdk.Pixbuf" />
<Parameter Name="watermark" Type="Gdk.Pixbuf" />
<Parameter Name="top_watermark" Type="Gdk.Pixbuf" />
</Parameters>
<Docs>
<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">
<MemberSignature Language="C#" Value="protected override void Finalize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Disposes the resources associated with the object.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DruidPageEdge (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
<returns>An instance of DruidPageEdge, wrapping the C object.</returns>
<remarks>
<para>This is an internal constructor, and should not be used by user code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DruidPageEdge (Gnome.EdgePosition position);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="position" Type="Gnome.EdgePosition" />
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Gnome.DruidPageEdge" /> widget.</summary>
<param name="position">Position in druid.</param>
<returns>a new <see cref="T:Gnome.DruidPageEdge" />.</returns>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DruidPageEdge (Gnome.EdgePosition position, bool antialiased, string title, string text, Gdk.Pixbuf logo, Gdk.Pixbuf watermark, Gdk.Pixbuf top_watermark);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="position" Type="Gnome.EdgePosition" />
<Parameter Name="antialiased" Type="System.Boolean" />
<Parameter Name="title" Type="System.String" />
<Parameter Name="text" Type="System.String" />
<Parameter Name="logo" Type="Gdk.Pixbuf" />
<Parameter Name="watermark" Type="Gdk.Pixbuf" />
<Parameter Name="top_watermark" Type="Gdk.Pixbuf" />
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Gnome.DruidPageEdge" /> widget with the values given.</summary>
<param name="position">Position in druid.</param>
<param name="antialiased">Use an antialiased canvas.</param>
<param name="title">The title.</param>
<param name="text">The introduction text.</param>
<param name="logo">The logo in the upper right corner.</param>
<param name="watermark">The watermark on the left.</param>
<param name="top_watermark">The top watermark.</param>
<returns>a new <see cref="T:Gnome.DruidPageEdge" />.</returns>
<remarks>It is acceptable for any of the reference values to be null.</remarks>
</Docs>
</Member>
<Member MemberName="BgColor">
<MemberSignature Language="C#" Value="public Gdk.Color BgColor { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<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">
<MemberSignature Language="C#" Value="public string Title { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>This will set the background color.</summary>
<param name="value"> The new background color.</param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="TextboxColor">
<MemberSignature Language="C#" Value="public Gdk.Color TextboxColor { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Sets the contents of the page's title text.</summary>
<param name="value">The title text.</param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="TextColor">
<MemberSignature Language="C#" Value="public Gdk.Color TextColor { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Sets the color of the background in the main text area of the page.</summary>
<param name="value">The new textbox color.</param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="LogoBgColor">
<MemberSignature Language="C#" Value="public Gdk.Color LogoBgColor { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Sets the color of the text in the body of the druid page.</summary>
<param name="value"> The new text color.</param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="Watermark">
<MemberSignature Language="C#" Value="public Gdk.Pixbuf Watermark { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Set the color behind the druid page's logo.</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">
<MemberSignature Language="C#" Value="public Gdk.Pixbuf TopWatermark { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Sets a <see cref="T:Gdk.Pixbuf" /> as the watermark on the left strip on the druid.</summary>
<param name="value">The <see cref="T:Gdk.Pixbuf" /> to use as a watermark.</param>
<returns>an object of type <see cref="T:Gdk.Pixbuf" /></returns>
<remarks>If watermark is set to null, it is reset to the normal color.</remarks>
</Docs>
</Member>
<Member MemberName="TitleColor">
<MemberSignature Language="C#" Value="public Gdk.Color TitleColor { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Sets a <see cref="T:Gdk.Pixbuf" /> as the watermark on top of the top strip on the druid.</summary>
<param name="value">The <see cref="T:Gdk.Pixbuf" /> to use as a top watermark</param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks>If the top watermark is set to null, it is reset to the normal color.</remarks>
</Docs>
</Member>
<Member MemberName="Logo">
<MemberSignature Language="C#" Value="public Gdk.Pixbuf Logo { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Sets the color of the title text on the current page.</summary>
<param name="value"> The color of the title text.</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">
<MemberSignature Language="C#" Value="public string Text { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Sets a <see cref="T:Gdk.Pixbuf" /> as the logo in the top right corner.</summary>
<param name="value">The <see cref="T:Gdk.Pixbuf" /> to use as a logo.</param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks>If set to null, then no logo will be displayed.</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Sets the contents of the text portion of the druid page.</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DruidPageEdge (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gnome.DruidPageEdge" /></returns>
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DruidPageEdge ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gnome.DruidPageEdge" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>