GtkSharp/doc/en/GLib/InputStream.xml
Mike Kestner b2d042d6a5 GLib updater run
svn path=/trunk/gtk-sharp/; revision=134155
2009-05-14 18:32:22 +00:00

540 lines
20 KiB
XML

<Type Name="InputStream" FullName="GLib.InputStream">
<TypeSignature Language="C#" Value="public class InputStream : GLib.Object" />
<AssemblyInfo>
<AssemblyName>gio-sharp</AssemblyName>
</AssemblyInfo>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected InputStream ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected InputStream (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<param name="gtype">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public InputStream (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="raw">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="ClearPending">
<MemberSignature Language="C#" Value="public void ClearPending ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="Close">
<MemberSignature Language="C#" Value="public bool Close (GLib.Cancellable cancellable);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellable" Type="GLib.Cancellable" />
</Parameters>
<Docs>
<param name="cancellable">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="CloseAsync">
<MemberSignature Language="C#" Value="public void CloseAsync (int io_priority, GLib.Cancellable cancellable, GLib.AsyncReadyCallback cb);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="io_priority" Type="System.Int32" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
<Parameter Name="cb" Type="GLib.AsyncReadyCallback" />
</Parameters>
<Docs>
<param name="io_priority">To be added.</param>
<param name="cancellable">To be added.</param>
<param name="cb">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="CloseFinish">
<MemberSignature Language="C#" Value="public bool CloseFinish (GLib.AsyncResult result);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="GLib.AsyncResult" />
</Parameters>
<Docs>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.GType</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="HasPending">
<MemberSignature Language="C#" Value="public bool HasPending { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="IsClosed">
<MemberSignature Language="C#" Value="public bool IsClosed { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="OnCloseAsync">
<MemberSignature Language="C#" Value="protected virtual void OnCloseAsync (int io_priority, GLib.Cancellable cancellable, GLib.AsyncReadyCallback cb);" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideCloseAsync", Type=typeof(GLib.InputStream))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="io_priority" Type="System.Int32" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
<Parameter Name="cb" Type="GLib.AsyncReadyCallback" />
</Parameters>
<Docs>
<param name="io_priority">To be added.</param>
<param name="cancellable">To be added.</param>
<param name="cb">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="OnCloseFinish">
<MemberSignature Language="C#" Value="protected virtual bool OnCloseFinish (GLib.AsyncResult result);" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideCloseFinish", Type=typeof(GLib.InputStream))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="GLib.AsyncResult" />
</Parameters>
<Docs>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="OnCloseFn">
<MemberSignature Language="C#" Value="protected virtual bool OnCloseFn (GLib.Cancellable cancellable);" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideCloseFn", Type=typeof(GLib.InputStream))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellable" Type="GLib.Cancellable" />
</Parameters>
<Docs>
<param name="cancellable">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="OnReadAsync">
<MemberSignature Language="C#" Value="protected virtual void OnReadAsync (IntPtr buffer, ulong count, int io_priority, GLib.Cancellable cancellable, GLib.AsyncReadyCallback cb);" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideReadAsync", Type=typeof(GLib.InputStream))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.IntPtr" />
<Parameter Name="count" Type="System.UInt64" />
<Parameter Name="io_priority" Type="System.Int32" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
<Parameter Name="cb" Type="GLib.AsyncReadyCallback" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<param name="count">To be added.</param>
<param name="io_priority">To be added.</param>
<param name="cancellable">To be added.</param>
<param name="cb">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="OnReadFinish">
<MemberSignature Language="C#" Value="protected virtual long OnReadFinish (GLib.AsyncResult result);" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideReadFinish", Type=typeof(GLib.InputStream))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="GLib.AsyncResult" />
</Parameters>
<Docs>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="OnReadFn">
<MemberSignature Language="C#" Value="protected virtual long OnReadFn (IntPtr buffer, ulong count, GLib.Cancellable cancellable);" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideReadFn", Type=typeof(GLib.InputStream))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.IntPtr" />
<Parameter Name="count" Type="System.UInt64" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<param name="count">To be added.</param>
<param name="cancellable">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="OnSkip">
<MemberSignature Language="C#" Value="protected virtual long OnSkip (ulong count, GLib.Cancellable cancellable);" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideSkip", Type=typeof(GLib.InputStream))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="count" Type="System.UInt64" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
</Parameters>
<Docs>
<param name="count">To be added.</param>
<param name="cancellable">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="OnSkipAsync">
<MemberSignature Language="C#" Value="protected virtual void OnSkipAsync (ulong count, int io_priority, GLib.Cancellable cancellable, GLib.AsyncReadyCallback cb);" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideSkipAsync", Type=typeof(GLib.InputStream))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="count" Type="System.UInt64" />
<Parameter Name="io_priority" Type="System.Int32" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
<Parameter Name="cb" Type="GLib.AsyncReadyCallback" />
</Parameters>
<Docs>
<param name="count">To be added.</param>
<param name="io_priority">To be added.</param>
<param name="cancellable">To be added.</param>
<param name="cb">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="OnSkipFinish">
<MemberSignature Language="C#" Value="protected virtual long OnSkipFinish (GLib.AsyncResult result);" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideSkipFinish", Type=typeof(GLib.InputStream))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="GLib.AsyncResult" />
</Parameters>
<Docs>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="Read">
<MemberSignature Language="C#" Value="public long Read (byte[] buffer, ulong count, GLib.Cancellable cancellable);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="count" Type="System.UInt64" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<param name="count">To be added.</param>
<param name="cancellable">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="ReadAll">
<MemberSignature Language="C#" Value="public bool ReadAll (byte[] buffer, ulong count, out ulong bytes_read, GLib.Cancellable cancellable);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="count" Type="System.UInt64" />
<Parameter Name="bytes_read" Type="System.UInt64&amp;" RefType="out" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<param name="count">To be added.</param>
<param name="bytes_read">To be added.</param>
<param name="cancellable">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="ReadAsync">
<MemberSignature Language="C#" Value="public void ReadAsync (byte[] buffer, ulong count, int io_priority, GLib.Cancellable cancellable, GLib.AsyncReadyCallback cb);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="count" Type="System.UInt64" />
<Parameter Name="io_priority" Type="System.Int32" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
<Parameter Name="cb" Type="GLib.AsyncReadyCallback" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<param name="count">To be added.</param>
<param name="io_priority">To be added.</param>
<param name="cancellable">To be added.</param>
<param name="cb">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="ReadFinish">
<MemberSignature Language="C#" Value="public long ReadFinish (GLib.AsyncResult result);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="GLib.AsyncResult" />
</Parameters>
<Docs>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="SetPending">
<MemberSignature Language="C#" Value="public bool SetPending ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="Skip">
<MemberSignature Language="C#" Value="public long Skip (ulong count, GLib.Cancellable cancellable);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="count" Type="System.UInt64" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
</Parameters>
<Docs>
<param name="count">To be added.</param>
<param name="cancellable">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="SkipAsync">
<MemberSignature Language="C#" Value="public void SkipAsync (ulong count, int io_priority, GLib.Cancellable cancellable, GLib.AsyncReadyCallback cb);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="count" Type="System.UInt64" />
<Parameter Name="io_priority" Type="System.Int32" />
<Parameter Name="cancellable" Type="GLib.Cancellable" />
<Parameter Name="cb" Type="GLib.AsyncReadyCallback" />
</Parameters>
<Docs>
<param name="count">To be added.</param>
<param name="io_priority">To be added.</param>
<param name="cancellable">To be added.</param>
<param name="cb">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
<Member MemberName="SkipFinish">
<MemberSignature Language="C#" Value="public long SkipFinish (GLib.AsyncResult result);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="GLib.AsyncResult" />
</Parameters>
<Docs>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
</Members>
</Type>