GtkSharp/doc/en/Gnome/DruidPageStandard.xml

<Type Name="DruidPageStandard" FullName="Gnome.DruidPageStandard">
  <TypeSignature Language="C#" Value="public class DruidPageStandard : 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 the middle pages in a druid's sequence.</summary>
    <remarks>
      <para>This widget provides similar functionality to that in <see cref="T:Gnome.DruidPageEdge" />. 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" /> widget), rather than just displaying text (which is the common case for edge pages).</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="AppendItem">
      <MemberSignature Language="C#" Value="public void AppendItem (string question, Gtk.Widget item, string additional_info);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="question" Type="System.String" />
        <Parameter Name="item" Type="Gtk.Widget" />
        <Parameter Name="additional_info" Type="System.String" />
      </Parameters>
      <Docs>
        <summary>Add a <see cref="T:Gtk.Widget" /> to a <see cref="T:Gnome.DruidPageStandard" />'s VBox.</summary>
        <param name="question"> The text to place above the item.</param>
        <param name="item">The <see cref="T:Gtk.Widget" /> to be included.</param>
        <param name="additional_info"> The text to be placed below the item in a smaller font.</param>
        <remarks>
          <para>Convenience function to add a <see cref="T:Gtk.Widget" /> to a <see cref="T:Gnome.DruidPageStandard" />'s VBox. This function creates a new contents section that has the question text followed by the item widget and then the addition_info text, all stacked vertically from top to bottom.</para>
          <para>The item widget could be something like a set of radio checkbuttons requesting a choice from the user.</para>
        </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 DruidPageStandard (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 DruidPageStandard, 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 DruidPageStandard ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>Construct a new <see cref="T:Gnome.DruidPageStandard" />.</summary>
        <returns>a new <see cref="T:Gnome.DruidPageStandard" />.</returns>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public DruidPageStandard (string title, Gdk.Pixbuf logo, Gdk.Pixbuf top_watermark);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="title" Type="System.String" />
        <Parameter Name="logo" Type="Gdk.Pixbuf" />
        <Parameter Name="top_watermark" Type="Gdk.Pixbuf" />
      </Parameters>
      <Docs>
        <summary>Constructs a new <see cref="T:Gnome.DruidPageStandard" /> and allows the caller to fill in some of the values at the same time.</summary>
        <param name="title"> The title of the druid page.</param>
        <param name="logo"> The logo to put on the druid page.</param>
        <param name="top_watermark"> The watermark to put at the top of the druid page.</param>
        <returns>a new <see cref="T:Gnome.DruidPageStandard" />.</returns>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="ContentsBackground">
      <MemberSignature Language="C#" Value="public Gdk.Color ContentsBackground { set; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Color</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <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">
      <MemberSignature Language="C#" Value="public Gdk.Color TitleForegroundGdk { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Color</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Sets the color of the main contents section's background.</summary>
        <param name="value"> The new color for the main body's background.</param>
        <returns>an object of type <see cref="T:Gdk.Color" /></returns>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="LogoBackgroundGdk">
      <MemberSignature Language="C#" Value="public Gdk.Color LogoBackgroundGdk { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Color</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <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">
      <MemberSignature Language="C#" Value="public bool TitleForegroundSet { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>To be added</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>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="Logo">
      <MemberSignature Language="C#" Value="public Gdk.Pixbuf Logo { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Pixbuf</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">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">
      <MemberSignature Language="C#" Value="public Gdk.Color TitleForeground { set; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Color</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:Gdk.Color" /></returns>
        <remarks>If set to null, then no logo will be displayed.</remarks>
      </Docs>
    </Member>
    <Member MemberName="LogoBackground">
      <MemberSignature Language="C#" Value="public Gdk.Color LogoBackground { set; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Color</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Sets the title text to the specified color.</summary>
        <param name="value"> The new color of the title text.</param>
        <returns>an object of type <see cref="T:Gdk.Color" /></returns>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Background">
      <MemberSignature Language="C#" Value="public Gdk.Color Background { set; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Color</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Set the color behind the druid page's logo.</summary>
        <param name="value"> The new color for the logo background.</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; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Sets the background color of the top section of the druid page.</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="BackgroundGdk">
      <MemberSignature Language="C#" Value="public Gdk.Color BackgroundGdk { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Color</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <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">
      <MemberSignature Language="C#" Value="public Gdk.Pixbuf TopWatermark { set; get; };" />
      <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 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">
      <MemberSignature Language="C#" Value="public bool LogoBackgroundSet { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</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:System.Boolean" /></returns>
        <remarks>If set to null, the top watermark is reset to the normal color.</remarks>
      </Docs>
    </Member>
    <Member MemberName="BackgroundSet">
      <MemberSignature Language="C#" Value="public bool BackgroundSet { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>To be added</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>To be added</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>To be added</summary>
        <returns>a <see cref="T:GLib.GType" /></returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected DruidPageStandard (GLib.GType gtype);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="gtype" Type="GLib.GType" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="gtype">a <see cref="T:GLib.GType" /></param>
        <returns>a <see cref="T:Gnome.DruidPageStandard" /></returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
  </Members>
</Type>