IconInfo

Contains information found when looking up an icon in an icon theme.

class IconInfo : ObjectWrap {}

Constructors

this
this(void* ptr, Flag!"Take" take)

Members

Functions

getAttachPoints
bool getAttachPoints(gdk.types.Point[] points)

This function is deprecated and always returns false.

getBaseScale
int getBaseScale()

Gets the base scale for the icon. The base scale is a scale for the icon that was specified by the icon theme creator. For instance an icon drawn for a high-dpi screen with window scale 2 for a base size of 32 will be 64 pixels tall and have a base scale of 2.

getBaseSize
int getBaseSize()

Gets the base size for the icon. The base size is a size for the icon that was specified by the icon theme creator. This may be different than the actual size of image; an example of this is small emblem icons that can be attached to a larger icon. These icons will be given the same base size as the larger icons to which they are attached.

getBuiltinPixbuf
gdkpixbuf.pixbuf.Pixbuf getBuiltinPixbuf()

Gets the built-in image for this icon, if any. To allow GTK+ to use built in icon images, you must pass the gtk.types.IconLookupFlags.UseBuiltin to gtk.icon_theme.IconTheme.lookupIcon.

getDisplayName
string getDisplayName()

This function is deprecated and always returns null.

getEmbeddedRect
bool getEmbeddedRect(gdk.rectangle.Rectangle rectangle)

This function is deprecated and always returns false.

getFilename
string getFilename()

Gets the filename for the icon. If the gtk.types.IconLookupFlags.UseBuiltin flag was passed to gtk.icon_theme.IconTheme.lookupIcon, there may be no filename if a builtin icon is returned; in this case, you should use gtk.icon_info.IconInfo.getBuiltinPixbuf.

isSymbolic
bool isSymbolic()

Checks if the icon is symbolic or not. This currently uses only the file name and not the file contents for determining this. This behaviour may change in the future.

loadIcon
gdkpixbuf.pixbuf.Pixbuf loadIcon()

Renders an icon previously looked up in an icon theme using gtk.icon_theme.IconTheme.lookupIcon; the size will be based on the size passed to gtk.icon_theme.IconTheme.lookupIcon. Note that the resulting pixbuf may not be exactly this size; an icon theme may have icons that differ slightly from their nominal sizes, and in addition GTK+ will avoid scaling icons that it considers sufficiently close to the requested size or for which the source image would have to be scaled up too far. (This maintains sharpness.). This behaviour can be changed by passing the gtk.types.IconLookupFlags.ForceSize flag when obtaining the #GtkIconInfo. If this flag has been specified, the pixbuf returned by this function will be scaled to the exact size.

loadIconAsync
void loadIconAsync(gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback)

Asynchronously load, render and scale an icon previously looked up from the icon theme using gtk.icon_theme.IconTheme.lookupIcon.

loadIconFinish
gdkpixbuf.pixbuf.Pixbuf loadIconFinish(gio.async_result.AsyncResult res)

Finishes an async icon load, see gtk.icon_info.IconInfo.loadIconAsync.

loadSurface
cairo.surface.Surface loadSurface(gdk.window.Window forWindow)

Renders an icon previously looked up in an icon theme using gtk.icon_theme.IconTheme.lookupIcon; the size will be based on the size passed to gtk.icon_theme.IconTheme.lookupIcon. Note that the resulting surface may not be exactly this size; an icon theme may have icons that differ slightly from their nominal sizes, and in addition GTK+ will avoid scaling icons that it considers sufficiently close to the requested size or for which the source image would have to be scaled up too far. (This maintains sharpness.). This behaviour can be changed by passing the gtk.types.IconLookupFlags.ForceSize flag when obtaining the #GtkIconInfo. If this flag has been specified, the pixbuf returned by this function will be scaled to the exact size.

loadSymbolic
gdkpixbuf.pixbuf.Pixbuf loadSymbolic(gdk.rgba.RGBA fg, gdk.rgba.RGBA successColor, gdk.rgba.RGBA warningColor, gdk.rgba.RGBA errorColor, bool wasSymbolic)

Loads an icon, modifying it to match the system colours for the foreground, success, warning and error colors provided. If the icon is not a symbolic one, the function will return the result from gtk.icon_info.IconInfo.loadIcon.

loadSymbolicAsync
void loadSymbolicAsync(gdk.rgba.RGBA fg, gdk.rgba.RGBA successColor, gdk.rgba.RGBA warningColor, gdk.rgba.RGBA errorColor, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback)

Asynchronously load, render and scale a symbolic icon previously looked up from the icon theme using gtk.icon_theme.IconTheme.lookupIcon.

loadSymbolicFinish
gdkpixbuf.pixbuf.Pixbuf loadSymbolicFinish(gio.async_result.AsyncResult res, bool wasSymbolic)

Finishes an async icon load, see gtk.icon_info.IconInfo.loadSymbolicAsync.

loadSymbolicForContext
gdkpixbuf.pixbuf.Pixbuf loadSymbolicForContext(gtk.style_context.StyleContext context, bool wasSymbolic)

