Bug 549835 – Feature Request: Configurable cursor appearance

2008-10-14  Behdad Esfahbod  <behdad@gnome.org>

        Bug 549835 – Feature Request: Configurable cursor appearance

        * src/vte.h:
        New public api:

                VteTerminalCursorShape
                vte_terminal_set_cursor_shape
                vte_terminal_get_cursor_shape

        * src/vte-private.h:
        * src/vte.c (_vte_terminal_insert_char), (vte_terminal_init),
        (vte_terminal_paint_cursor), (vte_terminal_paint),
        (vte_terminal_set_cursor_shape), (vte_terminal_get_cursor_shape):
        Implement new API.  Also clean up cursor drawing in general.

        * doc/reference/Makefile.am:
        * doc/reference/tmpl/reaper.sgml:
        * doc/reference/tmpl/vte-unused.sgml:
        * doc/reference/tmpl/vte.sgml:
        * doc/reference/vte-sections.txt:
        Doc new symbols.  Also add some missing docs.


svn path=/trunk/; revision=2116

5 files changed, 101 insertions, 33 deletions

diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index 6242fd6..db4aa07 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -6,6 +6,9 @@ DOC_MODULE=vte
 # The top-level SGML file.
 DOC_MAIN_SGML_FILE=vte-docs.sgml
 
+# Extra options to supply to gtkdoc-scan
+SCAN_OPTIONS=--deprecated-guards="VTE_DISABLE_DEPRECATED"
+
 # The directory containing the source code. Relative to $(srcdir)
 DOC_SOURCE_DIR=../../src
 
diff --git a/doc/reference/tmpl/reaper.sgml b/doc/reference/tmpl/reaper.sgml
index 4c80438..92ed24c 100644
--- a/doc/reference/tmpl/reaper.sgml
+++ b/doc/reference/tmpl/reaper.sgml
@@ -23,35 +23,3 @@ a proxy for glib's own functionality.
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### STRUCT VteReaper ##### -->
-<para>
-This should not be accessed directly.
-</para>
-
-
-<!-- ##### 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().
-
-<!-- ##### FUNCTION vte_reaper_get ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### FUNCTION vte_reaper_add_child ##### -->
-<para>
-
-</para>
-
-@pid: 
-@Returns: 
-
-
diff --git a/doc/reference/tmpl/vte-unused.sgml b/doc/reference/tmpl/vte-unused.sgml
index 3198646..5938ed9 100644
--- a/doc/reference/tmpl/vte-unused.sgml
+++ b/doc/reference/tmpl/vte-unused.sgml
@@ -172,6 +172,21 @@ VteBg
 @VTE_DEBUG_KEYBOARD: 
 @VTE_DEBUG_LIFECYCLE: 
 
+<!-- ##### STRUCT VteReaper ##### -->
+<para>
+This should not be accessed directly.
+</para>
+
+
+<!-- ##### 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().
+
 <!-- ##### STRUCT VteReaperClass ##### -->
 <para>
 
@@ -333,6 +348,21 @@ VteBg
 @rows: 
 @Returns: 
 
+<!-- ##### FUNCTION vte_reaper_add_child ##### -->
+<para>
+
+</para>
+
+@pid: 
+@Returns: 
+
+<!-- ##### FUNCTION vte_reaper_get ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
 <!-- ##### FUNCTION vte_ring_append ##### -->
 <para>
 
diff --git a/doc/reference/tmpl/vte.sgml b/doc/reference/tmpl/vte.sgml
index 27fb427..97556bb 100644
--- a/doc/reference/tmpl/vte.sgml
+++ b/doc/reference/tmpl/vte.sgml
@@ -35,7 +35,7 @@ All of these fields should be considered read-only.
 
 <!-- ##### SIGNAL VteTerminal::beep ##### -->
 <para>
-
+This signal is emitted when the a child sends a beep request to the terminal.
 </para>
 
 @vteterminal: the object which received the signal.
@@ -288,6 +288,27 @@ keys.
 @VTE_ERASE_ASCII_DELETE: Send an ASCII delete character (0x7F).
 @VTE_ERASE_DELETE_SEQUENCE: Send the "@@7" control sequence.
 
