GtkSharp/doc/en/GConf/Client.xml
Mike Kestner aa928785b7 GConf doc updates
svn path=/trunk/gtk-sharp/; revision=122792
2009-01-08 16:49:42 +00:00

109 lines
4.1 KiB
XML

<Type Name="Client" FullName="GConf.Client">
<TypeSignature Language="C#" Value="public class Client : GConf.ClientBase" Maintainer="John Luke" />
<AssemblyInfo>
<AssemblyName>gconf-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
<Base>
<BaseTypeName>GConf.ClientBase</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Basic functions to initialize GConf and get/set values.</summary>
<remarks>The following example attempts to retrieve a setting from GConf, and set a default value otherwise.</remarks>
<example>
<code language="C#">
string MyVal;
GConf.Client gconfClient = new GConf.Client ();
try
{
MyVal = (string) gconfClient.Get ("/apps/monoapps/SampleApp/setting1"));
}
catch (GConf.NoSuchKeyException)
{
gconfClient.Set ("/apps/monoapps/SampleApp/setting1", "sample");
}
</code>
</example>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Client ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Creates a new <see cref="T:GConf.Client" />.</summary>
<remarks>This is the default constructor for <see cref="T:GConf.Client" />.</remarks>
</Docs>
</Member>
<Member MemberName="AddNotify">
<MemberSignature Language="C#" Value="public void AddNotify (string dir, GConf.NotifyEventHandler notify);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dir" Type="System.String" />
<Parameter Name="notify" Type="GConf.NotifyEventHandler" />
</Parameters>
<Docs>
<param name="dir">an object of type <see cref="T:System.String" /></param>
<param name="notify">an object of type <see cref="T:GConf.NotifyEventHandler" /></param>
<summary>Registers a notification request.</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="Get">
<MemberSignature Language="C#" Value="public override object Get (string key);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="System.String" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RemoveNotify">
<MemberSignature Language="C#" Value="public void RemoveNotify (string dir, GConf.NotifyEventHandler notify);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dir" Type="System.String" />
<Parameter Name="notify" Type="GConf.NotifyEventHandler" />
</Parameters>
<Docs>
<param name="dir">an object of type <see cref="T:System.String" /></param>
<param name="notify">an object of type <see cref="T:GConf.NotifyEventHandler" /></param>
<summary>Removes a notification request.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="SuggestSync">
<MemberSignature Language="C#" Value="public void SuggestSync ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Suggests that you have just finished a block of changes, and it would be an optimal time to sync to permanent storage.</summary>
<remarks>This function is just a "hint" provided to maximize efficiency and minimize data loss.</remarks>
</Docs>
</Member>
</Members>
</Type>