diff options
| -rw-r--r-- | docs/reference/gtk/tmpl/.gitignore | 1 | ||||
| -rw-r--r-- | docs/reference/gtk/tmpl/gtktexttag.sgml | 498 | ||||
| -rw-r--r-- | gtk/gtkenums.h | 13 | ||||
| -rw-r--r-- | gtk/gtktextattributes.h | 8 | ||||
| -rw-r--r-- | gtk/gtktexttag.c | 16 |
5 files changed, 37 insertions, 499 deletions
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore index 1cea81d52d..2d8d06735a 100644 --- a/docs/reference/gtk/tmpl/.gitignore +++ b/docs/reference/gtk/tmpl/.gitignore @@ -67,6 +67,7 @@ gtkstatusbar.sgml gtkstyle.sgml gtktesting.sgml gtktextiter.sgml +gtktexttag.sgml gtktexttagtable.sgml gtktextview.sgml gtktoggleaction.sgml diff --git a/docs/reference/gtk/tmpl/gtktexttag.sgml b/docs/reference/gtk/tmpl/gtktexttag.sgml deleted file mode 100644 index 85203a04d9..0000000000 --- a/docs/reference/gtk/tmpl/gtktexttag.sgml +++ /dev/null @@ -1,498 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GtkTextTag - -<!-- ##### SECTION Short_Description ##### --> -A tag that can be applied to text in a GtkTextBuffer - -<!-- ##### SECTION Long_Description ##### --> -<para> -You may wish to begin by reading the <link linkend="TextWidget">text widget -conceptual overview</link> which gives an overview of all the objects and data -types related to the text widget and how they work together. -</para> - -<para> -Tags should be in the #GtkTextTagTable for a given #GtkTextBuffer -before using them with that buffer. -</para> - -<para> -gtk_text_buffer_create_tag() is the best way to create tags. -See <application>gtk-demo</application> for numerous examples. -</para> - -<para> -The "invisible" property was not implemented for GTK+ 2.0. -It is working (with minor issues) since 2.8. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT GtkTextTag ##### --> -<para> - -</para> - - -<!-- ##### SIGNAL GtkTextTag::event ##### --> -<para> - -</para> - -@texttag: the object which received the signal. -@arg1: -@event: -@arg2: -@Returns: - -<!-- ##### ARG GtkTextTag:accumulative-margin ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:background ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:background-full-height ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:background-full-height-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:background-gdk ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:background-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:direction ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:editable ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:editable-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:family ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:family-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:font ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:font-desc ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:foreground ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:foreground-gdk ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:foreground-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:indent ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:indent-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:invisible ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:invisible-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:justification ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:justification-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:language ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:language-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:left-margin ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:left-margin-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:name ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:paragraph-background ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:paragraph-background-gdk ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:paragraph-background-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:pixels-above-lines ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:pixels-above-lines-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:pixels-below-lines ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:pixels-below-lines-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:pixels-inside-wrap ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:pixels-inside-wrap-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:right-margin ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:right-margin-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:rise ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:rise-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:scale ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:scale-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:size ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:size-points ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:size-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:stretch ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:stretch-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:strikethrough ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:strikethrough-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:style ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:style-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:tabs ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:tabs-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:underline ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:underline-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:variant ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:variant-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:weight ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:weight-set ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:wrap-mode ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:wrap-mode-set ##### --> -<para> - -</para> - -<!-- ##### ENUM GtkWrapMode ##### --> -<para> -Describes a type of line wrapping. -</para> - -@GTK_WRAP_NONE: do not wrap lines; just make the text area wider -@GTK_WRAP_CHAR: wrap text, breaking lines anywhere the cursor can - appear (between characters, usually - if you want to - be technical, between graphemes, see - pango_get_log_attrs()) -@GTK_WRAP_WORD: wrap text, breaking lines in between words -@GTK_WRAP_WORD_CHAR: wrap text, breaking lines in between words, or if - that is not enough, also between graphemes. - -<!-- ##### STRUCT GtkTextAttributes ##### --> -<para> -Using #GtkTextAttributes directly should rarely be necessary. It's -primarily useful with gtk_text_iter_get_attributes(). As with most -GTK+ structs, the fields in this struct should only be read, never -modified directly. -</para> - -@appearance: pointer to sub-struct containing certain attributes -@justification: -@direction: -@font: -@font_scale: -@left_margin: -@indent: -@right_margin: -@pixels_above_lines: -@pixels_below_lines: -@pixels_inside_wrap: -@tabs: -@wrap_mode: -@language: -@invisible: -@bg_full_height: -@editable: - -<!-- ##### FUNCTION gtk_text_tag_new ##### --> -<para> - -</para> - -@name: -@Returns: - - -<!-- ##### FUNCTION gtk_text_tag_get_priority ##### --> -<para> - -</para> - -@tag: -@Returns: - - -<!-- ##### FUNCTION gtk_text_tag_set_priority ##### --> -<para> - -</para> - -@tag: -@priority: - - -<!-- ##### FUNCTION gtk_text_tag_event ##### --> -<para> - -</para> - -@tag: -@event_object: -@event: -@iter: -@Returns: - - -<!-- ##### STRUCT GtkTextAppearance ##### --> -<para> - -</para> - -@bg_color: -@fg_color: -@rise: -@underline: -@strikethrough: -@draw_bg: -@inside_selection: -@is_text: - -<!-- ##### FUNCTION gtk_text_attributes_new ##### --> -<para> - -</para> - -@void: -@Returns: - - -<!-- ##### FUNCTION gtk_text_attributes_copy ##### --> -<para> - -</para> - -@src: -@Returns: - - -<!-- ##### FUNCTION gtk_text_attributes_copy_values ##### --> -<para> - -</para> - -@src: -@dest: - - -<!-- ##### FUNCTION gtk_text_attributes_unref ##### --> -<para> - -</para> - -@values: - - -<!-- ##### FUNCTION gtk_text_attributes_ref ##### --> -<para> - -</para> - -@values: -@Returns: - - diff --git a/gtk/gtkenums.h b/gtk/gtkenums.h index e62e43e107..78ea40c98d 100644 --- a/gtk/gtkenums.h +++ b/gtk/gtkenums.h @@ -619,7 +619,18 @@ typedef enum GTK_WINDOW_POPUP } GtkWindowType; -/* Text wrap */ +/** + * GtkWrapMode: + * @GTK_WRAP_NONE: do not wrap lines; just make the text area wider + * @GTK_WRAP_CHAR: wrap text, breaking lines anywhere the cursor can + * appear (between characters, usually - if you want to be technical, + * between graphemes, see pango_get_log_attrs()) + * @GTK_WRAP_WORD: wrap text, breaking lines in between words + * @GTK_WRAP_WORD_CHAR: wrap text, breaking lines in between words, or if + * that is not enough, also between graphemes + * + * Describes a type of line wrapping. + */ typedef enum { GTK_WRAP_NONE, diff --git a/gtk/gtktextattributes.h b/gtk/gtktextattributes.h index 5d43676f18..aa7d6f8aa8 100644 --- a/gtk/gtktextattributes.h +++ b/gtk/gtktextattributes.h @@ -67,6 +67,14 @@ typedef struct _GtkTextAttributes GtkTextAttributes; typedef struct _GtkTextAppearance GtkTextAppearance; +/** + * GtkTextAttributes: + * + * Using #GtkTextAttributes directly should rarely be necessary. + * It's primarily useful with gtk_text_iter_get_attributes(). + * As with most GTK+ structs, the fields in this struct should only + * be read, never modified directly. + */ struct _GtkTextAppearance { /*< public >*/ diff --git a/gtk/gtktexttag.c b/gtk/gtktexttag.c index 9d9e788843..bae882638c 100644 --- a/gtk/gtktexttag.c +++ b/gtk/gtktexttag.c @@ -47,6 +47,22 @@ * */ +/** + * SECTION:GtkTextTag + * @Title: GtkTextTag + * @Short_description: A tag that can be applied to text in a GtkTextBuffer + * + * You may wish to begin by reading the <link linkend="TextWidget">text widget + * conceptual overview</link> which gives an overview of all the objects and + * data types related to the text widget and how they work together. + * + * Tags should be in the #GtkTextTagTable for a given #GtkTextBuffer + * before using them with that buffer. + * + * gtk_text_buffer_create_tag() is the best way to create tags. + * See <application>gtk3-demo</application> for numerous examples. + */ + #include "config.h" #include <stdlib.h> |