gtkmm  4.8.0
Public Types | Public Member Functions | Static Public Member Functions | Related Functions | List of all members
Gtk::Inscription Class Reference

Gtk::Inscription is a widget to show text in a predefined area. More...

#include <gtkmm/inscription.h>

Inheritance diagram for Gtk::Inscription:
Inheritance graph
[legend]

Public Types

enum class  Overflow {
  CLIP ,
  ELLIPSIZE_START ,
  ELLIPSIZE_MIDDLE ,
  ELLIPSIZE_END
}
 The different methods to handle text in Gtk::Inscription when it doesn't fit the available space. More...
 
- Public Types inherited from Gtk::Widget
using SlotTick = sigc::slot< bool(const Glib::RefPtr< Gdk::FrameClock > &)>
 Callback type for adding a function to update animations. More...
 
- Public Types inherited from Gtk::Accessible
enum class  Role {
  ALERT ,
  ALERT_DIALOG ,
  BANNER ,
  BUTTON ,
  CAPTION ,
  CELL ,
  CHECKBOX ,
  COLUMN_HEADER ,
  COMBO_BOX ,
  COMMAND ,
  COMPOSITE ,
  DIALOG ,
  DOCUMENT ,
  FEED ,
  FORM ,
  GENERIC ,
  GRID ,
  GRID_CELL ,
  GROUP ,
  HEADING ,
  IMG ,
  INPUT ,
  LABEL ,
  LANDMARK ,
  LEGEND ,
  LINK ,
  LIST ,
  LIST_BOX ,
  LIST_ITEM ,
  LOG ,
  MAIN ,
  MARQUEE ,
  MATH ,
  METER ,
  MENU ,
  MENU_BAR ,
  MENU_ITEM ,
  MENU_ITEM_CHECKBOX ,
  MENU_ITEM_RADIO ,
  NAVIGATION ,
  NONE ,
  NOTE ,
  OPTION ,
  PRESENTATION ,
  PROGRESS_BAR ,
  RADIO ,
  RADIO_GROUP ,
  RANGE ,
  REGION ,
  ROW ,
  ROW_GROUP ,
  ROW_HEADER ,
  SCROLLBAR ,
  SEARCH ,
  SEARCH_BOX ,
  SECTION ,
  SECTION_HEAD ,
  SELECT ,
  SEPARATOR ,
  SLIDER ,
  SPIN_BUTTON ,
  STATUS ,
  STRUCTURE ,
  SWITCH ,
  TAB ,
  TABLE ,
  TAB_LIST ,
  TAB_PANEL ,
  TEXT_BOX ,
  TIME ,
  TIMER ,
  TOOLBAR ,
  TOOLTIP ,
  TREE ,
  TREE_GRID ,
  TREE_ITEM ,
  WIDGET ,
  WINDOW
}
 The accessible role for a Gtk::Accessible implementation. More...
 
enum class  State {
  BUSY ,
  CHECKED ,
  DISABLED ,
  EXPANDED ,
  HIDDEN ,
  INVALID ,
  PRESSED ,
  SELECTED
}
 The possible accessible states of a Gtk::Accessible. More...
 
enum class  Property {
  AUTOCOMPLETE ,
  DESCRIPTION ,
  HAS_POPUP ,
  KEY_SHORTCUTS ,
  LABEL ,
  LEVEL ,
  MODAL ,
  MULTI_LINE ,
  MULTI_SELECTABLE ,
  ORIENTATION ,
  PLACEHOLDER ,
  READ_ONLY ,
  REQUIRED ,
  ROLE_DESCRIPTION ,
  SORT ,
  VALUE_MAX ,
  VALUE_MIN ,
  VALUE_NOW ,
  VALUE_TEXT
}
 The possible accessible properties of a Gtk::Accessible. More...
 
enum class  Relation {
  ACTIVE_DESCENDANT ,
  COL_COUNT ,
  COL_INDEX ,
  COL_INDEX_TEXT ,
  COL_SPAN ,
  CONTROLS ,
  DESCRIBED_BY ,
  DETAILS ,
  ERROR_MESSAGE ,
  FLOW_TO ,
  LABELLED_BY ,
  OWNS ,
  POS_IN_SET ,
  ROW_COUNT ,
  ROW_INDEX ,
  ROW_INDEX_TEXT ,
  ROW_SPAN ,
  SET_SIZE
}
 The possible accessible relations of a Gtk::Accessible. More...
 

Public Member Functions

 Inscription (Inscription && src) noexcept
 
Inscriptionoperator= (Inscription && src) noexcept
 
 Inscription (const Inscription &)=delete
 
Inscriptionoperator= (const Inscription &)=delete
 
 ~Inscription () noexcept override
 
GtkInscription * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkInscription * gobj () const
 Provides access to the underlying C GObject. More...
 
 Inscription ()
 
 Inscription (const Glib::ustring & text)
 Creates a new Gtk::Inscription with the given text. More...
 
Glib::ustring get_text () const
 Gets the text that is displayed. More...
 
void set_text (const Glib::ustring & text)
 Sets the text to be displayed. More...
 
Pango::AttrList get_attributes () const
 Gets the inscription's attribute list. More...
 
void set_attributes (Pango::AttrList & attrs)
 Apply attributes to the inscription text. More...
 
void set_markup (const Glib::ustring & markup)
 Utility function to set the text and attributes to be displayed. More...
 
Inscription::Overflow get_text_overflow () const
 Gets the inscription's overflow method. More...
 
void set_text_overflow (Overflow overflow)
 Sets what to do when the text doesn't fit. More...
 
Pango::WrapMode get_wrap_mode () const
 Returns line wrap mode used by the inscription. More...
 
void set_wrap_mode (Pango::WrapMode wrap_mode)
 Controls how line wrapping is done. More...
 
unsigned int get_min_chars () const
 Gets the min-chars of the inscription. More...
 
void set_min_chars (unsigned int min_chars)
 Sets the min-chars of the inscription. More...
 
unsigned int get_nat_chars () const
 Gets the nat-chars of the inscription. More...
 
void set_nat_chars (unsigned int nat_chars)
 Sets the nat-chars of the inscription. More...
 
unsigned int get_min_lines () const
 Gets the min-lines of the inscription. More...
 
void set_min_lines (unsigned int min_lines)
 Sets the min-lines of the inscription. More...
 
unsigned int get_nat_lines () const
 Gets the nat-lines of the inscription. More...
 
void set_nat_lines (unsigned int nat_lines)
 Sets the nat-lines of the inscription. More...
 
float get_xalign () const
 Gets the xalign of the inscription. More...
 
void set_xalign (float xalign)
 Sets the xalign of the inscription. More...
 
