Struct gtk4::builders::TextViewBuilder

pub struct TextViewBuilder { /* private fields */ }

A builder-pattern type to construct TextView objects.

Implementations

impl TextViewBuilder

pub fn new() -> Self

Create a new TextViewBuilder.

pub fn build(self) -> TextView

Build the TextView.

pub fn accepts_tab(self, accepts_tab: bool) -> Self

Whether Tab will result in a tab character being entered.

pub fn bottom_margin(self, bottom_margin: i32) -> Self

The bottom margin for text in the text view.

Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.

Don’t confuse this property with property::Widget::margin-bottom.

pub fn buffer(self, buffer: &impl IsA<TextBuffer>) -> Self

The buffer which is displayed.

pub fn cursor_visible(self, cursor_visible: bool) -> Self

If the insertion cursor is shown.

pub fn editable(self, editable: bool) -> Self

pub fn extra_menu(self, extra_menu: &impl IsA<MenuModel>) -> Self

A menu model whose contents will be appended to the context menu.

pub fn im_module(self, im_module: &str) -> Self

Which IM (input method) module should be used for this text_view.

See IMMulticontext.

Setting this to a non-None value overrides the system-wide IM module setting. See the GtkSettings property::Settings::gtk-im-module property.

pub fn indent(self, indent: i32) -> Self

Amount to indent the paragraph, in pixels.

pub fn input_hints(self, input_hints: InputHints) -> Self

Additional hints (beyond property::TextView::input-purpose) that allow input methods to fine-tune their behaviour.

pub fn input_purpose(self, input_purpose: InputPurpose) -> Self

The purpose of this text field.

This property can be used by on-screen keyboards and other input methods to adjust their behaviour.

pub fn justification(self, justification: Justification) -> Self

pub fn left_margin(self, left_margin: i32) -> Self

The default left margin for text in the text view.

Tags in the buffer may override the default.

Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.

pub fn monospace(self, monospace: bool) -> Self

Whether text should be displayed in a monospace font.

If true, set the .monospace style class on the text view to indicate that a monospace font is desired.

pub fn overwrite(self, overwrite: bool) -> Self

Whether entered text overwrites existing contents.

pub fn pixels_above_lines(self, pixels_above_lines: i32) -> Self

pub fn pixels_below_lines(self, pixels_below_lines: i32) -> Self

pub fn pixels_inside_wrap(self, pixels_inside_wrap: i32) -> Self

pub fn right_margin(self, right_margin: i32) -> Self

The default right margin for text in the text view.

Tags in the buffer may override the default.

Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.

pub fn tabs(self, tabs: &TabArray) -> Self

pub fn top_margin(self, top_margin: i32) -> Self

The top margin for text in the text view.

Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.

Don’t confuse this property with property::Widget::margin-top.

pub fn wrap_mode(self, wrap_mode: WrapMode) -> Self

pub fn can_focus(self, can_focus: bool) -> Self

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

pub fn can_target(self, can_target: bool) -> Self

Whether the widget can receive pointer events.

pub fn css_classes(self, css_classes: Vec<String>) -> Self

A list of css classes applied to this widget.

pub fn css_name(self, css_name: &str) -> Self

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

pub fn cursor(self, cursor: &Cursor) -> Self

The cursor used by @widget.

pub fn focus_on_click(self, focus_on_click: bool) -> Self

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

pub fn focusable(self, focusable: bool) -> Self

Whether this widget itself will accept the input focus.

pub fn halign(self, halign: Align) -> Self

How to distribute horizontal space if widget gets extra space.

pub fn has_tooltip(self, has_tooltip: bool) -> Self

Enables or disables the emission of the ::query-tooltip signal on @widget.

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using signal::Widget::query-tooltip to determine whether it will provide a tooltip or not.

pub fn height_request(self, height_request: i32) -> Self

Override for height request of the widget.

If this is -1, the natural request will be used.

pub fn hexpand(self, hexpand: bool) -> Self

Whether to expand horizontally.

pub fn hexpand_set(self, hexpand_set: bool) -> Self

Whether to use the hexpand property.

pub fn layout_manager(self, layout_manager: &impl IsA<LayoutManager>) -> Self

The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

pub fn margin_bottom(self, margin_bottom: i32) -> Self

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

pub fn margin_end(self, margin_end: i32) -> Self

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

pub fn margin_start(self, margin_start: i32) -> Self

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

pub fn margin_top(self, margin_top: i32) -> Self

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

pub fn name(self, name: &str) -> Self

The name of the widget.

pub fn opacity(self, opacity: f64) -> Self

The requested opacity of the widget.

pub fn overflow(self, overflow: Overflow) -> Self

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

pub fn receives_default(self, receives_default: bool) -> Self

Whether the widget will receive the default action when it is focused.

pub fn sensitive(self, sensitive: bool) -> Self

Whether the widget responds to input.

pub fn tooltip_markup(self, tooltip_markup: &str) -> Self

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: property::Widget::has-tooltip will automatically be set to true and there will be taken care of signal::Widget::query-tooltip in the default signal handler.

Note that if both property::Widget::tooltip-text and property::Widget::tooltip-markup are set, the last one wins.

pub fn tooltip_text(self, tooltip_text: &str) -> Self

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: property::Widget::has-tooltip will automatically be set to true and there will be taken care of signal::Widget::query-tooltip in the default signal handler.

Note that if both property::Widget::tooltip-text and property::Widget::tooltip-markup are set, the last one wins.

pub fn valign(self, valign: Align) -> Self

How to distribute vertical space if widget gets extra space.

pub fn vexpand(self, vexpand: bool) -> Self

Whether to expand vertically.

pub fn vexpand_set(self, vexpand_set: bool) -> Self

Whether to use the vexpand property.

pub fn visible(self, visible: bool) -> Self

Whether the widget is visible.

pub fn width_request(self, width_request: i32) -> Self

Override for width request of the widget.

If this is -1, the natural request will be used.

pub fn accessible_role(self, accessible_role: AccessibleRole) -> Self

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

pub fn hadjustment(self, hadjustment: &impl IsA<Adjustment>) -> Self

Horizontal Adjustment of the scrollable widget.

This adjustment is shared between the scrollable widget and its parent.

pub fn hscroll_policy(self, hscroll_policy: ScrollablePolicy) -> Self

Determines when horizontal scrolling should start.

pub fn vadjustment(self, vadjustment: &impl IsA<Adjustment>) -> Self

Vertical Adjustment of the scrollable widget.

This adjustment is shared between the scrollable widget and its parent.

pub fn vscroll_policy(self, vscroll_policy: ScrollablePolicy) -> Self

Determines when vertical scrolling should start.

Trait Implementations

impl Clone for TextViewBuilder

fn clone(&self) -> TextViewBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for TextViewBuilder

fn default() -> TextViewBuilder

Returns the “default value” for a type.