textview: Add property annotations

Connect properties, getters, and setters with annotations.
This commit is contained in:
Matthias Clasen 2021-02-24 21:58:35 -05:00 committed by Emmanuele Bassi
parent 693f3d6b41
commit 50df5e0ec2

View File

@ -58,10 +58,7 @@
#include "gtkwidgetprivate.h"
/**
* SECTION:gtktextview
* @Short_description: Widget that displays a GtkTextBuffer
* @Title: GtkTextView
* @See_also: `GtkTextBuffer`, `GtkTextIter`
* GtkTextView:
*
* A widget that displays the contents of a [class@Gtk.TextBuffer].
*
@ -837,7 +834,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
*/
/**
* GtkTextview:pixels-above-lines:
* GtkTextview:pixels-above-lines: (attributes org.gtk.Property.get=gtk_text_view_get_pixels_above_lines org.gtk.Property.set=gtk_text_view_set_pixels_above_lines)
*
* Pixels of blank space above paragraphs.
*/
@ -850,7 +847,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
/**
* GtkTextview:pixels-below-lines:
* GtkTextview:pixels-below-lines: (attributes org.gtk.Property.get=gtk_text_view_get_pixels_below_lines org.gtk.Property.set=gtk_text_view_set_pixels_below_lines)
*
* Pixels of blank space below paragraphs.
*/
@ -863,7 +860,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
/**
* GtkTextview:pixels-inside-wrap:
* GtkTextview:pixels-inside-wrap: (attributes org.gtk.Property.get=gtk_text_view_get_pixels_inside_wrap org.gtk.Property.set=gtk_text_view_set_pixels_inside_wrap)
*
* Pixels of blank space between wrapped lines in a paragraph.
*/
@ -876,7 +873,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
/**
* GtkTextview:editable:
* GtkTextview:editable: (attributes org.gtk.Property.get=gtk_text_view_get_editable org.gtk.Property.set=gtk_text_view_set_editable)
*
* Whether the text can be modified by the user.
*/
@ -889,7 +886,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
/**
* GtkTextview:wrap-mode:
* GtkTextview:wrap-mode: (attributes org.gtk.Property.get=gtk_text_view_get_wrap_mode org.gtk.Property.set=gtk_text_view_set_wrap_mode)
*
* Whether to wrap lines never, at word boundaries, or at character boundaries.
*/
@ -903,7 +900,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
/**
* GtkTextview:justification:
* GtkTextview:justification: (attributes org.gtk.Property.get=gtk_text_view_get_justification org.gtk.Property.set=gtk_text_view_set_justification)
*
* Left, right, or center justification.
*/
@ -917,7 +914,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
/**
* GtkTextView:left-margin:
* GtkTextView:left-margin: (attributes org.gtk.Property.get=gtk_text_view_get_left_margin org.gtk.Property.set=gtk_text_view_set_left_margin)
*
* The default left margin for text in the text view.
*
@ -936,7 +933,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
/**
* GtkTextView:right-margin:
* GtkTextView:right-margin: (attributes org.gtk.Property.get=gtk_text_view_get_right_margin org.gtk.Property.set=gtk_text_view_set_right_margin)
*
* The default right margin for text in the text view.
*
@ -955,7 +952,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
/**
* GtkTextView:top-margin:
* GtkTextView:top-margin: (attributes org.gtk.Property.get=gtk_text_view_get_top_margin org.gtk.Property.set=gtk_text_view_set_top_margin)
*
* The top margin for text in the text view.
*
@ -974,7 +971,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
/**
* GtkTextView:bottom-margin:
* GtkTextView:bottom-margin: (attributes org.gtk.Property.get=gtk_text_view_get_bottom_margin org.gtk.Property.set=gtk_text_view_set_bottom_margin)
*
* The bottom margin for text in the text view.
*
@ -993,7 +990,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
/**
* GtkTextView:indent:
* GtkTextView:indent: (attributes org.gtk.Property.get=gtk_text_view_get_indent org.gtk.Property.set=gtk_text_view_set_indent)
*
* Amount to indent the paragraph, in pixels.
*/
@ -1006,7 +1003,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
/**
* GtkTextview:tabs:
* GtkTextview:tabs: (attributes org.gtk.Property.get=gtk_text_view_get_tabs org.gtk.Property.set=gtk_text_view_set_tabs)
*
* Custom tabs for this text.
*/
@ -1019,7 +1016,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE));
/**
* GtkTextView:cursor-visible:
* GtkTextView:cursor-visible: (attributes org.gtk.Property.get=gtk_text_view_get_cursor_visible org.gtk.Property.set=gtk_text_view_set_cursor_visible)
*
* If the insertion cursor is shown.
*/
@ -1032,7 +1029,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
/**
* GtkTextView:buffer:
* GtkTextView:buffer: (attributes org.gtk.Property.get=gtk_text_view_get_buffer org.gtk.Property.set=gtk_text_view_set_buffer)
*
* The buffer which is displayed.
*/
@ -1045,7 +1042,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE));
/**
* GtkTextView:overwrite:
* GtkTextView:overwrite: (attributes org.gtk.Property.get=gtk_text_view_get_overwrite org.gtk.Property.set=gtk_text_view_set_overwrite)
*
* Whether entered text overwrites existing contents.
*/
@ -1058,7 +1055,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
/**
* GtkTextView:accepts-tab:
* GtkTextView:accepts-tab: (attributes org.gtk.Property.get=gtk_text_view_get_accepts_tab org.gtk.Property.set=gtk_text_view_set_accepts_tab)
*
* Whether Tab will result in a tab character being entered.
*/
@ -1089,7 +1086,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE));
/**
* GtkTextView:input-purpose:
* GtkTextView:input-purpose: (attributes org.gtk.Property.get=gtk_text_view_get_input_purpose org.gtk.Property.set=gtk_text_view_set_input_purpose)
*
* The purpose of this text field.
*
@ -1107,7 +1104,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
/**
* GtkTextView:input-hints:
* GtkTextView:input-hints: (attributes org.gtk.Property.get=gtk_text_view_get_input_hints org.gtk.Property.set=gtk_text_view_set_input_hints)
*
* Additional hints (beyond [property@Gtk.TextView:input-purpose])
* that allow input methods to fine-tune their behaviour.
@ -1123,7 +1120,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
/**
* GtkTextView:monospace:
* GtkTextView:monospace: (attributes org.gtk.Property.get=gtk_text_view_get_monospace org.gtk.Property.set=gtk_text_view_set_monospace)
*
* Whether text should be displayed in a monospace font.
*
@ -1139,7 +1136,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
/**
* GtkTextView:extra-menu:
* GtkTextView:extra-menu: (attributes org.gtk.Property.get=gtk_text_view_get_extra_menu org.gtk.Property.set=gtk_text_view_set_extra_menu)
*
* A menu model whose contents will be appended to the context menu.
*/
@ -2101,7 +2098,7 @@ gtk_text_view_new_with_buffer (GtkTextBuffer *buffer)
}
/**
* gtk_text_view_set_buffer:
* gtk_text_view_set_buffer: (attributes org.gtk.Method.set_property=buffer)
* @text_view: a `GtkTextView`
* @buffer: (allow-none): a `GtkTextBuffer`
*
@ -2244,7 +2241,7 @@ gtk_text_view_create_buffer (GtkTextView *text_view)
}
/**
* gtk_text_view_get_buffer:
* gtk_text_view_get_buffer: (attributes org.gtk.Method.get_property=buffer)
* @text_view: a `GtkTextView`
*
* Returns the `GtkTextBuffer` being displayed by this text view.
@ -3103,7 +3100,7 @@ gtk_text_view_get_visible_rect (GtkTextView *text_view,
}
/**
* gtk_text_view_set_wrap_mode:
* gtk_text_view_set_wrap_mode: (attributes org.gtk.Method.set_property=wrap-mode)
* @text_view: a `GtkTextView`
* @wrap_mode: a `GtkWrapMode`
*
@ -3133,7 +3130,7 @@ gtk_text_view_set_wrap_mode (GtkTextView *text_view,
}
/**
* gtk_text_view_get_wrap_mode:
* gtk_text_view_get_wrap_mode: (attributes org.gtk.Method.get_property=wrap-mode)
* @text_view: a `GtkTextView`
*
* Gets the line wrapping for the view.
@ -3149,7 +3146,7 @@ gtk_text_view_get_wrap_mode (GtkTextView *text_view)
}
/**
* gtk_text_view_set_editable:
* gtk_text_view_set_editable: (attributes org.gtk.Method.set_property=editable)
* @text_view: a `GtkTextView`
* @setting: whether its editable
*
@ -3204,7 +3201,7 @@ gtk_text_view_set_editable (GtkTextView *text_view,
}
/**
* gtk_text_view_get_editable:
* gtk_text_view_get_editable: (attributes org.gtk.Method.get_property=editable)
* @text_view: a `GtkTextView`
*
* Returns the default editability of the `GtkTextView`.
@ -3222,7 +3219,7 @@ gtk_text_view_get_editable (GtkTextView *text_view)
}
/**
* gtk_text_view_set_pixels_above_lines:
* gtk_text_view_set_pixels_above_lines: (attributes org.gtk.Method.set_property=pixels-above-lines)
* @text_view: a `GtkTextView`
* @pixels_above_lines: pixels above paragraphs
*
@ -3255,7 +3252,7 @@ gtk_text_view_set_pixels_above_lines (GtkTextView *text_view,
}
/**
* gtk_text_view_get_pixels_above_lines:
* gtk_text_view_get_pixels_above_lines: (attributes org.gtk.Method.get_property=pixels-above-lines)
* @text_view: a `GtkTextView`
*
* Gets the default number of pixels to put above paragraphs.
@ -3274,7 +3271,7 @@ gtk_text_view_get_pixels_above_lines (GtkTextView *text_view)
}
/**
* gtk_text_view_set_pixels_below_lines:
* gtk_text_view_set_pixels_below_lines: (attributes org.gtk.Method.set_property=pixels-below-lines)
* @text_view: a `GtkTextView`
* @pixels_below_lines: pixels below paragraphs
*
@ -3308,7 +3305,7 @@ gtk_text_view_set_pixels_below_lines (GtkTextView *text_view,
}
/**
* gtk_text_view_get_pixels_below_lines:
* gtk_text_view_get_pixels_below_lines: (attributes org.gtk.Method.get_property=pixels-below-lines)
* @text_view: a `GtkTextView`
*
* Gets the default number of pixels to put below paragraphs.
@ -3327,7 +3324,7 @@ gtk_text_view_get_pixels_below_lines (GtkTextView *text_view)
}
/**
* gtk_text_view_set_pixels_inside_wrap:
* gtk_text_view_set_pixels_inside_wrap: (attributes org.gtk.Method.set_property=pixels-inside-wrap)
* @text_view: a `GtkTextView`
* @pixels_inside_wrap: default number of pixels between wrapped lines
*
@ -3361,7 +3358,7 @@ gtk_text_view_set_pixels_inside_wrap (GtkTextView *text_view,
}
/**
* gtk_text_view_get_pixels_inside_wrap:
* gtk_text_view_get_pixels_inside_wrap: (attributes org.gtk.Method.get_property=pixels-inside-wrap)
* @text_view: a `GtkTextView`
*
* Gets the default number of pixels to put between wrapped lines
@ -3378,7 +3375,7 @@ gtk_text_view_get_pixels_inside_wrap (GtkTextView *text_view)
}
/**
* gtk_text_view_set_justification:
* gtk_text_view_set_justification: (attributes org.gtk.Method.set_property=justification)
* @text_view: a `GtkTextView`
* @justification: justification
*
@ -3411,7 +3408,7 @@ gtk_text_view_set_justification (GtkTextView *text_view,
}
/**
* gtk_text_view_get_justification:
* gtk_text_view_get_justification: (attributes org.gtk.Method.get_property=justification)
* @text_view: a `GtkTextView`
*
* Gets the default justification of paragraphs in @text_view.
@ -3429,7 +3426,7 @@ gtk_text_view_get_justification (GtkTextView *text_view)
}
/**
* gtk_text_view_set_left_margin:
* gtk_text_view_set_left_margin: (attributes org.gtk.Method.set_property=left-margin)
* @text_view: a `GtkTextView`
* @left_margin: left margin in pixels
*
@ -3464,7 +3461,7 @@ gtk_text_view_set_left_margin (GtkTextView *text_view,
}
/**
* gtk_text_view_get_left_margin:
* gtk_text_view_get_left_margin: (attributes org.gtk.Method.get_property=left-margin)
* @text_view: a `GtkTextView`
*
* Gets the default left margin size of paragraphs in the @text_view.
@ -3482,7 +3479,7 @@ gtk_text_view_get_left_margin (GtkTextView *text_view)
}
/**
* gtk_text_view_set_right_margin:
* gtk_text_view_set_right_margin: (attributes org.gtk.Method.set_property=right-margin)
* @text_view: a `GtkTextView`
* @right_margin: right margin in pixels
*
@ -3517,7 +3514,7 @@ gtk_text_view_set_right_margin (GtkTextView *text_view,
}
/**
* gtk_text_view_get_right_margin:
* gtk_text_view_get_right_margin: (attributes org.gtk.Method.get_property=right-margin)
* @text_view: a `GtkTextView`
*
* Gets the default right margin for text in @text_view.
@ -3535,7 +3532,7 @@ gtk_text_view_get_right_margin (GtkTextView *text_view)
}
/**
* gtk_text_view_set_top_margin:
* gtk_text_view_set_top_margin: (attributes org.gtk.Method.set_property=top-margin)
* @text_view: a `GtkTextView`
* @top_margin: top margin in pixels
*
@ -3569,7 +3566,7 @@ gtk_text_view_set_top_margin (GtkTextView *text_view,
}
/**
* gtk_text_view_get_top_margin:
* gtk_text_view_get_top_margin: (attributes org.gtk.Method.get_property=top-margin)
* @text_view: a `GtkTextView`
*
* Gets the top margin for text in the @text_view.
@ -3585,7 +3582,7 @@ gtk_text_view_get_top_margin (GtkTextView *text_view)
}
/**
* gtk_text_view_set_bottom_margin:
* gtk_text_view_set_bottom_margin: (attributes org.gtk.Method.set_property=bottom-margin)
* @text_view: a `GtkTextView`
* @bottom_margin: bottom margin in pixels
*
@ -3615,7 +3612,7 @@ gtk_text_view_set_bottom_margin (GtkTextView *text_view,
}
/**
* gtk_text_view_get_bottom_margin:
* gtk_text_view_get_bottom_margin: (attributes org.gtk.Method.get_property=bottom-margin)
* @text_view: a `GtkTextView`
*
* Gets the bottom margin for text in the @text_view.
@ -3631,7 +3628,7 @@ gtk_text_view_get_bottom_margin (GtkTextView *text_view)
}
/**
* gtk_text_view_set_indent:
* gtk_text_view_set_indent: (attributes org.gtk.Method.set_property=indent)
* @text_view: a `GtkTextView`
* @indent: indentation in pixels
*
@ -3664,7 +3661,7 @@ gtk_text_view_set_indent (GtkTextView *text_view,
}
/**
* gtk_text_view_get_indent:
* gtk_text_view_get_indent: (attributes org.gtk.Method.get_property=indent)
* @text_view: a `GtkTextView`
*
* Gets the default indentation of paragraphs in @text_view.
@ -3683,7 +3680,7 @@ gtk_text_view_get_indent (GtkTextView *text_view)
}
/**
* gtk_text_view_set_tabs:
* gtk_text_view_set_tabs: (attributes org.gtk.Method.set_property=tabs)
* @text_view: a `GtkTextView`
* @tabs: tabs as a #PangoTabArray
*
@ -3722,7 +3719,7 @@ gtk_text_view_set_tabs (GtkTextView *text_view,
}
/**
* gtk_text_view_get_tabs:
* gtk_text_view_get_tabs: (attributes org.gtk.Method.get_property=tabs)
* @text_view: a `GtkTextView`
*
* Gets the default tabs for @text_view.
@ -3750,7 +3747,7 @@ gtk_text_view_toggle_cursor_visible (GtkTextView *text_view)
}
/**
* gtk_text_view_set_cursor_visible:
* gtk_text_view_set_cursor_visible: (attributes org.gtk.Method.set_property=cursor-visible)
* @text_view: a `GtkTextView`
* @setting: whether to show the insertion cursor
*
@ -3791,7 +3788,7 @@ gtk_text_view_set_cursor_visible (GtkTextView *text_view,
}
/**
* gtk_text_view_get_cursor_visible:
* gtk_text_view_get_cursor_visible: (attributes org.gtk.Method.get_property=cursor-visible)
* @text_view: a `GtkTextView`
*
* Find out whether the cursor should be displayed.
@ -6999,7 +6996,7 @@ gtk_text_view_toggle_overwrite (GtkTextView *text_view)
}
/**
* gtk_text_view_get_overwrite:
* gtk_text_view_get_overwrite: (attributes org.gtk.Method.get_property=overwrite)
* @text_view: a `GtkTextView`
*
* Returns whether the `GtkTextView` is in overwrite mode or not.
@ -7015,7 +7012,7 @@ gtk_text_view_get_overwrite (GtkTextView *text_view)
}
/**
* gtk_text_view_set_overwrite:
* gtk_text_view_set_overwrite: (attributes org.gtk.Method.set_property=overwrite)
* @text_view: a `GtkTextView`
* @overwrite: %TRUE to turn on overwrite mode, %FALSE to turn it off
*
@ -7033,7 +7030,7 @@ gtk_text_view_set_overwrite (GtkTextView *text_view,
}
/**
* gtk_text_view_set_accepts_tab:
* gtk_text_view_set_accepts_tab: (attributes org.gtk.Method.set_property=accepts-tab)
* @text_view: A `GtkTextView`
* @accepts_tab: %TRUE if pressing the Tab key should insert a tab
* character, %FALSE, if pressing the Tab key should move the
@ -7062,7 +7059,7 @@ gtk_text_view_set_accepts_tab (GtkTextView *text_view,
}
/**
* gtk_text_view_get_accepts_tab:
* gtk_text_view_get_accepts_tab: (attributes org.gtk.Method.get_property=accepts-tab)
* @text_view: A `GtkTextView`
*
* Returns whether pressing the Tab key inserts a tab characters.
@ -9639,7 +9636,7 @@ gtk_text_view_move_visually (GtkTextView *text_view,
}
/**
* gtk_text_view_set_input_purpose:
* gtk_text_view_set_input_purpose: (attributes org.gtk.Method.set_property=input-purpose)
* @text_view: a `GtkTextView`
* @purpose: the purpose
*
@ -9666,7 +9663,7 @@ gtk_text_view_set_input_purpose (GtkTextView *text_view,
}
/**
* gtk_text_view_get_input_purpose:
* gtk_text_view_get_input_purpose: (attributes org.gtk.Method.get_property=input-purpose)
* @text_view: a `GtkTextView`
*
* Gets the `input-purpose` of the `GtkTextView`.
@ -9686,7 +9683,7 @@ gtk_text_view_get_input_purpose (GtkTextView *text_view)
}
/**
* gtk_text_view_set_input_hints:
* gtk_text_view_set_input_hints: (attributes org.gtk.Method.set_property=input-hints)
* @text_view: a `GtkTextView`
* @hints: the hints
*
@ -9714,7 +9711,7 @@ gtk_text_view_set_input_hints (GtkTextView *text_view,
}
/**
* gtk_text_view_get_input_hints:
* gtk_text_view_get_input_hints: (attributes org.gtk.Method.get_property=input-hints)
* @text_view: a `GtkTextView`
*
* Gets the `input-hints` of the `GtkTextView`.
@ -9734,7 +9731,7 @@ gtk_text_view_get_input_hints (GtkTextView *text_view)
}
/**
* gtk_text_view_set_monospace:
* gtk_text_view_set_monospace: (attributes org.gtk.Method.set_property=monospace)
* @text_view: a `GtkTextView`
* @monospace: %TRUE to request monospace styling
*
@ -9763,7 +9760,7 @@ gtk_text_view_set_monospace (GtkTextView *text_view,
}
/**
* gtk_text_view_get_monospace:
* gtk_text_view_get_monospace: (attributes org.gtk.Method.get_property=monospace)
* @text_view: a `GtkTextView`
*
* Gets whether the `GtkTextView` uses monospace styling.
@ -9844,7 +9841,7 @@ gtk_text_view_insert_emoji (GtkTextView *text_view)
}
/**
* gtk_text_view_set_extra_menu:
* gtk_text_view_set_extra_menu: (attributes org.gtk.Method.set_property=extra-menu)
* @text_view: a `GtkTextView`
* @model: (allow-none): a `GMenuModel`
*
@ -9869,7 +9866,7 @@ gtk_text_view_set_extra_menu (GtkTextView *text_view,
}
/**
* gtk_text_view_get_extra_menu:
* gtk_text_view_get_extra_menu: (attributes org.gtk.Method.get_property=extra-menu)
* @text_view: a `GtkTextView`
*
* Gets the menu model that gets added to the context menu