float get_yalign () const
 Gets the yalign of the inscription. More...
 
void set_yalign (float yalign)
 Sets the yalign of the inscription. More...
 
Glib::PropertyProxy< Pango::AttrList > property_attributes ()
 A list of style attributes to apply to the text of the inscription. More...
 
Glib::PropertyProxy_ReadOnly< Pango::AttrList > property_attributes () const
 A list of style attributes to apply to the text of the inscription. More...
 
Glib::PropertyProxy_WriteOnly< Glib::ustring > property_markup ()
 Utility property that sets both the property_text() and property_attributes() properties, mainly intended for use in GtkBuilder ui files to ease translation support and bindings. More...
 
Glib::PropertyProxy< unsigned int > property_min_chars ()
 The number of characters that should fit into the inscription at minimum. More...
 
Glib::PropertyProxy_ReadOnly< unsigned int > property_min_chars () const
 The number of characters that should fit into the inscription at minimum. More...
 
Glib::PropertyProxy< unsigned int > property_min_lines ()
 The number of lines that should fit into the inscription at minimum. More...
 
Glib::PropertyProxy_ReadOnly< unsigned int > property_min_lines () const
 The number of lines that should fit into the inscription at minimum. More...
 
Glib::PropertyProxy< unsigned int > property_nat_chars ()
 The number of characters that should ideally fit into the inscription. More...
 
Glib::PropertyProxy_ReadOnly< unsigned int > property_nat_chars () const
 The number of characters that should ideally fit into the inscription. More...
 
Glib::PropertyProxy< unsigned int > property_nat_lines ()
 The number of lines that should ideally fit into the inscription. More...
 
Glib::PropertyProxy_ReadOnly< unsigned int > property_nat_lines () const
 The number of lines that should ideally fit into the inscription. More...
 
Glib::PropertyProxy< Glib::ustring > property_text ()
 The displayed text. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_text () const
 The displayed text. More...
 
Glib::PropertyProxy< Inscription::Overflowproperty_text_overflow ()
 The overflow method to use for the text. More...
 
Glib::PropertyProxy_ReadOnly< Inscription::Overflowproperty_text_overflow () const
 The overflow method to use for the text. More...
 
Glib::PropertyProxy< Pango::WrapMode > property_wrap_mode ()
 Controls how the line wrapping is done. More...
 
Glib::PropertyProxy_ReadOnly< Pango::WrapMode > property_wrap_mode () const
 Controls how the line wrapping is done. More...
 
Glib::PropertyProxy< float > property_xalign ()
 The horizontal alignment of the text inside the allocated size. More...
 
Glib::PropertyProxy_ReadOnly< float > property_xalign () const
 The horizontal alignment of the text inside the allocated size. More...
 
Glib::PropertyProxy< float > property_yalign ()
 The vertical alignment of the text inside the allocated size. More...
 
Glib::PropertyProxy_ReadOnly< float > property_yalign () const
 The vertical alignment of the text inside the allocated size. More...
 
- Public Member Functions inherited from Gtk::Widget
 Widget (Widget && src) noexcept
 
Widgetoperator= (Widget && src) noexcept
 
 Widget (const Widget &)=delete
 
Widgetoperator= (const Widget &)=delete
 
 ~Widget () noexcept override
 Destroys the widget. More...
 
GtkWidget * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkWidget * gobj () const
 Provides access to the underlying C GObject. More...
 
Glib::RefPtr< ConstraintTargetmake_refptr_constrainttarget ()
 Converts this widget to a reference counted Gtk::ConstraintTarget. More...
 
Glib::RefPtr< const ConstraintTargetmake_refptr_constrainttarget () const
 Converts this widget to a reference counted Gtk::ConstraintTarget. More...
 
void show ()
 Flags a widget to be displayed. More...
 
void hide ()
 Reverses the effects of show(). More...
 
void queue_draw ()
 Schedules this widget to be redrawn in the paint phase of the current or the next frame. More...
 
void queue_resize ()
 Flags a widget to have its size renegotiated. More...
 
void queue_allocate ()
 Flags the widget for a rerun of the size_allocate_vfunc() function. More...
 
void size_allocate (const Allocation & allocation, int baseline)
 Allocates widget with a transformation that translates the origin to the position in allocation. More...
 
SizeRequestMode get_request_mode () const
 Gets whether the widget prefers a height-for-width layout or a width-for-height layout. More...
 
void measure (Orientation orientation, int for_size, int & minimum, int & natural, int & minimum_baseline, int & natural_baseline) const
 Measures widget in the orientation orientation and for the given for_size. More...
 
void get_preferred_size (Requisition & minimum_size, Requisition & natural_size) const
 Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management. More...
 
void set_layout_manager (const Glib::RefPtr< LayoutManager > & layout_manager)
 Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of widget. More...
 
void unset_layout_manager ()
 Undoes the effect of a previous call to set_layout_manager(). More...
 
Glib::RefPtr< LayoutManagerget_layout_manager ()
 Retrieves the layout manager used by widget. More...
 
Glib::RefPtr< const LayoutManagerget_layout_manager () const
 Retrieves the layout manager used by widget. More...
 
bool mnemonic_activate (bool group_cycling)
 Emits the signal_mnemonic_activate() signal. More...
 
bool activate ()
 For widgets that can be “activated” (buttons, menu items, etc.) this function activates them. More...
 
void set_can_focus (bool can_focus=true)
 Specifies whether the input focus can enter the widget or any of its children. More...
 
bool get_can_focus () const
 Determines whether the input focus can enter widget or any of its children. More...
 
void set_focusable (bool focusable=true)
 Specifies whether widget can own the input focus. More...
 
bool get_focusable () const
 Determines whether widget can own the input focus. More...
 
bool has_focus () const
 Determines if the widget has the global input focus. More...
 
bool is_focus () const
 Determines if the widget is the focus widget within its toplevel. More...
 
bool has_visible_focus () const
 Determines if the widget should show a visible indication that it has the global input focus. More...
 
bool grab_focus ()
 Causes widget to have the keyboard focus for the Gtk::Window it's inside. More...
 
void set_focus_on_click (bool focus_on_click=true)
 Sets whether the widget should grab focus when it is clicked with the mouse. More...
 
bool get_focus_on_click () const
 Returns whether the widget should grab focus when it is clicked with the mouse. More...
 
void set_can_target (bool can_target=true)
 Sets whether widget can be the target of pointer events. More...
 
bool get_can_target () const
 Queries whether widget can be the target of pointer events. More...
 
bool has_default () const
 Determines whether widget is the current default widget within its toplevel. More...
 
