GtkSharp/doc/en/Gtk/FileInfo.xml
Shane Landrum 59a94673b6 2005-01-04 Shane Landrum <epicene@pobox.com>
* en/Gtk/Image.xml
	* en/Gtk/RetrieveSurroundingArgs.xml
	* en/Gtk/IMMulticontext.xml
	* en/Gtk/FileInfo.xml
	* en/Gtk/FileInfoType.xml
	* en/Gtk/IMStatusStyle.xml
	* en/Gtk/RetrieveSurroundingHandler.xml
	* en/Gtk/IMPreeditStyle.xml: Added docs.


svn path=/trunk/gtk-sharp/; revision=38328
2005-01-04 21:05:14 +00:00

192 lines
7.2 KiB
XML

<Type Name="FileInfo" FullName="Gtk.FileInfo">
<TypeSignature Language="C#" Value="public class FileInfo : GLib.Opaque, IWrapper" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>[00 24 00 00 04 80 00 00 94 00 00 00 06 02 00 00 00 24 00 00 52 53 41 31 00 04 00 00 01 00 01 00 71 EB 6C 55 75 52 9C BF 72 44 F7 A6 EA 05 62 84 F9 EA E0 3B CF F2 CC 13 2C 9C 49 0A B3 09 EA B0 B5 6B CE 44 9D F5 03 D9 C0 A8 1E 52 05 85 CD BE 70 E2 FB 90 43 4B AC 04 FA 62 22 A8 00 98 B7 A1 A7 B3 AF 99 1A 41 23 24 BB 43 25 F6 B8 65 BB 64 EB F6 D1 C2 06 D5 73 2D DF BC 70 A7 38 9E E5 3E 0C 24 6E 32 79 74 1A D0 05 03 E4 98 42 E1 9B F3 7B 19 8B 40 21 26 CB 36 89 C2 EA 64 96 A4 7C B4]</AssemblyPublicKey>
<AssemblyVersion>2.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>
A class for handling information about files.
</summary>
<remarks>
For use with <see cref="T:Gtk.FileSystem"/> classes.
</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Opaque</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="Free">
<MemberSignature Language="C#" Value="public void Free ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Frees memory associated with this data structure.</summary>
<remarks>Subject to change in the future.</remarks>
</Docs>
</Member>
<Member MemberName="Copy">
<MemberSignature Language="C#" Value="public Gtk.FileInfo Copy ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.FileInfo</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns a new object that's a copy of this object.</summary>
<returns>a <see cref="T:Gtk.FileInfo" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FileInfo (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Public constructor for internal use only.</summary>
<param name="raw">a <see cref="T:System.IntPtr" />, the underlying C object.</param>
<returns>a <see cref="T:Gtk.FileInfo" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FileInfo ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Public constructor.</summary>
<returns>a <see cref="T:Gtk.FileInfo" /></returns>
<remarks></remarks>
</Docs>
</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>When making a derived class, override this method to change
that class's <see cref="T:GLib.GType" />.</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="DisplayName">
<MemberSignature Language="C#" Value="public string DisplayName { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The file's name.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="MimeType">
<MemberSignature Language="C#" Value="public string MimeType { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The file's MIME type.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ModificationTime">
<MemberSignature Language="C#" Value="public long ModificationTime { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The file's last-modified time.</summary>
<returns>a <see cref="T:System.Int64" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Size">
<MemberSignature Language="C#" Value="public long Size { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The file's size.</summary>
<returns>a <see cref="T:System.Int64" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="IsHidden">
<MemberSignature Language="C#" Value="public bool IsHidden { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Whether the file is hidden or not.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="DisplayKey">
<MemberSignature Language="C#" Value="public string DisplayKey { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Generates a collation key on the display name for faster sorting.</summary>
<returns>a <see cref="T:System.String" />,
the collate key for the display name, or <see langword="null"/>
if the display name hasn't been set.</returns>
<remarks>
The collate key is a string that can be usefully compared with
others using the C method strcmp().
This is useful when sorting a bunch of <see cref="T:Gtk.FileInfo"/>
objects since the collate key will be only computed once.
</remarks>
</Docs>
</Member>
<Member MemberName="IsFolder">
<MemberSignature Language="C#" Value="public bool IsFolder { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Whether the file is actually a folder or not.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>