Back to Seed Clases

Gtk

Classes

Interfaces

Structs

Unions

Enums

Struct Gtk.IconSource

Import line:	Gtk = imports.gi.Gtk;
GIR File:	Gtk-3.0.gir
C documentation:	GtkIconSource
Struct :	IconSource

Properties
None

Methods / Constructors
Method / Constructor		Defined By
	new Gtk.IconSource.c_new () : Gtk.IconSource Create a new Gtk.IconSource Create a new Gtk.IconSource Returns: Gtk.IconSource a new GtkIconSource
	copy () : Gtk.IconSource Creates a copy of source; mostly useful for language bindings. Creates a copy of source; mostly useful for language bindings. Returns: Gtk.IconSource a new GtkIconSource	Gtk.IconSource
	free () : none Frees a dynamically-allocated icon source, along with its filename, size, and pixbuf fields if those are not NULL. Frees a dynamically-allocated icon source, along with its filename, size, and pixbuf fields if those are not NULL. Returns: none	Gtk.IconSource
	get_direction () : Gtk.TextDirection Obtains the text direction this icon source applies to. Obtains the text direction this icon source applies to. The return value is only useful/meaningful if the text direction is not wildcarded. Returns: Gtk.TextDirection text direction this source matches	Gtk.IconSource
	get_direction_wildcarded () : gboolean Gets the value set by gtk_icon_source_set_direction_wildcarded(). Gets the value set by gtk_icon_source_set_direction_wildcarded(). Returns: gboolean TRUE if this icon source is a base for any text direction variant	Gtk.IconSource
	get_filename () : String Retrieves the source filename, or NULL if none is set. Retrieves the source filename, or NULL if none is set. The filename is not a copy, and should not be modified or expected to persist beyond the lifetime of the icon source. be modified or freed. Returns: String image filename. This string must not	Gtk.IconSource
	get_icon_name () : String Retrieves the source icon name, or NULL if none is set. Retrieves the source icon name, or NULL if none is set. The icon_name is not a copy, and should not be modified or expected to persist beyond the lifetime of the icon source. Returns: String icon name. This string must not be modified or freed.	Gtk.IconSource
	get_pixbuf () : GdkPixbuf.Pixbuf Retrieves the source pixbuf, or NULL if none is set. Retrieves the source pixbuf, or NULL if none is set. In addition, if a filename source is in use, this function in some cases will return the pixbuf from loaded from the filename. This is, for example, true for the GtkIconSource passed to the GtkStyle::render_icon() virtual function. The reference count on the pixbuf is not incremented. Returns: GdkPixbuf.Pixbuf source pixbuf	Gtk.IconSource
	get_size () : gint32 Obtains the icon size this source applies to. Obtains the icon size this source applies to. The return value is only useful/meaningful if the icon size is not wildcarded. Returns: gint32 icon size this source matches.	Gtk.IconSource
	get_size_wildcarded () : gboolean Gets the value set by gtk_icon_source_set_size_wildcarded(). Gets the value set by gtk_icon_source_set_size_wildcarded(). Returns: gboolean TRUE if this icon source is a base for any icon size variant	Gtk.IconSource
	get_state () : Gtk.StateType Obtains the widget state this icon source applies to. Obtains the widget state this icon source applies to. The return value is only useful/meaningful if the widget state is not wildcarded. Returns: Gtk.StateType widget state this source matches	Gtk.IconSource
	get_state_wildcarded () : gboolean Gets the value set by gtk_icon_source_set_state_wildcarded(). Gets the value set by gtk_icon_source_set_state_wildcarded(). Returns: gboolean TRUE if this icon source is a base for any widget state variant	Gtk.IconSource
	set_direction (TextDirection *direction) : none Sets the text direction this icon source is intended to be used with. Sets the text direction this icon source is intended to be used with. Setting the text direction on an icon source makes no difference if the text direction is wildcarded. Therefore, you should usually call gtk_icon_source_set_direction_wildcarded() to un-wildcard it in addition to calling this function. Parameters: Gtk.TextDirection direction* Required (not null) text direction this source applies to Returns: none	Gtk.IconSource
	set_direction_wildcarded (gboolean *setting) : none If the text direction is wildcarded, this source can be used as the base image for an icon in any GtkTextDirection. If the text direction is wildcarded, this source can be used as the base image for an icon in any GtkTextDirection. If the text direction is not wildcarded, then the text direction the icon source applies to should be set with gtk_icon_source_set_direction(), and the icon source will only be used with that text direction. GtkIconSet* prefers non-wildcarded sources (exact matches) over wildcarded sources, and will use an exact match when possible. Parameters: gboolean setting Required (not null) TRUE to wildcard the text direction Returns: none	Gtk.IconSource
	set_filename (String *filename) : none Sets the name of an image file to use as a base image when creating icon variants for GtkIconSet. Sets the name of an image file to use as a base image when creating icon variants for GtkIconSet. The filename must be absolute. Parameters: String filename* Required (not null) image file to use Returns: none	Gtk.IconSource
	set_icon_name (String *icon_name) : none Sets the name of an icon to look up in the current icon theme to use as a base image when creating icon variants for GtkIconSet. Sets the name of an icon to look up in the current icon theme to use as a base image when creating icon variants for GtkIconSet. Parameters: String icon_name* name of icon to use Returns: none	Gtk.IconSource
	set_pixbuf (Pixbuf *pixbuf) : none Sets a pixbuf to use as a base image when creating icon variants for GtkIconSet. Sets a pixbuf to use as a base image when creating icon variants for GtkIconSet. Parameters: GdkPixbuf.Pixbuf pixbuf* Required (not null) pixbuf to use as a source Returns: none	Gtk.IconSource
	set_size (gint32 *size) : none Sets the icon size this icon source is intended to be used with. Sets the icon size this icon source is intended to be used with. Setting the icon size on an icon source makes no difference if the size is wildcarded. Therefore, you should usually call gtk_icon_source_set_size_wildcarded() to un-wildcard it in addition to calling this function. Parameters: gint32 size* Required (not null) icon size this source applies to Returns: none	Gtk.IconSource
	set_size_wildcarded (gboolean *setting) : none If the icon size is wildcarded, this source can be used as the base image for an icon of any size. If the icon size is wildcarded, this source can be used as the base image for an icon of any size. If the size is not wildcarded, then the size the source applies to should be set with gtk_icon_source_set_size() and the icon source will only be used with that specific size. GtkIconSet* prefers non-wildcarded sources (exact matches) over wildcarded sources, and will use an exact match when possible. GtkIconSet will normally scale wildcarded source images to produce an appropriate icon at a given size, but will not change the size of source images that match exactly. Parameters: gboolean setting Required (not null) TRUE to wildcard the widget state Returns: none	Gtk.IconSource
	set_state (StateType *state) : none Sets the widget state this icon source is intended to be used with. Sets the widget state this icon source is intended to be used with. Setting the widget state on an icon source makes no difference if the state is wildcarded. Therefore, you should usually call gtk_icon_source_set_state_wildcarded() to un-wildcard it in addition to calling this function. Parameters: Gtk.StateType state* Required (not null) widget state this source applies to Returns: none	Gtk.IconSource
	set_state_wildcarded (gboolean *setting) : none If the widget state is wildcarded, this source can be used as the base image for an icon in any GtkStateType. If the widget state is wildcarded, this source can be used as the base image for an icon in any GtkStateType. If the widget state is not wildcarded, then the state the source applies to should be set with gtk_icon_source_set_state() and the icon source will only be used with that specific state. GtkIconSet* prefers non-wildcarded sources (exact matches) over wildcarded sources, and will use an exact match when possible. GtkIconSet will normally transform wildcarded source images to produce an appropriate icon for a given state, for example lightening an image on prelight, but will not modify source images that match exactly. Parameters: gboolean setting Required (not null) TRUE to wildcard the widget state Returns: none	Gtk.IconSource

Events
None

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gtk Method	Gtk.render_icon_pixbuf (StyleContext *context, IconSource source, gint32 size) : GdkPixbuf.Pixbuf Renders the icon specified by source* at the given size, returning the result in a pixbuf.
Gtk.IconSet Method	add_source (IconSource *source) : none Icon sets have a list of GtkIconSource*, which they use as base icons for rendering icons in different states and sizes.
Gtk.Style Method	render_icon (IconSource *source, TextDirection direction, StateType state, gint32 size, Widget widget, String detail) : GdkPixbuf.Pixbuf Renders the icon specified by source* at the given size according to the given parameters and returns the result in a pixbuf.

Un-official Seed Documentation

Gtk

Classes

Interfaces

Structs

Unions

Enums

Struct Gtk.IconSource