1772 lines
99 KiB
HTML
1772 lines
99 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<html>
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<title>GtkImage: GTK+ 3 Reference Manual</title>
|
||
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
|
||
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
|
||
<link rel="up" href="DisplayWidgets.html" title="Display Widgets">
|
||
<link rel="prev" href="GtkLabel.html" title="GtkLabel">
|
||
<link rel="next" href="GtkSpinner.html" title="GtkSpinner">
|
||
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
|
||
<link rel="stylesheet" href="style.css" type="text/css">
|
||
</head>
|
||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
|
||
<td width="100%" align="left" class="shortcuts">
|
||
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
|
||
<a href="#GtkImage.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
|
||
<a href="#GtkImage.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
|
||
<a href="#GtkImage.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
|
||
<a href="#GtkImage.properties" class="shortcut">Properties</a></span>
|
||
</td>
|
||
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
|
||
<td><a accesskey="u" href="DisplayWidgets.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
|
||
<td><a accesskey="p" href="GtkLabel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||
<td><a accesskey="n" href="GtkSpinner.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
|
||
</tr></table>
|
||
<div class="refentry">
|
||
<a name="GtkImage"></a><div class="titlepage"></div>
|
||
<div class="refnamediv"><table width="100%"><tr>
|
||
<td valign="top">
|
||
<h2><span class="refentrytitle"><a name="GtkImage.top_of_page"></a>GtkImage</span></h2>
|
||
<p>GtkImage — A widget displaying an image</p>
|
||
</td>
|
||
<td class="gallery_image" valign="top" align="right"><img src="image.png"></td>
|
||
</tr></table></div>
|
||
<div class="refsect1">
|
||
<a name="GtkImage.functions"></a><h2>Functions</h2>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="functions_return">
|
||
<col class="functions_name">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-get-icon-set" title="gtk_image_get_icon_set ()">gtk_image_get_icon_set</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">GdkPixbuf</span> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-get-pixbuf" title="gtk_image_get_pixbuf ()">gtk_image_get_pixbuf</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-get-stock" title="gtk_image_get_stock ()">gtk_image_get_stock</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">GdkPixbufAnimation</span> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-get-animation" title="gtk_image_get_animation ()">gtk_image_get_animation</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-get-icon-name" title="gtk_image_get_icon_name ()">gtk_image_get_icon_name</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-get-gicon" title="gtk_image_get_gicon ()">gtk_image_get_gicon</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkImage.html#GtkImageType" title="enum GtkImageType"><span class="returnvalue">GtkImageType</span></a>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-get-storage-type" title="gtk_image_get_storage_type ()">gtk_image_get_storage_type</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-new-from-file" title="gtk_image_new_from_file ()">gtk_image_new_from_file</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-new-from-icon-set" title="gtk_image_new_from_icon_set ()">gtk_image_new_from_icon_set</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-new-from-pixbuf" title="gtk_image_new_from_pixbuf ()">gtk_image_new_from_pixbuf</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-new-from-stock" title="gtk_image_new_from_stock ()">gtk_image_new_from_stock</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-new-from-animation" title="gtk_image_new_from_animation ()">gtk_image_new_from_animation</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-new-from-icon-name" title="gtk_image_new_from_icon_name ()">gtk_image_new_from_icon_name</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-new-from-gicon" title="gtk_image_new_from_gicon ()">gtk_image_new_from_gicon</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-new-from-resource" title="gtk_image_new_from_resource ()">gtk_image_new_from_resource</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-new-from-surface" title="gtk_image_new_from_surface ()">gtk_image_new_from_surface</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-set-from-file" title="gtk_image_set_from_file ()">gtk_image_set_from_file</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-set-from-icon-set" title="gtk_image_set_from_icon_set ()">gtk_image_set_from_icon_set</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-set-from-pixbuf" title="gtk_image_set_from_pixbuf ()">gtk_image_set_from_pixbuf</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-set-from-stock" title="gtk_image_set_from_stock ()">gtk_image_set_from_stock</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-set-from-animation" title="gtk_image_set_from_animation ()">gtk_image_set_from_animation</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-set-from-icon-name" title="gtk_image_set_from_icon_name ()">gtk_image_set_from_icon_name</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-set-from-gicon" title="gtk_image_set_from_gicon ()">gtk_image_set_from_gicon</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-set-from-resource" title="gtk_image_set_from_resource ()">gtk_image_set_from_resource</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-set-from-surface" title="gtk_image_set_from_surface ()">gtk_image_set_from_surface</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-clear" title="gtk_image_clear ()">gtk_image_clear</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-new" title="gtk_image_new ()">gtk_image_new</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-set-pixel-size" title="gtk_image_set_pixel_size ()">gtk_image_set_pixel_size</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gint</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkImage.html#gtk-image-get-pixel-size" title="gtk_image_get_pixel_size ()">gtk_image_get_pixel_size</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkImage.properties"></a><h2>Properties</h2>
|
||
<div class="informaltable"><table class="informaltable" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="properties_type">
|
||
<col width="300px" class="properties_name">
|
||
<col width="200px" class="properties_flags">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="property_type">
|
||
<span class="type">gchar</span> *</td>
|
||
<td class="property_name"><a class="link" href="GtkImage.html#GtkImage--file" title="The “file” property">file</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type">
|
||
<span class="type">GIcon</span> *</td>
|
||
<td class="property_name"><a class="link" href="GtkImage.html#GtkImage--gicon" title="The “gicon” property">gicon</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type">
|
||
<span class="type">gchar</span> *</td>
|
||
<td class="property_name"><a class="link" href="GtkImage.html#GtkImage--icon-name" title="The “icon-name” property">icon-name</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type">
|
||
<a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSet"><span class="type">GtkIconSet</span></a> *</td>
|
||
<td class="property_name"><a class="link" href="GtkImage.html#GtkImage--icon-set" title="The “icon-set” property">icon-set</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type"><span class="type">gint</span></td>
|
||
<td class="property_name"><a class="link" href="GtkImage.html#GtkImage--icon-size" title="The “icon-size” property">icon-size</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type">
|
||
<span class="type">GdkPixbuf</span> *</td>
|
||
<td class="property_name"><a class="link" href="GtkImage.html#GtkImage--pixbuf" title="The “pixbuf” property">pixbuf</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type">
|
||
<span class="type">GdkPixbufAnimation</span> *</td>
|
||
<td class="property_name"><a class="link" href="GtkImage.html#GtkImage--pixbuf-animation" title="The “pixbuf-animation” property">pixbuf-animation</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type"><span class="type">gint</span></td>
|
||
<td class="property_name"><a class="link" href="GtkImage.html#GtkImage--pixel-size" title="The “pixel-size” property">pixel-size</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type">
|
||
<span class="type">gchar</span> *</td>
|
||
<td class="property_name"><a class="link" href="GtkImage.html#GtkImage--resource" title="The “resource” property">resource</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type">
|
||
<span class="type">gchar</span> *</td>
|
||
<td class="property_name"><a class="link" href="GtkImage.html#GtkImage--stock" title="The “stock” property">stock</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type"><a class="link" href="GtkImage.html#GtkImageType" title="enum GtkImageType"><span class="type">GtkImageType</span></a></td>
|
||
<td class="property_name"><a class="link" href="GtkImage.html#GtkImage--storage-type" title="The “storage-type” property">storage-type</a></td>
|
||
<td class="property_flags">Read</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type">
|
||
<span class="type">CairoSurface</span> *</td>
|
||
<td class="property_name"><a class="link" href="GtkImage.html#GtkImage--surface" title="The “surface” property">surface</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type"><span class="type">gboolean</span></td>
|
||
<td class="property_name"><a class="link" href="GtkImage.html#GtkImage--use-fallback" title="The “use-fallback” property">use-fallback</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkImage.other"></a><h2>Types and Values</h2>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="name">
|
||
<col class="description">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="datatype_keyword">struct</td>
|
||
<td class="function_name"><a class="link" href="GtkImage.html#GtkImage-struct" title="struct GtkImage">GtkImage</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="datatype_keyword">enum</td>
|
||
<td class="function_name"><a class="link" href="GtkImage.html#GtkImageType" title="enum GtkImageType">GtkImageType</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkImage.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
||
<pre class="screen"> GObject
|
||
<span class="lineart">╰──</span> GInitiallyUnowned
|
||
<span class="lineart">╰──</span> <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
|
||
<span class="lineart">╰──</span> <a class="link" href="GtkMisc.html" title="GtkMisc">GtkMisc</a>
|
||
<span class="lineart">╰──</span> GtkImage
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkImage.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
|
||
<p>
|
||
GtkImage implements
|
||
AtkImplementorIface and <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkImage.includes"></a><h2>Includes</h2>
|
||
<pre class="synopsis">#include <gtk/gtk.h>
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkImage.description"></a><h2>Description</h2>
|
||
<p>The <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> widget displays an image. Various kinds of object
|
||
can be displayed as an image; most typically, you would load a
|
||
<span class="type">GdkPixbuf</span> ("pixel buffer") from a file, and then display that.
|
||
There’s a convenience function to do this, <a class="link" href="GtkImage.html#gtk-image-new-from-file" title="gtk_image_new_from_file ()"><code class="function">gtk_image_new_from_file()</code></a>,
|
||
used as follows:</p>
|
||
<div class="informalexample">
|
||
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
|
||
<tbody>
|
||
<tr>
|
||
<td class="listing_lines" align="right"><pre>1
|
||
2</pre></td>
|
||
<td class="listing_code"><pre class="programlisting"><span class="usertype">GtkWidget</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">image</span><span class="symbol">;</span>
|
||
<span class="normal">image </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkImage.html#gtk-image-new-from-file">gtk_image_new_from_file</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"myfile.png"</span><span class="symbol">);</span></pre></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<p>
|
||
If the file isn’t loaded successfully, the image will contain a
|
||
“broken image” icon similar to that used in many web browsers.
|
||
If you want to handle errors in loading the file yourself,
|
||
for example by displaying an error message, then load the image with
|
||
<code class="function">gdk_pixbuf_new_from_file()</code>, then create the <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> with
|
||
<a class="link" href="GtkImage.html#gtk-image-new-from-pixbuf" title="gtk_image_new_from_pixbuf ()"><code class="function">gtk_image_new_from_pixbuf()</code></a>.</p>
|
||
<p>The image file may contain an animation, if so the <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> will
|
||
display an animation (<span class="type">GdkPixbufAnimation</span>) instead of a static image.</p>
|
||
<p><a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> is a subclass of <a class="link" href="GtkMisc.html" title="GtkMisc"><span class="type">GtkMisc</span></a>, which implies that you can
|
||
align it (center, left, right) and add padding to it, using
|
||
<a class="link" href="GtkMisc.html" title="GtkMisc"><span class="type">GtkMisc</span></a> methods.</p>
|
||
<p><a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> is a “no window” widget (has no <span class="type">GdkWindow</span> of its own),
|
||
so by default does not receive events. If you want to receive events
|
||
on the image, such as button clicks, place the image inside a
|
||
<a class="link" href="GtkEventBox.html" title="GtkEventBox"><span class="type">GtkEventBox</span></a>, then connect to the event signals on the event box.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.3.8.3.9.8"></a><h4>Handling button press events on a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a>.</h4>
|
||
<div class="informalexample">
|
||
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
|
||
<tbody>
|
||
<tr>
|
||
<td class="listing_lines" align="right"><pre>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</pre></td>
|
||
<td class="listing_code"><pre class="programlisting"><span class="keyword">static</span><span class="normal"> gboolean</span>
|
||
<span class="function">button_press_callback</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">GtkWidget</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">event_box</span><span class="symbol">,</span>
|
||
<span class="normal"> </span><span class="usertype">GdkEventButton</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">event</span><span class="symbol">,</span>
|
||
<span class="normal"> </span><span class="usertype">gpointer</span><span class="normal"> data</span><span class="symbol">)</span>
|
||
<span class="cbracket">{</span>
|
||
<span class="normal"> </span><span class="function">g_print</span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Event box clicked at coordinates %f,%f</span><span class="specialchar">\n</span><span class="string">"</span><span class="symbol">,</span>
|
||
<span class="normal"> event</span><span class="symbol">-></span><span class="normal">x</span><span class="symbol">,</span><span class="normal"> event</span><span class="symbol">-></span><span class="normal">y</span><span class="symbol">);</span>
|
||
|
||
<span class="normal"> </span><span class="comment">// Returning TRUE means we handled the event, so the signal</span>
|
||
<span class="normal"> </span><span class="comment">// emission should be stopped (don’t call any further callbacks</span>
|
||
<span class="normal"> </span><span class="comment">// that may be connected). Return FALSE to continue invoking callbacks.</span>
|
||
<span class="normal"> </span><span class="keyword">return</span><span class="normal"> TRUE</span><span class="symbol">;</span>
|
||
<span class="cbracket">}</span>
|
||
|
||
<span class="keyword">static</span><span class="normal"> <a href="GtkWidget.html#GtkWidget-struct">GtkWidget</a></span><span class="symbol">*</span>
|
||
<span class="function">create_image</span><span class="normal"> </span><span class="symbol">(</span><span class="type">void</span><span class="symbol">)</span>
|
||
<span class="cbracket">{</span>
|
||
<span class="normal"> </span><span class="usertype">GtkWidget</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">image</span><span class="symbol">;</span>
|
||
<span class="normal"> </span><span class="usertype">GtkWidget</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">event_box</span><span class="symbol">;</span>
|
||
|
||
<span class="normal"> image </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkImage.html#gtk-image-new-from-file">gtk_image_new_from_file</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"myfile.png"</span><span class="symbol">);</span>
|
||
|
||
<span class="normal"> event_box </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkEventBox.html#gtk-event-box-new">gtk_event_box_new</a></span><span class="normal"> </span><span class="symbol">();</span>
|
||
|
||
<span class="normal"> </span><span class="function"><a href="GtkContainer.html#gtk-container-add">gtk_container_add</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_CONTAINER</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">event_box</span><span class="symbol">),</span><span class="normal"> image</span><span class="symbol">);</span>
|
||
|
||
<span class="normal"> </span><span class="function">g_signal_connect</span><span class="normal"> </span><span class="symbol">(</span><span class="function">G_OBJECT</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">event_box</span><span class="symbol">),</span>
|
||
<span class="normal"> </span><span class="string">"button_press_event"</span><span class="symbol">,</span>
|
||
<span class="normal"> </span><span class="function">G_CALLBACK</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">button_press_callback</span><span class="symbol">),</span>
|
||
<span class="normal"> image</span><span class="symbol">);</span>
|
||
|
||
<span class="normal"> </span><span class="keyword">return</span><span class="normal"> image</span><span class="symbol">;</span>
|
||
<span class="cbracket">}</span></pre></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<p></p>
|
||
<p>When handling events on the event box, keep in mind that coordinates
|
||
in the image may be different from event box coordinates due to
|
||
the alignment and padding settings on the image (see <a class="link" href="GtkMisc.html" title="GtkMisc"><span class="type">GtkMisc</span></a>).
|
||
The simplest way to solve this is to set the alignment to 0.0
|
||
(left/top), and set the padding to zero. Then the origin of
|
||
the image will be the same as the origin of the event box.</p>
|
||
<p>Sometimes an application will want to avoid depending on external data
|
||
files, such as image files. GTK+ comes with a program to avoid this,
|
||
called “gdk-pixbuf-csource”. This library
|
||
allows you to convert an image into a C variable declaration, which
|
||
can then be loaded into a <span class="type">GdkPixbuf</span> using
|
||
<code class="function">gdk_pixbuf_new_from_inline()</code>.</p>
|
||
</div>
|
||
<div class="refsect2">
|
||
<a name="id-1.3.8.3.9.9"></a><h3>CSS nodes</h3>
|
||
<p>GtkImage has a single CSS node with the name image.</p>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkImage.functions_details"></a><h2>Functions</h2>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-get-icon-set"></a><h3>gtk_image_get_icon_set ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_image_get_icon_set (<em class="parameter"><code><a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> *image</code></em>,
|
||
<em class="parameter"><code><a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSet"><span class="type">GtkIconSet</span></a> **icon_set</code></em>,
|
||
<em class="parameter"><code><a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a> *size</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_image_get_icon_set</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p>
|
||
<p>Use <a class="link" href="GtkImage.html#gtk-image-get-icon-name" title="gtk_image_get_icon_name ()"><code class="function">gtk_image_get_icon_name()</code></a> instead.</p>
|
||
</div>
|
||
<p>Gets the icon set and size being displayed by the <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a>.
|
||
The storage type of the image must be <a class="link" href="GtkImage.html#GTK-IMAGE-EMPTY:CAPS"><code class="literal">GTK_IMAGE_EMPTY</code></a> or
|
||
<a class="link" href="GtkImage.html#GTK-IMAGE-ICON-SET:CAPS"><code class="literal">GTK_IMAGE_ICON_SET</code></a> (see <a class="link" href="GtkImage.html#gtk-image-get-storage-type" title="gtk_image_get_storage_type ()"><code class="function">gtk_image_get_storage_type()</code></a>).</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-get-icon-set.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>image</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>icon_set</p></td>
|
||
<td class="parameter_description"><p>location to store a
|
||
<a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSet"><span class="type">GtkIconSet</span></a>, or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>size</p></td>
|
||
<td class="parameter_description"><p>location to store a stock
|
||
icon size (<a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a>), or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> int]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-get-pixbuf"></a><h3>gtk_image_get_pixbuf ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">GdkPixbuf</span> *
|
||
gtk_image_get_pixbuf (<em class="parameter"><code><a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> *image</code></em>);</pre>
|
||
<p>Gets the <span class="type">GdkPixbuf</span> being displayed by the <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a>.
|
||
The storage type of the image must be <a class="link" href="GtkImage.html#GTK-IMAGE-EMPTY:CAPS"><code class="literal">GTK_IMAGE_EMPTY</code></a> or
|
||
<a class="link" href="GtkImage.html#GTK-IMAGE-PIXBUF:CAPS"><code class="literal">GTK_IMAGE_PIXBUF</code></a> (see <a class="link" href="GtkImage.html#gtk-image-get-storage-type" title="gtk_image_get_storage_type ()"><code class="function">gtk_image_get_storage_type()</code></a>).
|
||
The caller of this function does not own a reference to the
|
||
returned pixbuf.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-get-pixbuf.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>image</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-get-pixbuf.returns"></a><h4>Returns</h4>
|
||
<p>the displayed pixbuf, or <code class="literal">NULL</code> if
|
||
the image is empty. </p>
|
||
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-get-stock"></a><h3>gtk_image_get_stock ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_image_get_stock (<em class="parameter"><code><a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> *image</code></em>,
|
||
<em class="parameter"><code><span class="type">gchar</span> **stock_id</code></em>,
|
||
<em class="parameter"><code><a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a> *size</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_image_get_stock</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p>
|
||
<p>Use <a class="link" href="GtkImage.html#gtk-image-get-icon-name" title="gtk_image_get_icon_name ()"><code class="function">gtk_image_get_icon_name()</code></a> instead.</p>
|
||
</div>
|
||
<p>Gets the stock icon name and size being displayed by the <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a>.
|
||
The storage type of the image must be <a class="link" href="GtkImage.html#GTK-IMAGE-EMPTY:CAPS"><code class="literal">GTK_IMAGE_EMPTY</code></a> or
|
||
<a class="link" href="GtkImage.html#GTK-IMAGE-STOCK:CAPS"><code class="literal">GTK_IMAGE_STOCK</code></a> (see <a class="link" href="GtkImage.html#gtk-image-get-storage-type" title="gtk_image_get_storage_type ()"><code class="function">gtk_image_get_storage_type()</code></a>).
|
||
The returned string is owned by the <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> and should not
|
||
be freed.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-get-stock.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>image</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>stock_id</p></td>
|
||
<td class="parameter_description"><p>place to store a
|
||
stock icon name, or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>size</p></td>
|
||
<td class="parameter_description"><p>place to store a stock icon
|
||
size (<a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a>), or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> int]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-get-animation"></a><h3>gtk_image_get_animation ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">GdkPixbufAnimation</span> *
|
||
gtk_image_get_animation (<em class="parameter"><code><a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> *image</code></em>);</pre>
|
||
<p>Gets the <span class="type">GdkPixbufAnimation</span> being displayed by the <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a>.
|
||
The storage type of the image must be <a class="link" href="GtkImage.html#GTK-IMAGE-EMPTY:CAPS"><code class="literal">GTK_IMAGE_EMPTY</code></a> or
|
||
<a class="link" href="GtkImage.html#GTK-IMAGE-ANIMATION:CAPS"><code class="literal">GTK_IMAGE_ANIMATION</code></a> (see <a class="link" href="GtkImage.html#gtk-image-get-storage-type" title="gtk_image_get_storage_type ()"><code class="function">gtk_image_get_storage_type()</code></a>).
|
||
The caller of this function does not own a reference to the
|
||
returned animation.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-get-animation.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>image</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-get-animation.returns"></a><h4>Returns</h4>
|
||
<p>the displayed animation, or <code class="literal">NULL</code> if
|
||
the image is empty. </p>
|
||
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-get-icon-name"></a><h3>gtk_image_get_icon_name ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_image_get_icon_name (<em class="parameter"><code><a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> *image</code></em>,
|
||
<em class="parameter"><code>const <span class="type">gchar</span> **icon_name</code></em>,
|
||
<em class="parameter"><code><a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a> *size</code></em>);</pre>
|
||
<p>Gets the icon name and size being displayed by the <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a>.
|
||
The storage type of the image must be <a class="link" href="GtkImage.html#GTK-IMAGE-EMPTY:CAPS"><code class="literal">GTK_IMAGE_EMPTY</code></a> or
|
||
<a class="link" href="GtkImage.html#GTK-IMAGE-ICON-NAME:CAPS"><code class="literal">GTK_IMAGE_ICON_NAME</code></a> (see <a class="link" href="GtkImage.html#gtk-image-get-storage-type" title="gtk_image_get_storage_type ()"><code class="function">gtk_image_get_storage_type()</code></a>).
|
||
The returned string is owned by the <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> and should not
|
||
be freed.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-get-icon-name.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>image</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>icon_name</p></td>
|
||
<td class="parameter_description"><p>place to store an
|
||
icon name, or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>size</p></td>
|
||
<td class="parameter_description"><p>place to store an icon size
|
||
(<a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a>), or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> int]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.6</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-get-gicon"></a><h3>gtk_image_get_gicon ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_image_get_gicon (<em class="parameter"><code><a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> *image</code></em>,
|
||
<em class="parameter"><code><span class="type">GIcon</span> **gicon</code></em>,
|
||
<em class="parameter"><code><a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a> *size</code></em>);</pre>
|
||
<p>Gets the <span class="type">GIcon</span> and size being displayed by the <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a>.
|
||
The storage type of the image must be <a class="link" href="GtkImage.html#GTK-IMAGE-EMPTY:CAPS"><code class="literal">GTK_IMAGE_EMPTY</code></a> or
|
||
<a class="link" href="GtkImage.html#GTK-IMAGE-GICON:CAPS"><code class="literal">GTK_IMAGE_GICON</code></a> (see <a class="link" href="GtkImage.html#gtk-image-get-storage-type" title="gtk_image_get_storage_type ()"><code class="function">gtk_image_get_storage_type()</code></a>).
|
||
The caller of this function does not own a reference to the
|
||
returned <span class="type">GIcon</span>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-get-gicon.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>image</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>gicon</p></td>
|
||
<td class="parameter_description"><p>place to store a
|
||
<span class="type">GIcon</span>, or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>size</p></td>
|
||
<td class="parameter_description"><p>place to store an icon size
|
||
(<a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a>), or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> int]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.14</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-get-storage-type"></a><h3>gtk_image_get_storage_type ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkImage.html#GtkImageType" title="enum GtkImageType"><span class="returnvalue">GtkImageType</span></a>
|
||
gtk_image_get_storage_type (<em class="parameter"><code><a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> *image</code></em>);</pre>
|
||
<p>Gets the type of representation being used by the <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a>
|
||
to store image data. If the <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> has no image data,
|
||
the return value will be <a class="link" href="GtkImage.html#GTK-IMAGE-EMPTY:CAPS"><code class="literal">GTK_IMAGE_EMPTY</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-get-storage-type.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>image</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-get-storage-type.returns"></a><h4>Returns</h4>
|
||
<p> image representation being used</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-new-from-file"></a><h3>gtk_image_new_from_file ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
gtk_image_new_from_file (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
|
||
<p>Creates a new <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> displaying the file <em class="parameter"><code>filename</code></em>
|
||
. If the file
|
||
isn’t found or can’t be loaded, the resulting <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> will
|
||
display a “broken image” icon. This function never returns <code class="literal">NULL</code>,
|
||
it always returns a valid <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> widget.</p>
|
||
<p>If the file contains an animation, the image will contain an
|
||
animation.</p>
|
||
<p>If you need to detect failures to load the file, use
|
||
<code class="function">gdk_pixbuf_new_from_file()</code> to load the file yourself, then create
|
||
the <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> from the pixbuf. (Or for animations, use
|
||
<code class="function">gdk_pixbuf_animation_new_from_file()</code>).</p>
|
||
<p>The storage type (<a class="link" href="GtkImage.html#gtk-image-get-storage-type" title="gtk_image_get_storage_type ()"><code class="function">gtk_image_get_storage_type()</code></a>) of the returned
|
||
image is not defined, it will be whatever is appropriate for
|
||
displaying the file.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-new-from-file.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>filename</p></td>
|
||
<td class="parameter_description"><p>a filename. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-new-from-file.returns"></a><h4>Returns</h4>
|
||
<p> a new <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-new-from-icon-set"></a><h3>gtk_image_new_from_icon_set ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
gtk_image_new_from_icon_set (<em class="parameter"><code><a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSet"><span class="type">GtkIconSet</span></a> *icon_set</code></em>,
|
||
<em class="parameter"><code><a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a> size</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_image_new_from_icon_set</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p>
|
||
<p>Use <a class="link" href="GtkImage.html#gtk-image-new-from-icon-name" title="gtk_image_new_from_icon_name ()"><code class="function">gtk_image_new_from_icon_name()</code></a> instead.</p>
|
||
</div>
|
||
<p>Creates a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> displaying an icon set. Sample stock sizes are
|
||
<a class="link" href="gtk3-Themeable-Stock-Images.html#GTK-ICON-SIZE-MENU:CAPS"><span class="type">GTK_ICON_SIZE_MENU</span></a>, <a class="link" href="gtk3-Themeable-Stock-Images.html#GTK-ICON-SIZE-SMALL-TOOLBAR:CAPS"><span class="type">GTK_ICON_SIZE_SMALL_TOOLBAR</span></a>. Instead of using
|
||
this function, usually it’s better to create a <a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconFactory"><span class="type">GtkIconFactory</span></a>, put
|
||
your icon sets in the icon factory, add the icon factory to the
|
||
list of default factories with <a class="link" href="gtk3-Themeable-Stock-Images.html#gtk-icon-factory-add-default" title="gtk_icon_factory_add_default ()"><code class="function">gtk_icon_factory_add_default()</code></a>, and
|
||
then use <a class="link" href="GtkImage.html#gtk-image-new-from-stock" title="gtk_image_new_from_stock ()"><code class="function">gtk_image_new_from_stock()</code></a>. This will allow themes to
|
||
override the icon you ship with your application.</p>
|
||
<p>The <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> does not assume a reference to the
|
||
icon set; you still need to unref it if you own references.
|
||
<a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> will add its own reference rather than adopting yours.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-new-from-icon-set.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>icon_set</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSet"><span class="type">GtkIconSet</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>size</p></td>
|
||
<td class="parameter_description"><p>a stock icon size (<a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a>). </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> int]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-new-from-icon-set.returns"></a><h4>Returns</h4>
|
||
<p> a new <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-new-from-pixbuf"></a><h3>gtk_image_new_from_pixbuf ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
gtk_image_new_from_pixbuf (<em class="parameter"><code><span class="type">GdkPixbuf</span> *pixbuf</code></em>);</pre>
|
||
<p>Creates a new <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> displaying <em class="parameter"><code>pixbuf</code></em>
|
||
.
|
||
The <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> does not assume a reference to the
|
||
pixbuf; you still need to unref it if you own references.
|
||
<a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> will add its own reference rather than adopting yours.</p>
|
||
<p>Note that this function just creates an <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> from the pixbuf. The
|
||
<a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> created will not react to state changes. Should you want that,
|
||
you should use <a class="link" href="GtkImage.html#gtk-image-new-from-icon-name" title="gtk_image_new_from_icon_name ()"><code class="function">gtk_image_new_from_icon_name()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-new-from-pixbuf.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>pixbuf</p></td>
|
||
<td class="parameter_description"><p>a <span class="type">GdkPixbuf</span>, or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-new-from-pixbuf.returns"></a><h4>Returns</h4>
|
||
<p> a new <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-new-from-stock"></a><h3>gtk_image_new_from_stock ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
gtk_image_new_from_stock (<em class="parameter"><code>const <span class="type">gchar</span> *stock_id</code></em>,
|
||
<em class="parameter"><code><a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a> size</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_image_new_from_stock</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p>
|
||
<p>Use <a class="link" href="GtkImage.html#gtk-image-new-from-icon-name" title="gtk_image_new_from_icon_name ()"><code class="function">gtk_image_new_from_icon_name()</code></a> instead.</p>
|
||
</div>
|
||
<p>Creates a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> displaying a stock icon. Sample stock icon
|
||
names are <a class="link" href="gtk3-Stock-Items.html#GTK-STOCK-OPEN:CAPS" title="GTK_STOCK_OPEN"><span class="type">GTK_STOCK_OPEN</span></a>, <a class="link" href="gtk3-Stock-Items.html#GTK-STOCK-QUIT:CAPS" title="GTK_STOCK_QUIT"><span class="type">GTK_STOCK_QUIT</span></a>. Sample stock sizes
|
||
are <a class="link" href="gtk3-Themeable-Stock-Images.html#GTK-ICON-SIZE-MENU:CAPS"><span class="type">GTK_ICON_SIZE_MENU</span></a>, <a class="link" href="gtk3-Themeable-Stock-Images.html#GTK-ICON-SIZE-SMALL-TOOLBAR:CAPS"><span class="type">GTK_ICON_SIZE_SMALL_TOOLBAR</span></a>. If the stock
|
||
icon name isn’t known, the image will be empty.
|
||
You can register your own stock icon names, see
|
||
<a class="link" href="gtk3-Themeable-Stock-Images.html#gtk-icon-factory-add-default" title="gtk_icon_factory_add_default ()"><code class="function">gtk_icon_factory_add_default()</code></a> and <a class="link" href="gtk3-Themeable-Stock-Images.html#gtk-icon-factory-add" title="gtk_icon_factory_add ()"><code class="function">gtk_icon_factory_add()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-new-from-stock.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>stock_id</p></td>
|
||
<td class="parameter_description"><p>a stock icon name</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>size</p></td>
|
||
<td class="parameter_description"><p>a stock icon size (<a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a>). </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> int]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-new-from-stock.returns"></a><h4>Returns</h4>
|
||
<p> a new <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> displaying the stock icon</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-new-from-animation"></a><h3>gtk_image_new_from_animation ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
gtk_image_new_from_animation (<em class="parameter"><code><span class="type">GdkPixbufAnimation</span> *animation</code></em>);</pre>
|
||
<p>Creates a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> displaying the given animation.
|
||
The <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> does not assume a reference to the
|
||
animation; you still need to unref it if you own references.
|
||
<a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> will add its own reference rather than adopting yours.</p>
|
||
<p>Note that the animation frames are shown using a timeout with
|
||
<span class="type">G_PRIORITY_DEFAULT</span>. When using animations to indicate busyness,
|
||
keep in mind that the animation will only be shown if the main loop
|
||
is not busy with something that has a higher priority.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-new-from-animation.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>animation</p></td>
|
||
<td class="parameter_description"><p>an animation</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-new-from-animation.returns"></a><h4>Returns</h4>
|
||
<p> a new <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> widget</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-new-from-icon-name"></a><h3>gtk_image_new_from_icon_name ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
gtk_image_new_from_icon_name (<em class="parameter"><code>const <span class="type">gchar</span> *icon_name</code></em>,
|
||
<em class="parameter"><code><a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a> size</code></em>);</pre>
|
||
<p>Creates a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> displaying an icon from the current icon theme.
|
||
If the icon name isn’t known, a “broken image” icon will be
|
||
displayed instead. If the current icon theme is changed, the icon
|
||
will be updated appropriately.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-new-from-icon-name.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>icon_name</p></td>
|
||
<td class="parameter_description"><p>an icon name or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>size</p></td>
|
||
<td class="parameter_description"><p>a stock icon size (<a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a>). </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> int]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-new-from-icon-name.returns"></a><h4>Returns</h4>
|
||
<p> a new <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> displaying the themed icon</p>
|
||
</div>
|
||
<p class="since">Since: 2.6</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-new-from-gicon"></a><h3>gtk_image_new_from_gicon ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
gtk_image_new_from_gicon (<em class="parameter"><code><span class="type">GIcon</span> *icon</code></em>,
|
||
<em class="parameter"><code><a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a> size</code></em>);</pre>
|
||
<p>Creates a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> displaying an icon from the current icon theme.
|
||
If the icon name isn’t known, a “broken image” icon will be
|
||
displayed instead. If the current icon theme is changed, the icon
|
||
will be updated appropriately.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-new-from-gicon.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>icon</p></td>
|
||
<td class="parameter_description"><p>an icon</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>size</p></td>
|
||
<td class="parameter_description"><p>a stock icon size (<a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a>). </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> int]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-new-from-gicon.returns"></a><h4>Returns</h4>
|
||
<p> a new <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> displaying the themed icon</p>
|
||
</div>
|
||
<p class="since">Since: 2.14</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-new-from-resource"></a><h3>gtk_image_new_from_resource ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
gtk_image_new_from_resource (<em class="parameter"><code>const <span class="type">gchar</span> *resource_path</code></em>);</pre>
|
||
<p>Creates a new <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> displaying the resource file <em class="parameter"><code>resource_path</code></em>
|
||
. If the file
|
||
isn’t found or can’t be loaded, the resulting <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> will
|
||
display a “broken image” icon. This function never returns <code class="literal">NULL</code>,
|
||
it always returns a valid <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> widget.</p>
|
||
<p>If the file contains an animation, the image will contain an
|
||
animation.</p>
|
||
<p>If you need to detect failures to load the file, use
|
||
<code class="function">gdk_pixbuf_new_from_file()</code> to load the file yourself, then create
|
||
the <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> from the pixbuf. (Or for animations, use
|
||
<code class="function">gdk_pixbuf_animation_new_from_file()</code>).</p>
|
||
<p>The storage type (<a class="link" href="GtkImage.html#gtk-image-get-storage-type" title="gtk_image_get_storage_type ()"><code class="function">gtk_image_get_storage_type()</code></a>) of the returned
|
||
image is not defined, it will be whatever is appropriate for
|
||
displaying the file.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-new-from-resource.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>resource_path</p></td>
|
||
<td class="parameter_description"><p>a resource path</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-new-from-resource.returns"></a><h4>Returns</h4>
|
||
<p> a new <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p>
|
||
</div>
|
||
<p class="since">Since: <a class="link" href="api-index-3-4.html#api-index-3.4">3.4</a></p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-new-from-surface"></a><h3>gtk_image_new_from_surface ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
gtk_image_new_from_surface (<em class="parameter"><code><span class="type">cairo_surface_t</span> *surface</code></em>);</pre>
|
||
<p>Creates a new <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> displaying <em class="parameter"><code>surface</code></em>
|
||
.
|
||
The <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> does not assume a reference to the
|
||
surface; you still need to unref it if you own references.
|
||
<a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> will add its own reference rather than adopting yours.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-new-from-surface.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>surface</p></td>
|
||
<td class="parameter_description"><p>a <span class="type">cairo_surface_t</span>, or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-new-from-surface.returns"></a><h4>Returns</h4>
|
||
<p> a new <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p>
|
||
</div>
|
||
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-set-from-file"></a><h3>gtk_image_set_from_file ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_image_set_from_file (<em class="parameter"><code><a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> *image</code></em>,
|
||
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
|
||
<p>See <a class="link" href="GtkImage.html#gtk-image-new-from-file" title="gtk_image_new_from_file ()"><code class="function">gtk_image_new_from_file()</code></a> for details.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-set-from-file.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>image</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>filename</p></td>
|
||
<td class="parameter_description"><p>a filename or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-set-from-icon-set"></a><h3>gtk_image_set_from_icon_set ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_image_set_from_icon_set (<em class="parameter"><code><a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> *image</code></em>,
|
||
<em class="parameter"><code><a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSet"><span class="type">GtkIconSet</span></a> *icon_set</code></em>,
|
||
<em class="parameter"><code><a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a> size</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_image_set_from_icon_set</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p>
|
||
<p>Use <a class="link" href="GtkImage.html#gtk-image-set-from-icon-name" title="gtk_image_set_from_icon_name ()"><code class="function">gtk_image_set_from_icon_name()</code></a> instead.</p>
|
||
</div>
|
||
<p>See <a class="link" href="GtkImage.html#gtk-image-new-from-icon-set" title="gtk_image_new_from_icon_set ()"><code class="function">gtk_image_new_from_icon_set()</code></a> for details.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-set-from-icon-set.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>image</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>icon_set</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSet"><span class="type">GtkIconSet</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>size</p></td>
|
||
<td class="parameter_description"><p>a stock icon size (<a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a>). </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> int]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-set-from-pixbuf"></a><h3>gtk_image_set_from_pixbuf ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_image_set_from_pixbuf (<em class="parameter"><code><a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> *image</code></em>,
|
||
<em class="parameter"><code><span class="type">GdkPixbuf</span> *pixbuf</code></em>);</pre>
|
||
<p>See <a class="link" href="GtkImage.html#gtk-image-new-from-pixbuf" title="gtk_image_new_from_pixbuf ()"><code class="function">gtk_image_new_from_pixbuf()</code></a> for details.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-set-from-pixbuf.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>image</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>pixbuf</p></td>
|
||
<td class="parameter_description"><p>a <span class="type">GdkPixbuf</span> or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-set-from-stock"></a><h3>gtk_image_set_from_stock ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_image_set_from_stock (<em class="parameter"><code><a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> *image</code></em>,
|
||
<em class="parameter"><code>const <span class="type">gchar</span> *stock_id</code></em>,
|
||
<em class="parameter"><code><a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a> size</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_image_set_from_stock</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p>
|
||
<p>Use <a class="link" href="GtkImage.html#gtk-image-set-from-icon-name" title="gtk_image_set_from_icon_name ()"><code class="function">gtk_image_set_from_icon_name()</code></a> instead.</p>
|
||
</div>
|
||
<p>See <a class="link" href="GtkImage.html#gtk-image-new-from-stock" title="gtk_image_new_from_stock ()"><code class="function">gtk_image_new_from_stock()</code></a> for details.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-set-from-stock.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>image</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>stock_id</p></td>
|
||
<td class="parameter_description"><p>a stock icon name</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>size</p></td>
|
||
<td class="parameter_description"><p>a stock icon size (<a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a>). </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> int]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-set-from-animation"></a><h3>gtk_image_set_from_animation ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_image_set_from_animation (<em class="parameter"><code><a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> *image</code></em>,
|
||
<em class="parameter"><code><span class="type">GdkPixbufAnimation</span> *animation</code></em>);</pre>
|
||
<p>Causes the <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> to display the given animation (or display
|
||
nothing, if you set the animation to <code class="literal">NULL</code>).</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-set-from-animation.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>image</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>animation</p></td>
|
||
<td class="parameter_description"><p>the <span class="type">GdkPixbufAnimation</span></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-set-from-icon-name"></a><h3>gtk_image_set_from_icon_name ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_image_set_from_icon_name (<em class="parameter"><code><a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> *image</code></em>,
|
||
<em class="parameter"><code>const <span class="type">gchar</span> *icon_name</code></em>,
|
||
<em class="parameter"><code><a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a> size</code></em>);</pre>
|
||
<p>See <a class="link" href="GtkImage.html#gtk-image-new-from-icon-name" title="gtk_image_new_from_icon_name ()"><code class="function">gtk_image_new_from_icon_name()</code></a> for details.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-set-from-icon-name.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>image</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>icon_name</p></td>
|
||
<td class="parameter_description"><p>an icon name or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>size</p></td>
|
||
<td class="parameter_description"><p>an icon size (<a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a>). </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> int]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.6</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-set-from-gicon"></a><h3>gtk_image_set_from_gicon ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_image_set_from_gicon (<em class="parameter"><code><a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> *image</code></em>,
|
||
<em class="parameter"><code><span class="type">GIcon</span> *icon</code></em>,
|
||
<em class="parameter"><code><a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a> size</code></em>);</pre>
|
||
<p>See <a class="link" href="GtkImage.html#gtk-image-new-from-gicon" title="gtk_image_new_from_gicon ()"><code class="function">gtk_image_new_from_gicon()</code></a> for details.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-set-from-gicon.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>image</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>icon</p></td>
|
||
<td class="parameter_description"><p>an icon</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>size</p></td>
|
||
<td class="parameter_description"><p>an icon size (<a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize"><span class="type">GtkIconSize</span></a>). </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> int]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.14</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-set-from-resource"></a><h3>gtk_image_set_from_resource ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_image_set_from_resource (<em class="parameter"><code><a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> *image</code></em>,
|
||
<em class="parameter"><code>const <span class="type">gchar</span> *resource_path</code></em>);</pre>
|
||
<p>See <a class="link" href="GtkImage.html#gtk-image-new-from-resource" title="gtk_image_new_from_resource ()"><code class="function">gtk_image_new_from_resource()</code></a> for details.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-set-from-resource.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>image</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>resource_path</p></td>
|
||
<td class="parameter_description"><p>a resource path or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-set-from-surface"></a><h3>gtk_image_set_from_surface ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_image_set_from_surface (<em class="parameter"><code><a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> *image</code></em>,
|
||
<em class="parameter"><code><span class="type">cairo_surface_t</span> *surface</code></em>);</pre>
|
||
<p>See <a class="link" href="GtkImage.html#gtk-image-new-from-surface" title="gtk_image_new_from_surface ()"><code class="function">gtk_image_new_from_surface()</code></a> for details.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-set-from-surface.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>image</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>surface</p></td>
|
||
<td class="parameter_description"><p>a cairo_surface_t or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-clear"></a><h3>gtk_image_clear ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_image_clear (<em class="parameter"><code><a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> *image</code></em>);</pre>
|
||
<p>Resets the image to be empty.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-clear.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>image</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.8</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-new"></a><h3>gtk_image_new ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
gtk_image_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
||
<p>Creates a new empty <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> widget.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-new.returns"></a><h4>Returns</h4>
|
||
<p> a newly created <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> widget. </p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-set-pixel-size"></a><h3>gtk_image_set_pixel_size ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_image_set_pixel_size (<em class="parameter"><code><a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> *image</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> pixel_size</code></em>);</pre>
|
||
<p>Sets the pixel size to use for named icons. If the pixel size is set
|
||
to a value != -1, it is used instead of the icon size set by
|
||
<a class="link" href="GtkImage.html#gtk-image-set-from-icon-name" title="gtk_image_set_from_icon_name ()"><code class="function">gtk_image_set_from_icon_name()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-set-pixel-size.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>image</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>pixel_size</p></td>
|
||
<td class="parameter_description"><p>the new pixel size</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.6</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-image-get-pixel-size"></a><h3>gtk_image_get_pixel_size ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gint</span>
|
||
gtk_image_get_pixel_size (<em class="parameter"><code><a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> *image</code></em>);</pre>
|
||
<p>Gets the pixel size used for named icons.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-get-pixel-size.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>image</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-image-get-pixel-size.returns"></a><h4>Returns</h4>
|
||
<p> the pixel size used for named icons.</p>
|
||
</div>
|
||
<p class="since">Since: 2.6</p>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkImage.other_details"></a><h2>Types and Values</h2>
|
||
<div class="refsect2">
|
||
<a name="GtkImage-struct"></a><h3>struct GtkImage</h3>
|
||
<pre class="programlisting">struct GtkImage;</pre>
|
||
<p>This struct contain private data only and should be accessed by the functions
|
||
below.</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkImageType"></a><h3>enum GtkImageType</h3>
|
||
<p>Describes the image data representation used by a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a>. If you
|
||
want to get the image from the widget, you can only get the
|
||
currently-stored representation. e.g. if the
|
||
<a class="link" href="GtkImage.html#gtk-image-get-storage-type" title="gtk_image_get_storage_type ()"><code class="function">gtk_image_get_storage_type()</code></a> returns <a class="link" href="GtkImage.html#GTK-IMAGE-PIXBUF:CAPS"><span class="type">GTK_IMAGE_PIXBUF</span></a>, then you can
|
||
call <a class="link" href="GtkImage.html#gtk-image-get-pixbuf" title="gtk_image_get_pixbuf ()"><code class="function">gtk_image_get_pixbuf()</code></a> but not <a class="link" href="GtkImage.html#gtk-image-get-stock" title="gtk_image_get_stock ()"><code class="function">gtk_image_get_stock()</code></a>. For empty
|
||
images, you can request any storage type (call any of the "get"
|
||
functions), but they will all return <code class="literal">NULL</code> values.</p>
|
||
<div class="refsect3">
|
||
<a name="GtkImageType.members"></a><h4>Members</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="300px" class="enum_members_name">
|
||
<col class="enum_members_description">
|
||
<col width="200px" class="enum_members_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="enum_member_name"><p><a name="GTK-IMAGE-EMPTY:CAPS"></a>GTK_IMAGE_EMPTY</p></td>
|
||
<td class="enum_member_description">
|
||
<p>there is no image displayed by the widget</p>
|
||
</td>
|
||
<td class="enum_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="enum_member_name"><p><a name="GTK-IMAGE-PIXBUF:CAPS"></a>GTK_IMAGE_PIXBUF</p></td>
|
||
<td class="enum_member_description">
|
||
<p>the widget contains a <span class="type">GdkPixbuf</span></p>
|
||
</td>
|
||
<td class="enum_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="enum_member_name"><p><a name="GTK-IMAGE-STOCK:CAPS"></a>GTK_IMAGE_STOCK</p></td>
|
||
<td class="enum_member_description">
|
||
<p>the widget contains a stock item name</p>
|
||
</td>
|
||
<td class="enum_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="enum_member_name"><p><a name="GTK-IMAGE-ICON-SET:CAPS"></a>GTK_IMAGE_ICON_SET</p></td>
|
||
<td class="enum_member_description">
|
||
<p>the widget contains a <a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSet"><span class="type">GtkIconSet</span></a></p>
|
||
</td>
|
||
<td class="enum_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="enum_member_name"><p><a name="GTK-IMAGE-ANIMATION:CAPS"></a>GTK_IMAGE_ANIMATION</p></td>
|
||
<td class="enum_member_description">
|
||
<p>the widget contains a <span class="type">GdkPixbufAnimation</span></p>
|
||
</td>
|
||
<td class="enum_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="enum_member_name"><p><a name="GTK-IMAGE-ICON-NAME:CAPS"></a>GTK_IMAGE_ICON_NAME</p></td>
|
||
<td class="enum_member_description">
|
||
<p>the widget contains a named icon.
|
||
This image type was added in GTK+ 2.6</p>
|
||
</td>
|
||
<td class="enum_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="enum_member_name"><p><a name="GTK-IMAGE-GICON:CAPS"></a>GTK_IMAGE_GICON</p></td>
|
||
<td class="enum_member_description">
|
||
<p>the widget contains a <span class="type">GIcon</span>.
|
||
This image type was added in GTK+ 2.14</p>
|
||
</td>
|
||
<td class="enum_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="enum_member_name"><p><a name="GTK-IMAGE-SURFACE:CAPS"></a>GTK_IMAGE_SURFACE</p></td>
|
||
<td class="enum_member_description">
|
||
<p>the widget contains a <span class="type">cairo_surface_t</span>.
|
||
This image type was added in GTK+ 3.10</p>
|
||
</td>
|
||
<td class="enum_member_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkImage.property-details"></a><h2>Property Details</h2>
|
||
<div class="refsect2">
|
||
<a name="GtkImage--file"></a><h3>The <code class="literal">“file”</code> property</h3>
|
||
<pre class="programlisting"> “file” <span class="type">gchar</span> *</pre>
|
||
<p>Filename to load and display.</p>
|
||
<p>Flags: Read / Write</p>
|
||
<p>Default value: NULL</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkImage--gicon"></a><h3>The <code class="literal">“gicon”</code> property</h3>
|
||
<pre class="programlisting"> “gicon” <span class="type">GIcon</span> *</pre>
|
||
<p>The GIcon displayed in the GtkImage. For themed icons,
|
||
If the icon theme is changed, the image will be updated
|
||
automatically.</p>
|
||
<p>Flags: Read / Write</p>
|
||
<p class="since">Since: 2.14</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkImage--icon-name"></a><h3>The <code class="literal">“icon-name”</code> property</h3>
|
||
<pre class="programlisting"> “icon-name” <span class="type">gchar</span> *</pre>
|
||
<p>The name of the icon in the icon theme. If the icon theme is
|
||
changed, the image will be updated automatically.</p>
|
||
<p>Flags: Read / Write</p>
|
||
<p>Default value: NULL</p>
|
||
<p class="since">Since: 2.6</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkImage--icon-set"></a><h3>The <code class="literal">“icon-set”</code> property</h3>
|
||
<pre class="programlisting"> “icon-set” <a class="link" href="gtk3-Themeable-Stock-Images.html#GtkIconSet"><span class="type">GtkIconSet</span></a> *</pre>
|
||
<p>Icon set to display.</p>
|
||
<div class="warning">
|
||
<p><code class="literal">GtkImage:icon-set</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p>
|
||
<p>Use <a class="link" href="GtkImage.html#GtkImage--icon-name" title="The “icon-name” property"><span class="type">“icon-name”</span></a> instead.</p>
|
||
</div>
|
||
<p>Flags: Read / Write</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkImage--icon-size"></a><h3>The <code class="literal">“icon-size”</code> property</h3>
|
||
<pre class="programlisting"> “icon-size” <span class="type">gint</span></pre>
|
||
<p>Symbolic size to use for stock icon, icon set or named icon.</p>
|
||
<p>Flags: Read / Write</p>
|
||
<p>Allowed values: >= 0</p>
|
||
<p>Default value: 4</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkImage--pixbuf"></a><h3>The <code class="literal">“pixbuf”</code> property</h3>
|
||
<pre class="programlisting"> “pixbuf” <span class="type">GdkPixbuf</span> *</pre>
|
||
<p>A GdkPixbuf to display.</p>
|
||
<p>Flags: Read / Write</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkImage--pixbuf-animation"></a><h3>The <code class="literal">“pixbuf-animation”</code> property</h3>
|
||
<pre class="programlisting"> “pixbuf-animation” <span class="type">GdkPixbufAnimation</span> *</pre>
|
||
<p>GdkPixbufAnimation to display.</p>
|
||
<p>Flags: Read / Write</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkImage--pixel-size"></a><h3>The <code class="literal">“pixel-size”</code> property</h3>
|
||
<pre class="programlisting"> “pixel-size” <span class="type">gint</span></pre>
|
||
<p>The "pixel-size" property can be used to specify a fixed size
|
||
overriding the <a class="link" href="GtkImage.html#GtkImage--icon-size" title="The “icon-size” property"><span class="type">“icon-size”</span></a> property for images of type
|
||
<a class="link" href="GtkImage.html#GTK-IMAGE-ICON-NAME:CAPS"><code class="literal">GTK_IMAGE_ICON_NAME</code></a>.</p>
|
||
<p>Flags: Read / Write</p>
|
||
<p>Allowed values: >= -1</p>
|
||
<p>Default value: -1</p>
|
||
<p class="since">Since: 2.6</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkImage--resource"></a><h3>The <code class="literal">“resource”</code> property</h3>
|
||
<pre class="programlisting"> “resource” <span class="type">gchar</span> *</pre>
|
||
<p>A path to a resource file to display.</p>
|
||
<p>Flags: Read / Write</p>
|
||
<p>Default value: NULL</p>
|
||
<p class="since">Since: <a class="link" href="api-index-3-8.html#api-index-3.8">3.8</a></p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkImage--stock"></a><h3>The <code class="literal">“stock”</code> property</h3>
|
||
<pre class="programlisting"> “stock” <span class="type">gchar</span> *</pre>
|
||
<p>Stock ID for a stock image to display.</p>
|
||
<div class="warning">
|
||
<p><code class="literal">GtkImage:stock</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p>
|
||
<p>Use <a class="link" href="GtkImage.html#GtkImage--icon-name" title="The “icon-name” property"><span class="type">“icon-name”</span></a> instead.</p>
|
||
</div>
|
||
<p>Flags: Read / Write</p>
|
||
<p>Default value: NULL</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkImage--storage-type"></a><h3>The <code class="literal">“storage-type”</code> property</h3>
|
||
<pre class="programlisting"> “storage-type” <a class="link" href="GtkImage.html#GtkImageType" title="enum GtkImageType"><span class="type">GtkImageType</span></a></pre>
|
||
<p>The representation being used for image data.</p>
|
||
<p>Flags: Read</p>
|
||
<p>Default value: GTK_IMAGE_EMPTY</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkImage--surface"></a><h3>The <code class="literal">“surface”</code> property</h3>
|
||
<pre class="programlisting"> “surface” <span class="type">CairoSurface</span> *</pre>
|
||
<p>A cairo_surface_t to display.</p>
|
||
<p>Flags: Read / Write</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkImage--use-fallback"></a><h3>The <code class="literal">“use-fallback”</code> property</h3>
|
||
<pre class="programlisting"> “use-fallback” <span class="type">gboolean</span></pre>
|
||
<p>Whether the icon displayed in the GtkImage will use
|
||
standard icon names fallback. The value of this property
|
||
is only relevant for images of type <a class="link" href="GtkImage.html#GTK-IMAGE-ICON-NAME:CAPS"><code class="literal">GTK_IMAGE_ICON_NAME</code></a>
|
||
and <a class="link" href="GtkImage.html#GTK-IMAGE-GICON:CAPS"><code class="literal">GTK_IMAGE_GICON</code></a>.</p>
|
||
<p>Flags: Read / Write</p>
|
||
<p>Default value: FALSE</p>
|
||
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkImage.see-also"></a><h2>See Also</h2>
|
||
<p><span class="type">GdkPixbuf</span></p>
|
||
</div>
|
||
</div>
|
||
<div class="footer">
|
||
<hr>Generated by GTK-Doc V1.28</div>
|
||
</body>
|
||
</html> |