[Mono-docs-list] Gtk.Arrow and Gtk.CornerType

Kevin Breit mrproper@ximian.com
21 Feb 2003 12:38:46 -0500
Previous message: [Mono-docs-list] Documentators
Next message: [Mono-docs-list] How to have more FUN documenting gtk-sharp
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
--=-iJb9IgpT98qib7FS+Keg
Content-Type: text/plain
Content-Transfer-Encoding: 7bit

Hey,
	Attached is Gtk.Arrow and Gtk.CornerType.  If someone could review them
and get back to me, I'd appreciate it.

Thanks!
-- 
Kevin Breit <mrproper@ximian.com>

--=-iJb9IgpT98qib7FS+Keg
Content-Disposition: attachment; filename=Arrow.xml
Content-Type: text/xml; name=Arrow.xml; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit

<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 shadow in,
	  shadow out, etched in, or etched out. 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="T:Gtk.Misc"/>, it can be padded 
	  and/or aligned, fill exactly the space the programmer
	  desires.
	</para>
	<para>
	  Arrows are created with a call to gtk_arrow_new(). The direction or
	  style of an arrow can be changed after creation by using
	  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>The enumerated cardinal directions are: GTK_ARROW_UP,
        GTK_ARROW_DOWN, GTK_ARROW_LEFT and GTK_ARROW_RIGHT.  The
        enumerated shadow types are: GTK_SHADOW_NONE, GTK_SHADOW_IN,
        GTK_SHADOW_OUT, GTK_SHADOW_ETCHED_IN and
        GTK_SHADOW_ETCHED_OUT.</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 widge</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 Arrow type.</param>
        <param name="shadow_type">A valid shadow type.</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 Shadow.</returns>
        <remarks>The enumerated shadow types are: GTK_SHADOW_NONE,
        GTK_SHADOW_IN, GTK_SHADOW_OUT, GTK_SHADOW_ETCHED_IN and GTK_SHADOW_ETCHED_OUT.</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>The enumerated cardinal directions are: GTK_ARROW_UP,
        GTK_ARROW_DOWN, GTK_ARROW_LEFT and GTK_ARROW_RIGHT.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>
--=-iJb9IgpT98qib7FS+Keg
Content-Disposition: attachment; filename=CornerType.xml
Content-Type: text/xml; name=CornerType.xml; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit

<Type Name="CornerType" FullName="Gtk.CornerType">
  <TypeSignature Language="C#" Value="public sealed struct
  CornerType;" Maintainer="Kevin Breit" />
  <AssemblyInfo>
    <AssemblyName>gtk-sharp</AssemblyName>
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
    <Attributes />
  </AssemblyInfo>
  <ThreadSafetyStatement>CornerType is a thread safe object.</ThreadSafetyStatement>
  <Docs>
    <summary>Specifies which corner a child widget should be placed in when packed into a GtkScrolledWindow. This is effectively the opposite of where the scroll bars are placed.</summary>
    <remarks>This is effectively the opposite of where the scroll bars are placed.</remarks>
  </Docs>
  <Base>
    <BaseTypeName>System.Enum</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.IComparable</InterfaceName>
    </Interface>
    <Interface>
      <InterfaceName>System.IConvertible</InterfaceName>
    </Interface>
    <Interface>
      <InterfaceName>System.IFormattable</InterfaceName>
    </Interface>
  </Interfaces>
  <Attributes />
  <Members>
    <Member MemberName="TopLeft">
      <MemberSignature Language="C#" Value="public static Gtk.CornerType TopLeft;" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.CornerType</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Place the scrollbars on the right and bottom of the widget (default behaviour).</summary>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="BottomLeft">
      <MemberSignature Language="C#" Value="public static Gtk.CornerType BottomLeft;" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.CornerType</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Place the scrollbars on the top and right of the widget.</summary>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="TopRight">
      <MemberSignature Language="C#" Value="public static Gtk.CornerType TopRight;" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.CornerType</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Place the scrollbars on the left and bottom of the widget.</summary>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="BottomRight">
      <MemberSignature Language="C#" Value="public static Gtk.CornerType BottomRight;" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.CornerType</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Place the scrollbars on the top and left of the widget.</summary>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="value__">
      <MemberSignature Language="C#" Value="public int value__;" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added</summary>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
  </Members>
</Type>
--=-iJb9IgpT98qib7FS+Keg--
Previous message: [Mono-docs-list] Documentators
Next message: [Mono-docs-list] How to have more FUN documenting gtk-sharp
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]