GtkSharp/doc/en/Gnome/CanvasWidget.xml

<Type Name="CanvasWidget" FullName="Gnome.CanvasWidget">
  <TypeSignature Language="C#" Value="public class CanvasWidget : Gnome.CanvasItem, IWrapper, IDisposable" Maintainer="auto" />
  <AssemblyInfo>
    <AssemblyName>gnome-sharp</AssemblyName>
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
    <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>Widget canvas item</summary>
    <remarks>
      <para>
        A canvas item for placing arbitrary <see cref="T:Gtk.Widget" /> objects onto a
        canvas.
      </para>
    </remarks>
  </Docs>
  <Base>
    <BaseTypeName>Gnome.CanvasItem</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>GLib.IWrapper</InterfaceName>
    </Interface>
    <Interface>
      <InterfaceName>System.IDisposable</InterfaceName>
    </Interface>
  </Interfaces>
  <Attributes />
  <Members>
    <Member MemberName="Finalize">
      <MemberSignature Language="C#" Value="protected override void Finalize ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Disposes the resources associated with the object.</summary>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public CanvasWidget (IntPtr raw);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="raw" Type="System.IntPtr" />
      </Parameters>
      <Docs>
        <summary>Internal constructor</summary>
        <param name="raw">Pointer to the C object.</param>
        <returns>An instance of CanvasWidget, wrapping the C object.</returns>
        <remarks>
          <para>This is an internal constructor, and should not be used by user code.</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected CanvasWidget ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>To be added</summary>
        <returns>To be added: an object of type 'Gnome.CanvasWidget'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public CanvasWidget (Gnome.CanvasGroup group);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="group" Type="Gnome.CanvasGroup" />
      </Parameters>
      <Docs>
        <summary>Creates a new Widget container</summary>
        <param name="group">
          The <see cref="T:Gnome.CanvasGroup" /> that this item
          belongs to.
        </param>
        <returns>the newly-created <see cref="T:Gnome.CanvasWidget" /> object</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>The GLib Type for Gnome.CanvasWidget</summary>
        <returns>The GLib Type for the Gnome.CanvasWidget class.</returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Width">
      <MemberSignature Language="C#" Value="public double Width { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Parameters></Parameters>
      <Docs>
        <summary>
          Width of widget (units specified by <see cref="P:Gnome.CanvasWidget.SizePixels" /> property).
        </summary>
        <param name="value">the width of the widget</param>
        <returns>the width of the widget</returns>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="Height">
      <MemberSignature Language="C#" Value="public double Height { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Parameters></Parameters>
      <Docs>
        <summary>
          Height of widget (units specified by <see cref="P:Gnome.CanvasWidget.SizePixels" /> property).
        </summary>
        <param name="value">the height of the widget</param>
        <returns>the height of the widget</returns>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="Anchor">
      <MemberSignature Language="C#" Value="public Gtk.AnchorType Anchor { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.AnchorType</ReturnType>
      </ReturnValue>
      <Parameters></Parameters>
      <Docs>
        <summary>Anchor position for widget.</summary>
        <param name="value">the anchor's position</param>
        <returns>anchor position for the widget</returns>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="Widget">
      <MemberSignature Language="C#" Value="public Gtk.Widget Widget { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.Widget</ReturnType>
      </ReturnValue>
      <Parameters></Parameters>
      <Docs>
        <summary>The embedded widget</summary>
        <param name="value">The embedded widget</param>
        <returns>the embedded widget</returns>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="SizePixels">
      <MemberSignature Language="C#" Value="public bool SizePixels { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters></Parameters>
      <Docs>
        <summary>Whether the widget size is specified in pixels or canvas units.</summary>
        <param name="value">
          <see langword="true" /> to use pixels unit, <see langword="false" /> to use canvas units
        </param>
        <returns>whether the widget size is specified in pixels or canvas units.</returns>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="Y">
      <MemberSignature Language="C#" Value="public double Y { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Parameters></Parameters>
      <Docs>
        <summary>Y coordinate of anchor point.</summary>
        <param name="value">Y coordinate of anchor point.</param>
        <returns>Y coordinate of anchor point.</returns>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="X">
      <MemberSignature Language="C#" Value="public double X { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Parameters></Parameters>
      <Docs>
        <summary>X coordinate of anchor point.</summary>
        <param name="value">X coordinate of anchor point.</param>
        <returns>X coordinate of anchor point.</returns>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected CanvasWidget (GLib.Type gtype);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="gtype" Type="GLib.Type" />
      </Parameters>
      <Docs>
        <summary>Internal constructor</summary>
        <param name="gtype">GLib type for the type</param>
        <returns>Creates a new instance of CanvasWidget, using the GLib-provided type</returns>
        <remarks>
          <para>This is a constructor used by derivative types of <see cref="T:Gnome.CanvasWidget" /> that would have their own GLib type assigned to it.  This is not typically used by C# code.</para>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>