GtkSharp/doc/en/Atk/Value.xml
Mike Kestner 352fc8e849 Run the doc updater
Didn't audit any of this.
2012-03-28 22:10:46 -05:00

110 lines
5.2 KiB
XML

<Type Name="Value" FullName="Atk.Value">
<TypeSignature Language="C#" Maintainer="auto" Value="public interface Value : GLib.IWrapper" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract Value implements class GLib.IWrapper" />
<AssemblyInfo>
<AssemblyName>atk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
</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>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>The interface implemented by valuators and components which display or select a value from a bounded range of values.
</summary>
<remarks>
<see cref="T:Atk.Value" /> should be implemented for components which either display a value from a bounded range, or which allow the user to specify a value from a bounded range, or both. For instance, most sliders and range controls, as well as dials, should have <see cref="T:Atk.Object" /> representations which implement <see cref="T:Atk.Value" /> on the component's behalf. <see cref="T:Atk.Value" />s may be read-only, in which case attempts to alter the value return <see langword="false" /> to indicate failure.</remarks>
</Docs>
<Members>
<Member MemberName="GetCurrentValue">
<MemberSignature Language="C#" Value="public void GetCurrentValue (ref GLib.Value value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void GetCurrentValue(valuetype GLib.Value value) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="GLib.Value&amp;" RefType="ref" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="GetMaximumValue">
<MemberSignature Language="C#" Value="public void GetMaximumValue (ref GLib.Value value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void GetMaximumValue(valuetype GLib.Value value) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="GLib.Value&amp;" RefType="ref" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="GetMinimumIncrement">
<MemberSignature Language="C#" Value="public void GetMinimumIncrement (ref GLib.Value value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void GetMinimumIncrement(valuetype GLib.Value value) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="GLib.Value&amp;" RefType="ref" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="GetMinimumValue">
<MemberSignature Language="C#" Value="public void GetMinimumValue (ref GLib.Value value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void GetMinimumValue(valuetype GLib.Value value) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="GLib.Value&amp;" RefType="ref" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="SetCurrentValue">
<MemberSignature Language="C#" Value="public bool SetCurrentValue (GLib.Value value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool SetCurrentValue(valuetype GLib.Value value) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="GLib.Value" />
</Parameters>
<Docs>
<param name="value">an object of type <see cref="T:GLib.Value" /> which is the desired new accessible value.</param>
<summary>Sets the value of this object.</summary>
<returns>
<see langword="true" /> if new value is successfully set, otherwise <see langword="false" />.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>