void set_receives_default (bool receives_default=true)
 Specifies whether widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default. More...
 
bool get_receives_default () const
 Determines whether widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default. More...
 
void set_name (const Glib::ustring & name)
 Sets a widgets name. More...
 
void unset_name ()
 
Glib::ustring get_name () const
 Retrieves the name of a widget. More...
 
void set_state_flags (StateFlags flags, bool clear=true)
 Turns on flag values in the current widget state. More...
 
void unset_state_flags (StateFlags flags)
 Turns off flag values for the current widget state. More...
 
StateFlags get_state_flags () const
 Returns the widget state as a flag set. More...
 
void set_sensitive (bool sensitive=true)
 Sets the sensitivity of a widget. More...
 
bool get_sensitive () const
 Returns the widget’s sensitivity. More...
 
bool is_sensitive () const
 Returns the widget’s effective sensitivity. More...
 
void set_visible (bool visible=true)
 Sets the visibility state of widget. More...
 
bool get_visible () const
 Determines whether the widget is visible. More...
 
bool is_visible () const
 Determines whether the widget and all its parents are marked as visible. More...
 
bool is_drawable () const
 Determines whether widget can be drawn to. More...
 
bool get_realized () const
 Determines whether widget is realized. More...
 
bool get_mapped () const
 Whether the widget is mapped. More...
 
void set_child_visible (bool visible=true)
 Sets whether widget should be mapped along with its parent. More...
 
bool get_child_visible () const
 Gets the value set with set_child_visible(). More...
 
int get_allocated_width () const
 Returns the width that has currently been allocated to widget. More...
 
int get_allocated_height () const
 Returns the height that has currently been allocated to widget. More...
 
int get_allocated_baseline () const
 Returns the baseline that has currently been allocated to widget. More...
 
Allocation get_allocation () const
 Retrieves the widget’s location. More...
 
int get_width () const
 Returns the content width of the widget. More...
 
int get_height () const
 Returns the content height of the widget. More...
 
int get_size (Orientation orientation) const
 Returns the content width or height of the widget. More...
 
Widgetget_parent ()
 Returns the parent widget of widget. More...
 
const Widgetget_parent () const
 Returns the parent widget of widget. More...
 
Rootget_root ()
 Returns the Gtk::Root widget of widget. More...
 
const Rootget_root () const
 Returns the Gtk::Root widget of widget. More...
 
Nativeget_native ()
 Returns the nearest Gtk::Native ancestor of widget. More...
 
const Nativeget_native () const
 Returns the nearest Gtk::Native ancestor of widget. More...
 
bool child_focus (DirectionType direction)
 Called by widgets as the user moves around the window using keyboard shortcuts. More...
 
bool keynav_failed (DirectionType direction)
 Emits the ::keynav-failed signal on the widget. More...
 
void error_bell ()
 Notifies the user about an input-related error on this widget. More...
 
void set_size_request (int width=-1, int height=-1)
 Sets the minimum size of a widget. More...
 
void get_size_request (int & width, int & height) const
 Gets the size request that was explicitly set for the widget using set_size_request(). More...
 
void set_opacity (double opacity)
 Request the widget to be rendered partially transparent. More...
 
double get_opacity () const
 #Fetches the requested opacity for this widget. More...
 
void set_overflow (Overflow overflow)
 Sets how widget treats content that is drawn outside the widget's content area. More...
 
Overflow get_overflow () const
 Returns the widgets overflow value. More...
 
Widgetget_ancestor (GType widget_type)
 Gets the first ancestor of widget with type widget_type. More...
 
const Widgetget_ancestor (GType widget_type) const
 Gets the first ancestor of widget with type widget_type. More...
 
int get_scale_factor () const
 Retrieves the internal scale factor that maps from window coordinates to the actual device pixels. More...
 
Glib::RefPtr< Gdk::Displayget_display ()
 Get the Gdk::Display for the toplevel window associated with this widget. More...
 
Glib::RefPtr< const Gdk::Displayget_display () const
 Get the Gdk::Display for the toplevel window associated with this widget. More...
 
Glib::RefPtr< Settingsget_settings ()
 Gets the settings object holding the settings used for this widget. More...
 
Glib::RefPtr< Gdk::Clipboardget_clipboard ()
 Gets the clipboard object for widget. More...
 
Glib::RefPtr< const Gdk::Clipboardget_clipboard () const
 Gets the clipboard object for widget. More...
 
Glib::RefPtr< Gdk::Clipboardget_primary_clipboard ()
 Gets the primary clipboard of widget. More...
 
Glib::RefPtr< const Gdk::Clipboardget_primary_clipboard () const
 Gets the primary clipboard of widget. More...
 
bool get_hexpand () const
 Gets whether the widget would like any available extra horizontal space. More...
 
void set_hexpand (bool expand=true)
 Sets whether the widget would like any available extra horizontal space. More...
 
bool get_hexpand_set () const
 Gets whether set_hexpand() has been used to explicitly set the expand flag on this widget. More...
 
void set_hexpand_set (bool set=true)
 Sets whether the hexpand flag will be used. More...
 
bool get_vexpand () const
 Gets whether the widget would like any available extra vertical space. More...
 
void set_vexpand (bool expand=true)
 Sets whether the widget would like any available extra vertical space. More...
 
bool get_vexpand_set () const
 Gets whether set_vexpand() has been used to explicitly set the expand flag on this widget. More...
 
void set_vexpand_set (bool set=true)
 Sets whether the vexpand flag will be used. More...
 
bool compute_expand (Orientation orientation)
 Computes whether a container should give this widget extra space when possible. More...
 
void set_expand (bool expand=true)
 Sets whether the widget would like any available extra space in both directions. More...
 
Align get_halign () const
 Gets the horizontal alignment of widget. More...
 
void set_halign (Align align)
 Sets the horizontal alignment of widget. More...
 
Align get_valign () const
 Gets the vertical alignment of widget. More...
 
void set_valign (Align align)
 Sets the vertical alignment of widget. More...
 
int get_margin_start () const
 Gets the start margin of widget. More...
 
void set_margin_start (int margin)
 Sets the start margin of widget. More...
 
int get_margin_end () const
 Gets the end margin of widget. More...
 
void set_margin_end (int margin)
 Sets the end margin of widget. More...
 
int get_margin_top () const
 Gets the top margin of widget. More...
 
void set_margin_top (int margin)
 Sets the top margin of widget. More...
 
int get_margin_bottom () const
 Gets the bottom margin of widget. More...
 
void set_margin_bottom (int margin)
 Sets the bottom margin of widget. More...
 
void set_margin (int margin)
 Set all 4 margins to the same value. More...
 
