<Type Name="Icon" FullName="Gtk.Icon"> <TypeSignature Language="C#" Value="public class Icon" Maintainer="Hector Gomez M" /> <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Icon extends System.Object" /> <AssemblyInfo> <AssemblyName>gtk-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>Methods for handling icon properties.</summary> <remarks /> </Docs> <Members> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public Icon ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" /> <MemberType>Constructor</MemberType> <ReturnValue /> <Parameters /> <Docs> <summary>A constructor.</summary> <remarks /> </Docs> </Member> <Member MemberName="SizeFromName"> <MemberSignature Language="C#" Value="public static Gtk.IconSize SizeFromName (string name);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype Gtk.IconSize SizeFromName(string name) cil managed" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>Gtk.IconSize</ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> <param name="name">The name to look up.</param> <summary>Looks up the icon size associated with <paramref name="name" />.</summary> <returns>The icon size with the given name.</returns> <remarks /> </Docs> </Member> <Member MemberName="SizeGetName"> <MemberSignature Language="C#" Value="public static string SizeGetName (Gtk.IconSize size);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig string SizeGetName(valuetype Gtk.IconSize size) cil managed" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Parameters> <Parameter Name="size" Type="Gtk.IconSize" /> </Parameters> <Docs> <param name="size">A <see cref="T:Gtk.IconSize" />.</param> <summary>Obtains the canonical name of the given icon size.</summary> <returns>The name of the given icon size.</returns> <remarks> <para> The returned string is statically allocated and should not be freed. </para> </remarks> </Docs> </Member> <Member MemberName="SizeLookup"> <MemberSignature Language="C#" Value="public static bool SizeLookup (Gtk.IconSize size, out int width, out int height);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig bool SizeLookup(valuetype Gtk.IconSize size, int32 width, int32 height) cil managed" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="size" Type="Gtk.IconSize" /> <Parameter Name="width" Type="System.Int32&" RefType="out" /> <Parameter Name="height" Type="System.Int32&" RefType="out" /> </Parameters> <Docs> <param name="size">An icon size.</param> <param name="width">Location to store icon width.</param> <param name="height">Location to store icon height.</param> <summary>Obtains the pixel size of a semantic icon size, possibly modified by user preferences fot the default <see cref="T:Gtk.Settings" />.</summary> <returns> <see langword="true" /> if <paramref name="size" /> was a valid size.</returns> <remarks> <para> Normally size would be <see cref="F:Gtk.IconSize.Menu" />, <see cref="F:Gtk.IconSize.Button" />, etc. This method is not normally needed, <see cref="M:Gtk.Widget.RenderIcon" /> is the usual way to get an icon for rendering, then just look at the size of the rendered pixbuf. The rendered pixbuf may not even correspond to the width/height returned by <see cref="M:Gtk.Icon.SizeLookup" />, because themes are free to render the pixbuf however they like, including changing the usual size. </para> </remarks> </Docs> </Member> <Member MemberName="SizeLookupForSettings"> <MemberSignature Language="C#" Value="public static bool SizeLookupForSettings (Gtk.Settings settings, Gtk.IconSize size, out int width, out int height);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig bool SizeLookupForSettings(class Gtk.Settings settings, valuetype Gtk.IconSize size, int32 width, int32 height) cil managed" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="settings" Type="Gtk.Settings" /> <Parameter Name="size" Type="Gtk.IconSize" /> <Parameter Name="width" Type="System.Int32&" RefType="out" /> <Parameter Name="height" Type="System.Int32&" RefType="out" /> </Parameters> <Docs> <param name="settings">A <see cref="T:Gtk.Settings" /> object, used to determine which set of user preferences to use.</param> <param name="size">An icon size.</param> <param name="width">Location to store icon width.</param> <param name="height">Location to store icon height.</param> <summary>Obtains the pixel size of a semantic icon size, possibly modified by user preferences for a particular <see cref="T:Gtk.Settings" />.</summary> <returns> <see langword="true" /> if <paramref name="size" /> was a valid size.</returns> <remarks> <para> Normally size would be <see cref="F:Gtk.IconSize.Menu" />, <see cref="F:Gtk.IconSize.Button" />, etc. This method is not normally needed, <see cref="M:Gtk.Widget.RenderIcon" /> is the usual way to get an icon for rendering, then just look at the size of the rendered pixbuf. The rendered pixbuf may not even correspond to the width/height returned by <see cref="M:Gtk.Icon.SizeLookup" />, because themes are free to render the pixbuf however they like, including changing the usual size. </para> </remarks> </Docs> </Member> <Member MemberName="SizeRegister"> <MemberSignature Language="C#" Value="public static Gtk.IconSize SizeRegister (string name, int width, int height);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype Gtk.IconSize SizeRegister(string name, int32 width, int32 height) cil managed" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>Gtk.IconSize</ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="width" Type="System.Int32" /> <Parameter Name="height" Type="System.Int32" /> </Parameters> <Docs> <param name="name">Name of the icon size.</param> <param name="width">The icon width.</param> <param name="height">The icon height.</param> <summary>Registers a new icon size.</summary> <returns>Integer value representing the size.</returns> <remarks> <para> Along the same lines as <see cref="F:Gtk.IconSize.Menu" />. Returns integer value for the size. </para> </remarks> </Docs> </Member> <Member MemberName="SizeRegisterAlias"> <MemberSignature Language="C#" Value="public static void SizeRegisterAlias (string alias, Gtk.IconSize target);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig void SizeRegisterAlias(string alias, valuetype Gtk.IconSize target) cil managed" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="alias" Type="System.String" /> <Parameter Name="target" Type="Gtk.IconSize" /> </Parameters> <Docs> <param name="alias">An alias for <paramref name="name" />.</param> <param name="target">An existing icon size.</param> <summary>Registers <paramref name="alias" /> as another name for <paramref name="target" />.</summary> <remarks> <para> Calling <see cref="M:Gtk.Icon.SizeFromName" /> with <paramref name="alias" /> as argument will return <paramref name="target" />. </para> </remarks> </Docs> </Member> </Members> </Type>