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, .

Implements

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

Implementations

Creates a new Inscription with the given text.

text

The text to display.

Returns

a new Inscription

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.

Gets the inscription’s attribute list.

Returns

the attribute list

Gets the min-chars of the inscription.

See the property::Inscription::min-chars property.

Returns

the min-chars property

Gets the min-lines of the inscription.

See the property::Inscription::min-lines property.

Returns

the min-lines property

Gets the nat-chars of the inscription.

See the property::Inscription::nat-chars property.

Returns

the nat-chars property

Gets the nat-lines of the inscription.

See the property::Inscription::nat-lines property.

Returns

the nat-lines property

Gets the text that is displayed.

Returns

The displayed text

Gets the inscription’s overflow method.

Returns

the overflow method

Returns line wrap mode used by the inscription.

See set_wrap_mode().

Returns

the line wrap mode

Gets the xalign of the inscription.

See the property::Inscription::xalign property.

Returns

the xalign property

Gets the yalign of the inscription.

See the property::Inscription::yalign property.

Returns

the yalign property

Apply attributes to the inscription text.

These attributes will not be evaluated for sizing the inscription.

attrs

a pango::AttrList

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

See the property::Inscription::markup property.

markup

The markup to display

Sets the min-chars of the inscription.

See the property::Inscription::min-chars property.

min_chars

the minimum number of characters that should fit, approximately

Sets the min-lines of the inscription.

See the property::Inscription::min-lines property.

min_lines

the minimum number of lines that should fit, approximately

Sets the nat-chars of the inscription.

See the property::Inscription::nat-chars property.

nat_chars

the number of characters that should ideally fit, approximately

Sets the nat-lines of the inscription.

See the property::Inscription::nat-lines property.

nat_lines

the number of lines that should ideally fit

Sets the text to be displayed.

text

The text to display

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

overflow

the overflow method to use

Controls how line wrapping is done.

wrap_mode

the line wrapping mode

Sets the xalign of the inscription.

See the property::Inscription::xalign property.

xalign

the new xalign value, between 0 and 1

Sets the yalign of the inscription.

See the property::Inscription::yalign property.

yalign

the new yalign value, between 0 and 1

Trait Implementations

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more
Formats the value using the given formatter. Read more
Feeds this value into the given Hasher. Read more
Feeds a slice of this type into the given Hasher. Read more
This method returns an Ordering between self and other. Read more
Compares and returns the maximum of two values. Read more
Compares and returns the minimum of two values. Read more
Restrict a value to a certain interval. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more
This method returns an ordering between self and other values if one exists. Read more
This method tests less than (for self and other) and is used by the < operator. Read more
This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
This method tests greater than (for self and other) and is used by the > operator. Read more
This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Returns the type identifier of Self.

Auto Trait Implementations

Blanket Implementations

Updates an array of accessible properties. Read more
Updates an array of accessible relations. Read more
Updates an array of accessible states. Read more
Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Upcasts an object to a superclass or interface T. Read more
Upcasts an object to a reference of its superclass or interface T. Read more
Tries to downcast to a subclass or interface implementor T. Read more
Tries to downcast to a reference of its subclass or interface implementor T. Read more
Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more
Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more
Casts to T unconditionally. Read more
Casts to &T unconditionally. Read more

Returns the argument unchanged.

Calls U::from(self).

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

Returns true if the object is an instance of (can be cast to) T.
Returns the type of the object.
Returns the ObjectClass of the object. Read more
Returns the class of the object.
Returns the class of the object in the given type T. Read more
Returns the interface T of the object. Read more
Sets the property property_name of the object to value value. Read more
Sets the property property_name of the object to value value. Read more
Sets multiple properties of the object at once. Read more
Sets multiple properties of the object at once. Read more
Gets the property property_name of the object and cast it to the type V. Read more
Gets the property property_name of the object. Read more
Check if the object has a property property_name of the given type_. Read more
Get the type of the property property_name of this object. Read more
Get the ParamSpec of the property property_name of this object.
Return all ParamSpec of the properties of this object.
Freeze all property notifications until the return guard object is dropped. Read more
Set arbitrary data on this object with the given key. Read more
Return previously set arbitrary data of this object with the given key. Read more
Retrieve previously set arbitrary data of this object with the given key. Read more
Set arbitrary data on this object with the given key. Read more
Return previously set arbitrary data of this object with the given key. Read more
Retrieve previously set arbitrary data of this object with the given key. Read more
Block a given signal handler. Read more
Unblock a given signal handler.
Stop emission of the currently emitted signal.
Stop emission of the currently emitted signal by the (possibly detailed) signal name.
Connect to the signal signal_name on this object. Read more
Connect to the signal signal_id on this object. Read more
Connect to the signal signal_name on this object. Read more
Connect to the signal signal_id on this object. Read more
Connect to the signal signal_name on this object. Read more
Connect to the signal signal_id on this object. Read more
Connect a closure to the signal signal_name on this object. Read more
Connect a closure to the signal signal_id on this object. Read more
Limits the lifetime of closure to the lifetime of the object. When the object’s reference count drops to zero, the closure will be invalidated. An invalidated closure will ignore any calls to invoke_with_values, or invoke when using Rust closures. Read more
Emit signal by signal id. Read more
Same as Self::emit but takes Value for the arguments.
Emit signal by its name. Read more
Emit signal by its name. Read more
Emit signal by its name with details. Read more
Emit signal by its name with details. Read more
Emit signal by signal id with details. Read more
Emit signal by signal id with details. Read more
Disconnect a previously connected signal handler.
Connect to the notify signal of the object. Read more
Connect to the notify signal of the object. Read more
Connect to the notify signal of the object. Read more
Notify that the given property has changed its value. Read more
Notify that the given property has changed its value. Read more
Downgrade this object to a weak reference.
Add a callback to be notified when the Object is disposed.
Add a callback to be notified when the Object is disposed. Read more
Bind property source_property on this object to the target_property on the target object. Read more
Returns the strong reference count of this object.
Runs the dispose mechanism of the object. Read more
Ensures that the type has been registered with the type system.
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
Converts the given value to a String. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.