bool is_ancestor (Widget & ancestor) const
 Determines whether widget is somewhere inside ancestor, possibly with intermediate containers. More...
 
bool translate_coordinates (Widget & dest_widget, double src_x, double src_y, double & dest_x, double & dest_y)
 Translate coordinates relative to src_widget’s allocation to coordinates relative to dest_widget’s allocations. More...
 
bool contains (double x, double y) const
 Tests if the point at ( x, y) is contained in widget. More...
 
Widgetpick (double x, double y, PickFlags flags=PickFlags::DEFAULT)
 Finds the descendant of widget closest to the point ( x, y). More...
 
const Widgetpick (double x, double y, PickFlags flags=PickFlags::DEFAULT) const
 Finds the descendant of widget closest to the point ( x, y). More...
 
void add_controller (const Glib::RefPtr< EventController > & controller)
 Adds controller to widget so that it will receive events. More...
 
void remove_controller (const Glib::RefPtr< EventController > & controller)
 Removes controller from widget, so that it doesn't process events anymore. More...
 
Glib::RefPtr< Pango::Context > create_pango_context ()
 Creates a new Pango::Context with the appropriate font map, font options, font description, and base direction for drawing text for this widget. More...
 
Glib::RefPtr< Pango::Context > get_pango_context ()
 Gets a Pango::Context with the appropriate font map, font description, and base direction for this widget. More...
 
void set_font_options (const Cairo::FontOptions & options)
 Sets the cairo_font_options_t used for Pango rendering in this widget. More...
 
void unset_font_options ()
 Undoes the effect of previous calls to set_font_options(). More...
 
Cairo::FontOptions get_font_options () const
 Returns the cairo_font_options_t of widget. More...
 
Glib::RefPtr< Pango::Layout > create_pango_layout (const Glib::ustring & text)
 Creates a new Pango::Layout with the appropriate font map, font description, and base direction for drawing text for this widget. More...
 
void set_direction (TextDirection dir)
 Sets the reading direction on a particular widget. More...
 
TextDirection get_direction () const
 Gets the reading direction for a particular widget. More...
 
void set_cursor (const Glib::RefPtr< Gdk::Cursor > & cursor)
 Sets the cursor to be shown when pointer devices point towards widget. More...
 
void set_cursor (const Glib::ustring & name={})
 Sets a named cursor to be shown when pointer devices point towards the widget. More...
 
Glib::RefPtr< Gdk::Cursorget_cursor ()
 Queries the cursor set on widget. More...
 
Glib::RefPtr< const Gdk::Cursorget_cursor () const
 Queries the cursor set on widget. More...
 
std::vector< Widget * > list_mnemonic_labels ()
 Returns the widgets for which this widget is the target of a mnemonic. More...
 
std::vector< const Widget * > list_mnemonic_labels () const
 Returns the widgets for which this widget is the target of a mnemonic. More...
 
void add_mnemonic_label (Widget & label)
 Adds a widget to the list of mnemonic labels for this widget. More...
 
void remove_mnemonic_label (Widget & label)
 Removes a widget from the list of mnemonic labels for this widget. More...
 
bool drag_check_threshold (int start_x, int start_y, int current_x, int current_y)
 Checks to see if a drag movement has passed the GTK drag threshold. More...
 
Glib::RefPtr< Gdk::FrameClockget_frame_clock ()
 Obtains the frame clock for a widget. More...
 
Glib::RefPtr< const Gdk::FrameClockget_frame_clock () const
 Obtains the frame clock for a widget. More...
 
void set_parent (Widget & parent)
 Sets parent as the parent widget of widget. More...
 
void unparent ()
 Dissociate widget from its parent. More...
 
void map ()
 Causes a widget to be mapped if it isn’t already. More...
 
void unmap ()
 Causes a widget to be unmapped if it’s currently mapped. More...
 
void trigger_tooltip_query ()
 Triggers a tooltip query on the display where the toplevel of widget is located. More...
 
void set_tooltip_text (const Glib::ustring & text)
 Sets text as the contents of the tooltip. More...
 
Glib::ustring get_tooltip_text () const
 Gets the contents of the tooltip for widget. More...
 
void set_tooltip_markup (const Glib::ustring & markup)
 Sets markup as the contents of the tooltip, which is marked up with the Pango text markup language. More...
 
Glib::ustring get_tooltip_markup () const
 Gets the contents of the tooltip for widget. More...
 
void set_has_tooltip (bool has_tooltip=TRUE)
 Sets the has-tooltip property on widget to has_tooltip. More...
 
bool get_has_tooltip () const
 Returns the current value of the has-tooltip property. More...
 
bool in_destruction () const
 Returns whether the widget is currently being destroyed. More...
 
Glib::RefPtr< StyleContextget_style_context ()
 Returns the style context associated to widget. More...
 
Glib::RefPtr< const StyleContextget_style_context () const
 Returns the style context associated to widget. More...
 
guint add_tick_callback (const SlotTick & slot)
 Queues an animation frame update and adds a callback to be called before each frame. More...
 
void remove_tick_callback (guint id)
 Removes a tick callback previously registered with add_tick_callback(). More...
 
void insert_action_group (const Glib::ustring & name, const Glib::RefPtr< Gio::ActionGroup > & group)
 Inserts group into widget. More...
 
void remove_action_group (const Glib::ustring & name)
 Removes a group from the widget. More...
 
bool activate_action (const Glib::ustring & name, const Glib::VariantBase & args={})
 Looks up the action in the action groups associated with the widget and its ancestors, and activates it. More...
 
void activate_default ()
 Activates the default.activate action from widget. More...
 
void set_font_map (const Glib::RefPtr< Pango::FontMap > & font_map)
 Sets the font map to use for Pango rendering. More...
 
Glib::RefPtr< Pango::FontMap > get_font_map ()
 Gets the font map of widget. More...
 
Glib::RefPtr< const Pango::FontMap > get_font_map () const
 Gets the font map of widget. More...
 
Widgetget_first_child ()
 Returns the widgets first child. More...
 
const Widgetget_first_child () const
 Returns the widgets first child. More...
 
Widgetget_last_child ()
 Returns the widgets last child. More...
 
const Widgetget_last_child () const
 Returns the widgets last child. More...
 
Widgetget_next_sibling ()
 Returns the widgets next sibling. More...
 
const Widgetget_next_sibling () const
 Returns the widgets next sibling. More...
 
Widgetget_prev_sibling ()
 Returns the widgets previous sibling. More...
 
const Widgetget_prev_sibling () const
 Returns the widgets previous sibling. More...
 
Glib::RefPtr< Gio::ListModel > observe_children ()
 Returns a Gio::ListModel to track the children of widget. More...
 
