|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /proc/21585/root/usr/share/gtk-doc/html/libgnomeui/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GnomeIconLookup</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GNOME UI Library Reference Manual">
<link rel="up" href="fixme.html" title="Miscellaneous Widgets">
<link rel="prev" href="GnomeIconList.html" title="GnomeIconList">
<link rel="next" href="libgnomeui-GnomeIconTheme.html" title="GnomeIconTheme">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="GNOME UI Library (libgnomeui)">
</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="2">
<tr valign="middle">
<td><a accesskey="p" href="GnomeIconList.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="fixme.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GNOME UI Library Reference Manual</th>
<td><a accesskey="n" href="libgnomeui-GnomeIconTheme.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id3055768" class="shortcut">Top</a>
 | 
<a href="#id3055944" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgnomeui-GnomeIconLookup"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id3055768"></a><span class="refentrytitle">GnomeIconLookup</span>
</h2>
<p>GnomeIconLookup — </p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <libgnomeui/libgnomeui.h>
enum <a href="libgnomeui-GnomeIconLookup.html#GnomeIconLookupFlags">GnomeIconLookupFlags</a>;
enum <a href="libgnomeui-GnomeIconLookup.html#GnomeIconLookupResultFlags">GnomeIconLookupResultFlags</a>;
char* <a href="libgnomeui-GnomeIconLookup.html#gnome-icon-lookup">gnome_icon_lookup</a> (<a
href="/usr/share/gtk-doc/html/gtk/GtkIconTheme.html"
>GtkIconTheme</a> *icon_theme,
<a href="libgnomeui-GnomeThumbnail.html#GnomeThumbnailFactory">GnomeThumbnailFactory</a> *thumbnail_factory,
const char *file_uri,
const char *custom_icon,
<a
href="/usr/share/gtk-doc/html/gnome-vfs-2.0/gnome-vfs-20-gnome-vfs-file-info.html#GnomeVFSFileInfo"
>GnomeVFSFileInfo</a> *file_info,
const char *mime_type,
<a href="libgnomeui-GnomeIconLookup.html#GnomeIconLookupFlags">GnomeIconLookupFlags</a> flags,
<a href="libgnomeui-GnomeIconLookup.html#GnomeIconLookupResultFlags">GnomeIconLookupResultFlags</a> *result);
char* <a href="libgnomeui-GnomeIconLookup.html#gnome-icon-lookup-sync">gnome_icon_lookup_sync</a> (<a
href="/usr/share/gtk-doc/html/gtk/GtkIconTheme.html"
>GtkIconTheme</a> *icon_theme,
<a href="libgnomeui-GnomeThumbnail.html#GnomeThumbnailFactory">GnomeThumbnailFactory</a> *thumbnail_factory,
const char *file_uri,
const char *custom_icon,
<a href="libgnomeui-GnomeIconLookup.html#GnomeIconLookupFlags">GnomeIconLookupFlags</a> flags,
<a href="libgnomeui-GnomeIconLookup.html#GnomeIconLookupResultFlags">GnomeIconLookupResultFlags</a> *result);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3055944"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id3055959"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id3055969"></a><h3>
<a name="GnomeIconLookupFlags"></a>enum GnomeIconLookupFlags</h3>
<a class="indexterm" name="id3055982"></a><pre class="programlisting">typedef enum {
GNOME_ICON_LOOKUP_FLAGS_NONE = 0,
GNOME_ICON_LOOKUP_FLAGS_EMBEDDING_TEXT = 1<<0,
GNOME_ICON_LOOKUP_FLAGS_SHOW_SMALL_IMAGES_AS_THEMSELVES = 1<<1,
GNOME_ICON_LOOKUP_FLAGS_ALLOW_SVG_AS_THEMSELVES = 1<<2
} GnomeIconLookupFlags;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3056006"></a><h3>
<a name="GnomeIconLookupResultFlags"></a>enum GnomeIconLookupResultFlags</h3>
<a class="indexterm" name="id3056020"></a><pre class="programlisting">typedef enum {
GNOME_ICON_LOOKUP_RESULT_FLAGS_NONE = 0,
GNOME_ICON_LOOKUP_RESULT_FLAGS_THUMBNAIL = 1<<0
} GnomeIconLookupResultFlags;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3056037"></a><h3>
<a name="gnome-icon-lookup"></a>gnome_icon_lookup ()</h3>
<a class="indexterm" name="id3056053"></a><pre class="programlisting">char* gnome_icon_lookup (<a
href="/usr/share/gtk-doc/html/gtk/GtkIconTheme.html"
>GtkIconTheme</a> *icon_theme,
<a href="libgnomeui-GnomeThumbnail.html#GnomeThumbnailFactory">GnomeThumbnailFactory</a> *thumbnail_factory,
const char *file_uri,
const char *custom_icon,
<a
href="/usr/share/gtk-doc/html/gnome-vfs-2.0/gnome-vfs-20-gnome-vfs-file-info.html#GnomeVFSFileInfo"
>GnomeVFSFileInfo</a> *file_info,
const char *mime_type,
<a href="libgnomeui-GnomeIconLookup.html#GnomeIconLookupFlags">GnomeIconLookupFlags</a> flags,
<a href="libgnomeui-GnomeIconLookup.html#GnomeIconLookupResultFlags">GnomeIconLookupResultFlags</a> *result);</pre>
<p>
This function tries to locate an icon in <em class="parameter"><code>icon_theme</code></em> that can be used
to represent the file passed. It can optionally also look for existing
thumbnails. It does no I/O, so the lookup should be relatively fast.
</p>
<p>
If you don't know any information about the file already you can use
<a href="libgnomeui-GnomeIconLookup.html#gnome-icon-lookup-sync"><code class="function">gnome_icon_lookup_sync()</code></a> which gets this information using gnome-vfs.
</p>
<p>
For backwards compatibility, this function also accepts a GnomeIconTheme
instead of a GtkIconTheme.
</p>
<p>
The following <em class="parameter"><code>flags</code></em> are valid:
</p>
<p>
GNOME_ICON_LOOKUP_FLAGS_EMBEDDING_TEXT - Return the text icon for scripts.
This is useful if you do text embedding in the icons.
</p>
<p>
GNOME_ICON_LOOKUP_FLAGS_SHOW_SMALL_IMAGES_AS_THEMSELVES - Return the
filename of the filename itself for small images. Only availible if you
pass a thumbnail_factory.
</p>
<p>
Possible <em class="parameter"><code>result</code></em> flags:
</p>
<p>
GNOME_ICON_LOOKUP_RESULT_FLAGS_THUMBNAIL - The returned file is a thumbnail.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_theme</code></em> :</span></td>
<td> a <a
href="/usr/share/gtk-doc/html/gtk/GtkIconTheme.html"
><span class="type">GtkIconTheme</span></a>, or (deprecated) a <a href="libgnomeui-GnomeIconTheme.html#GnomeIconTheme"><span class="type">GnomeIconTheme</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>thumbnail_factory</code></em> :</span></td>
<td> an optional <a href="libgnomeui-GnomeThumbnail.html#GnomeThumbnailFactory"><span class="type">GnomeThumbnailFactory</span></a> used to look up thumbnails
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>file_uri</code></em> :</span></td>
<td> the uri of the file
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>custom_icon</code></em> :</span></td>
<td> optionally the name of a custom icon to try
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>file_info</code></em> :</span></td>
<td> information about the file from <a
href="/usr/share/gtk-doc/html/gnome-vfs-2.0/gnome-vfs-20-gnome-vfs-file-info-ops.html#gnome-vfs-get-file-info"
><code class="function">gnome_vfs_get_file_info()</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>mime_type</code></em> :</span></td>
<td> the mime type of the icon
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>flags</code></em> :</span></td>
<td> flags that affect the result of the lookup
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>result</code></em> :</span></td>
<td> optionally result flags of the lookups are stored here
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The name of an icon or an absolute filename of an image to
use for the file.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3056381"></a><h3>
<a name="gnome-icon-lookup-sync"></a>gnome_icon_lookup_sync ()</h3>
<a class="indexterm" name="id3056396"></a><pre class="programlisting">char* gnome_icon_lookup_sync (<a
href="/usr/share/gtk-doc/html/gtk/GtkIconTheme.html"
>GtkIconTheme</a> *icon_theme,
<a href="libgnomeui-GnomeThumbnail.html#GnomeThumbnailFactory">GnomeThumbnailFactory</a> *thumbnail_factory,
const char *file_uri,
const char *custom_icon,
<a href="libgnomeui-GnomeIconLookup.html#GnomeIconLookupFlags">GnomeIconLookupFlags</a> flags,
<a href="libgnomeui-GnomeIconLookup.html#GnomeIconLookupResultFlags">GnomeIconLookupResultFlags</a> *result);</pre>
<p>
This function tries to locate an icon in <em class="parameter"><code>icon_theme</code></em> that can be used
to represent the file passed. See <a href="libgnomeui-GnomeIconLookup.html#gnome-icon-lookup"><code class="function">gnome_icon_lookup()</code></a> for more information.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_theme</code></em> :</span></td>
<td> a <a
href="/usr/share/gtk-doc/html/gtk/GtkIconTheme.html"
><span class="type">GtkIconTheme</span></a>, or (deprecated) a <a href="libgnomeui-GnomeIconTheme.html#GnomeIconTheme"><span class="type">GnomeIconTheme</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>thumbnail_factory</code></em> :</span></td>
<td> an optional <a href="libgnomeui-GnomeThumbnail.html#GnomeThumbnailFactory"><span class="type">GnomeThumbnailFactory</span></a> used to look up thumbnails
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>file_uri</code></em> :</span></td>
<td> the uri of the file
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>custom_icon</code></em> :</span></td>
<td> optionally the name of a custom icon to try
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>flags</code></em> :</span></td>
<td> flags that affect the result of the lookup
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>result</code></em> :</span></td>
<td> optionally result flags of the lookups are stored here
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The name of an icon or an absolute filename of an image to
use for the file.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.2
</p>
</div>
</div>
</div>
</body>
</html>