Back to Seed Clases

Gtk

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gtk.IconTheme

Class Gtk.IconTheme

Import line:	Gtk = imports.gi.Gtk;
GIR File:	Gtk-3.0.gir
C documentation:	GtkIconTheme
Class :	IconTheme
Extends:	GObject.Object

Properties
Properties		Defined By
	parent_instance : GObject.Object read only	Gtk.IconTheme
	priv : Gtk.IconThemePrivate read only	Gtk.IconTheme

Methods / Constructors
Method / Constructor		Defined By
	new Gtk.IconTheme (Object *properties) Create a new Gtk.IconTheme Create a new Gtk.IconTheme Parameters: Object properties*
	Gtk.IconTheme.add_builtin_icon (String *icon_name, gint32 size, Pixbuf pixbuf) : none Registers a built-in icon for icon theme lookups. Registers a built-in icon for icon theme lookups. The idea of built-in icons is to allow an application or library that uses themed icons to function requiring files to be present in the file system. For instance, the default images for all of GTK+'s stock icons are registered as built-icons. In general, if you use gtk_icon_theme_add_builtin_icon() you should also install the icon in the icon theme, so that the icon is generally available. This function will generally be used with pixbufs loaded via gdk_pixbuf_new_from_inline(). Parameters: String icon_name* Required (not null) the name of the icon to register gint32 size Required (not null) the size at which to register the icon (different images can be registered for the same icon name at different sizes.) GdkPixbuf.Pixbuf pixbuf Required (not null) GdkPixbuf that contains the image to use for icon_name. Returns: none	Gtk.IconTheme
	Gtk.IconTheme.get_default () : Gtk.IconTheme Gets the icon theme for the default screen. Gets the icon theme for the default screen. See gtk_icon_theme_get_for_screen(). the default screen. This icon theme is associated with the screen and can be used as long as the screen is open. Do not ref or unref it. Returns: Gtk.IconTheme A unique GtkIconTheme associated with	Gtk.IconTheme
	Gtk.IconTheme.get_for_screen (Screen *screen) : Gtk.IconTheme Gets the icon theme object associated with screen; if this function has not previously been called for the given screen, a new icon theme object will be created and associated with the screen. Gets the icon theme object associated with screen; if this function has not previously been called for the given screen, a new icon theme object will be created and associated with the screen. Icon theme objects are fairly expensive to create, so using this function is usually a better choice than calling than gtk_icon_theme_new() and setting the screen yourself; by using this function a single icon theme object will be shared between users. the given screen. This icon theme is associated with the screen and can be used as long as the screen is open. Do not ref or unref it. Parameters: Gdk.Screen screen* Required (not null) a GdkScreen Returns: Gtk.IconTheme A unique GtkIconTheme associated with	Gtk.IconTheme
	append_search_path (String *path) : none Appends a directory to the search path. Appends a directory to the search path. See gtk_icon_theme_set_search_path(). Parameters: String path* Required (not null) directory name to append to the icon path Returns: none	Gtk.IconTheme
	choose_icon (Array *icon_names, gint32 size, IconLookupFlags flags) : Gtk.IconInfo Looks up a named icon and returns a structure containing information such as the filename of the icon. Looks up a named icon and returns a structure containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon() combines these two steps if all you need is the pixbuf.) If icon_names* contains more than one name, this function tries them all in the given order before falling back to inherited icon themes. about the icon, or NULL if the icon wasn't found. Free with gtk_icon_info_free() Parameters: Array icon_names Required (not null) NULL-terminated array of icon names to lookup gint32 size Required (not null) desired icon size Gtk.IconLookupFlags flags Required (not null) flags modifying the behavior of the icon lookup Returns: Gtk.IconInfo a GtkIconInfo structure containing information	Gtk.IconTheme
	get_example_icon_name () : String Gets the name of an icon that is representative of the current theme (for instance, to use when presenting a list of themes to the user. Gets the name of an icon that is representative of the current theme (for instance, to use when presenting a list of themes to the user.) Free with g_free(). Returns: String the name of an example icon or NULL.	Gtk.IconTheme
	get_icon_sizes (String *icon_name) : Array Returns an array of integers describing the sizes at which the icon is available without scaling. Returns an array of integers describing the sizes at which the icon is available without scaling. A size of -1 means that the icon is available in a scalable format. The array is zero-terminated. describing the sizes at which the icon is available. The array should be freed with g_free() when it is no longer needed. Parameters: String icon_name* Required (not null) the name of an icon Returns: Array An newly allocated array	Gtk.IconTheme
	get_search_path () : Object Gets the current search path. Gets the current search path. See gtk_icon_theme_set_search_path(). Returns: path: Array n_elements: gint32	Gtk.IconTheme
	has_icon (String *icon_name) : gboolean Checks whether an icon theme includes an icon for a particular name. Checks whether an icon theme includes an icon for a particular name. icon for icon_name. Parameters: String icon_name* Required (not null) the name of an icon Returns: gboolean TRUE if icon_theme includes an	Gtk.IconTheme
	list_contexts () : Array Gets the list of contexts available within the current hierarchy of icon themes holding the names of all the contexts in the theme. Gets the list of contexts available within the current hierarchy of icon themes holding the names of all the contexts in the theme. You must first free each element in the list with g_free(), then free the list itself with g_list_free(). Returns: Array a GList list	Gtk.IconTheme
	list_icons (String *context) : Array Lists the icons in the current icon theme. Lists the icons in the current icon theme. Only a subset of the icons can be listed by providing a context string. The set of values for the context string is system dependent, but will typically include such values as "Applications" and "MimeTypes". holding the names of all the icons in the theme. You must first free each element in the list with g_free(), then free the list itself with g_list_free(). Parameters: String context* a string identifying a particular type of icon, or NULL to list all icons. Returns: Array a GList list	Gtk.IconTheme
	load_icon (String *icon_name, gint32 size, IconLookupFlags flags) : GdkPixbuf.Pixbuf Looks up an icon in an icon theme, scales it to the given size and renders it into a pixbuf. Looks up an icon in an icon theme, scales it to the given size and renders it into a pixbuf. This is a convenience function; if more details about the icon are needed, use gtk_icon_theme_lookup_icon() followed by gtk_icon_info_load_icon(). Note that you probably want to listen for icon theme changes and update the icon. This is usually done by connecting to the GtkWidget::style-set signal. If for some reason you do not want to update the icon when the icon theme changes, you should consider using gdk_pixbuf_copy() to make a private copy of the pixbuf returned by this function. Otherwise GTK+ may need to keep the old icon theme loaded, which would be a waste of memory. newly created icon or a new reference to an internal icon, so you must not modify the icon. Use g_object_unref() to release your reference to the icon. NULL* if the icon isn't found. Parameters: String icon_name Required (not null) the name of the icon to lookup gint32 size Required (not null) the desired icon size. The resulting icon may not be exactly this size; see gtk_icon_info_load_icon(). Gtk.IconLookupFlags flags Required (not null) flags modifying the behavior of the icon lookup Returns: GdkPixbuf.Pixbuf the rendered icon; this may be a	Gtk.IconTheme
	lookup_by_gicon (Icon *icon, gint32 size, IconLookupFlags flags) : Gtk.IconInfo Looks up an icon and returns a structure containing information such as the filename of the icon. Looks up an icon and returns a structure containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using gtk_icon_info_load_icon(). information about the icon, or NULL* if the icon wasn't found. Free with gtk_icon_info_free() Parameters: Gio.Icon icon Required (not null) the GIcon to look up gint32 size Required (not null) desired icon size Gtk.IconLookupFlags flags Required (not null) flags modifying the behavior of the icon lookup Returns: Gtk.IconInfo a GtkIconInfo structure containing	Gtk.IconTheme
	lookup_icon (String *icon_name, gint32 size, IconLookupFlags flags) : Gtk.IconInfo Looks up a named icon and returns a structure containing information such as the filename of the icon. Looks up a named icon and returns a structure containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon() combines these two steps if all you need is the pixbuf.) about the icon, or NULL* if the icon wasn't found. Free with gtk_icon_info_free() Parameters: String icon_name Required (not null) the name of the icon to lookup gint32 size Required (not null) desired icon size Gtk.IconLookupFlags flags Required (not null) flags modifying the behavior of the icon lookup Returns: Gtk.IconInfo a GtkIconInfo structure containing information	Gtk.IconTheme
	prepend_search_path (String *path) : none Prepends a directory to the search path. Prepends a directory to the search path. See gtk_icon_theme_set_search_path(). Parameters: String path* Required (not null) directory name to prepend to the icon path Returns: none	Gtk.IconTheme
	rescan_if_needed () : gboolean Checks to see if the icon theme has changed; if it has, any currently cached information is discarded and will be reloaded next time icon_theme is accessed. Checks to see if the icon theme has changed; if it has, any currently cached information is discarded and will be reloaded next time icon_theme is accessed. to be reloaded. Returns: gboolean TRUE if the icon theme has changed and needed	Gtk.IconTheme
	set_custom_theme (String *theme_name) : none Sets the name of the icon theme that the GtkIconTheme* object uses overriding system configuration. Sets the name of the icon theme that the GtkIconTheme object uses overriding system configuration. This function cannot be called on the icon theme objects returned from gtk_icon_theme_get_default() and gtk_icon_theme_get_for_screen(). Parameters: String theme_name name of icon theme to use instead of configured theme, or NULL to unset a previously set custom theme Returns: none	Gtk.IconTheme
	set_screen (Screen *screen) : none Sets the screen for an icon theme; the screen is used to track the user's currently configured icon theme, which might be different for different screens. Sets the screen for an icon theme; the screen is used to track the user's currently configured icon theme, which might be different for different screens. Parameters: Gdk.Screen screen* Required (not null) a GdkScreen Returns: none	Gtk.IconTheme
	set_search_path (Array *path, gint32 n_elements) : none Sets the search path for the icon theme object. Sets the search path for the icon theme object. When looking for an icon theme, GTK+ will search for a subdirectory of one or more of the directories in path* with the same name as the icon theme. (Themes from multiple of the path elements are combined to allow themes to be extended by adding icons in the user's home directory.) In addition if an icon found isn't found either in the current icon theme or the default icon theme, and an image file with the right name is found directly in one of the elements of (This is legacy feature, and new icons should be put into the default icon theme, which is called DEFAULT_THEME_NAME, rather than directly on the icon path.) Parameters: Array path Required (not null) array of directories that are searched for icon themes gint32 n_elements Required (not null) number of elements in path. Returns: none	Gtk.IconTheme

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	changed (IconTheme *self) : none Emitted when the current icon theme is switched or GTK+ detects that a change has occurred in the contents of the current icon theme. Emitted when the current icon theme is switched or GTK+ detects that a change has occurred in the contents of the current icon theme. Parameters: Gtk.IconTheme self* Returns: {none}	Gtk.IconTheme

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gtk.IconInfo Method	new Gtk.IconInfo.for_pixbuf (IconTheme *icon_theme, Pixbuf pixbuf*) : Gtk.IconInfo Create a new Gtk.IconInfo

Un-official Seed Documentation

Gtk

Classes

Interfaces

Structs

Unions

Enums

Class Gtk.IconTheme