Glib::RefPtr< const Gio::ListModel > observe_children () const
 Returns a Gio::ListModel to track the children of widget. More...
 
Glib::RefPtr< Gio::ListModel > observe_controllers ()
 Returns a Gio::ListModel to track the Gtk::EventControllers of widget. More...
 
Glib::RefPtr< const Gio::ListModel > observe_controllers () const
 Returns a Gio::ListModel to track the Gtk::EventControllers of widget. More...
 
void insert_after (Widget & parent, const Widget & previous_sibling)
 Inserts the Widget into the child widget list of parent after previous_sibling. More...
 
void insert_before (Widget & parent, const Widget & next_sibling)
 Inserts the Widget into the child widget list of parent before next_sibling. More...
 
void insert_at_start (Widget & parent)
 Inserts the Widget at the beginning of the child widget list of parent. More...
 
void insert_at_end (Widget & parent)
 Inserts the Widget at the end of the child widget list of parent. More...
 
void snapshot_child (Widget & child, const Glib::RefPtr< Gtk::Snapshot > & snapshot)
 Snapshot the a child of widget. More...
 
bool should_layout () const
 Returns whether widget should contribute to the measuring and allocation of its parent. More...
 
Glib::ustring get_css_name () const
 Returns the CSS name that is used for self. More...
 
void add_css_class (const Glib::ustring & css_class)
 Adds a style class to widget. More...
 
void remove_css_class (const Glib::ustring & css_class)
 Removes a style from widget. More...
 
bool has_css_class (const Glib::ustring & css_class) const
 Returns whether css_class is currently applied to widget. More...
 
std::vector< Glib::ustring > get_css_classes () const
 Returns the list of style classes applied to widget. More...
 
void set_css_classes (const std::vector< Glib::ustring > & classes)
 Clear all style classes applied to widget and replace them with classes. More...
 
Gdk::RGBA get_color () const
 Gets the current foreground color for the widget's CSS style. More...
 
Glib::SignalProxy< void()> signal_show ()
 
Glib::SignalProxy< void()> signal_hide ()
 
Glib::SignalProxy< void()> signal_map ()
 Emitted on mapping of a widget to the screen. More...
 
Glib::SignalProxy< void()> signal_unmap ()
 
Glib::SignalProxy< void()> signal_realize ()
 Emitted on realization of a widget. More...
 
Glib::SignalProxy< void()> signal_unrealize ()
 
Glib::SignalProxy< void(Gtk::StateFlags)> signal_state_flags_changed ()
 
Glib::SignalProxy< void(TextDirection)> signal_direction_changed ()
 
Glib::SignalProxy< bool(bool)> signal_mnemonic_activate ()
 
Glib::SignalProxy< void()> signal_destroy ()
 Emitted during the dispose phase. More...
 
Glib::SignalProxy< bool(int, int, bool, const Glib::RefPtr< Tooltip > &)> signal_query_tooltip ()
 
Glib::PropertyProxy< Glib::ustring > property_name ()
 The name of the widget. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_name () const
 The name of the widget. More...
 
Glib::PropertyProxy_ReadOnly< Widget * > property_parent () const
 The parent widget of this widget. More...
 
Glib::PropertyProxy_ReadOnly< Root * > property_root () const
 The Gtk::Root widget of the widget tree containing this widget. More...
 
Glib::PropertyProxy< int > property_width_request ()
 Override for width request of the widget. More...
 
Glib::PropertyProxy_ReadOnly< int > property_width_request () const
 Override for width request of the widget. More...
 
Glib::PropertyProxy< int > property_height_request ()
 Override for height request of the widget. More...
 
Glib::PropertyProxy_ReadOnly< int > property_height_request () const
 Override for height request of the widget. More...
 
Glib::PropertyProxy< bool > property_visible ()
 Whether the widget is visible. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_visible () const
 Whether the widget is visible. More...
 
Glib::PropertyProxy< bool > property_sensitive ()
 Whether the widget responds to input. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_sensitive () const
 Whether the widget responds to input. More...
 
Glib::PropertyProxy< bool > property_can_focus ()
 Whether the widget or any of its descendents can accept the input focus. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_can_focus () const
 Whether the widget or any of its descendents can accept the input focus. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_has_focus () const
 Whether the widget has the input focus. More...
 
Glib::PropertyProxy< bool > property_can_target ()
 Whether the widget can receive pointer events. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_can_target () const
 Whether the widget can receive pointer events. More...
 
Glib::PropertyProxy< bool > property_focus_on_click ()
 Whether the widget should grab focus when it is clicked with the mouse. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_focus_on_click () const
 Whether the widget should grab focus when it is clicked with the mouse. More...
 
Glib::PropertyProxy< bool > property_focusable ()
 Whether this widget itself will accept the input focus. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_focusable () const
 Whether this widget itself will accept the input focus. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_has_default () const
 Whether the widget is the default widget. More...
 
Glib::PropertyProxy< bool > property_receives_default ()
 Whether the widget will receive the default action when it is focused. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_receives_default () const
 Whether the widget will receive the default action when it is focused. More...
 
Glib::PropertyProxy< Glib::RefPtr< Gdk::Cursor > > property_cursor ()
 The cursor used by widget. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Cursor > > property_cursor () const
 The cursor used by widget. More...
 
Glib::PropertyProxy< bool > property_has_tooltip ()
 Enables or disables the emission of the signal_query_tooltip() signal on widget. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_has_tooltip () const
 Enables or disables the emission of the signal_query_tooltip() signal on widget. More...
 
Glib::PropertyProxy< Glib::ustring > property_tooltip_markup ()
 Sets the text of tooltip to be the given string, which is marked up with Pango markup. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_tooltip_markup () const
 Sets the text of tooltip to be the given string, which is marked up with Pango markup. More...
 
Glib::PropertyProxy< Glib::ustring > property_tooltip_text ()
 Sets the text of tooltip to be the given string. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_tooltip_text () const
 Sets the text of tooltip to be the given string. More...
 
Glib::PropertyProxy< Alignproperty_halign ()
 How to distribute horizontal space if widget gets extra space. More...
 
Glib::PropertyProxy_ReadOnly< Alignproperty_halign () const
 How to distribute horizontal space if widget gets extra space. More...
 
Glib::PropertyProxy< Alignproperty_valign ()
 How to distribute vertical space if widget gets extra space. More...
 
Glib::PropertyProxy_ReadOnly< Alignproperty_valign () const
 How to distribute vertical space if widget gets extra space. More...
 
Glib::PropertyProxy< int > property_margin_start ()
 Margin on start of widget, horizontally. More...
 