+<!-- ##### ENUM VteTerminalCursorShape ##### -->
+<para>
+An enumerated type which can be used to indicate what should the terminal
+draw at the cursor position.
+</para>
+
+@VTE_CURSOR_SHAPE_BLOCK: Draw a block cursor.  This is the default.
+@VTE_CURSOR_SHAPE_IBEAM: Draw a vertical bar on the left side of character.
+This is similar to the default cursor for other GTK+ widgets.
+@VTE_CURSOR_SHAPE_UNDERLINE: Draw a horizontal bar below the character.
+
+<!-- ##### ENUM VteTerminalCursorBlinkMode ##### -->
+<para>
+An enumerated type which can be used to indicate the cursor blink mode
+for the terminal.
+</para>
+
+@VTE_CURSOR_BLINK_SYSTEM: Follow GTK+ settings for cursor blinking.
+@VTE_CURSOR_BLINK_ON: Cursor blinks.
+@VTE_CURSOR_BLINK_OFF: Cursor does not blink.
+
 <!-- ##### FUNCTION vte_terminal_new ##### -->
 <para>
 </para>
@@ -341,6 +362,15 @@ keys.
 @pty_master: 
 
 
+<!-- ##### FUNCTION vte_terminal_get_pty ##### -->
+<para>
+
+</para>
+
+@terminal: 
+@Returns: 
+
+
 <!-- ##### FUNCTION vte_terminal_feed ##### -->
 <para>
 
@@ -371,6 +401,15 @@ keys.
 @length: 
 
 
+<!-- ##### FUNCTION vte_terminal_get_child_exit_status ##### -->
+<para>
+
+</para>
+
+@terminal: 
+@Returns: 
+
+
 <!-- ##### FUNCTION vte_terminal_select_all ##### -->
 <para>
 
@@ -638,6 +677,24 @@ keys.
 @scroll: 
 
 
+<!-- ##### FUNCTION vte_terminal_set_cursor_shape ##### -->
+<para>
+
+</para>
+
+@terminal: 
+@shape: 
+
+
+<!-- ##### FUNCTION vte_terminal_get_cursor_shape ##### -->
+<para>
+
+</para>
+
+@terminal: 
+@Returns: 
+
+
 <!-- ##### FUNCTION vte_terminal_set_cursor_blinks ##### -->
 <para>
 
diff --git a/doc/reference/vte-sections.txt b/doc/reference/vte-sections.txt
index 70c8fc9..90ce512 100644
--- a/doc/reference/vte-sections.txt
+++ b/doc/reference/vte-sections.txt
@@ -3,14 +3,18 @@
 <TITLE>VteTerminal</TITLE>
 VteTerminal
 VteTerminalEraseBinding
+VteTerminalCursorShape
+VteTerminalCursorBlinkMode
 vte_terminal_new
 vte_terminal_im_append_menuitems
 vte_terminal_fork_command
 vte_terminal_forkpty
 vte_terminal_set_pty
+vte_terminal_get_pty
 vte_terminal_feed
 vte_terminal_feed_child
 vte_terminal_feed_child_binary
+vte_terminal_get_child_exit_status
 vte_terminal_select_all
 vte_terminal_select_none
 vte_terminal_copy_clipboard
@@ -41,6 +45,8 @@ vte_terminal_set_background_saturation
 vte_terminal_set_background_transparent
 vte_terminal_set_background_tint_color
 vte_terminal_set_scroll_background
+vte_terminal_set_cursor_shape
+vte_terminal_get_cursor_shape
 vte_terminal_set_cursor_blinks
 vte_terminal_get_cursor_blink_mode
 vte_terminal_set_cursor_blink_mode
@@ -79,6 +85,10 @@ vte_terminal_get_encoding
 vte_terminal_get_status_line
 vte_terminal_get_padding
 <SUBSECTION Standard>
+vte_terminal_cursor_blink_mode_get_type
+vte_terminal_cursor_shape_get_type
+VTE_TYPE_TERMINAL_CURSOR_BLINK_MODE
+VTE_TYPE_TERMINAL_CURSOR_SHAPE
 vte_terminal_erase_binding_get_type
 VTE_TYPE_TERMINAL_ERASE_BINDING
 VTE_IS_TERMINAL_ERASE_BINDING