GtkSharp/doc/en/Gnome/Client.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

607 lines
No EOL
23 KiB
XML

<Type Name="Client" FullName="Gnome.Client">
<TypeSignature Language="C#" Value="public class Client : Gtk.Object, 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.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="FlagsGetType">
<MemberSignature Language="C#" Value="public static uint FlagsGetType ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ModuleInfoGet">
<MemberSignature Language="C#" Value="public static Gnome.ModuleInfo ModuleInfoGet ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.ModuleInfo</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gnome.ModuleInfo'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="StateGetType">
<MemberSignature Language="C#" Value="public static uint StateGetType ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="NewWithoutConnection">
<MemberSignature Language="C#" Value="public static Gnome.Client NewWithoutConnection ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.Client</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gnome.Client'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetRestartCommand">
<MemberSignature Language="C#" Value="public void SetRestartCommand (int argc, string[] argv);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="argc" Type="System.Int32" />
<Parameter Name="argv" Type="System.String[]" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="argc">To be added: an object of type 'int'</param>
<param name="argv">To be added: an object of type 'string[]'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Flush">
<MemberSignature Language="C#" Value="public void Flush ();" />
<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="RequestSave">
<MemberSignature Language="C#" Value="public void RequestSave (Gnome.SaveStyle save_style, bool shutdown, Gnome.InteractStyle interact_style, bool fast, bool global);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="save_style" Type="Gnome.SaveStyle" />
<Parameter Name="shutdown" Type="System.Boolean" />
<Parameter Name="interact_style" Type="Gnome.InteractStyle" />
<Parameter Name="fast" Type="System.Boolean" />
<Parameter Name="global" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="save_style">To be added: an object of type 'Gnome.SaveStyle'</param>
<param name="shutdown">To be added: an object of type 'bool'</param>
<param name="interact_style">To be added: an object of type 'Gnome.InteractStyle'</param>
<param name="fast">To be added: an object of type 'bool'</param>
<param name="global">To be added: an object of type 'bool'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetShutdownCommand">
<MemberSignature Language="C#" Value="public void SetShutdownCommand (int argc, string[] argv);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="argc" Type="System.Int32" />
<Parameter Name="argv" Type="System.String[]" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="argc">To be added: an object of type 'int'</param>
<param name="argv">To be added: an object of type 'string[]'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetCloneCommand">
<MemberSignature Language="C#" Value="public void SetCloneCommand (int argc, string[] argv);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="argc" Type="System.Int32" />
<Parameter Name="argv" Type="System.String[]" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="argc">To be added: an object of type 'int'</param>
<param name="argv">To be added: an object of type 'string[]'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RequestInteractionInterp">
<MemberSignature Language="C#" Value="public void RequestInteractionInterp (Gnome.DialogType dialog_type, Gtk.CallbackMarshal function, IntPtr data, Gtk.DestroyNotify destroy);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dialog_type" Type="Gnome.DialogType" />
<Parameter Name="function" Type="Gtk.CallbackMarshal" />
<Parameter Name="data" Type="System.IntPtr" />
<Parameter Name="destroy" Type="Gtk.DestroyNotify" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="dialog_type">To be added: an object of type 'Gnome.DialogType'</param>
<param name="function">To be added: an object of type 'Gtk.CallbackMarshal'</param>
<param name="data">To be added: an object of type 'IntPtr'</param>
<param name="destroy">To be added: an object of type 'Gtk.DestroyNotify'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RequestInteraction">
<MemberSignature Language="C#" Value="public void RequestInteraction (Gnome.DialogType dialog_type, Gnome.InteractFunction function);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dialog_type" Type="Gnome.DialogType" />
<Parameter Name="function" Type="Gnome.InteractFunction" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="dialog_type">To be added: an object of type 'Gnome.DialogType'</param>
<param name="function">To be added: an object of type 'Gnome.InteractFunction'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetDiscardCommand">
<MemberSignature Language="C#" Value="public void SetDiscardCommand (int argc, string[] argv);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="argc" Type="System.Int32" />
<Parameter Name="argv" Type="System.String[]" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="argc">To be added: an object of type 'int'</param>
<param name="argv">To be added: an object of type 'string[]'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Disconnect">
<MemberSignature Language="C#" Value="public void Disconnect ();" />
<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="Connect">
<MemberSignature Language="C#" Value="public void Connect ();" />
<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="SaveErrorDialog">
<MemberSignature Language="C#" Value="public void SaveErrorDialog (Gtk.Dialog dialog);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dialog" Type="Gtk.Dialog" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="dialog">To be added: an object of type 'Gtk.Dialog'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RequestPhase2">
<MemberSignature Language="C#" Value="public void RequestPhase2 ();" />
<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="SetResignCommand">
<MemberSignature Language="C#" Value="public void SetResignCommand (int argc, string[] argv);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="argc" Type="System.Int32" />
<Parameter Name="argv" Type="System.String[]" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="argc">To be added: an object of type 'int'</param>
<param name="argv">To be added: an object of type 'string[]'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetEnvironment">
<MemberSignature Language="C#" Value="public void SetEnvironment (string name, string value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="name">To be added: an object of type 'string'</param>
<param name="value">To be added: an object of type 'string'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SaveAnyDialog">
<MemberSignature Language="C#" Value="public void SaveAnyDialog (Gtk.Dialog dialog);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dialog" Type="Gtk.Dialog" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="dialog">To be added: an object of type 'Gtk.Dialog'</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 Client (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 Client, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gnome.Client" /> 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 Client (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 Client, 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 Client ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gnome.Client'</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.Client</summary>
<returns>The GLib TYpe for the Gnome.Client class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Priority">
<MemberSignature Language="C#" Value="public uint Priority { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'uint'</param>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RestartStyle">
<MemberSignature Language="C#" Value="public Gnome.RestartStyle RestartStyle { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gnome.RestartStyle</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Gnome.RestartStyle" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gnome.RestartStyle'</param>
<returns>To be added: an object of type 'Gnome.RestartStyle'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Flags">
<MemberSignature Language="C#" Value="public Gnome.ClientFlags Flags { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gnome.ClientFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gnome.ClientFlags'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GlobalConfigPrefix">
<MemberSignature Language="C#" Value="public string GlobalConfigPrefix { set; get; };" />
<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="PreviousId">
<MemberSignature Language="C#" Value="public string PreviousId { 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="Program">
<MemberSignature Language="C#" Value="public string Program { 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="Id">
<MemberSignature Language="C#" Value="public string Id { set; get; };" />
<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="ConfigPrefix">
<MemberSignature Language="C#" Value="public string ConfigPrefix { 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="CurrentDirectory">
<MemberSignature Language="C#" Value="public string CurrentDirectory { 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="UserId">
<MemberSignature Language="C#" Value="public string UserId { 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="DesktopId">
<MemberSignature Language="C#" Value="public string DesktopId { 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="ShutdownCancelled">
<MemberSignature Language="C#" Value="public event EventHandler ShutdownCancelled;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Die">
<MemberSignature Language="C#" Value="public event EventHandler Die;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SaveYourself">
<MemberSignature Language="C#" Value="public event GnomeSharp.SaveYourselfHandler SaveYourself;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Disconnected">
<MemberSignature Language="C#" Value="public event EventHandler Disconnected;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SaveComplete">
<MemberSignature Language="C#" Value="public event EventHandler SaveComplete;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Connected">
<MemberSignature Language="C#" Value="public event GnomeSharp.ConnectedHandler Connected;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>