Glib::PropertyProxy_ReadOnly< int > property_margin_start () const
 Margin on start of widget, horizontally. More...
 
Glib::PropertyProxy< int > property_margin_end ()
 Margin on end of widget, horizontally. More...
 
Glib::PropertyProxy_ReadOnly< int > property_margin_end () const
 Margin on end of widget, horizontally. More...
 
Glib::PropertyProxy< int > property_margin_top ()
 Margin on top side of widget. More...
 
Glib::PropertyProxy_ReadOnly< int > property_margin_top () const
 Margin on top side of widget. More...
 
Glib::PropertyProxy< int > property_margin_bottom ()
 Margin on bottom side of widget. More...
 
Glib::PropertyProxy_ReadOnly< int > property_margin_bottom () const
 Margin on bottom side of widget. More...
 
Glib::PropertyProxy< bool > property_hexpand ()
 Whether to expand horizontally. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_hexpand () const
 Whether to expand horizontally. More...
 
Glib::PropertyProxy< bool > property_hexpand_set ()
 Whether to use the hexpand property. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_hexpand_set () const
 Whether to use the hexpand property. More...
 
Glib::PropertyProxy< bool > property_vexpand ()
 Whether to expand vertically. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_vexpand () const
 Whether to expand vertically. More...
 
Glib::PropertyProxy< bool > property_vexpand_set ()
 Whether to use the vexpand property. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_vexpand_set () const
 Whether to use the vexpand property. More...
 
Glib::PropertyProxy< double > property_opacity ()
 The requested opacity of the widget. More...
 
Glib::PropertyProxy_ReadOnly< double > property_opacity () const
 The requested opacity of the widget. More...
 
Glib::PropertyProxy< Overflowproperty_overflow ()
 How content outside the widget's content area is treated. More...
 
Glib::PropertyProxy_ReadOnly< Overflowproperty_overflow () const
 How content outside the widget's content area is treated. More...
 
Glib::PropertyProxy_ReadOnly< int > property_scale_factor () const
 The scale factor of the widget. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_css_name () const
 The name of this widget in the CSS tree. More...
 
Glib::PropertyProxy< std::vector< Glib::ustring > > property_css_classes ()
 A list of css classes applied to this widget. More...
 
Glib::PropertyProxy_ReadOnly< std::vector< Glib::ustring > > property_css_classes () const
 A list of css classes applied to this widget. More...
 
Glib::PropertyProxy< Glib::RefPtr< LayoutManager > > property_layout_manager ()
 The Gtk::LayoutManager instance to use to compute the preferred size of the widget, and allocate its children. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< LayoutManager > > property_layout_manager () const
 The Gtk::LayoutManager instance to use to compute the preferred size of the widget, and allocate its children. More...
 
- Public Member Functions inherited from Gtk::Object
 Object (Object && src) noexcept
 
Objectoperator= (Object && src) noexcept
 
 ~Object () noexcept override
 
- Public Member Functions inherited from Gtk::Accessible
 Accessible (Accessible && src) noexcept
 
Accessibleoperator= (Accessible && src) noexcept
 
 ~Accessible () noexcept override
 
GtkAccessible * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkAccessible * gobj () const
 Provides access to the underlying C GObject. More...
 
Role get_accessible_role () const
 Retrieves the Gtk::Accessible::Role for the given Gtk::Accessible. More...
 
void update_state (State state, const Glib::ValueBase & value)
 Updates an accessible state. More...
 
void update_property (Property property, const Glib::ValueBase & value)
 Updates an accessible property. More...
 
void update_relation (Relation relation, const Glib::ValueBase & value)
 Updates an accessible relation. More...
 
void reset_state (State state)
 Resets the accessible state to its default value. More...
 
void reset_property (Property property)
 Resets the accessible property to its default value. More...
 
void reset_relation (Relation relation)
 Resets the accessible relation to its default value. More...
 
Glib::PropertyProxy< Roleproperty_accessible_role ()
 The accessible role of the given Gtk::Accessible implementation. More...
 
Glib::PropertyProxy_ReadOnly< Roleproperty_accessible_role () const
 The accessible role of the given Gtk::Accessible implementation. More...
 
- Public Member Functions inherited from Gtk::Buildable
 Buildable (Buildable && src) noexcept
 
Buildableoperator= (Buildable && src) noexcept
 
 ~Buildable () noexcept override
 
GtkBuildable * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkBuildable * gobj () const
 Provides access to the underlying C GObject. More...
 
Glib::ustring get_buildable_id () const
 Gets the ID of the buildable object. More...
 
- Public Member Functions inherited from Gtk::ConstraintTarget
 ConstraintTarget (ConstraintTarget && src) noexcept
 
ConstraintTargetoperator= (ConstraintTarget && src) noexcept
 
 ~ConstraintTarget () noexcept override
 
GtkConstraintTarget * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkConstraintTarget * gobj () const
 Provides access to the underlying C GObject. More...
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
- Static Public Member Functions inherited from Gtk::Widget
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
static void set_default_direction (TextDirection dir)
 Sets the default reading direction for widgets. More...
 
static TextDirection get_default_direction ()
 Obtains the current default reading direction. More...
 
- Static Public Member Functions inherited from Gtk::Accessible
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
- Static Public Member Functions inherited from Gtk::Buildable
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
- Static Public Member Functions inherited from Gtk::ConstraintTarget
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 

Related Functions

(Note that these are not member functions.)

