Struct gtk4::Inscription

source ·

#[repr(transparent)]
pub struct Inscription { /* private fields */ }

Available on crate feature v4_8 only.

Expand description

Inscription is a widget to show text in a predefined area.

You likely want to use Label instead as this widget is intended only for a small subset of use cases. The main scenario envisaged is inside lists such as ColumnView.

While a Label sizes itself depending on the text that is displayed, Inscription is given a size and inscribes the given text into that space as well as it can.

Users of this widget should take care to plan behaviour for the common case where the text doesn’t fit exactly in the allocated space.

Properties

`attributes`

A list of style attributes to apply to the text of the inscription.

Readable | Writeable

`markup`

Utility property that sets both the text and attributes properties, mainly intended for use in GtkBuilder ui files to ease translation support and bindings.

This function uses parse_markup() to parse the markup into text and attributes. The markup must be valid. If you cannot ensure that, consider using parse_markup() and setting the two properties yourself.

Writeable

`min-chars`

The number of characters that should fit into the inscription at minimum.

This influences the requested width, not the width actually given to the widget, which might turn out to be larger.

Note that this is an approximate character width, so some characters might be wider and some might be thinner, so do not expect the number of characters to exactly match.

If you set this property to 0, the inscription will not request any width at all and its width will be determined entirely by its surroundings.

Readable | Writeable

`min-lines`

The number of lines that should fit into the inscription at minimum.

This influences the requested height, not the height actually given to the widget, which might turn out to be larger.

Note that this is an approximate line height, so if the text uses things like fancy Unicode or attribute that influence the height, the text might not fit.

If you set this property to 0, the inscription will not request any height at all and its height will be determined entirely by its surroundings.

Readable | Writeable

`nat-chars`

The number of characters that should ideally fit into the inscription.

This influences the requested width, not the width actually given to the widget. The widget might turn out larger as well as smaller.

If this property is set to a value smaller than min-chars, that value will be used. In particular, for the default value of 0, this will always be the case.

Readable | Writeable

`nat-lines`

The number of lines that should ideally fit into the inscription.

This influences the requested height, not the height actually given to the widget. The widget might turn out larger as well as smaller.

If this property is set to a value smaller than min-lines, that value will be used. In particular, for the default value of 0, this will always be the case.

Readable | Writeable

`text`

The displayed text.

Readable | Writeable

`text-overflow`

The overflow method to use for the text.

Readable | Writeable

`wrap-mode`

Controls how the line wrapping is done.

Note that unlike Label, the default here is pango::WrapMode::WordChar.

Readable | Writeable

`xalign`

The horizontal alignment of the text inside the allocated size.

Compare this to halign, which determines how the inscription’s size allocation is positioned in the available space.

Readable | Writeable

`yalign`

The vertical alignment of the text inside the allocated size.

Compare this to valign, which determines how the inscription’s size allocation is positioned in the available space.

Readable | Writeable

Widget

`can-focus`

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.

Readable | Writeable

`can-target`

Whether the widget can receive pointer events.

Readable | Writeable

`css-classes`

A list of css classes applied to this widget.

Readable | Writeable

`css-name`

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.

Readable | Writeable | Construct Only

`cursor`

The cursor used by @widget.

Readable | Writeable

`focus-on-click`

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

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

Readable | Writeable

`focusable`

Whether this widget itself will accept the input focus.

Readable | Writeable

`halign`

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

`has-default`

Whether the widget is the default widget.

Readable

`has-focus`

Whether the widget has the input focus.

Readable

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.

Readable | Writeable

`height-request`

Override for height request of the widget.

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

Readable | Writeable

`hexpand`

Whether to expand horizontally.

Readable | Writeable

`hexpand-set`

Whether to use the hexpand property.

Readable | Writeable

`layout-manager`

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.

Readable | Writeable

`margin-bottom`

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.

Readable | Writeable

`margin-end`

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.

Readable | Writeable

`margin-start`

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.

Readable | Writeable

`margin-top`

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.

Readable | Writeable

`name`

The name of the widget.

Readable | Writeable

`opacity`

The requested opacity of the widget.

Readable | Writeable

`overflow`

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.

Readable | Writeable

`parent`

The parent widget of this widget.

Readable

`receives-default`

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

Readable | Writeable

`root`

The Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

`scale-factor`

The scale factor of the widget.

Readable

`sensitive`

Whether the widget responds to input.

Readable | Writeable

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.

Readable | Writeable

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.

Readable | Writeable

`valign`

How to distribute vertical space if widget gets extra space.

Readable | Writeable

`vexpand`

Whether to expand vertically.

Readable | Writeable

`vexpand-set`

Whether to use the vexpand property.

Readable | Writeable

`visible`

Whether the widget is visible.

Readable | Writeable

`width-request`

Override for width request of the widget.

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

Readable | Writeable

Accessible

`accessible-role`

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, WidgetExtManual, AccessibleExtManual

Struct gtk4::Inscription

Widget

Accessible

Implementations§

impl Inscription

pub fn new(text: Option<&str>) -> Inscription

pub fn builder() -> InscriptionBuilder

pub fn attributes(&self) -> Option<AttrList>

pub fn min_chars(&self) -> u32

pub fn min_lines(&self) -> u32

pub fn nat_chars(&self) -> u32

pub fn nat_lines(&self) -> u32

pub fn text(&self) -> Option<GString>

pub fn text_overflow(&self) -> InscriptionOverflow

pub fn wrap_mode(&self) -> WrapMode

pub fn xalign(&self) -> f32

pub fn yalign(&self) -> f32

pub fn set_attributes(&self, attrs: Option<&AttrList>)

pub fn set_markup(&self, markup: Option<&str>)

pub fn set_min_chars(&self, min_chars: u32)

pub fn set_min_lines(&self, min_lines: u32)

pub fn set_nat_chars(&self, nat_chars: u32)

pub fn set_nat_lines(&self, nat_lines: u32)

pub fn set_text(&self, text: Option<&str>)

pub fn set_text_overflow(&self, overflow: InscriptionOverflow)

pub fn set_wrap_mode(&self, wrap_mode: WrapMode)

pub fn set_xalign(&self, xalign: f32)

pub fn set_yalign(&self, yalign: f32)

pub fn connect_attributes_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_markup_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_min_chars_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_min_lines_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_nat_chars_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_nat_lines_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_text_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_text_overflow_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_wrap_mode_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_xalign_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_yalign_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations§

impl Clone for Inscription

fn clone(&self) -> Self

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

impl Debug for Inscription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl Default for Inscription

fn default() -> Self

impl Display for Inscription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl HasParamSpec for Inscription

type ParamSpec = ParamSpecObject

type SetValue = Inscription

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Inscription>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Inscription

fn hash<H>(&self, state: &mut H)where H: Hasher,

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

impl Ord for Inscription

fn cmp(&self, other: &Self) -> Ordering

fn max(self, other: Self) -> Selfwhere Self: Sized,

fn min(self, other: Self) -> Selfwhere Self: Sized,

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

impl ParentClassIs for Inscription

type Parent = Widget

impl<OT: ObjectType> PartialEq<OT> for Inscription

fn eq(&self, other: &OT) -> bool

fn ne(&self, other: &Rhs) -> bool

impl<OT: ObjectType> PartialOrd<OT> for Inscription

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

fn lt(&self, other: &Rhs) -> bool

fn le(&self, other: &Rhs) -> bool

fn gt(&self, other: &Rhs) -> bool

fn ge(&self, other: &Rhs) -> bool