← Back to branch summary

~andywingo/guile-gnome/libgnomeui

« back to all changes in this revision

Viewing changes to doc/defuns-gnome-appbar.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-appbar.xml.texi
1
1
 
2
2
@c %start of fragment
3
3
 
4
 
@deftp Class <gnome-app-bar>
5
 
This @code{<gobject>} class defines the following properties:
6
 
 
7
 
@table @code
8
 
@item has-progress
9
 
Create a progress widget.
10
 
 
11
 
@item has-status
12
 
Create a status widget.
13
 
 
14
 
@item interactivity
15
 
Level of user activity required.
16
 
 
17
 
@end table
18
 
 
19
 
@end deftp
20
 
 
21
 
@defop Signal <gnome-app-bar> user-response 
22
 
@end defop
23
 
 
24
 
@defop Signal <gnome-app-bar> clear-prompt 
25
 
@end defop
26
 
 
27
 
@deffn Function gnome-appbar-new  (has_progress@tie{}@code{bool}) (has_status@tie{}@code{bool}) (interactivity@tie{}@code{<gnome-preferences-type>}) @result{}@tie{} (ret@tie{}@code{<gtk-widget>})
28
 
Create a new GNOME application status bar. If @var{has-progress} is
29
 
@samp{@code{#t}}, a small progress bar widget will be created, and placed on the
30
 
left side of the appbar. If @var{has-status} is @samp{@code{#t}}, a status bar,
31
 
possibly an editable one, is created.
32
 
 
33
 
The @var{interactivity} parameter determines whether the appbar is an
34
 
interactive "minibuffer" or just a status bar. If it is set to
35
 
@code{<gnome-preferences-never>}, it is never interactive. If it is set to
36
 
@code{<gnome-preferences-user>} we respect user preferences from ui-properties.
37
 
If it's @code{<gnome-preferences-always>} we are interactive whether the user
38
 
likes it or not. Basically, if your app supports both interactive and not (for
39
 
example, if you use the gnome-app-util interfaces), you should use
40
 
@code{<gnome-preferences-user>}. Otherwise, use the setting you support. Please
41
 
note that "interactive" mode is not functional now; GtkEntry is inadequate and
42
 
so a custom widget will be written eventually.
43
 
 
44
 
@table @var
45
 
@item has-progress
46
 
@samp{@code{#t}} if appbar needs progress bar widget, @samp{@code{#f}} if not.
47
 
 
48
 
@item has-status
49
 
@samp{@code{#t}} if appbar needs status bar widget, @samp{@code{#f}} if not.
50
 
 
51
 
@item interactivity
52
 
Level of user activity required.
53
 
 
54
 
@item ret
55
 
Pointer to new @code{<gnome-app-bar>} widget.
56
 
 
57
 
@end table
58
 
 
59
 
@end deffn
60
 
 
61
 
@deffn Function gnome-appbar-set-status  (self@tie{}@code{<gnome-app-bar>}) (status@tie{}@code{mchars})
62
 
Sets the status label without changing widget state; next call to
63
 
@code{gnome-appbar-set-status} or @code{gnome-appbar-push} will destroy this
64
 
permanently.
65
 
 
66
 
@table @var
67
 
@item appbar
68
 
A @code{<gnome-app-bar>} instance.
69
 
 
70
 
@item status
71
 
Text to which status label will be set.
72
 
 
73
 
@end table
74
 
 
75
 
@end deffn
76
 
 
77
 
@deffn Function gnome-appbar-get-status  (self@tie{}@code{<gnome-app-bar>}) @result{}@tie{} (ret@tie{}@code{<gtk-widget>})
78
 
Retrieves the statusbar widget.
79
 
 
80
 
@table @var
81
 
@item appbar
82
 
A @code{<gnome-app-bar>} instance.
83
 
 
84
 
@item ret
85
 
A pointer to the statusbar widget.
86
 
 
87
 
@end table
88
 
 
89
 
@end deffn
90
 
 
91
 
@deffn Function gnome-appbar-set-default  (self@tie{}@code{<gnome-app-bar>}) (default_status@tie{}@code{mchars})
92
 
What to show when showing nothing else is on the stack; defaults to the empty
93
 
string.
94
 
 
95
 
@table @var
96
 
@item appbar
97
 
A @code{<gnome-app-bar>} instance.
98
 
 
99
 
@item default-status
100
 
Text for status label.
101
 
 
102
 
@end table
103
 
 
104
 
@end deffn
105
 
 
106
 
@deffn Function gnome-appbar-push  (self@tie{}@code{<gnome-app-bar>}) (status@tie{}@code{mchars})
107
 
Push a new status message onto the status bar stack and display it.
108
 
 
109
 
@table @var
110
 
@item appbar
111
 
A @code{<gnome-app-bar>} instance.
112
 
 
113
 
@item status
114
 
Text of status message.
115
 
 
116
 
@end table
117
 
 
118
 
@end deffn
119
 
 
120
 
@deffn Function gnome-appbar-pop  (self@tie{}@code{<gnome-app-bar>})
121
 
Remove current status message, and display previous status message, if any. It
122
 
is fine to call this with an empty stack.
123
 
 
124
 
@table @var
125
 
@item appbar
126
 
A @code{<gnome-app-bar>} instance.
127
 
 
128
 
@end table
129
 
 
130
 
@end deffn
131
 
 
132
 
@deffn Function gnome-appbar-clear-stack  (self@tie{}@code{<gnome-app-bar>})
133
 
Remove all status messages from @var{appbar}, and display default status message
134
 
(if present).
135
 
 
136
 
@table @var
137
 
@item appbar
138
 
A @code{<gnome-app-bar>} instance.
139
 
 
140
 
@end table
141
 
 
142
 
@end deffn
143
 
 
144
 
@deffn Function gnome-appbar-get-progress  (self@tie{}@code{<gnome-app-bar>}) @result{}@tie{} (ret@tie{}@code{<gtk-progress-bar>})
145
 
Retrieves the progress bar widget for further manipulation.
146
 
 
147
 
@table @var
148
 
@item appbar
149
 
A @code{<gnome-app-bar>} instance.
150
 
 
151
 
@item ret
152
 
A @code{<gtk-progress-bar>} widget which is @var{appbar}'s progress bar, or
153
 
@samp{@code{#f}} if @var{appbar} has no progress bar.
154
 
 
155
 
@end table
156
 
 
157
 
@end deffn
158
 
 
159
 
@deffn Function gnome-appbar-refresh  (self@tie{}@code{<gnome-app-bar>})
160
 
Refresh the status message bar by redrawing the item on the top of the stack, or
161
 
the default value if the stack is empty.. Useful to force the message from a
162
 
previous call to @code{gnome-appbar-set-status} to disappear.
163
 
 
164
 
@table @var
165
 
@item appbar
166
 
A @code{<gnome-app-bar>} instance.
167
 
 
168
 
@end table
169
 
 
170
 
@end deffn
171
 
 
172
 
@deffn Function gnome-appbar-set-prompt  (self@tie{}@code{<gnome-app-bar>}) (prompt@tie{}@code{mchars}) (modal@tie{}@code{bool})
173
 
Put a prompt in the appbar and wait for a response. When the user responds or
174
 
cancels, a 'user_response' signal is emitted.
175
 
 
176
 
@table @var
177
 
@item appbar
178
 
A @code{<gnome-app-bar>} instance.
179
 
 
180
 
@item prompt
181
 
Text of the prompt message.
182
 
 
183
 
@item modal
184
 
If @samp{@code{#t}}, grabs input.
185
 
 
186
 
@end table
187
 
 
188
 
@end deffn
189
 
 
190
 
@deffn Function gnome-appbar-clear-prompt  (self@tie{}@code{<gnome-app-bar>})
191
 
Remove any prompt from the status message bar.
192
 
 
193
 
@table @var
194
 
@item appbar
195
 
A @code{<gnome-app-bar>} instance.
196
 
 
197
 
@end table
198
 
 
199
 
@end deffn
200
 
 
201
 
@deffn Function gnome-appbar-get-response  (self@tie{}@code{<gnome-app-bar>}) @result{}@tie{} (ret@tie{}@code{mchars})
202
 
Get the response to the prompt, if any.
203
 
 
204
 
@table @var
205
 
@item appbar
206
 
A @code{<gnome-app-bar>} instance.
207
 
 
208
 
@item ret
209
 
Text from @var{appbar} entry widget, as entered by user. This string should be
210
 
freed by the caller (using @code{gfree}) when no longer required.
211
 
 
212
 
@end table
213
 
 
214
 
@end deffn
215
 
 
216
4
 
217
5
@c %end of fragment