Back to Seed Clases

Gtk

Classes

Interfaces

Structs

Unions

Enums

Struct Gtk.IconInfo

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

Properties
None

Methods / Constructors
Method / Constructor		Defined By
	new Gtk.IconInfo.for_pixbuf (IconTheme *icon_theme, Pixbuf pixbuf) : Gtk.IconInfo Create a new Gtk.IconInfo Create a new Gtk.IconInfo Parameters: Gtk.IconTheme icon_theme* Required (not null) a GtkIconTheme GdkPixbuf.Pixbuf pixbuf Required (not null) the pixbuf to wrap in a GtkIconInfo Returns: Gtk.IconInfo a GtkIconInfo
	copy () : Gtk.IconInfo Make a copy of a GtkIconInfo. Make a copy of a GtkIconInfo. Returns: Gtk.IconInfo the new GtkIconInfo	Gtk.IconInfo
	free () : none Free a GtkIconInfo and associated information Free a GtkIconInfo and associated information Returns: none	Gtk.IconInfo
	get_attach_points (Object *out_values) : gboolean Fetches the set of attach points for an icon. Fetches the set of attach points for an icon. An attach point is a location in the icon that can be used as anchor points for attaching emblems or overlays to the icon. Parameters: Object out_values* Array points gint32 n_points Returns: gboolean TRUE if there are any attach points for the icon.	Gtk.IconInfo
	get_base_size () : gint32 Gets the base size for the icon. 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. size is known for the icon. Returns: gint32 the base size, or 0, if no base	Gtk.IconInfo
	get_builtin_pixbuf () : GdkPixbuf.Pixbuf Gets the built-in image for this icon, if any. Gets the built-in image for this icon, if any. To allow GTK+ to use built in icon images, you must pass the GTK_ICON_LOOKUP_USE_BUILTIN to gtk_icon_theme_lookup_icon(). extra reference is added to the returned pixbuf, so if you want to keep it around, you must use g_object_ref(). The returned image must not be modified. Returns: GdkPixbuf.Pixbuf the built-in image pixbuf, or NULL. No	Gtk.IconInfo
	get_display_name () : String Gets the display name for an icon. Gets the display name for an icon. A display name is a string to be used in place of the icon name in a user visible context like a list of icons. the icon doesn't have a specified display name. This value is owned icon_info and must not be modified or free. Returns: String the display name for the icon or NULL, if	Gtk.IconInfo
	get_embedded_rect (Object *out_values) : gboolean Gets the coordinates of a rectangle within the icon that can be used for display of information such as a preview of the contents of a text file. Gets the coordinates of a rectangle within the icon that can be used for display of information such as a preview of the contents of a text file. See gtk_icon_info_set_raw_coordinates() for further information about the coordinate system. Parameters: Object out_values* cairo.RectangleInt rectangle Returns: gboolean TRUE if the icon has an embedded rectangle	Gtk.IconInfo
	get_filename () : String Gets the filename for the icon. Gets the filename for the icon. If the GTK_ICON_LOOKUP_USE_BUILTIN flag was passed to gtk_icon_theme_lookup_icon(), there may be no filename if a builtin icon is returned; in this case, you should use gtk_icon_info_get_builtin_pixbuf(). if gtk_icon_info_get_builtin_pixbuf() should be used instead. The return value is owned by GTK+ and should not be modified or freed. Returns: String the filename for the icon, or NULL	Gtk.IconInfo
	load_icon () : GdkPixbuf.Pixbuf Renders an icon previously looked up in an icon theme using gtk_icon_theme_lookup_icon(); the size will be based on the size passed to gtk_icon_theme_lookup_icon(). Renders an icon previously looked up in an icon theme using gtk_icon_theme_lookup_icon(); the size will be based on the size passed to gtk_icon_theme_lookup_icon(). 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_ICON_LOOKUP_FORCE_SIZE flag when obtaining the GtkIconInfo. If this flag has been specified, the pixbuf returned by this function will be scaled to the exact size. 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. Returns: GdkPixbuf.Pixbuf the rendered icon; this may be a newly	Gtk.IconInfo
	load_symbolic (RGBA fg, RGBA *success_color, RGBA warning_color, RGBA error_color, Object out_values) : GdkPixbuf.Pixbuf Loads an icon, modifying it to match the system colours for the foreground, success, warning and error colors provided. 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_load_icon(). This allows loading symbolic icons that will match the system theme. Unless you are implementing a widget, you will want to use g_themed_icon_new_with_default_fallbacks() to load the icon. As implementation details, the icon loaded needs to be of SVG type, contain the "symbolic" term as the last component of the icon name, and use the 'fg', 'success', 'warning' and 'error' CSS styles in the SVG file itself. See the Symbolic Icons spec for more information about symbolic icons. Parameters: Gdk.RGBA fg Required (not null) a GdkRGBA* representing the foreground color of the icon Gdk.RGBA success_color a GdkRGBA representing the warning color of the icon or NULL to use the default color Gdk.RGBA warning_color a GdkRGBA representing the warning color of the icon or NULL to use the default color Gdk.RGBA error_color a GdkRGBA representing the error color of the icon or NULL to use the default color (allow-none) Object out_values gboolean was_symbolic Returns: GdkPixbuf.Pixbuf a GdkPixbuf representing the loaded icon	Gtk.IconInfo
	load_symbolic_for_context (StyleContext *context, Object out_values) : GdkPixbuf.Pixbuf Loads an icon, modifying it to match the system colors for the foreground, success, warning and error colors provided. 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_load_icon(). This function uses the regular foreground color and the symbolic colors with the names "success_color", "warning_color" and "error_color" from the context. This allows loading symbolic icons that will match the system theme. See gtk_icon_info_load_symbolic() for more details. Parameters: Gtk.StyleContext context* Required (not null) a GtkStyleContext Object out_values gboolean was_symbolic Returns: GdkPixbuf.Pixbuf a GdkPixbuf representing the loaded icon	Gtk.IconInfo
	load_symbolic_for_style (Style *style, StateType state, Object out_values) : GdkPixbuf.Pixbuf Loads an icon, modifying it to match the system colours for the foreground, success, warning and error colors provided. 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_load_icon(). This allows loading symbolic icons that will match the system theme. See gtk_icon_info_load_symbolic() for more details. Parameters: Gtk.Style style* Required (not null) a GtkStyle to take the colors from Gtk.StateType state Required (not null) the widget state to use for colors Object out_values gboolean was_symbolic Returns: GdkPixbuf.Pixbuf a GdkPixbuf representing the loaded icon	Gtk.IconInfo
	set_raw_coordinates (gboolean *raw_coordinates) : none Sets whether the coordinates returned by gtk_icon_info_get_embedded_rect() and gtk_icon_info_get_attach_points() 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_load_icon(). Sets whether the coordinates returned by gtk_icon_info_get_embedded_rect() and gtk_icon_info_get_attach_points() 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_load_icon(). Raw coordinates are somewhat strange; they are specified to be with respect to the unscaled pixmap for PNG and XPM icons, but for SVG icons, they are in a 1000x1000 coordinate space that is scaled to the final size of the icon. You can determine if the icon is an SVG icon by using gtk_icon_info_get_filename(), and seeing if it is non-NULL* and ends in '.svg'. This function is provided primarily to allow compatibility wrappers for older API's, and is not expected to be useful for applications. Parameters: gboolean raw_coordinates Required (not null) whether the coordinates of embedded rectangles and attached points should be returned in their original (unscaled) form. Returns: none	Gtk.IconInfo

Events
None

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gtk.IconTheme Method	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.
Gtk.IconTheme Method	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.
Gtk.IconTheme Method	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.

Documentation generated by Introspection Doc Generator Loosely Based on JsDoc Toolkit on Sat Apr 16 2011 17:15:07 GMT+0800 (HKT)