Struct gtk4::builders::TextBuilder

source ·
pub struct TextBuilder { /* private fields */ }
Expand description

A builder-pattern type to construct Text objects.

Implementations§

source§

impl TextBuilder

source

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

Whether to activate the default widget when Enter is pressed.

source

pub fn attributes(self, attributes: &AttrList) -> Self

A list of Pango attributes to apply to the text of the Text.

This is mainly useful to change the size or weight of the text.

The PangoAttribute’s @start_index and @end_index must refer to the EntryBuffer text, i.e. without the preedit string.

source

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

The EntryBuffer object which stores the text.

source

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

Whether to suggest Emoji replacements.

source

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

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

source

pub fn im_module(self, im_module: impl Into<GString>) -> Self

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

See IMMulticontext.

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

source

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

Additional hints that allow input methods to fine-tune their behaviour.

source

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.

Note that setting the purpose to InputPurpose::Password or InputPurpose::Pin is independent from setting visibility.

source

pub fn invisible_char(self, invisible_char: u32) -> Self

The character to used when masking contents (in “password mode”).

source

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

Whether the invisible char has been set for the Text.

source

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

Maximum number of characters that are allowed.

Zero indicates no limit.

source

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

If text is overwritten when typing in the Text.

source

pub fn placeholder_text(self, placeholder_text: impl Into<GString>) -> Self

The text that will be displayed in the Text when it is empty and unfocused.

source

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

Whether the widget should grow and shrink with the content.

source

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

A list of tabstops to apply to the text of the Text.

source

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

When true, pasted multi-line text is truncated to the first line.

source

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

If false, the text is masked with the “invisible char”.

source

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.

source

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

Whether the widget can receive pointer events.

source

pub fn css_classes(self, css_classes: impl Into<StrV>) -> Self

A list of css classes applied to this widget.

source

pub fn css_name(self, css_name: impl Into<GString>) -> 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.

source

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

The cursor used by @widget.

source

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.

source

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

Whether this widget itself will accept the input focus.

source

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

How to distribute horizontal space if widget gets extra space.

source

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 query-tooltip to determine whether it will provide a tooltip or not.

source

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.

source

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

Whether to expand horizontally.

source

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

Whether to use the hexpand property.

source

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.

source

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.

source

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.

source

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.

source

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.

source

pub fn name(self, name: impl Into<GString>) -> Self

The name of the widget.

source

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

The requested opacity of the widget.

source

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.

source

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

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

source

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

Whether the widget responds to input.

source

pub fn tooltip_markup(self, tooltip_markup: impl Into<GString>) -> 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: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

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

source

pub fn tooltip_text(self, tooltip_text: impl Into<GString>) -> 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: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

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

source

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

How to distribute vertical space if widget gets extra space.

source

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

Whether to expand vertically.

source

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

Whether to use the vexpand property.

source

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

Whether the widget is visible.

source

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.

source

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.

source

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

Whether the entry contents can be edited.

source

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

If undo/redo should be enabled for the editable.

source

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

The desired maximum width of the entry, in characters.

source

pub fn text(self, text: impl Into<GString>) -> Self

The contents of the entry.

source

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

Number of characters to leave space for in the entry.

source

pub fn xalign(self, xalign: f32) -> Self

The horizontal alignment, from 0 (left) to 1 (right).

Reversed for RTL layouts.

source

pub fn build(self) -> Text

Build the Text.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.