GtkSharp/doc/en/Gda/XmlDocument.xml
Mike Kestner ab07fa8056 updates to assembly version elements
svn path=/trunk/gtk-sharp/; revision=46164
2005-06-17 18:43:30 +00:00

222 lines
7.7 KiB
XML

<Type Name="XmlDocument" FullName="Gda.XmlDocument">
<TypeSignature Language="C#" Maintainer="auto" Value="public class XmlDocument : GLib.Object" />
<AssemblyInfo>
<AssemblyName>gda-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.6.0.0</AssemblyVersion>
</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>
<para>
Base class for XML document management.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Members>
<Member MemberName="Stringify">
<MemberSignature Language="C#" Value="public string Stringify ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ToFile">
<MemberSignature Language="C#" Value="public bool ToFile (string uri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="System.String" />
</Parameters>
<Docs>
<summary>
<para>
Saves object to disk file.
</para>
</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>
<para>
That is, it translates the in-memory document structure, transforms it to XML and saves, in the given file, the resulting XML output.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Construct">
<MemberSignature Language="C#" Value="public void Construct (string root_doc);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="root_doc" Type="System.String" />
</Parameters>
<Docs>
<summary>
<para>
Constructs a new XmlDocument.
</para>
</summary>
<param name="root_doc">a <see cref="T:System.String" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public XmlDocument (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>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public XmlDocument (string root_doc);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="root_doc" Type="System.String" />
</Parameters>
<Docs>
<summary>
<para>
Creates s new Gda.XmlDocument, with a root document.
</para>
</summary>
<param name="root_doc">a <see cref="T:System.String" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CompressMode">
<MemberSignature Language="C#" Value="public int CompressMode { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>
Gets / Sets the compression mode that object should use.
</para>
</summary>
<value>a <see cref="T:System.Int32" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Error">
<MemberSignature Language="C#" Value="public event Gda.ErrorHandler Error;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Gda.ErrorHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Signal(CName="error")</AttributeName>
</Attribute>
</Attributes></Member>
<Member MemberName="Warning">
<MemberSignature Language="C#" Value="public event Gda.WarningHandler Warning;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Gda.WarningHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Signal(CName="warning")</AttributeName>
</Attribute>
</Attributes></Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>GType Property.</summary>
<value>a <see cref="T:GLib.GType" /></value>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gda.XmlDocument" />.</remarks>
</Docs>
</Member>
<Member MemberName="OnError">
<MemberSignature Language="C#" Value="protected virtual void OnError (string msg);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="msg" Type="System.String" />
</Parameters>
<Docs>
<summary>Default handler for the <see cref="M:Gda.XmlDocument.Error" /> event.</summary>
<param name="msg">a <see cref="T:System.String" /></param>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gda.XmlDocument.Error" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="OnWarning">
<MemberSignature Language="C#" Value="protected virtual void OnWarning (string msg);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="msg" Type="System.String" />
</Parameters>
<Docs>
<summary>Default handler for the <see cref="M:Gda.XmlDocument.Warning" /> event.</summary>
<param name="msg">a <see cref="T:System.String" /></param>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gda.XmlDocument.Warning" /> event.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected XmlDocument (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete(Message=null, IsError=False)</AttributeName>
</Attribute>
</Attributes></Member>
</Members>
</Type>