← Back to branch summary

~ubuntu-branches/ubuntu/trusty/guile-gnome-platform/trusty-proposed

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Rottmann
  • Date: 2009-03-01 22:51:48 UTC
  • mfrom: (1.1.2 upstream) (3.2.1 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090301225148-5cubt342wiv8jpmf
Tags: 2.16.1-1
* New upstream release.
* Upstream bumped API, hence all package names changed from
  guile-gnome0-* to guile-gnome2-*.
* Standards-Version 3.8.0 (no changes).
* Remove unused guile-gnome2-cairo.install file.
* Added ${misc:Depends} to all packages.
* Do not build-depend on a -1 revision of the g-wrap packages.
* Add a proper "Copyright YEARS AUTHORS" line to debian/copyright.

Show diffs side-by-side

added added

removed removed

Lines of Context:
libgnomeui/doc/defuns-gnome-icon-entry.xml.texi
1
 
 
2
 
@c %start of fragment
3
 
 
4
 
@deftp Class <gnome-icon-entry>
5
 
This @code{<gobject>} class defines the following properties:
6
 
 
7
 
@table @code
8
 
@item history-id
9
 
Unique identifier for the icon entry. This will be used to save the history
10
 
list.
11
 
 
12
 
@item browse-dialog-title
13
 
Title for the Browse icon dialog.
14
 
 
15
 
@item pixmap-subdir
16
 
Directory that will be searched for icons.
17
 
 
18
 
@item filename
19
 
Filename that should be displayed in the icon entry.
20
 
 
21
 
@item pick-dialog
22
 
Icon picker dialog. You can use this property to get the GtkDialog if you need
23
 
to modify or query any of its properties.
24
 
 
25
 
@end table
26
 
 
27
 
@end deftp
28
 
 
29
 
@defop Signal <gnome-icon-entry> changed 
30
 
@end defop
31
 
 
32
 
@defop Signal <gnome-icon-entry> browse 
33
 
@end defop
34
 
 
35
 
@deffn Function gnome-icon-entry-new  (history_id@tie{}@code{mchars}) (browse_dialog_title@tie{}@code{mchars}) @result{}@tie{} (ret@tie{}@code{<gtk-widget>})
36
 
Creates a new icon entry widget
37
 
 
38
 
@table @var
39
 
@item history-id
40
 
the id given to @code{<gnome-entry-new>}
41
 
 
42
 
@item browse-dialog-title
43
 
title of the browse dialog and icon selection dialog
44
 
 
45
 
@item ret
46
 
Returns the new object
47
 
 
48
 
@end table
49
 
 
50
 
@end deffn
51
 
 
52
 
@deffn Function gnome-icon-entry-construct  (self@tie{}@code{<gnome-icon-entry>}) (history_id@tie{}@code{mchars}) (browse_dialog_title@tie{}@code{mchars})
53
 
@deffnx Method construct
54
 
For language bindings and subclassing, from C use @code{<gnome-icon-entry-new>}
55
 
 
56
 
@table @var
57
 
@item ientry
58
 
the GnomeIconEntry to work with
59
 
 
60
 
@item history-id
61
 
the id given to @code{<gnome-entry-new>} in the browse dialog
62
 
 
63
 
@item browse-dialog-title
64
 
title of the icon selection dialog
65
 
 
66
 
@end table
67
 
 
68
 
@end deffn
69
 
 
70
 
@deffn Function gnome-icon-entry-set-pixmap-subdir  (self@tie{}@code{<gnome-icon-entry>}) (subdir@tie{}@code{mchars})
71
 
@deffnx Method set-pixmap-subdir
72
 
Sets the subdirectory below gnome's default pixmap directory to use as the
73
 
default path for the file entry. The path can also be an absolute one. If
74
 
@samp{@code{#f}} is passed then the pixmap directory itself is used.
75
 
 
76
 
@table @var
77
 
@item ientry
78
 
the GnomeIconEntry to work with
79
 
 
80
 
@item subdir
81
 
subdirectory
82
 
 
83
 
@end table
84
 
 
85
 
@end deffn
86
 
 
87
 
@deffn Function gnome-icon-entry-get-filename  (self@tie{}@code{<gnome-icon-entry>}) @result{}@tie{} (ret@tie{}@code{mchars})
88
 
@deffnx Method get-filename
89
 
Gets the file name of the image if it was possible to load it into the preview.
90
 
That is, it will only return a filename if the image exists and it was possible
91
 
to load it as an image.
92
 
 
93
 
@table @var
94
 
@item ientry
95
 
the GnomeIconEntry to work with
96
 
 
97
 
@item ret
98
 
a newly allocated string with the path or @samp{@code{#f}} if it couldn't load
99
 
the file
100
 
 
101
 
@end table
102
 
 
103
 
@end deffn
104
 
 
105
 
@deffn Function gnome-icon-entry-set-filename  (self@tie{}@code{<gnome-icon-entry>}) (filename@tie{}@code{mchars}) @result{}@tie{} (ret@tie{}@code{bool})
106
 
@deffnx Method set-filename
107
 
Sets the icon of GnomeIconEntry to be the one pointed to by @var{filename} (in
108
 
the current subdirectory).
109
 
 
110
 
@table @var
111
 
@item ientry
112
 
the GnomeIconEntry to work with
113
 
 
114
 
@item filename
115
 
a filename
116
 
 
117
 
@item ret
118
 
@samp{@code{#t}} if icon was loaded ok, @samp{@code{#f}} otherwise
119
 
 
120
 
@end table
121
 
 
122
 
@end deffn
123
 
 
124
 
@deffn Function gnome-icon-entry-set-history-id  (self@tie{}@code{<gnome-icon-entry>}) (history_id@tie{}@code{mchars})
125
 
@deffnx Method set-history-id
126
 
Set the history_id of the entry in the browse dialog and reload the history
127
 
 
128
 
@table @var
129
 
@item ientry
130
 
the GnomeIconEntry to work with
131
 
 
132
 
@item history-id
133
 
the id given to @code{<gnome-entry-new>} in the browse dialog
134
 
 
135
 
@end table
136
 
 
137
 
@end deffn
138
 
 
139
 
@deffn Function gnome-icon-entry-set-max-saved  (self@tie{}@code{<gnome-icon-entry>}) (max_saved@tie{}@code{unsigned-int})
140
 
@deffnx Method set-max-saved
141
 
Set the max_saved of the entry in the browse dialog
142
 
 
143
 
@table @var
144
 
@item ientry
145
 
the GnomeIconEntry to work with
146
 
 
147
 
@item max-saved
148
 
the maximum number of saved entries
149
 
 
150
 
@end table
151
 
 
152
 
Since 2.4
153
 
 
154
 
@end deffn
155
 
 
156
 
@deffn Function gnome-icon-entry-pick-dialog  (self@tie{}@code{<gnome-icon-entry>}) @result{}@tie{} (ret@tie{}@code{<gtk-widget>})
157
 
@deffnx Method pick-dialog
158
 
If a pick dialog exists, return a pointer to it or return NULL. This is if you
159
 
need to do something with all dialogs. You would use the browse signal with
160
 
connect_after to get the pick dialog when it is displayed.
161
 
 
162
 
@table @var
163
 
@item ientry
164
 
the GnomeIconEntry to work with
165
 
 
166
 
@item ret
167
 
The pick dialog or @samp{@code{#f}} if none exists
168
 
 
169
 
@end table
170
 
 
171
 
@end deffn
172
 
 
173
 
@deffn Function gnome-icon-entry-set-icon  (self@tie{}@code{<gnome-icon-entry>}) (filename@tie{}@code{mchars})
174
 
@deffnx Method set-icon
175
 
Deprecated in favour of @code{<gnome-icon-entry-set-filename>}
176
 
 
177
 
@table @var
178
 
@item ientry
179
 
the GnomeIconEntry to work with
180
 
 
181
 
@item filename
182
 
a filename
183
 
 
184
 
@end table
185
 
 
186
 
@end deffn
187
 
 
188
 
@deffn Function gnome-icon-entry-gnome-file-entry  (self@tie{}@code{<gnome-icon-entry>}) @result{}@tie{} (ret@tie{}@code{<gtk-widget>})
189
 
@deffnx Method gnome-file-entry
190
 
Get the GnomeFileEntry widget that's part of the entry DEPRECATED! Use the
191
 
"changed" signal for getting changes
192
 
 
193
 
@table @var
194
 
@item ientry
195
 
the GnomeIconEntry to work with
196
 
 
197
 
@item ret
198
 
Returns GnomeFileEntry widget
199
 
 
200
 
@end table
201
 
 
202
 
@end deffn
203
 
 
204
 
@deffn Function gnome-icon-entry-gnome-entry  (self@tie{}@code{<gnome-icon-entry>}) @result{}@tie{} (ret@tie{}@code{<gtk-widget>})
205
 
@deffnx Method gnome-entry
206
 
Get the GnomeEntry widget that's part of the entry DEPRECATED! Use the "changed"
207
 
signal for getting changes
208
 
 
209
 
@table @var
210
 
@item ientry
211
 
the GnomeIconEntry to work with
212
 
 
213
 
@item ret
214
 
Returns GnomeEntry widget
215
 
 
216
 
@end table
217
 
 
218
 
@end deffn
219
 
 
220
 
@deffn Function gnome-icon-entry-gtk-entry  (self@tie{}@code{<gnome-icon-entry>}) @result{}@tie{} (ret@tie{}@code{<gtk-widget>})
221
 
@deffnx Method gtk-entry
222
 
Get the GtkEntry widget that's part of the entry. DEPRECATED! Use the "changed"
223
 
signal for getting changes
224
 
 
225
 
@table @var
226
 
@item ientry
227
 
the GnomeIconEntry to work with
228
 
 
229
 
@item ret
230
 
Returns GtkEntry widget
231
 
 
232
 
@end table
233
 
 
234
 
@end deffn
235
 
 
236
 
 
237
 
@c %end of fragment