Struct Inscription

pub struct Inscription { /* private fields */ }

Available on crate feature v4_8 only.

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

has-tooltip

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

tooltip-markup

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

tooltip-text

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, [trait@glib::ObjectExt], AccessibleExt, BuildableExt, ConstraintTargetExt, AccessibleTextExt, WidgetExtManual, AccessibleExtManual

GLib type: GObject with reference counted clone semantics.

Implementations

impl Inscription

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

Creates a new Inscription with the given text.

text

The text to display.

Returns

a new Inscription

pub fn builder() -> InscriptionBuilder

Creates a new builder-pattern struct instance to construct Inscription objects.

This method returns an instance of InscriptionBuilder which can be used to create Inscription objects.

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

Gets the inscription’s attribute list.

Returns

the attribute list

pub fn min_chars(&self) -> u32

Gets the min-chars of the inscription.

See the min-chars property.

Returns

the min-chars property

pub fn min_lines(&self) -> u32

Gets the min-lines of the inscription.

See the min-lines property.

Returns

the min-lines property

pub fn nat_chars(&self) -> u32

Gets the nat-chars of the inscription.

See the nat-chars property.

Returns

the nat-chars property

pub fn nat_lines(&self) -> u32

Gets the nat-lines of the inscription.

See the nat-lines property.

Returns

the nat-lines property

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

Gets the text that is displayed.

Returns

The displayed text

pub fn text_overflow(&self) -> InscriptionOverflow

Gets the inscription’s overflow method.

Returns

the overflow method

pub fn wrap_mode(&self) -> WrapMode

Returns line wrap mode used by the inscription.

See set_wrap_mode().

Returns

the line wrap mode

pub fn xalign(&self) -> f32

Gets the xalign of the inscription.

See the xalign property.

Returns

the xalign property

pub fn yalign(&self) -> f32

Gets the yalign of the inscription.

See the yalign property.

Returns

the yalign property

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

Apply attributes to the inscription text.

These attributes will not be evaluated for sizing the inscription.

attrs

a pango::AttrList

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

Utility function to set the text and attributes to be displayed.

See the markup property.

markup

The markup to display

pub fn set_min_chars(&self, min_chars: u32)

Sets the min-chars of the inscription.

See the min-chars property.

min_chars

the minimum number of characters that should fit, approximately

pub fn set_min_lines(&self, min_lines: u32)

Sets the min-lines of the inscription.

See the min-lines property.

min_lines

the minimum number of lines that should fit, approximately

pub fn set_nat_chars(&self, nat_chars: u32)

Sets the nat-chars of the inscription.

See the nat-chars property.

nat_chars

the number of characters that should ideally fit, approximately

pub fn set_nat_lines(&self, nat_lines: u32)

Sets the nat-lines of the inscription.

See the nat-lines property.

nat_lines

the number of lines that should ideally fit

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

Sets the text to be displayed.

text

The text to display

pub fn set_text_overflow(&self, overflow: InscriptionOverflow)

Sets what to do when the text doesn’t fit.

overflow

the overflow method to use

pub fn set_wrap_mode(&self, wrap_mode: WrapMode)

Controls how line wrapping is done.

wrap_mode

the line wrapping mode

pub fn set_xalign(&self, xalign: f32)

Sets the xalign of the inscription.

See the xalign property.

xalign

the new xalign value, between 0 and 1

pub fn set_yalign(&self, yalign: f32)

Sets the yalign of the inscription.

See the yalign property.

yalign

the new yalign value, between 0 and 1

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

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for Inscription

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

Formats the value using the given formatter.

impl Default for Inscription

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for Inscription

type ParamSpec = ParamSpecObject

type SetValue = Inscription

Preferred value to be used as setter for the associated ParamSpec.

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,

Hashes the memory address of this object.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Inscription

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for Inscription

type Parent = Widget

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Inscription

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Inscription

impl IsA<Accessible> for Inscription

impl IsA<AccessibleText> for Inscription

impl IsA<Buildable> for Inscription

impl IsA<ConstraintTarget> for Inscription

impl IsA<Widget> for Inscription