summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNalin Dahyabhai <nalin@src.gnome.org>2004-04-20 06:35:43 +0000
committerNalin Dahyabhai <nalin@src.gnome.org>2004-04-20 06:35:43 +0000
commitbc403a3836f9eb2caadb40062c0f36d5b4f5d50f (patch)
treed60d2a0b4bb88b7cc6781714ac463383e6fed166 /doc
parentd7e1045596a8cb452d2649dee7b9638f5f50194b (diff)
downloadvte-bc403a3836f9eb2caadb40062c0f36d5b4f5d50f.tar.gz
document the child-exited signal. document the emulation-changed and
* doc/reference/tmpl/reaper.sgml: document the child-exited signal. * doc/reference/tmpl/vte.sgml: document the emulation-changed and encoding-changed signals. One hundred percent*. ONE HUNDRED PERCENT* I TELL YOU! * Except for the unused bits.
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/tmpl/reaper.sgml4
-rw-r--r--doc/reference/tmpl/vte-unused.sgml157
-rw-r--r--doc/reference/tmpl/vte.sgml7
3 files changed, 164 insertions, 4 deletions
diff --git a/doc/reference/tmpl/reaper.sgml b/doc/reference/tmpl/reaper.sgml
index 20bee6df..c37681b5 100644
--- a/doc/reference/tmpl/reaper.sgml
+++ b/doc/reference/tmpl/reaper.sgml
@@ -26,12 +26,12 @@ This should not be accessed directly.
<!-- ##### SIGNAL VteReaper::child-exited ##### -->
<para>
-
+Emitted when the #VteReaper object detects that a child of the current process has exited.
</para>
@vtereaper: the object which received the signal.
@arg1: the process ID of the exited child.
-@arg2: the status of the exited child, as returned by #waitpid.
+@arg2: the status of the exited child, as returned by waitpid().
<!-- ##### FUNCTION vte_reaper_get ##### -->
<para>
diff --git a/doc/reference/tmpl/vte-unused.sgml b/doc/reference/tmpl/vte-unused.sgml
index 1b7584fb..6497a22b 100644
--- a/doc/reference/tmpl/vte-unused.sgml
+++ b/doc/reference/tmpl/vte-unused.sgml
@@ -40,6 +40,68 @@ pty
reaper.sgml
+<!-- ##### SECTION ./tmpl/vtebg.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/vtebg.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/vtebg.sgml:Short_Description ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/vtebg.sgml:Title ##### -->
+VteBg
+
+
+<!-- ##### MACRO VTE_BG ##### -->
+<para>
+
+</para>
+
+@obj:
+
+<!-- ##### MACRO VTE_BGWATCHER ##### -->
+<para>
+
+</para>
+
+@obj:
+
+<!-- ##### MACRO VTE_BGWATCHER_CLASS ##### -->
+<para>
+
+</para>
+
+@klass:
+
+<!-- ##### MACRO VTE_BGWATCHER_GET_CLASS ##### -->
+<para>
+
+</para>
+
+@obj:
+
+<!-- ##### MACRO VTE_BG_CLASS ##### -->
+<para>
+
+</para>
+
+@klass:
+
+<!-- ##### MACRO VTE_BG_GET_CLASS ##### -->
+<para>
+
+</para>
+
+@obj:
+
<!-- ##### MACRO VTE_META_MASK ##### -->
<para>
@@ -52,6 +114,41 @@ reaper.sgml
</para>
+<!-- ##### STRUCT VteBg ##### -->
+<para>
+
+</para>
+
+@parent:
+@root_pixmap:
+@native:
+@pvt:
+
+<!-- ##### STRUCT VteBgClass ##### -->
+<para>
+
+</para>
+
+@parent_class:
+@root_pixmap_changed:
+
+<!-- ##### STRUCT VteBgWatcher ##### -->
+<para>
+
+</para>
+
+@object:
+@pixbuf:
+@pixmap:
+
+<!-- ##### STRUCT VteBgWatcherClass ##### -->
+<para>
+
+</para>
+
+@parent_class:
+@background_changed_signal:
+
<!-- ##### ENUM VteDebugFlags ##### -->
<para>
@@ -97,6 +194,66 @@ reaper.sgml
</para>
+<!-- ##### FUNCTION vte_bg_get ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+<!-- ##### FUNCTION vte_bg_get_pixbuf ##### -->
+<para>
+
+</para>
+
+@bg:
+@Returns:
+
+<!-- ##### FUNCTION vte_bg_get_pixmap ##### -->
+<para>
+
+</para>
+
+@bg:
+@Returns:
+
+<!-- ##### FUNCTION vte_bg_get_type ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+<!-- ##### FUNCTION vte_bg_watcher_get ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+<!-- ##### FUNCTION vte_bg_watcher_get_pixbuf ##### -->
+<para>
+
+</para>
+
+@watcher:
+@Returns:
+
+<!-- ##### FUNCTION vte_bg_watcher_get_pixmap ##### -->
+<para>
+
+</para>
+
+@watcher:
+@Returns:
+
+<!-- ##### FUNCTION vte_bg_watcher_get_type ##### -->
+<para>
+
+</para>
+
+@Returns:
+
<!-- ##### STRUCT vte_buffer ##### -->
<para>
diff --git a/doc/reference/tmpl/vte.sgml b/doc/reference/tmpl/vte.sgml
index 91231025..6e863071 100644
--- a/doc/reference/tmpl/vte.sgml
+++ b/doc/reference/tmpl/vte.sgml
@@ -91,14 +91,17 @@ Emitted at the child application's request.
<!-- ##### SIGNAL VteTerminal::emulation-changed ##### -->
<para>
-
+Emitted whenever the terminal's emulation changes, only possible at the
+parent application's request.
</para>
@vteterminal: the object which received the signal.
<!-- ##### SIGNAL VteTerminal::encoding-changed ##### -->
<para>
-
+Emitted whenever the terminal's current encoding has changed, either as a
+result of receiving a control sequence which toggled between the local and
+UTF-8 encodings, or at the parent application's request.
</para>
@vteterminal: the object which received the signal.