Loads an icon, modifying it to match the system colors for the foreground, success, warning and error colors provided. If the icon is not a symbolic one, the function will return the result from gtk.icon_info.IconInfo.loadIcon. This function uses the regular foreground color and the symbolic colors with the names “success_color”, “warning_color” and “error_color” from the context.

loadSymbolicForContextAsync
void loadSymbolicForContextAsync(gtk.style_context.StyleContext context, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback)

Asynchronously load, render and scale a symbolic icon previously looked up from the icon theme using gtk.icon_theme.IconTheme.lookupIcon.

loadSymbolicForContextFinish
gdkpixbuf.pixbuf.Pixbuf loadSymbolicForContextFinish(gio.async_result.AsyncResult res, bool wasSymbolic)

Finishes an async icon load, see gtk.icon_info.IconInfo.loadSymbolicForContextAsync.

loadSymbolicForStyle
gdkpixbuf.pixbuf.Pixbuf loadSymbolicForStyle(gtk.style.Style style, gtk.types.StateType state, bool wasSymbolic)

Loads an icon, modifying it to match the system colours for the foreground, success, warning and error colors provided. If the icon is not a symbolic one, the function will return the result from gtk.icon_info.IconInfo.loadIcon.

self
IconInfo self()

Returns this, for use in with statements.

setRawCoordinates
void setRawCoordinates(bool rawCoordinates)

Sets whether the coordinates returned by gtk.icon_info.IconInfo.getEmbeddedRect and gtk.icon_info.IconInfo.getAttachPoints should be returned in their original form as specified in the icon theme, instead of scaled appropriately for the pixbuf returned by gtk.icon_info.IconInfo.loadIcon.

Properties

_gType
GType _gType [@property getter]

Static functions

_getGType
GType _getGType()
builder
IconInfoGidBuilder builder()

Get builder for gtk.icon_info.IconInfo

newForPixbuf
gtk.icon_info.IconInfo newForPixbuf(gtk.icon_theme.IconTheme iconTheme, gdkpixbuf.pixbuf.Pixbuf pixbuf)

Creates a #GtkIconInfo for a #GdkPixbuf.

Inherited Members

From ObjectWrap

_setGObject
void _setGObject(void* cObj, Flag!"Take" take)

Set the GObject of a D ObjectWrap wrapper.

_cPtr
void* _cPtr(Flag!"Dup" dup)

Get a pointer to the underlying C object.

_ref
void* _ref(void* gObj)

Calls g_object_ref() on a GObject.

_unref
_unref(void* gObj)

Calls g_object_unref() on a GObject.

_getGType
GType _getGType()

Get the GType of an object.

_gType
GType _gType [@property getter]

GObject GType property.

self
ObjectWrap self()

Convenience method to return this cast to a type. For use in D with statements.

_getDObject
T _getDObject(void* cptr, Flag!"Take" take)

Template to get the D object from a C GObject and cast it to the given D object type.

connectSignalClosure
gulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after)

Connect a D closure to an object signal.

setProperty
void setProperty(string propertyName, T val)

Template for setting a GObject property.

getProperty
T getProperty(string propertyName)

Template for getting a GObject property.

compatControl
size_t compatControl(size_t what, void* data)
bindProperty
gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectWrap target, string targetProperty, gobject.types.BindingFlags flags)

Creates a binding between source_property on source and target_property on target.

bindPropertyFull
gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectWrap target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom)

Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

forceFloating
void forceFloating()

This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectWrap.refSink.

freezeNotify
void freezeNotify()

Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

getData
void* getData(string key)

Gets a named field from the objects table of associations (see gobject.object.ObjectWrap.setData).

getProperty
void getProperty(string propertyName, gobject.value.Value value)

Gets a property of an object.

getQdata
void* getQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata.

getv
void getv(string[] names, gobject.value.Value[] values)

Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

isFloating
bool isFloating()

Checks whether object has a floating[floating-ref] reference.

notify
void notify(string propertyName)

Emits a "notify" signal for the property property_name on object.

notifyByPspec
void notifyByPspec(gobject.param_spec.ParamSpec pspec)

Emits a "notify" signal for the property specified by pspec on object.

refSink
gobject.object.ObjectWrap refSink()

Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.

runDispose
void runDispose()

Releases all references to other objects. This can be used to break reference cycles.

setData
void setData(string key, void* data)

Each object carries around a table of associations from strings to pointers. This function lets you set an association.

setProperty
void setProperty(string propertyName, gobject.value.Value value)

Sets a property on an object.

stealData
void* stealData(string key)

Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

stealQdata
void* stealQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

thawNotify
void thawNotify()

Reverts the effect of a previous call to gobject.object.ObjectWrap.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

watchClosure
void watchClosure(gobject.closure.Closure closure)

This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectWrap.ref_ and gobject.object.ObjectWrap.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

connectNotify
gulong connectNotify(string detail, T callback, Flag!"After" after)

Connect to Notify signal.