GtkSharp/doc/en/Rsvg/Handle.xml

<Type Name="Handle" FullName="Rsvg.Handle">
  <TypeSignature Language="C#" Value="public class Handle : GLib.Opaque, IWrapper" Maintainer="auto" />
  <AssemblyInfo>
    <AssemblyName>rsvg-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>To be added</summary>
    <remarks>To be added</remarks>
  </Docs>
  <Base>
    <BaseTypeName>GLib.Opaque</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>GLib.IWrapper</InterfaceName>
    </Interface>
  </Interfaces>
  <Attributes />
  <Members>
    <Member MemberName="Close">
      <MemberSignature Language="C#" Value="public bool Close ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Close, to indicate that loading the image is complete. </summary>
        <returns>
          <see langword="true" /> if the loader closed successfully, or <see langword="false" /> if there was an error.</returns>
        <remarks>This will return <see langword="true" /> if the loader closed successfully.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Free">
      <MemberSignature Language="C#" Value="public void Free ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Frees handle.</summary>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Handle (IntPtr raw);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="raw" Type="System.IntPtr" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="raw">a <see cref="T:System.IntPtr" /></param>
        <returns>a <see cref="T:Rsvg.Handle" /></returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Handle ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>Returns a new rsvg handle.</summary>
        <returns>a new <see cref="T:Rsvg.Handle" /></returns>
        <remarks>This handle can be used for dynamically loading an image. You need to feed it data using <see cref="M:Rsvg.Handle.Write()" />, then call <see cref="M:Rsvg.Handle.Close()" /> when done. No more than one image can be loaded with one handle.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Pixbuf">
      <MemberSignature Language="C#" Value="public Gdk.Pixbuf Pixbuf { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Pixbuf</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>The pixbuf loaded by handle.</summary>
        <returns>a <see cref="T:Gdk.Pixbuf" /></returns>
        <remarks>If insufficient data has been read to create the pixbuf, or an error occurred in loading, then <see langword="null" /> will be returned.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Dpi">
      <MemberSignature Language="C#" Value="public double Dpi { set; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Sets the DPI for the all future outgoing pixbufs.</summary>
        <returns> Dots Per Inch (aka Pixels Per Inch)</returns>
        <remarks>Common values are 72, 90, and 300 DPI. Passing a number &lt;= 0 to dpi will reset the DPI to whatever the default value happens to be.</remarks>
      </Docs>
    </Member>
    <Member MemberName="NewGz">
      <MemberSignature Language="C#" Value="public static Rsvg.Handle NewGz ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Rsvg.Handle</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>See <see cref="C:Rsvg.Handle" />, except that this will handle GZipped SVGs (svgz)</summary>
        <returns>a <see cref="T:Rsvg.Handle" /></returns>
        <remarks>Use the returned handle identically to how you use a handle returned from <see cref="C:Rsvg.Handle" /></remarks>
      </Docs>
    </Member>
    <Member MemberName="Write">
      <MemberSignature Language="C#" Value="public bool Write (byte [] buf, uint count);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="buf" Type="System.Byte[]" />
        <Parameter Name="count" Type="System.UInt32" />
      </Parameters>
      <Docs>
        <summary>Loads the next <paramref name="count" /> bytes</summary>
        <param name="buf"> Pointer to svg data</param>
        <param name="count"> length of the <paramref name="buf" /> buffer in bytes</param>
        <returns>a <see cref="T:System.Boolean" /></returns>
        <remarks>This will return <see langword="true" /> if the data was loaded successful, and <see langword="false" /> if an error occurred. In the latter case, the loader will be closed, and will not accept further writes.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>