GtkSharp/doc/en/Gnome/AppBar.xml
Duncan Mak f3966a2a4c 2003-02-23 Duncan Mak <duncan@ximian.com>
* en/*/*.xml: a Big patch. This adds code-generated documentation
	for internal constructors, the GType property and the Finalized method.

svn path=/trunk/gtk-sharp/; revision=11858
2003-02-23 07:26:30 +00:00

337 lines
12 KiB
XML

<Type Name="AppBar" FullName="Gnome.AppBar">
<TypeSignature Language="C#" Value="public class AppBar : Gtk.HBox, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gnome-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<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>
</Docs>
<Base>
<BaseTypeName>Gtk.HBox</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Atk.Implementor</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="ClearStack">
<MemberSignature Language="C#" Value="public void ClearStack ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Pop">
<MemberSignature Language="C#" Value="public void Pop ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ClearPrompt">
<MemberSignature Language="C#" Value="public void ClearPrompt ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Push">
<MemberSignature Language="C#" Value="public void Push (string status);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="status" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="status">To be added: an object of type 'string'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Refresh">
<MemberSignature Language="C#" Value="public void Refresh ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetPrompt">
<MemberSignature Language="C#" Value="public void SetPrompt (string prompt, bool modal);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="prompt" Type="System.String" />
<Parameter Name="modal" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="prompt">To be added: an object of type 'string'</param>
<param name="modal">To be added: an object of type 'bool'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetStatus">
<MemberSignature Language="C#" Value="public void SetStatus (string status);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="status" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="status">To be added: an object of type 'string'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected virtual 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="protected AppBar (uint gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
<returns>Creates a new instance of AppBar, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gnome.AppBar" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AppBar (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 AppBar, 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 AppBar (bool has_progress, bool has_status, Gnome.PreferencesType interactivity);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="has_progress" Type="System.Boolean" />
<Parameter Name="has_status" Type="System.Boolean" />
<Parameter Name="interactivity" Type="Gnome.PreferencesType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="has_progress">To be added: an object of type 'bool'</param>
<param name="has_status">To be added: an object of type 'bool'</param>
<param name="interactivity">To be added: an object of type 'Gnome.PreferencesType'</param>
<returns>To be added: an object of type 'Gnome.AppBar'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected AppBar ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gnome.AppBar'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static uint GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The GLib Type for Gnome.AppBar</summary>
<returns>The GLib TYpe for the Gnome.AppBar class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Response">
<MemberSignature Language="C#" Value="public string Response { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Status">
<MemberSignature Language="C#" Value="public Gtk.Widget Status { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Widget</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.Widget'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Progress">
<MemberSignature Language="C#" Value="public Gtk.ProgressBar Progress { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.ProgressBar</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.ProgressBar'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Default">
<MemberSignature Language="C#" Value="public string Default { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</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>
</Docs>
</Member>
<Member MemberName="ProgressPercentage">
<MemberSignature Language="C#" Value="public float ProgressPercentage { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Single" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'float'</param>
<returns>To be added: an object of type 'float'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Interactivity">
<MemberSignature Language="C#" Value="public Gnome.PreferencesType Interactivity { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gnome.PreferencesType</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gnome.PreferencesType'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="HasProgress">
<MemberSignature Language="C#" Value="public bool HasProgress { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="HasStatus">
<MemberSignature Language="C#" Value="public bool HasStatus { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="PromptCleared">
<MemberSignature Language="C#" Value="public event EventHandler PromptCleared;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="UserResponse">
<MemberSignature Language="C#" Value="public event EventHandler UserResponse;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>