Class

GtkInscription

since: 4.8

Description [src]

final class Gtk.Inscription : Gtk.Widget
  implements Gtk.Accessible, Gtk.AccessibleText, Gtk.Buildable, Gtk.ConstraintTarget {
  /* No available fields */
}

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

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

While a GtkLabel sizes itself depending on the text that is displayed, GtkInscription 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.

Available since: 4.8

Hierarchy

hierarchy this GtkInscription implements_0 GtkAccessible this--implements_0 implements_1 GtkAccessibleText this--implements_1 implements_2 GtkBuildable this--implements_2 implements_3 GtkConstraintTarget this--implements_3 ancestor_0 GtkWidget ancestor_0--this ancestor_1 GInitiallyUnowned ancestor_1--ancestor_0 ancestor_2 GObject ancestor_2--ancestor_1

Constructors

gtk_inscription_new

Creates a new GtkInscription with the given text.

since: 4.8

Instance methods

gtk_inscription_get_attributes

Gets the inscription’s attribute list.

since: 4.8

gtk_inscription_get_min_chars

Gets the min-chars of the inscription.

since: 4.8

gtk_inscription_get_min_lines

Gets the min-lines of the inscription.

since: 4.8

gtk_inscription_get_nat_chars

Gets the nat-chars of the inscription.

since: 4.8

gtk_inscription_get_nat_lines

Gets the nat-lines of the inscription.

since: 4.8

gtk_inscription_get_text

Gets the text that is displayed.

since: 4.8

gtk_inscription_get_text_overflow

Gets the inscription’s overflow method.

since: 4.8

gtk_inscription_get_wrap_mode

Returns line wrap mode used by the inscription.

since: 4.8

gtk_inscription_get_xalign

Gets the xalign of the inscription.

since: 4.8

gtk_inscription_get_yalign

Gets the yalign of the inscription.

since: 4.8

gtk_inscription_set_attributes

Apply attributes to the inscription text.

since: 4.8

gtk_inscription_set_markup

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

since: 4.8

gtk_inscription_set_min_chars

Sets the min-chars of the inscription.

since: 4.8

gtk_inscription_set_min_lines

Sets the min-lines of the inscription.

since: 4.8

gtk_inscription_set_nat_chars

Sets the nat-chars of the inscription.

since: 4.8

gtk_inscription_set_nat_lines

Sets the nat-lines of the inscription.

since: 4.8

gtk_inscription_set_text

Sets the text to be displayed.

since: 4.8

gtk_inscription_set_text_overflow

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

since: 4.8

gtk_inscription_set_wrap_mode

Controls how line wrapping is done.

since: 4.8

gtk_inscription_set_xalign

Sets the xalign of the inscription.

since: 4.8

gtk_inscription_set_yalign

Sets the yalign of the inscription.

since: 4.8

Methods inherited from GtkWidget (162)

Please see GtkWidget for a full list of methods.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GtkAccessible (19)
gtk_accessible_announce

Requests the user’s screen reader to announce the given message.

since: 4.14

gtk_accessible_get_accessible_parent

Retrieves the accessible parent for an accessible object.

since: 4.10

gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

gtk_accessible_get_at_context

Retrieves the accessible implementation for the given GtkAccessible.

since: 4.10

gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

since: 4.10

gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

since: 4.10

gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

since: 4.10

gtk_accessible_get_platform_state

Query a platform state, such as focus.

since: 4.10

gtk_accessible_reset_property

Resets the accessible property to its default value.

gtk_accessible_reset_relation

Resets the accessible relation to its default value.

gtk_accessible_reset_state

Resets the accessible state to its default value.

gtk_accessible_set_accessible_parent

Sets the parent and sibling of an accessible object.

since: 4.10

gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling of self.

since: 4.10

gtk_accessible_update_property

Updates a list of accessible properties.

gtk_accessible_update_property_value

Updates an array of accessible properties.

gtk_accessible_update_relation

Updates a list of accessible relations.

gtk_accessible_update_relation_value

Updates an array of accessible relations.

gtk_accessible_update_state

Updates a list of accessible states. See the GtkAccessibleState documentation for the value types of accessible states.

gtk_accessible_update_state_value

