GtkSharp/doc/en/Gnome/DruidPage.xml

<Type Name="DruidPage" FullName="Gnome.DruidPage">
  <TypeSignature Language="C#" Value="public class DruidPage : Gtk.Bin, 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 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>
  </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="Finish">
      <MemberSignature Language="C#" Value="public void Finish ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Emit the <see cref="E:Gnome.DruidPage.FinishClicked" /> event.</summary>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="Next">
      <MemberSignature Language="C#" Value="public bool Next ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Emit the <see cref="E:Gnome.DruidPage.NextClicked" /> 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">
      <MemberSignature Language="C#" Value="public bool Cancel ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Emit the <see cref="E:Gnome.DruidPage.CancelClicked" /> 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">
      <MemberSignature Language="C#" Value="public void Prepare ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <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">
      <MemberSignature Language="C#" Value="public bool Back ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Emit the <see cref="E:Gnome.DruidPage.BackClicked" /> 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">
      <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 DruidPage (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 DruidPage, 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 DruidPage ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>Creates a new <see cref="T:Gnome.DruidPage" />.</summary>
        <returns>an object of type <see cref="T:Gnome.DruidPage" /></returns>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="CancelClicked">
      <MemberSignature Language="C#" Value="public event Gnome.CancelClickedHandler CancelClicked;" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>Gnome.CancelClickedHandler</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Emitted when the "Cancel" button of the page is clicked.</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="BackClicked">
      <MemberSignature Language="C#" Value="public event Gnome.BackClickedHandler BackClicked;" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>Gnome.BackClickedHandler</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Emitted when the "Back" button of the page is clicked.</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="FinishClicked">
      <MemberSignature Language="C#" Value="public event Gnome.FinishClickedHandler FinishClicked;" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>Gnome.FinishClickedHandler</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Emitted when the "Finish" button of the page is clicked.</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="NextClicked">
      <MemberSignature Language="C#" Value="public event Gnome.NextClickedHandler NextClicked;" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>Gnome.NextClickedHandler</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Emitted when the "Next" button of the page is clicked.</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Prepared">
      <MemberSignature Language="C#" Value="public event Gnome.PreparedHandler Prepared;" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>Gnome.PreparedHandler</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Emitted immediately prior to a druid page being shown.</summary>
        <remarks>
        </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>GType Property.</summary>
        <returns>a <see cref="T:GLib.GType" /></returns>
        <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gnome.DruidPage" />.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OnPrepared">
      <MemberSignature Language="C#" Value="protected virtual void OnPrepared (Gtk.Widget druid);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="druid" Type="Gtk.Widget" />
      </Parameters>
      <Docs>
        <summary>Default handler for the <see cref="M:Gnome.DruidPage.Prepared" /> event.</summary>
        <param name="druid">a <see cref="T:Gtk.Widget" /></param>
        <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gnome.DruidPage.Prepared" /> event.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OnNextClicked">
      <MemberSignature Language="C#" Value="protected virtual bool OnNextClicked (Gtk.Widget druid);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="druid" Type="Gtk.Widget" />
      </Parameters>
      <Docs>
        <summary>Default handler for the <see cref="M:Gnome.DruidPage.NextClicked" /> event.</summary>
        <param name="druid">a <see cref="T:Gtk.Widget" /></param>
        <returns>a <see cref="T:System.Boolean" /></returns>
        <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gnome.DruidPage.NextClicked" /> event.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OnFinishClicked">
      <MemberSignature Language="C#" Value="protected virtual void OnFinishClicked (Gtk.Widget druid);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="druid" Type="Gtk.Widget" />
      </Parameters>
      <Docs>
        <summary>Default handler for the <see cref="M:Gnome.DruidPage.FinishClicked" /> event.</summary>
        <param name="druid">a <see cref="T:Gtk.Widget" /></param>
        <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gnome.DruidPage.FinishClicked" /> event.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OnBackClicked">
      <MemberSignature Language="C#" Value="protected virtual bool OnBackClicked (Gtk.Widget druid);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="druid" Type="Gtk.Widget" />
      </Parameters>
      <Docs>
        <summary>Default handler for the <see cref="M:Gnome.DruidPage.BackClicked" /> event.</summary>
        <param name="druid">a <see cref="T:Gtk.Widget" /></param>
        <returns>a <see cref="T:System.Boolean" /></returns>
        <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gnome.DruidPage.BackClicked" /> event.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OnCancelClicked">
      <MemberSignature Language="C#" Value="protected virtual bool OnCancelClicked (Gtk.Widget druid);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="druid" Type="Gtk.Widget" />
      </Parameters>
      <Docs>
        <summary>Default handler for the <see cref="M:Gnome.DruidPage.CancelClicked" /> event.</summary>
        <param name="druid">a <see cref="T:Gtk.Widget" /></param>
        <returns>a <see cref="T:System.Boolean" /></returns>
        <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gnome.DruidPage.CancelClicked" /> event.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected DruidPage (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.DruidPage" /></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>
  </Members>
</Type>