Gtk::Inscriptionwrap (GtkInscription * object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Gtk::Widget
virtual void root_vfunc ()
 
virtual void unroot_vfunc ()
 
virtual void size_allocate_vfunc (int width, int height, int baseline)
 
virtual SizeRequestMode get_request_mode_vfunc () const
 
virtual void measure_vfunc (Orientation orientation, int for_size, int & minimum, int & natural, int & minimum_baseline, int & natural_baseline) const
 
virtual bool grab_focus_vfunc ()
 
virtual void set_focus_child_vfunc (Widget * child)
 Sets the focused child of widget. More...
 
virtual void compute_expand_vfunc (bool & hexpand_p, bool & vexpand_p)
 
virtual bool contains_vfunc (double x, double y) const
 
virtual void snapshot_vfunc (const Glib::RefPtr< Gtk::Snapshot > & snapshot)
 
 Widget ()
 
void realize ()
 Creates the GDK resources associated with a widget. More...
 
void unrealize ()
 Causes a widget to be unrealized (frees all GDK resources associated with the widget). More...
 
void realize_if_needed ()
 
void set_focus_child (Widget & child)
 Set child as the current focus child of widget. More...
 
void unset_focus_child ()
 Unsets the focus child of the widget. More...
 
Widgetget_focus_child ()
 Returns the current focus child of widget. More...
 
const Widgetget_focus_child () const
 Returns the current focus child of widget. More...
 
virtual void on_show ()
 This is a default handler for the signal signal_show(). More...
 
virtual void on_hide ()
 This is a default handler for the signal signal_hide(). More...
 
virtual void on_map ()
 This is a default handler for the signal signal_map(). More...
 
virtual void on_unmap ()
 This is a default handler for the signal signal_unmap(). More...
 
virtual void on_realize ()
 This is a default handler for the signal signal_realize(). More...
 
virtual void on_unrealize ()
 This is a default handler for the signal signal_unrealize(). More...
 
virtual void on_state_flags_changed (Gtk::StateFlags previous_state_flags)
 This is a default handler for the signal signal_state_flags_changed(). More...
 
virtual void on_direction_changed (TextDirection direction)
 This is a default handler for the signal signal_direction_changed(). More...
 
virtual bool on_mnemonic_activate (bool group_cycling)
 This is a default handler for the signal signal_mnemonic_activate(). More...
 
virtual bool on_query_tooltip (int x, int y, bool keyboard_tooltip, const Glib::RefPtr< Tooltip > & tooltip)
 This is a default handler for the signal signal_query_tooltip(). More...
 
- Protected Member Functions inherited from Gtk::Accessible
 Accessible ()
 You should derive from this class to use it. More...
 
- Protected Member Functions inherited from Gtk::Buildable
 Buildable ()
 You should derive from this class to use it. More...
 
- Protected Member Functions inherited from Gtk::ConstraintTarget
 ConstraintTarget ()
 You should derive from this class to use it. More...
 

Detailed Description

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

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

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

Since gtkmm 4.8:

Constructor & Destructor Documentation

◆ Inscription() [1/4]

Gtk::Inscription::Inscription ( Inscription &&  src)
noexcept

◆ Inscription() [2/4]

Gtk::Inscription::Inscription ( const Inscription )
delete

◆ ~Inscription()

Gtk::Inscription::~Inscription ( )
overridenoexcept

◆ Inscription() [3/4]

Gtk::Inscription::Inscription ( )

◆ Inscription() [4/4]

Gtk::Inscription::Inscription ( const Glib::ustring &  text)
explicit

Creates a new Gtk::Inscription with the given text.

Parameters
textThe text.

Member Function Documentation

◆ get_attributes()

Pango::AttrList Gtk::Inscription::get_attributes ( ) const

Gets the inscription's attribute list.

Since gtkmm 4.8:
Returns
The attribute list.

◆ get_min_chars()

unsigned int Gtk::Inscription::get_min_chars ( ) const

Gets the min-chars of the inscription.

See the property_min_chars() property.

Since gtkmm 4.8:
Returns
The min-chars property.

◆ get_min_lines()

unsigned int Gtk::Inscription::get_min_lines ( ) const

Gets the min-lines of the inscription.

See the property_min_lines() property.

Since gtkmm 4.8:
Returns
The min-lines property.

◆ get_nat_chars()

unsigned int Gtk::Inscription::get_nat_chars ( ) const

Gets the nat-chars of the inscription.

See the property_nat_chars() property.

Since gtkmm 4.8:
Returns
The nat-chars property.

◆ get_nat_lines()

unsigned int Gtk::Inscription::get_nat_lines ( ) const

Gets the nat-lines of the inscription.

See the property_nat_lines() property.

Since gtkmm 4.8:
Returns
The nat-lines property.

◆ get_text()

Glib::ustring Gtk::Inscription::get_text ( ) const

Gets the text that is displayed.

Since gtkmm 4.8:
Returns
The displayed text.

◆ get_text_overflow()

Inscription::Overflow Gtk::Inscription::get_text_overflow ( ) const

Gets the inscription's overflow method.

Since gtkmm 4.8:
Returns
The overflow method.

◆ get_type()

static GType Gtk::Inscription::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

◆ get_wrap_mode()

Pango::WrapMode Gtk::Inscription::get_wrap_mode ( ) const

Returns line wrap mode used by the inscription.

See set_wrap_mode().

Since gtkmm 4.8:
Returns
The line wrap mode.

◆ get_xalign()

float Gtk::Inscription::get_xalign ( ) const

Gets the xalign of the inscription.

See the property_xalign() property.

Since gtkmm 4.8:
Returns
The xalign property.

◆ get_yalign()

float Gtk::Inscription::get_yalign ( ) const

Gets the yalign of the inscription.

See the property_yalign() property.

Since gtkmm 4.8:
Returns
The yalign property.

◆ gobj() [1/2]

GtkInscription* Gtk::Inscription::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkInscription* Gtk::Inscription::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ operator=() [1/2]

Inscription& Gtk::Inscription::operator= ( const Inscription )
delete

◆ operator=() [2/2]

Inscription& Gtk::Inscription::operator= ( Inscription &&  src)
noexcept

◆ property_attributes() [1/2]

Glib::PropertyProxy< Pango::AttrList > Gtk::Inscription::property_attributes ( )

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

Since gtkmm 4.8:
Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_attributes() [2/2]

Glib::PropertyProxy_ReadOnly< Pango::AttrList > Gtk::Inscription::property_attributes ( ) const

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

Since gtkmm 4.8:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_markup()

Glib::PropertyProxy_WriteOnly< Glib::ustring > Gtk::Inscription::property_markup ( )

Utility property that sets both the property_text() and property_attributes() properties, mainly intended for use in GtkBuilder ui files to ease translation support and bindings.

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

Since gtkmm 4.8:

Default value: ""

Returns
A PropertyProxy_WriteOnly that allows you to set the value of the property, or receive notification when the value of the property changes.

◆ property_min_chars() [1/2]

Glib::PropertyProxy< unsigned int > Gtk::Inscription::property_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.

Since gtkmm 4.8:

Default value: 3

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_min_chars() [2/2]

Glib::PropertyProxy_ReadOnly< unsigned int > Gtk::Inscription::property_min_chars ( ) const

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.

Since gtkmm 4.8:

Default value: 3

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_min_lines() [1/2]

Glib::PropertyProxy< unsigned int > Gtk::Inscription::property_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.

Since gtkmm 4.8:

Default value: 1

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_min_lines() [2/2]

Glib::PropertyProxy_ReadOnly< unsigned int > Gtk::Inscription::property_min_lines ( ) const

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.

Since gtkmm 4.8:

Default value: 1

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_nat_chars() [1/2]

Glib::PropertyProxy< unsigned int > Gtk::Inscription::property_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 property_min_chars(), that value will be used. In particular, for the default value of 0, this will always be the case.

Since gtkmm 4.8:

Default value: 0

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_nat_chars() [2/2]

Glib::PropertyProxy_ReadOnly< unsigned int > Gtk::Inscription::property_nat_chars ( ) const

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 property_min_chars(), that value will be used. In particular, for the default value of 0, this will always be the case.

Since gtkmm 4.8:

Default value: 0

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_nat_lines() [1/2]

Glib::PropertyProxy< unsigned int > Gtk::Inscription::property_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 property_min_lines(), that value will be used. In particular, for the default value of 0, this will always be the case.

Since gtkmm 4.8:

Default value: 0

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_nat_lines() [2/2]

Glib::PropertyProxy_ReadOnly< unsigned int > Gtk::Inscription::property_nat_lines ( ) const

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 property_min_lines(), that value will be used. In particular, for the default value of 0, this will always be the case.

Since gtkmm 4.8:

Default value: 0

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_text() [1/2]

Glib::PropertyProxy< Glib::ustring > Gtk::Inscription::property_text ( )

The displayed text.

Since gtkmm 4.8:

Default value: ""

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_text() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::Inscription::property_text ( ) const

The displayed text.

Since gtkmm 4.8:

Default value: ""

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_text_overflow() [1/2]

Glib::PropertyProxy< Inscription::Overflow > Gtk::Inscription::property_text_overflow ( )

The overflow method to use for the text.

Since gtkmm 4.8:

Default value: Gtk::Inscription::Overflow::CLIP

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_text_overflow() [2/2]

Glib::PropertyProxy_ReadOnly< Inscription::Overflow > Gtk::Inscription::property_text_overflow ( ) const

The overflow method to use for the text.

Since gtkmm 4.8:

Default value: Gtk::Inscription::Overflow::CLIP

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_wrap_mode() [1/2]

Glib::PropertyProxy< Pango::WrapMode > Gtk::Inscription::property_wrap_mode ( )

Controls how the line wrapping is done.

Note that unlike Gtk::Label, the default here is Pango::WrapMode::WORD_CHAR.

Since gtkmm 4.8:

Default value: Pango::WrapMode::WORD_CHAR

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_wrap_mode() [2/2]

Glib::PropertyProxy_ReadOnly< Pango::WrapMode > Gtk::Inscription::property_wrap_mode ( ) const

Controls how the line wrapping is done.

Note that unlike Gtk::Label, the default here is Pango::WrapMode::WORD_CHAR.

Since gtkmm 4.8:

Default value: Pango::WrapMode::WORD_CHAR

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_xalign() [1/2]

Glib::PropertyProxy< float > Gtk::Inscription::property_xalign ( )

The horizontal alignment of the text inside the allocated size.

Compare this to Gtk::Widget::property_halign(), which determines how the inscription's size allocation is positioned in the available space.

Since gtkmm 4.8:

Default value: 0

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_xalign() [2/2]

Glib::PropertyProxy_ReadOnly< float > Gtk::Inscription::property_xalign ( ) const

The horizontal alignment of the text inside the allocated size.

Compare this to Gtk::Widget::property_halign(), which determines how the inscription's size allocation is positioned in the available space.

Since gtkmm 4.8:

Default value: 0

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_yalign() [1/2]

Glib::PropertyProxy< float > Gtk::Inscription::property_yalign ( )

The vertical alignment of the text inside the allocated size.

Compare this to Gtk::Widget::property_valign(), which determines how the inscription's size allocation is positioned in the available space.

Since gtkmm 4.8:

Default value: 0.5

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_yalign() [2/2]

Glib::PropertyProxy_ReadOnly< float > Gtk::Inscription::property_yalign ( ) const

The vertical alignment of the text inside the allocated size.

Compare this to Gtk::Widget::property_valign(), which determines how the inscription's size allocation is positioned in the available space.

Since gtkmm 4.8:

Default value: 0.5

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ set_attributes()

void Gtk::Inscription::set_attributes ( Pango::AttrList &  attrs)

Apply attributes to the inscription text.

These attributes will not be evaluated for sizing the inscription.

Since gtkmm 4.8:
Parameters
attrsA Pango::AttrList.

◆ set_markup()

void Gtk::Inscription::set_markup ( const Glib::ustring &  markup)

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

See the property_markup() property.

Since gtkmm 4.8:
Parameters
markupThe markup to display.

◆ set_min_chars()

void Gtk::Inscription::set_min_chars ( unsigned int  min_chars)

Sets the min-chars of the inscription.

See the property_min_chars() property.

Since gtkmm 4.8:
Parameters
min_charsThe minimum number of characters that should fit, approximately.

◆ set_min_lines()

void Gtk::Inscription::set_min_lines ( unsigned int  min_lines)

Sets the min-lines of the inscription.

See the property_min_lines() property.

Since gtkmm 4.8:
Parameters
min_linesThe minimum number of lines that should fit, approximately.

◆ set_nat_chars()

void Gtk::Inscription::set_nat_chars ( unsigned int  nat_chars)

Sets the nat-chars of the inscription.

See the property_nat_chars() property.

Since gtkmm 4.8:
Parameters
nat_charsThe number of characters that should ideally fit, approximately.

◆ set_nat_lines()

void Gtk::Inscription::set_nat_lines ( unsigned int  nat_lines)

Sets the nat-lines of the inscription.

See the property_nat_lines() property.

Since gtkmm 4.8:
Parameters
nat_linesThe number of lines that should ideally fit.

◆ set_text()

void Gtk::Inscription::set_text ( const Glib::ustring &  text)

Sets the text to be displayed.

Since gtkmm 4.8:
Parameters
textThe text to display.

◆ set_text_overflow()

void Gtk::Inscription::set_text_overflow ( Overflow  overflow)

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

Since gtkmm 4.8:
Parameters
overflowThe overflow method to use.

◆ set_wrap_mode()

void Gtk::Inscription::set_wrap_mode ( Pango::WrapMode  wrap_mode)

Controls how line wrapping is done.

Since gtkmm 4.8:
Parameters
wrap_modeThe line wrapping mode.

◆ set_xalign()

void Gtk::Inscription::set_xalign ( float  xalign)

Sets the xalign of the inscription.

See the property_xalign() property.

Since gtkmm 4.8:
Parameters
xalignThe new xalign value, between 0 and 1.

◆ set_yalign()

void Gtk::Inscription::set_yalign ( float  yalign)

Sets the yalign of the inscription.

See the property_yalign() property.

Since gtkmm 4.8:
Parameters
yalignThe new yalign value, between 0 and 1.

Friends And Related Function Documentation

◆ wrap()

Gtk::Inscription * wrap ( GtkInscription *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.