Updates an array of accessible states.

Methods inherited from GtkAccessibleText (3)
gtk_accessible_text_update_caret_position

Updates the position of the caret.

since: 4.14

gtk_accessible_text_update_contents

Notifies assistive technologies of a change in contents.

since: 4.14

gtk_accessible_text_update_selection_bound

Updates the boundary of the selection.

since: 4.14

Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

Properties

Gtk.Inscription:attributes

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

since: 4.8

Gtk.Inscription:markup

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

since: 4.8

Gtk.Inscription:min-chars

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

since: 4.8

Gtk.Inscription:min-lines

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

since: 4.8

Gtk.Inscription:nat-chars

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

since: 4.8

Gtk.Inscription:nat-lines

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

since: 4.8

Gtk.Inscription:text

The displayed text.

since: 4.8

Gtk.Inscription:text-overflow

The overflow method to use for the text.

since: 4.8

Gtk.Inscription:wrap-mode

Controls how the line wrapping is done.

since: 4.8

Gtk.Inscription:xalign

The horizontal alignment of the text inside the allocated size.

since: 4.8

Gtk.Inscription:yalign

The vertical alignment of the text inside the allocated size.

since: 4.8

Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

Gtk.Widget:can-target

Whether the widget can receive pointer events.

Gtk.Widget:css-classes

A list of css classes applied to this widget.

Gtk.Widget:css-name

The name of this widget in the CSS tree.

Gtk.Widget:cursor

The cursor used by widget.

Gtk.Widget:focus-on-click

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

Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

Gtk.Widget:has-default

Whether the widget is the default widget.

Gtk.Widget:has-focus

Whether the widget has the input focus.

Gtk.Widget:has-tooltip

Enables or disables the emission of the ::query-tooltip signal on widget.

Gtk.Widget:height-request

Override for height request of the widget.

Gtk.Widget:hexpand

Whether to expand horizontally.

Gtk.Widget:hexpand-set

Whether to use the hexpand property.

Gtk.Widget:layout-manager

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

Gtk.Widget:margin-bottom

Margin on bottom side of widget.

Gtk.Widget:margin-end

Margin on end of widget, horizontally.

Gtk.Widget:margin-start

Margin on start of widget, horizontally.

Gtk.Widget:margin-top

Margin on top side of widget.

Gtk.Widget:name

The name of the widget.

Gtk.Widget:opacity

The requested opacity of the widget.

Gtk.Widget:overflow

How content outside the widget’s content area is treated.

Gtk.Widget:parent

The parent widget of this widget.

Gtk.Widget:receives-default

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

Gtk.Widget:root

The GtkRoot widget of the widget tree containing this widget.

Gtk.Widget:scale-factor

The scale factor of the widget.

Gtk.Widget:sensitive

Whether the widget responds to input.

Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

Gtk.Widget:vexpand

Whether to expand vertically.

Gtk.Widget:vexpand-set

Whether to use the vexpand property.

Gtk.Widget:visible

Whether the widget is visible.

Gtk.Widget:width-request

Override for width request of the widget.

Properties inherited from GtkAccessible (1)
GtkAccessible:accessible-role

The accessible role of the given GtkAccessible implementation.

Signals

Signals inherited from GtkWidget (13)
GtkWidget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

GtkWidget::direction-changed

Emitted when the text direction of a widget changes.

GtkWidget::hide

Emitted when widget is hidden.

GtkWidget::keynav-failed

Emitted if keyboard navigation fails.

GtkWidget::map

Emitted when widget is going to be mapped.

GtkWidget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

GtkWidget::move-focus

Emitted when the focus is moved.

GtkWidget::query-tooltip

Emitted when the widget’s tooltip is about to be shown.

GtkWidget::realize

Emitted when widget is associated with a GdkSurface.

GtkWidget::show

Emitted when widget is shown.

GtkWidget::state-flags-changed

Emitted when the widget state changes.

GtkWidget::unmap

Emitted when widget is going to be unmapped.

GtkWidget::unrealize

Emitted when the GdkSurface associated with widget is destroyed.

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct GtkInscriptionClass {
  GtkWidgetClass parent_class;
  
}

No description available.

Class members
parent_class: GtkWidgetClass

No description available.