GtkSharp/doc/en/Gnome/Icon.xml
Miguel de Icaza 41964eaccb Patch from ion_daniel2000@yahoo.com
svn path=/trunk/gtk-sharp/; revision=56305
2006-01-31 02:49:00 +00:00

91 lines
No EOL
5 KiB
XML

<Type Name="Icon" FullName="Gnome.Icon">
<TypeSignature Language="C#" Value="public class Icon" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gnome-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.8.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>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Icon ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="LookupSync">
<MemberSignature Language="C#" Value="public static string LookupSync (Gtk.IconTheme icon_theme, Gnome.ThumbnailFactory thumbnail_factory, string file_uri, string custom_icon, Gnome.IconLookupFlags flags, out Gnome.IconLookupResultFlags result);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="icon_theme" Type="Gtk.IconTheme" />
<Parameter Name="thumbnail_factory" Type="Gnome.ThumbnailFactory" />
<Parameter Name="file_uri" Type="System.String" />
<Parameter Name="custom_icon" Type="System.String" />
<Parameter Name="flags" Type="Gnome.IconLookupFlags" />
<Parameter Name="result" Type="Gnome.IconLookupResultFlags&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="icon_theme">a <see cref="T:Gtk.IconTheme" /></param>
<param name="thumbnail_factory">a <see cref="T:Gnome.ThumbnailFactory" /></param>
<param name="file_uri">a <see cref="T:System.String" /></param>
<param name="custom_icon">a <see cref="T:System.String" /></param>
<param name="flags">a <see cref="T:System.Int32" /></param>
<param name="result">a <see cref="T:Gnome.IconLookupResultFlags" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="Lookup">
<MemberSignature Language="C#" Value="public static string Lookup (Gtk.IconTheme icon_theme, Gnome.ThumbnailFactory thumbnail_factory, string file_uri, string custom_icon, Gnome.Vfs.FileInfo file_info, string mime_type, Gnome.IconLookupFlags flags, out Gnome.IconLookupResultFlags result);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="icon_theme" Type="Gtk.IconTheme" />
<Parameter Name="thumbnail_factory" Type="Gnome.ThumbnailFactory" />
<Parameter Name="file_uri" Type="System.String" />
<Parameter Name="custom_icon" Type="System.String" />
<Parameter Name="file_info" Type="Gnome.Vfs.FileInfo" />
<Parameter Name="mime_type" Type="System.String" />
<Parameter Name="flags" Type="Gnome.IconLookupFlags" />
<Parameter Name="result" Type="Gnome.IconLookupResultFlags&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="icon_theme">
<see cref="T:Gtk.IconTheme" />
</param>
<param name="thumbnail_factory">a <see cref="T:Gnome.ThumbnailFactory" /> used to look up thumbnails.</param>
<param name="file_uri">a <see cref="T:System.String" /> which represents the uri of the file.</param>
<param name="custom_icon">a <see cref="T:System.String" /> whish represent the name of a custom icon to try. This is optional.</param>
<param name="file_info">a <see cref="T:Gnome.Vfs.FileInfo" /> object which contains information about the file.</param>
<param name="mime_type">a <see cref="T:System.String" /> which represents the mime type of the icon.</param>
<param name="flags"> a <see cref="T:Gnome.IconLookupFlag" /> flag that affect the result of the lookup.</param>
<param name="result">To be added.</param>
<summary>This method tries to locate an icon in icon_theme that can be used to represent the file passed. It can optionally also look for existing thumbnails. It does no I/O, so the lookup should be relatively fast.
If you don't know any information about the file already you can use <see cref="M:Gnome.Icon.LookupSync" /> method which gets this information using <see cref="N:Gnome.Vfs" />.</summary>
<returns>The value returned is a <see cref="T:System.String" /> which is the name in absolute path of an image to use for the file.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
</Members>
</Type>