GtkSharp/doc/en/Atk/Value.xml

89 lines
3.9 KiB
XML
Raw Normal View History

<Type Name="Value" FullName="Atk.Value">
<TypeSignature Language="C#" Value="public abstract interface Value;" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>atk-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 <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<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>
<Base />
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="SetCurrentValue">
<MemberSignature Language="C#" Value="public virtual bool SetCurrentValue (GLib.Value value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="GLib.Value" />
</Parameters>
<Docs>
<summary>Sets the value of this object.</summary>
<param name="value">an object of type <see cref="T:GLib.Value" /> which is the desired new accessible value.</param>
<returns>
<see langword="true" /> if new value is successfully set, otherwise <see langword="false" />.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetMinimumValue">
<MemberSignature Language="C#" Value="public virtual void GetMinimumValue (GLib.Value value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="GLib.Value" />
</Parameters>
<Docs>
<summary>Gets the minimum value of this object.</summary>
<param name="value">an object of type <see cref="T:GLib.Value" /> representing the minimum accessible value</param>
<remarks />
</Docs>
</Member>
<Member MemberName="GetMaximumValue">
<MemberSignature Language="C#" Value="public virtual void GetMaximumValue (GLib.Value value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="GLib.Value" />
</Parameters>
<Docs>
<summary>Gets the maximum value of this object.</summary>
<param name="value">an object of type <see cref="T:GLib.Value" /> representing the maximum accessible value</param>
<remarks />
</Docs>
</Member>
<Member MemberName="CurrentValue">
<MemberSignature Language="C#" Value="public virtual GLib.Value CurrentValue { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.Value</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Gets the value of this object.</summary>
<returns>a <see cref="T:GLib.Value" /> representing the current accessible value.</returns>
<remarks>
</remarks>
</Docs>
</Member>
</Members>
</Type>