2
2
@c %start of fragment
4
@deffn Function gnome-icon-lookup (icon_theme@tie{}@code{<gtk-icon-theme>}) (thumbnail_factory@tie{}@code{<gnome-thumbnail-factory>}) (file_uri@tie{}@code{mchars}) (custom_icon@tie{}@code{mchars}) (file_info@tie{}@code{<gnome-vfs-file-info*>}) (mime_type@tie{}@code{mchars}) (flags@tie{}@code{<gnome-icon-lookup-flags>}) (result@tie{}@code{<gnome-icon-lookup-result-flags*>}) @result{}@tie{} (ret@tie{}@code{mchars})
5
This function tries to locate an icon in @var{icon-theme} that can be used to
6
represent the file passed. It can optionally also look for existing thumbnails.
7
It does no I/O, so the lookup should be relatively fast.
9
If you don't know any information about the file already you can use
10
@code{gnome-icon-lookup-sync} which gets this information using gnome-vfs.
12
For backwards compatibility, this function also accepts a GnomeIconTheme instead
15
The following @var{flags} are valid:
17
GNOME_ICON_LOOKUP_FLAGS_EMBEDDING_TEXT - Return the text icon for scripts. This
18
is useful if you do text embedding in the icons.
20
GNOME_ICON_LOOKUP_FLAGS_SHOW_SMALL_IMAGES_AS_THEMSELVES - Return the filename of
21
the filename itself for small images. Only availible if you pass a
24
Possible @var{result} flags:
26
GNOME_ICON_LOOKUP_RESULT_FLAGS_THUMBNAIL - The returned file is a thumbnail.
30
a @code{<gtk-icon-theme>}, or (deprecated) a @code{<gnome-icon-theme>}
32
@item thumbnail-factory
33
an optional @code{<gnome-thumbnail-factory>} used to look up thumbnails
39
optionally the name of a custom icon to try
42
information about the file from @code{gnome-vfs-get-file-info}
45
the mime type of the icon
48
flags that affect the result of the lookup
51
optionally result flags of the lookups are stored here
54
The name of an icon or an absolute filename of an image to use for the file.
62
@deffn Function gnome-icon-lookup-sync (icon_theme@tie{}@code{<gtk-icon-theme>}) (thumbnail_factory@tie{}@code{<gnome-thumbnail-factory>}) (file_uri@tie{}@code{mchars}) (custom_icon@tie{}@code{mchars}) (flags@tie{}@code{<gnome-icon-lookup-flags>}) (result@tie{}@code{<gnome-icon-lookup-result-flags*>}) @result{}@tie{} (ret@tie{}@code{mchars})
63
This function tries to locate an icon in @var{icon-theme} that can be used to
64
represent the file passed. See @code{gnome-icon-lookup} for more information.
68
a @code{<gtk-icon-theme>}, or (deprecated) a @code{<gnome-icon-theme>}
70
@item thumbnail-factory
71
an optional @code{<gnome-thumbnail-factory>} used to look up thumbnails
77
optionally the name of a custom icon to try
80
flags that affect the result of the lookup
83
optionally result flags of the lookups are stored here
86
The name of an icon or an absolute filename of an image to use for the file.