From f90bdb33c85d596e0396fdf9cd88878a600bc5eb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Javier=20Jard=C3=B3n?= Date: Sat, 6 Nov 2010 02:41:09 +0100 Subject: [PATCH] docs: Move documentation to inline comments: GtkTextView --- docs/reference/gtk/tmpl/.gitignore | 1 + docs/reference/gtk/tmpl/gtktextview.sgml | 883 ----------------------- gtk/gtktextchild.h | 12 +- gtk/gtktextview.c | 12 + gtk/gtktextview.h | 6 + 5 files changed, 26 insertions(+), 888 deletions(-) delete mode 100644 docs/reference/gtk/tmpl/gtktextview.sgml diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore index 59036d9fa2..4c4c615f90 100644 --- a/docs/reference/gtk/tmpl/.gitignore +++ b/docs/reference/gtk/tmpl/.gitignore @@ -48,6 +48,7 @@ gtkstyle.sgml gtktesting.sgml gtktextiter.sgml gtktexttagtable.sgml +gtktextview.sgml gtktoggleaction.sgml gtktoolbar.sgml gtktoolitem.sgml diff --git a/docs/reference/gtk/tmpl/gtktextview.sgml b/docs/reference/gtk/tmpl/gtktextview.sgml deleted file mode 100644 index 68a3c312a7..0000000000 --- a/docs/reference/gtk/tmpl/gtktextview.sgml +++ /dev/null @@ -1,883 +0,0 @@ - -GtkTextView - - -Widget that displays a GtkTextBuffer - - - -You may wish to begin by reading the text widget -conceptual overview which gives an overview of all the objects and data -types related to the text widget and how they work together. - - - - - - - - -#GtkTextBuffer, #GtkTextIter - - - - - - - - - - - - - - - - - - - -@textview: the object which received the signal. - - - - - - -@textview: the object which received the signal. - - - - - - -@textview: the object which received the signal. - - - - - - -@textview: the object which received the signal. -@arg1: -@arg2: - - - - - - -@textview: the object which received the signal. -@arg1: - - - - - - -@textview: the object which received the signal. -@arg1: -@arg2: -@arg3: - - - - - - -@textview: the object which received the signal. -@arg1: -@arg2: - - - - - - -@textview: the object which received the signal. - - - - - - -@textview: the object which received the signal. -@arg1: - - - - - - -@textview: the object which received the signal. -@arg1: - - - - - - -@textview: the object which received the signal. -@arg1: - - - - - - -@textview: the object which received the signal. - - - - - - -@textview: the object which received the signal. -@arg1: -@arg2: - - - - - - -@textview: the object which received the signal. - - - - - - -@textview: the object which received the signal. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@GTK_TEXT_WINDOW_PRIVATE: -@GTK_TEXT_WINDOW_WIDGET: -@GTK_TEXT_WINDOW_TEXT: -@GTK_TEXT_WINDOW_LEFT: -@GTK_TEXT_WINDOW_RIGHT: -@GTK_TEXT_WINDOW_TOP: -@GTK_TEXT_WINDOW_BOTTOM: - - - - - - -@void: -@Returns: - - - - - - - -@buffer: -@Returns: - - - - - - - -@text_view: -@buffer: - - - - - - - -@text_view: -@Returns: - - - - - - - -@text_view: -@Returns: - - - - - - - -@text_view: -@Returns: - - - - - - - -@text_view: -@mark: -@within_margin: -@use_align: -@xalign: -@yalign: - - - - - - - -@text_view: -@iter: -@within_margin: -@use_align: -@xalign: -@yalign: -@Returns: - - - - - - - -@text_view: -@mark: - - - - - - - -@text_view: -@mark: -@Returns: - - - - - - - -@text_view: -@Returns: - - - - - - - -@text_view: -@visible_rect: - - - - - - - -@text_view: -@iter: -@location: - - - - - - - -@text_view: -@target_iter: -@y: -@line_top: - - - - - - - -@text_view: -@iter: -@y: -@height: - - - - - - - -@text_view: -@iter: -@x: -@y: - - - - - - - -@text_view: -@iter: -@trailing: -@x: -@y: - - - - - - - -@text_view: -@win: -@buffer_x: -@buffer_y: -@window_x: -@window_y: - - - - - - - -@text_view: -@win: -@window_x: -@window_y: -@buffer_x: -@buffer_y: - - - - - - - -@text_view: -@win: -@Returns: - - - - - - - -@text_view: -@window: -@Returns: - - - - - - - -@text_view: -@type: -@size: - - - - - - - -@text_view: -@type: -@Returns: - - - - - - - -@text_view: -@iter: -@Returns: - - - - - - - -@text_view: -@iter: -@Returns: - - - - - - - -@text_view: -@iter: -@Returns: - - - - - - - -@text_view: -@iter: -@Returns: - - - - - - - -@text_view: -@iter: -@Returns: - - - - - - - -@text_view: -@iter: -@count: -@Returns: - - - - - - - -@text_view: -@child: -@anchor: - - - - -A GtkTextChildAnchor is a spot in the buffer -where child widgets can be "anchored" (inserted inline, as if they were -characters). The anchor can have multiple widgets anchored, to allow for -multiple views. - - - - - - - - -@void: -@Returns: - - - - - - - -@anchor: -@Returns: - - - - - - - -@anchor: -@Returns: - - - - - - - -@text_view: -@child: -@which_window: -@xpos: -@ypos: - - - - - - - -@text_view: -@child: -@xpos: -@ypos: - - - - - - - -@text_view: -@wrap_mode: - - - - - - - -@text_view: -@Returns: - - - - - - - -@text_view: -@setting: - - - - - - - -@text_view: -@Returns: - - - - - - - -@text_view: -@setting: - - - - - - - -@text_view: -@Returns: - - - - - - - -@text_view: -@overwrite: - - - - - - - -@text_view: -@Returns: - - - - - - - -@text_view: -@pixels_above_lines: - - - - - - - -@text_view: -@Returns: - - - - - - - -@text_view: -@pixels_below_lines: - - - - - - - -@text_view: -@Returns: - - - - - - - -@text_view: -@pixels_inside_wrap: - - - - - - - -@text_view: -@Returns: - - - - - - - -@text_view: -@justification: - - - - - - - -@text_view: -@Returns: - - - - - - - -@text_view: -@left_margin: - - - - - - - -@text_view: -@Returns: - - - - - - - -@text_view: -@right_margin: - - - - - - - -@text_view: -@Returns: - - - - - - - -@text_view: -@indent: - - - - - - - -@text_view: -@Returns: - - - - - - - -@text_view: -@tabs: - - - - - - - -@text_view: -@Returns: - - - - - - - -@text_view: -@accepts_tab: - - - - - - - -@text_view: -@Returns: - - - - - - - -@text_view: -@Returns: - - - - - - - -@text_view: -@event: -@Returns: - - - - - - - -@text_view: - - - - -The priority at which the text view validates onscreen lines -in an idle job in the background. - - - - diff --git a/gtk/gtktextchild.h b/gtk/gtktextchild.h index 7835e68f91..dd132f4278 100644 --- a/gtk/gtktextchild.h +++ b/gtk/gtktextchild.h @@ -36,12 +36,14 @@ G_BEGIN_DECLS -/* A GtkTextChildAnchor is a spot in the buffer where child widgets - * can be "anchored" (inserted inline, as if they were characters). - * The anchor can have multiple widgets anchored, to allow for multiple - * views. - */ +/** + * GtkTextChildAnchor: + * + * A #GtkTextChildAnchor is a spot in the buffer where child widgets can + * be "anchored" (inserted inline, as if they were characters). The anchor + * can have multiple widgets anchored, to allow for multiple views. + */ typedef struct _GtkTextChildAnchor GtkTextChildAnchor; typedef struct _GtkTextChildAnchorClass GtkTextChildAnchorClass; diff --git a/gtk/gtktextview.c b/gtk/gtktextview.c index 4e6d37218f..de6619d86e 100644 --- a/gtk/gtktextview.c +++ b/gtk/gtktextview.c @@ -52,6 +52,18 @@ #include "gtkscrollable.h" +/** + * SECTION:gtktextview + * @Short_description: Widget that displays a GtkTextBuffer + * @Title: GtkTextView + * @See_also: #GtkTextBuffer, #GtkTextIter + * + * You may wish to begin by reading the text widget + * conceptual overview which gives an overview of all the objects and data + * types related to the text widget and how they work together. + */ + + /* How scrolling, validation, exposes, etc. work. * * The expose_event handler has the invariant that the onscreen lines diff --git a/gtk/gtktextview.h b/gtk/gtktextview.h index 4e64b33e15..2853c63962 100644 --- a/gtk/gtktextview.h +++ b/gtk/gtktextview.h @@ -56,6 +56,12 @@ typedef enum GTK_TEXT_WINDOW_BOTTOM } GtkTextWindowType; +/** + * GTK_TEXT_VIEW_PRIORITY_VALIDATE: + * + * The priority at which the text view validates onscreen lines + * in an idle job in the background. + */ #define GTK_TEXT_VIEW_PRIORITY_VALIDATE (GDK_PRIORITY_REDRAW + 5) typedef struct _GtkTextView GtkTextView;