← Back to branch summary

~andywingo/guile-gnome/libgnomeui

« back to all changes in this revision

Viewing changes to doc/defuns-gnome-client.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-client.xml.texi
2
2
@c %start of fragment
3
3
 
4
4
@deftp Class <gnome-client>
5
 
This @code{<gobject>} class defines no properties, other than those defined by
6
 
its superclasses.
 
5
Derives from @code{<gtk-object>}.
 
6
 
 
7
This class defines no properties, other than those defined by its superclasses.
7
8
 
8
9
@end deftp
9
10
 
83
84
 
84
85
@end deffn
85
86
 
86
 
@deffn Function gnome-client-module-info-get  @result{}@tie{} (ret@tie{}@code{<gnome-module-info*>})
87
 
@table @var
88
 
@item ret
89
 
 
90
 
 
91
 
@end table
92
 
 
93
 
@end deffn
94
 
 
95
87
@deffn Function gnome-client-get-flags  (self@tie{}@code{<gnome-client>}) @result{}@tie{} (ret@tie{}@code{<gnome-client-flags>})
96
88
@deffnx Method get-flags
97
89
Determine the client's status with the session manager.,
445
437
 
446
438
@end deffn
447
439
 
448
 
@deffn Function gnome-client-request-interaction  (self@tie{}@code{<gnome-client>}) (dialog_type@tie{}@code{<gnome-dialog-type>}) (function@tie{}@code{<gnome-interact-function>}) (data@tie{}@code{<gpointer>})
449
 
@deffnx Method request-interaction
450
 
Use the following functions, if you want to interact with the user during a
451
 
"save_yourself" handler without being restricted to using the dialog based
452
 
commands @code{gnome-client-save-any-dialog} or
453
 
@code{gnome-client-save-error-dialog}. Note, however, that overriding the
454
 
session manager specified preference in this way (by using arbitrary dialog
455
 
boxes) is not very nice.
456
 
 
457
 
If and when the session manager decides that it's the app's turn to interact
458
 
then 'func' will be called with the specified arguments and a unique
459
 
'GnomeInteractionKey'. The session manager will block other clients from
460
 
interacting until this key is returned with @code{gnome-interaction-key-return}.
461
 
 
462
 
@table @var
463
 
@item client
464
 
A @code{<gnome-client>} object.
465
 
 
466
 
@item dialog-type
467
 
The type of dialog to create.
468
 
 
469
 
@item function
470
 
Callback to invoke to perform the interaction.
471
 
 
472
 
@item data
473
 
Callback data.
474
 
 
475
 
@end table
476
 
 
477
 
@end deffn
478
 
 
479
 
@deffn Function gnome-interaction-key-return  (key@tie{}@code{int}) (cancel_shutdown@tie{}@code{bool})
480
 
Used in interaction callback to tell the session manager you are done
481
 
interacting.
482
 
 
483
 
@table @var
484
 
@item key
485
 
Key passed to interaction callback
486
 
 
487
 
@item cancel-shutdown
488
 
If @samp{@code{#t}}, cancel the shutdown
489
 
 
490
 
@end table
491
 
 
492
 
@end deffn
493
 
 
494
440
 
495
441
@c %end of fragment