GtkSharp/doc/en/Gtk/Arrow.xml
Kevin Breit 951d74accb 2003-02-21 Kevin Breit <mrproper@ximian.com>
* en/Gtk/Arrow.xml: Fixed a small error where a . was missing at the end of a sentence.

svn path=/trunk/gtk-sharp/; revision=11821
2003-02-22 02:47:23 +00:00

204 lines
7.5 KiB
XML

<Type Name="Arrow" FullName="Gtk.Arrow">
<TypeSignature Language="C#" Value="public class Arrow : Gtk.Misc, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Kevin Breit" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<Attributes />
</AssemblyInfo>
<ThreadSafetyStatement>Arrow is not a thread safe object</ThreadSafetyStatement>
<Docs>
<summary>Produces an Arrow pointing in one of four cardinal directions.</summary>
<remarks>
<para>
Arrow should be used to draw simple arrows that need to point in one of the four cardinal directions (Up, Down, Left, or Right). The style of the arrow can be one of the following: None, In, Out, EtchedIn and EtchedOut. Note that these directions and style types may be ammended in versions of Gtk to come.
</para>
<para>
Arrow will fill any space alloted to it, but since it is inherited from <see cref="C:Gtk.Misc"/>, it can be padded
and/or aligned, fill exactly the space the programmer desires.
</para>
<para>
The direction or style of an arrow can be changed after creation by using <see cref="M:Gtk.Arrow.Set"/>.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Misc</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Atk.Implementor</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="TypeGetType">
<MemberSignature Language="C#" Value="public static uint TypeGetType ();" />
<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></remarks>
</Docs>
</Member>
<Member MemberName="Set">
<MemberSignature Language="C#" Value="public void Set (Gtk.ArrowType arrow_type, Gtk.ShadowType shadow_type);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="arrow_type" Type="Gtk.ArrowType" />
<Parameter Name="shadow_type" Type="Gtk.ShadowType" />
</Parameters>
<Docs>
<summary>Sets the direction and style of the Arrow.</summary>
<param name="arrow_type">A valid ArrowType.</param>
<param name="shadow_type">A valid ShadowType.</param>
<remarks>
<para>The cardinal directions are: Up, Down, Left and Right.</para>
<para>The shadow types are: None, In, Out, EtchedIn and EtchedOut.</para>
</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 of this widget</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Arrow (uint gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype"></param>
<returns>A new Arrow</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Arrow (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal construction</summary>
<param name="raw">A pointer to a GtkArrow, as returned by the Gtk+ C API.</param>
<returns>A C# Gtk.Arrow that wraps the <paramref name="raw"/> parameter</returns>
<remarks>
<para>If you don't already know that you need this constructor, it should not be used.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Arrow (Gtk.ArrowType arrow_type, Gtk.ShadowType shadow_type);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="arrow_type" Type="Gtk.ArrowType" />
<Parameter Name="shadow_type" Type="Gtk.ShadowType" />
</Parameters>
<Docs>
<summary>Constructor</summary>
<param name="arrow_type">A valid ArrowType.</param>
<param name="shadow_type">A valid ShadowType.</param>
<returns>A new Arrow</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Arrow ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Constructor</summary>
<returns>A new Arrow</returns>
<remarks></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>Get the type of this object, as registered with the GLib object system.</summary>
<returns>A number that uniquely identifies this type in the GLib object system</returns>
<remarks><para>Mostly for internal use.</para></remarks>
</Docs>
</Member>
<Member MemberName="ShadowType">
<MemberSignature Language="C#" Value="public Gtk.ShadowType ShadowType { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.ShadowType</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Gtk.ShadowType" />
</Parameters>
<Docs>
<summary>Used to change the appearance of an outline typically provided by a Frame.</summary>
<param name="value">A valid Shadow type.</param>
<returns>Returns a new ShadowType.</returns>
<remarks>
<para>
Changes the appearance of an outline typically provided by a <see cref="T:Gtk.Frame"/>.
</para>
<para>
The shadow types are: None, In, Out, EtchedIn and EtchedOut.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ArrowType">
<MemberSignature Language="C#" Value="public Gtk.ArrowType ArrowType { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.ArrowType</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Gtk.ArrowType" />
</Parameters>
<Docs>
<summary>Used to change the direction of an Arrow.</summary>
<param name="value">A valid ArrowType.</param>
<returns>A new Arrow.</returns>
<remarks>
<para>
Changes the direction of an Arrow.
</para>
<para>
The cardinal directions are: Up, Down, Left and Right.
</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>