← Back to branch summary

~andywingo/guile-gnome/libgnomeui

« back to all changes in this revision

Viewing changes to doc/defuns-gnome-icon-sel.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:
doc/defuns-gnome-icon-sel.xml.texi
1
1
 
2
2
@c %start of fragment
3
3
 
4
 
@deftp Class <gnome-icon-selection>
5
 
This @code{<gobject>} class defines no properties, other than those defined by
6
 
its superclasses.
7
 
 
8
 
@end deftp
9
 
 
10
 
@deffn Function gnome-icon-selection-new  @result{}@tie{} (ret@tie{}@code{<gtk-widget>})
11
 
Creates a new icon selection widget, it uses GnomeIconList for the listing of
12
 
icons
13
 
 
14
 
@table @var
15
 
@item ret
16
 
Returns the new object
17
 
 
18
 
@end table
19
 
 
20
 
@end deffn
21
 
 
22
 
@deffn Function gnome-icon-selection-add-defaults  (self@tie{}@code{<gnome-icon-selection>})
23
 
@deffnx Method add-defaults
24
 
Adds the default pixmap directory into the selection widget. It doesn't show the
25
 
icons in the selection until you do @code{<gnome-icon-selection-show-icons>}.
26
 
 
27
 
@table @var
28
 
@item gis
29
 
GnomeIconSelection to work with
30
 
 
31
 
@end table
32
 
 
33
 
@end deffn
34
 
 
35
 
@deffn Function gnome-icon-selection-add-directory  (self@tie{}@code{<gnome-icon-selection>}) (dir@tie{}@code{mchars})
36
 
@deffnx Method add-directory
37
 
Adds the icons from the directory @var{dir} to the selection widget. It doesn't
38
 
show the icons in the selection until you do
39
 
@code{<gnome-icon-selection-show-icons>}.
40
 
 
41
 
@table @var
42
 
@item gis
43
 
GnomeIconSelection to work with
44
 
 
45
 
@item dir
46
 
directory with pixmaps
47
 
 
48
 
@end table
49
 
 
50
 
@end deffn
51
 
 
52
 
@deffn Function gnome-icon-selection-show-icons  (self@tie{}@code{<gnome-icon-selection>})
53
 
@deffnx Method show-icons
54
 
Shows the icons inside the widget that were added with
55
 
@code{<gnome-icon-selection-add-defaults>} and
56
 
@code{<gnome-icon-selection-add-directory>}. Before this function is called the
57
 
icons aren't actually added to the listing and can't be picked by the user.
58
 
 
59
 
@table @var
60
 
@item gis
61
 
GnomeIconSelection to work with
62
 
 
63
 
@end table
64
 
 
65
 
@end deffn
66
 
 
67
 
@deffn Function gnome-icon-selection-clear  (self@tie{}@code{<gnome-icon-selection>}) (not_shown@tie{}@code{bool})
68
 
@deffnx Method clear
69
 
Clear the currently shown icons, the ones that weren't shown yet are not cleared
70
 
unless the not_shown parameter is given, in which case even those are cleared.
71
 
 
72
 
@table @var
73
 
@item gis
74
 
GnomeIconSelection to work with
75
 
 
76
 
@item not-shown
77
 
boolean
78
 
 
79
 
@end table
80
 
 
81
 
@end deffn
82
 
 
83
 
@deffn Function gnome-icon-selection-get-icon  (self@tie{}@code{<gnome-icon-selection>}) (full_path@tie{}@code{bool}) @result{}@tie{} (ret@tie{}@code{mchars})
84
 
@deffnx Method get-icon
85
 
Gets the currently selected icon name, if full_path is true, it returns the full
86
 
path to the icon, if none is selected it returns NULL
87
 
 
88
 
@table @var
89
 
@item gis
90
 
GnomeIconSelection to work with
91
 
 
92
 
@item full-path
93
 
boolean
94
 
 
95
 
@item ret
96
 
internal string, it must not be changed or freed or NULL
97
 
 
98
 
@end table
99
 
 
100
 
@end deffn
101
 
 
102
 
@deffn Function gnome-icon-selection-select-icon  (self@tie{}@code{<gnome-icon-selection>}) (filename@tie{}@code{mchars})
103
 
@deffnx Method select-icon
104
 
Selects the icon @var{filename}. This icon must have already been added and
105
 
shown * (see @var{gnome-icon-selection-show-icons})
106
 
 
107
 
@table @var
108
 
@item gis
109
 
GnomeIconSelection to work with
110
 
 
111
 
@item filename
112
 
icon filename
113
 
 
114
 
@end table
115
 
 
116
 
@end deffn
117
 
 
118
 
@deffn Function gnome-icon-selection-stop-loading  (self@tie{}@code{<gnome-icon-selection>})
119
 
@deffnx Method stop-loading
120
 
Stop the loading of images when we are in the loop in show_icons, otherwise it
121
 
does nothing and is harmless, it should be used say if the dialog was hidden or
122
 
when we want to quickly stop loading the images to do something else without
123
 
destroying the icon selection object. The remaining icons can be shown by
124
 
@code{<gnome-icon-selection-show-icons>}.
125
 
 
126
 
@table @var
127
 
@item gis
128
 
GnomeIconSelection to work with
129
 
 
130
 
@end table
131
 
 
132
 
@end deffn
133
 
 
134
 
@deffn Function gnome-icon-selection-get-gil  (self@tie{}@code{<gnome-icon-selection>}) @result{}@tie{} (ret@tie{}@code{<gtk-widget>})
135
 
@deffnx Method get-gil
136
 
Gets the @code{<gnome-icon-list>} widget that is used for the display of icons
137
 
 
138
 
@table @var
139
 
@item gis
140
 
GnomeIconSelection to work with
141
 
 
142
 
@item ret
143
 
a @code{<gtk-widget>} pointer to the interal widget
144
 
 
145
 
@end table
146
 
 
147
 
@end deffn
148
 
 
149
 
@deffn Function gnome-icon-selection-get-box  (self@tie{}@code{<gnome-icon-selection>}) @result{}@tie{} (ret@tie{}@code{<gtk-widget>})
150
 
@deffnx Method get-box
151
 
Gets the @code{<gtk-vbox>} widget that is used to pack the different elements of
152
 
the selection into.
153
 
 
154
 
@table @var
155
 
@item gis
156
 
GnomeIconSelection to work with
157
 
 
158
 
@item ret
159
 
a @code{<gtk-widget>} pointer to the interal widget
160
 
 
161
 
@end table
162
 
 
163
 
@end deffn
164
 
 
165
4
 
166
5
@c %end of fragment