~andywingo/guile-gnome/libgnomeui

« back to all changes in this revision

Viewing changes to doc/defuns-gnome-icon-lookup.xml.texi

  • Committer: Andy Wingo
  • Date: 2007-12-06 16:57:01 UTC
  • Revision ID: wingo@pobox.com-20071206165701-bvgnbf7esiu739gf
2007-12-06  Andy Wingo  <wingo@pobox.com>

        * tests/wrapset.api: Regnerated for massive API removal on
        previous commit.

        * doc/defuns-*.texi: Regenerated.

        * doc/guile-gnome-libgnomeui.texi (Top): 
        * doc/undocumented.texi: New section for undocumented exports.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
 
2
2
@c %start of fragment
3
3
 
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.
8
 
 
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.
11
 
 
12
 
For backwards compatibility, this function also accepts a GnomeIconTheme instead
13
 
of a GtkIconTheme.
14
 
 
15
 
The following @var{flags} are valid:
16
 
 
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.
19
 
 
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
22
 
thumbnail_factory.
23
 
 
24
 
Possible @var{result} flags:
25
 
 
26
 
GNOME_ICON_LOOKUP_RESULT_FLAGS_THUMBNAIL - The returned file is a thumbnail.
27
 
 
28
 
@table @var
29
 
@item icon-theme
30
 
a @code{<gtk-icon-theme>}, or (deprecated) a @code{<gnome-icon-theme>}
31
 
 
32
 
@item thumbnail-factory
33
 
an optional @code{<gnome-thumbnail-factory>} used to look up thumbnails
34
 
 
35
 
@item file-uri
36
 
the uri of the file
37
 
 
38
 
@item custom-icon
39
 
optionally the name of a custom icon to try
40
 
 
41
 
@item file-info
42
 
information about the file from @code{gnome-vfs-get-file-info}
43
 
 
44
 
@item mime-type
45
 
the mime type of the icon
46
 
 
47
 
@item flags
48
 
flags that affect the result of the lookup
49
 
 
50
 
@item result
51
 
optionally result flags of the lookups are stored here
52
 
 
53
 
@item ret
54
 
The name of an icon or an absolute filename of an image to use for the file.
55
 
 
56
 
@end table
57
 
 
58
 
Since 2.2
59
 
 
60
 
@end deffn
61
 
 
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.
65
 
 
66
 
@table @var
67
 
@item icon-theme
68
 
a @code{<gtk-icon-theme>}, or (deprecated) a @code{<gnome-icon-theme>}
69
 
 
70
 
@item thumbnail-factory
71
 
an optional @code{<gnome-thumbnail-factory>} used to look up thumbnails
72
 
 
73
 
@item file-uri
74
 
the uri of the file
75
 
 
76
 
@item custom-icon
77
 
optionally the name of a custom icon to try
78
 
 
79
 
@item flags
80
 
flags that affect the result of the lookup
81
 
 
82
 
@item result
83
 
optionally result flags of the lookups are stored here
84
 
 
85
 
@item ret
86
 
The name of an icon or an absolute filename of an image to use for the file.
87
 
 
88
 
@end table
89
 
 
90
 
Since 2.2
91
 
 
92
 
@end deffn
93
 
 
94
4
 
95
5
@c %end of fragment