1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
|
<Type Name="IconSet" FullName="Gtk.IconSet">
<TypeSignature Language="C#" Maintainer="duncan" Value="public class IconSet : GLib.Opaque" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit IconSet extends GLib.Opaque" />
<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>GLib.Opaque</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Docs>
<summary>
A <see cref="T:Gtk.IconSet" /> represents a single icon in various sizes and widget states.
</summary>
<remarks>
A <see cref="T:Gtk.IconSet" /> represents a single icon in
various sizes and widget states. It can provide a <see cref="T:Gdk.Pixbuf" /> for a given size and state on request,
and automatically caches some of the rendered <see cref="T:Gdk.Pixbuf" /> objects.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IconSet ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>
Creates a new <see cref="T:Gtk.IconSet" />. A <see cref="T:Gtk.IconSet" /> represents a single
icon in various sizes and widget states. It can provide a
<see cref="T:Gdk.Pixbuf" /> for a given size and state on request, and
automatically caches some of the rendered <see cref="T:Gdk.Pixbuf" /> objects.
</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IconSet (Gdk.Pixbuf pixbuf);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Gdk.Pixbuf pixbuf) cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="pixbuf" Type="Gdk.Pixbuf" />
</Parameters>
<Docs>
<param name="pixbuf">
a <see cref="T:Gdk.Pixbuf" /></param>
<summary>
Creates a new <see cref="T:Gtk.IconSet" /> with <paramref name="pixbuf" /> as the default/fallback source image.
</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IconSet (IntPtr raw);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int raw) cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="raw">Pointer to the C object.</param>
<summary>Internal constructor</summary>
<remarks>
<para>This is an internal constructor, and should not be used by user code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="AddSource">
<MemberSignature Language="C#" Value="public void AddSource (Gtk.IconSource source);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddSource(class Gtk.IconSource source) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="source" Type="Gtk.IconSource" />
</Parameters>
<Docs>
<param name="source">an object of type <see cref="T:Gtk.IconSource" /></param>
<summary>
Adds an IconSource to the current IconSet.
</summary>
<remarks>
<para>
Icon sets have a list of <see cref="T:Gtk.IconSource" />,
which they use as base icons for rendering icons in
different states and sizes. Icons are scaled, made to look
insensitive, etc. in <see cref="M:Gtk.Style.RenderIcon(Gtk.IconSource,Gtk.TextDirection,Gtk.StateType,Gtk.IconSize,Gtk.Widget,System.String)" />,
but <see cref="T:Gtk.IconSet" /> needs base images to work
with. The base images and when to use them are described
by a <see cref="T:Gtk.IconSource" />.
</para>
<para>
This function copies <paramref name="source" />, so you can reuse the same
source immediately without affecting the icon set.
</para>
<para>
An example of when you'd use this function: a web
browser's "Back to Previous Page" icon might point in a
different direction in Hebrew and in English; it might
look different when insensitive; and it might change size
depending on toolbar mode (small/large icons). So a single
icon set would contain all those variants of the icon, and
you might add a separate source for each one.
</para>
<para>
You should nearly always add a "default" icon source with
all fields wildcarded, which will be used as a fallback if
no more specific source matches. <see cref="T:Gtk.IconSet" />always prefers more specific icon sources to more
generic icon sources. The order in which you add the
sources to the icon set does not matter.
</para>
<para>
This <see cref="C:Gtk.IconSet(Gdk.Pixbuf)" /> constructor
creates a new icon set with a default icon source based on
the given pixbuf.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Copy">
<MemberSignature Language="C#" Value="public Gtk.IconSet Copy ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Gtk.IconSet Copy() cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.IconSet</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Copy the IconSet by value.
</summary>
<returns>a copy of the current IconSet</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="~IconSet ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Finalize() cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; }" />
<MemberSignature Language="ILAsm" Value=".property valuetype GLib.GType GType" />
<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:Gtk.IconSet" />.</remarks>
</Docs>
</Member>
<Member MemberName="Ref">
<MemberSignature Language="C#" Value="public Gtk.IconSet Ref ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Gtk.IconSet Ref() cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Gtk.IconSet is now refcounted automatically")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gtk.IconSet</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Increments the reference count.</summary>
<returns>the IconSet with the incremented reference count</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Ref">
<MemberSignature Language="C#" Value="protected override void Ref (IntPtr raw);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Ref(native int raw) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="raw">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="RenderIcon">
<MemberSignature Language="C#" Value="public Gdk.Pixbuf RenderIcon (Gtk.Style style, Gtk.TextDirection direction, Gtk.StateType state, Gtk.IconSize size, Gtk.Widget widget, string detail);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Gdk.Pixbuf RenderIcon(class Gtk.Style style, valuetype Gtk.TextDirection direction, valuetype Gtk.StateType state, valuetype Gtk.IconSize size, class Gtk.Widget widget, string detail) cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="style" Type="Gtk.Style" />
<Parameter Name="direction" Type="Gtk.TextDirection" />
<Parameter Name="state" Type="Gtk.StateType" />
<Parameter Name="size" Type="Gtk.IconSize" />
<Parameter Name="widget" Type="Gtk.Widget" />
<Parameter Name="detail" Type="System.String" />
</Parameters>
<Docs>
<param name="style">
a <see cref="T:Gtk.Style" /> associated with widget, or <see langword="null" /></param>
<param name="direction">The text direction</param>
<param name="state">The widget state</param>
<param name="size">The size of the icon</param>
<param name="widget">
widget that will display the icon, or <see langword="null" /></param>
<param name="detail">
detail to pass to the theme engine, or <see langword="null" /></param>
<summary>
Renders an icon using <see cref="M:Gtk.Style.RenderIcon(Gtk.IconSource,Gtk.TextDirection,Gtk.StateType,Gtk.IconSize,Gtk.Widget,System.String)" /></summary>
<returns>a <see cref="T:Gdk.Pixbuf" /> to be displayed</returns>
<remarks>
Renders an icon using <see cref="M:Gtk.Style.RenderIcon(Gtk.IconSource,Gtk.TextDirection,Gtk.StateType,Gtk.IconSize,Gtk.Widget,System.String)" />. In
most cases, <see cref="M:Gtk.Widget.RenderIcon(System.String,Gtk.IconSize,System.String)" /> is better, since it automatically provides most of the arguments from the
current widget settings. This function never returns <see langword="null" />;
if the icon can't be rendered (perhaps because an image file
fails to load), a default "missing image" icon will be
returned instead.
</remarks>
</Docs>
</Member>
<Member MemberName="RenderIconPixbuf">
<MemberSignature Language="C#" Value="public Gdk.Pixbuf RenderIconPixbuf (Gtk.StyleContext context, Gtk.IconSize size);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Gdk.Pixbuf RenderIconPixbuf(class Gtk.StyleContext context, valuetype Gtk.IconSize size) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="Gtk.StyleContext" />
<Parameter Name="size" Type="Gtk.IconSize" />
</Parameters>
<Docs>
<param name="context">To be added.</param>
<param name="size">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="Sizes">
<MemberSignature Language="C#" Value="public Gtk.IconSize[] Sizes { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Gtk.IconSize[] Sizes" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.IconSize[]</ReturnType>
</ReturnValue>
<Docs>
<summary>The available icon sizes on this system.</summary>
<value>a <see cref="T:Gtk.IconSize[]" /></value>
<remarks />
</Docs>
</Member>
<Member MemberName="Unref">
<MemberSignature Language="C#" Value="public void Unref ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Unref() cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Gtk.IconSet is now refcounted automatically")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Decrements the reference count</summary>
<remarks>
Decrements the reference count, and frees memory
if the reference count reaches 0.
</remarks>
</Docs>
</Member>
<Member MemberName="Unref">
<MemberSignature Language="C#" Value="protected override void Unref (IntPtr raw);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Unref(native int raw) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="raw">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
</Members>
</Type>
|