GtkSharp/doc/en/Glade/Parser.xml
Mike Kestner 1b41f742f6 glade doc update
svn path=/trunk/gtk-sharp/; revision=122791
2009-01-08 16:40:35 +00:00

73 lines
3.3 KiB
XML

<Type Name="Parser" FullName="Glade.Parser">
<TypeSignature Language="C#" Value="public class Parser" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>glade-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
</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>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Glade's parser used to turn XML into its internal format.</summary>
<remarks>Parser class loads / parses the .glade files from memory [buffer], or a file in disk.
This class has the helper functions to load the UI description from file/buffer, and
turn it into a GladeInterface, which has metadata about the .glade file,
its connections and properties etc.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Parser ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Default constructor</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="ParseBuffer">
<MemberSignature Language="C#" Value="public static Glade.Interface ParseBuffer (string buffer, string domain);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Glade.Interface</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.String" />
<Parameter Name="domain" Type="System.String" />
</Parameters>
<Docs>
<param name="buffer">a <see cref="T:System.String" /></param>
<param name="domain">a <see cref="T:System.String" /></param>
<summary>This function is similar to <see cref="M:Glade.Parser.ParseFile()" />, except that it parses XML data from a buffer in memory.</summary>
<returns>a <see cref="T:Glade.Interface" /></returns>
<remarks>This could be used to embed an interface into the executable, for instance.
<para>
Generally, user code will not need to call this function. Instead, it should go through the <see cref="T:Glade.XML" /> interfaces.
</para></remarks>
</Docs>
</Member>
<Member MemberName="ParseFile">
<MemberSignature Language="C#" Value="public static Glade.Interface ParseFile (string file, string domain);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Glade.Interface</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="file" Type="System.String" />
<Parameter Name="domain" Type="System.String" />
</Parameters>
<Docs>
<param name="file">a <see cref="T:System.String" /></param>
<param name="domain">a <see cref="T:System.String" /></param>
<summary>This function parses a Glade XML interface file to a <see cref="T:Glade.Interface" /> object (which is libglade's internal representation of the interface data).</summary>
<returns>a <see cref="T:Glade.Interface" /></returns>
<remarks>Generally, user code will not need to call this function. Instead, it should go through the <see cref="T:Glade.XML" /> interfaces.</remarks>
</Docs>
</Member>
</Members>
</Type>