GtkSharp/doc/en/GConf/Client.xml
Shane Landrum 87843406b7 2005-01-07 Shane Landrum <epicene@pobox.com>
* en/GConf/ChangeSet.xml
	* en/GConf/NoSuchKeyException.xml
	* en/GConf/NotifyEventArgs.xml
	* en/GConf/ClientBase.xml
	* en/GConf/NotifyFuncNative.xml
	* en/GConf/Client.xml: Cleaned up and added docs.


svn path=/trunk/gtk-sharp/; revision=38494
2005-01-07 16:04:26 +00:00

145 lines
5.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>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyCulture>neutral</AssemblyCulture>
<Attributes />
</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>
<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>
<Base>
<BaseTypeName>GConf.ClientBase</BaseTypeName>
</Base>
<Interfaces />
<Attributes />
<Members>
<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>
<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>
<summary>Removes a notification request.</summary>
<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>
<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>
<summary>Registers a notification request.</summary>
<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>
<remarks></remarks>
</Docs>
</Member>
<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>
<returns>an object of type <see cref="T:GConf.Client" /></returns>
<remarks>This is the default constructor for <see cref="T:GConf.Client" />.</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>
<summary>Gets a value from the GConf source.</summary>
<param name="key">an object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:System.Object" /></returns>
<remarks>Normally you will need to convert the value to the correct type before using it.
Here is how you could set a <see cref="T:Gtk.Toolbar" /> to use the system-wide setting for style.</remarks>
<example>
<code language="C#">
// assuming you have a Gtk.Toolbar named toolbar1
string val;
try
{
GConf.Client gconfclient = new GConf.Client ();
val = (string) gconfclient.Get ("/desktop/gnome/interface/toolbar_style");
}
catch (GConf.NoSuchKeyException)
{
val = "both";
}
switch (val) {
case "both":
toolbar1.ToolbarStyle = Gtk.ToolbarStyle.Both;
break;
case "text":
toolbar1.ToolbarStyle = Gtk.ToolbarStyle.Text;
break;
case "both_horiz":
toolbar1.ToolbarStyle = Gtk.ToolbarStyle.BothHoriz;
break;
default:
toolbar1.ToolbarStyle = Gtk.ToolbarStyle.Icons;
break;
}
</code>
</example>
</Docs>
</Member>
</Members>
</Type>