Struct gtk4::builders::TextBuilder
source · pub struct TextBuilder { /* private fields */ }
Expand description
A builder-pattern type to construct Text
objects.
Implementations§
source§impl TextBuilder
impl TextBuilder
sourcepub fn activates_default(self, activates_default: bool) -> Self
pub fn activates_default(self, activates_default: bool) -> Self
Whether to activate the default widget when Enter is pressed.
sourcepub fn attributes(self, attributes: &AttrList) -> Self
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.
sourcepub fn buffer(self, buffer: &impl IsA<EntryBuffer>) -> Self
pub fn buffer(self, buffer: &impl IsA<EntryBuffer>) -> Self
The EntryBuffer
object which stores the text.
sourcepub fn enable_emoji_completion(self, enable_emoji_completion: bool) -> Self
pub fn enable_emoji_completion(self, enable_emoji_completion: bool) -> Self
Whether to suggest Emoji replacements.
A menu model whose contents will be appended to the context menu.
sourcepub fn im_module(self, im_module: impl Into<GString>) -> Self
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.
sourcepub fn input_hints(self, input_hints: InputHints) -> Self
pub fn input_hints(self, input_hints: InputHints) -> Self
Additional hints that allow input methods to fine-tune their behaviour.
sourcepub fn input_purpose(self, input_purpose: InputPurpose) -> Self
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
.
sourcepub fn invisible_char(self, invisible_char: u32) -> Self
pub fn invisible_char(self, invisible_char: u32) -> Self
The character to used when masking contents (in “password mode”).
sourcepub fn invisible_char_set(self, invisible_char_set: bool) -> Self
pub fn invisible_char_set(self, invisible_char_set: bool) -> Self
Whether the invisible char has been set for the Text
.
sourcepub fn max_length(self, max_length: i32) -> Self
pub fn max_length(self, max_length: i32) -> Self
Maximum number of characters that are allowed.
Zero indicates no limit.
sourcepub fn overwrite_mode(self, overwrite_mode: bool) -> Self
pub fn overwrite_mode(self, overwrite_mode: bool) -> Self
If text is overwritten when typing in the Text
.
sourcepub fn placeholder_text(self, placeholder_text: impl Into<GString>) -> Self
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.
sourcepub fn propagate_text_width(self, propagate_text_width: bool) -> Self
pub fn propagate_text_width(self, propagate_text_width: bool) -> Self
Whether the widget should grow and shrink with the content.
sourcepub fn tabs(self, tabs: &TabArray) -> Self
pub fn tabs(self, tabs: &TabArray) -> Self
A list of tabstops to apply to the text of the Text
.
sourcepub fn truncate_multiline(self, truncate_multiline: bool) -> Self
pub fn truncate_multiline(self, truncate_multiline: bool) -> Self
When true
, pasted multi-line text is truncated to the first line.
sourcepub fn visibility(self, visibility: bool) -> Self
pub fn visibility(self, visibility: bool) -> Self
If false
, the text is masked with the “invisible char”.
sourcepub fn can_focus(self, can_focus: bool) -> 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.
sourcepub fn can_target(self, can_target: bool) -> Self
pub fn can_target(self, can_target: bool) -> Self
Whether the widget can receive pointer events.
sourcepub fn css_classes(self, css_classes: impl Into<StrV>) -> Self
pub fn css_classes(self, css_classes: impl Into<StrV>) -> Self
A list of css classes applied to this widget.
sourcepub fn css_name(self, css_name: impl Into<GString>) -> Self
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.
sourcepub fn focus_on_click(self, focus_on_click: bool) -> Self
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.
sourcepub fn focusable(self, focusable: bool) -> Self
pub fn focusable(self, focusable: bool) -> Self
Whether this widget itself will accept the input focus.
sourcepub fn halign(self, halign: Align) -> Self
pub fn halign(self, halign: Align) -> Self
How to distribute horizontal space if widget gets extra space.
sourcepub fn has_tooltip(self, has_tooltip: bool) -> Self
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.
sourcepub fn height_request(self, height_request: i32) -> Self
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.
sourcepub fn hexpand_set(self, hexpand_set: bool) -> Self
pub fn hexpand_set(self, hexpand_set: bool) -> Self
Whether to use the hexpand
property.
sourcepub fn layout_manager(self, layout_manager: &impl IsA<LayoutManager>) -> Self
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.
sourcepub fn margin_bottom(self, margin_bottom: i32) -> Self
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.
sourcepub fn margin_end(self, margin_end: i32) -> Self
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.
sourcepub fn margin_start(self, margin_start: i32) -> Self
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.
sourcepub fn margin_top(self, margin_top: i32) -> Self
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.
sourcepub fn overflow(self, overflow: Overflow) -> Self
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.
sourcepub fn receives_default(self, receives_default: bool) -> Self
pub fn receives_default(self, receives_default: bool) -> Self
Whether the widget will receive the default action when it is focused.
sourcepub fn tooltip_markup(self, tooltip_markup: impl Into<GString>) -> Self
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.
sourcepub fn tooltip_text(self, tooltip_text: impl Into<GString>) -> Self
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.
sourcepub fn valign(self, valign: Align) -> Self
pub fn valign(self, valign: Align) -> Self
How to distribute vertical space if widget gets extra space.
sourcepub fn vexpand_set(self, vexpand_set: bool) -> Self
pub fn vexpand_set(self, vexpand_set: bool) -> Self
Whether to use the vexpand
property.
sourcepub fn width_request(self, width_request: i32) -> Self
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.
sourcepub fn accessible_role(self, accessible_role: AccessibleRole) -> Self
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.
sourcepub fn enable_undo(self, enable_undo: bool) -> Self
pub fn enable_undo(self, enable_undo: bool) -> Self
If undo/redo should be enabled for the editable.
sourcepub fn max_width_chars(self, max_width_chars: i32) -> Self
pub fn max_width_chars(self, max_width_chars: i32) -> Self
The desired maximum width of the entry, in characters.
sourcepub fn width_chars(self, width_chars: i32) -> Self
pub fn width_chars(self, width_chars: i32) -> Self
Number of characters to leave space for in the entry.