gtkmm: Gtk::Label Class Reference
A widget that displays a small to medium amount of text. More...
#include <gtkmm/label.h>
Public Member Functions | |
Label (Label&& src) noexcept | |
Label& | operator= (Label&& src) noexcept |
Label (const Label&)=delete | |
Label& | operator= (const Label&)=delete |
~Label () noexcept override | |
GtkLabel* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkLabel* | gobj () const |
Provides access to the underlying C GObject. More... | |
Label () | |
Label (const Glib::ustring& label, bool mnemonic=false) | |
Label (const Glib::ustring& label, Align halign, Align valign=Align::CENTER, bool mnemonic=false) | |
This constructor is a shortcut to create a Label with Widget alignment properties different from the default Align::FILL. More... | |
void | set_text (const Glib::ustring& str) |
Sets the text within the Gtk::Label widget. More... | |
Glib::ustring | get_text () const |
Fetches the text from a label widget, as displayed on the screen. More... | |
void | set_attributes (Pango::AttrList& attrs) |
Sets a Pango::AttrList; the attributes in the list are applied to the label text. More... | |
Pango::AttrList | get_attributes () const |
Gets the attribute list that was set on the label using set_attributes(), if any. More... | |
void | set_label (const Glib::ustring& str) |
Sets the text of the label. More... | |
Glib::ustring | get_label () const |
Fetches the text from a label widget including any embedded underlines indicating mnemonics and Pango markup. More... | |
void | set_markup (const Glib::ustring& str) |
Parses str which is marked up with the [Pango text markup language][PangoMarkupFormat], setting the label’s text and attribute list based on the parse results. More... | |
void | set_use_markup (bool setting=true) |
Sets whether the text of the label contains markup in [Pango’s text markup language][PangoMarkupFormat]. More... | |
bool | get_use_markup () const |
Returns whether the label’s text is interpreted as marked up with the [Pango text markup language][PangoMarkupFormat]. More... | |
void | set_use_underline (bool setting=true) |
If true, an underline in the text indicates the next character should be used for the mnemonic accelerator key. More... | |
bool | get_use_underline () const |
Returns whether an embedded underline in the label indicates a mnemonic. More... | |
void | set_markup_with_mnemonic (const Glib::ustring& str) |
Parses str which is marked up with the [Pango text markup language][PangoMarkupFormat], setting the label’s text and attribute list based on the parse results. More... | |
guint | get_mnemonic_keyval () const |
If the label has been set so that it has a mnemonic key this function returns the keyval used for the mnemonic accelerator. More... | |
void | set_mnemonic_widget (Widget& widget) |
If the label has been set so that it has a mnemonic key (using i.e. set_markup_with_mnemonic(), set_text_with_mnemonic(), new_with_mnemonic() or the “use_underline” property) the label can be associated with a widget that is the target of the mnemonic. More... | |
Widget* | get_mnemonic_widget () |
Retrieves the target of the mnemonic (keyboard shortcut) of this label. More... | |
const Widget* | get_mnemonic_widget () const |
Retrieves the target of the mnemonic (keyboard shortcut) of this label. More... | |
void | set_text_with_mnemonic (const Glib::ustring& str) |
Sets the label’s text from the string str. More... | |
void | set_justify (Justification jtype) |
Sets the alignment of the lines in the text of the label relative to each other. More... | |
Justification | get_justify () const |
Returns the justification of the label. More... | |
void | set_ellipsize (Pango::EllipsizeMode mode) |
Sets the mode used to ellipsize (add an ellipsis: "...") to the text if there is not enough space to render the entire string. More... | |
Pango::EllipsizeMode | get_ellipsize () const |
Returns the ellipsizing position of the label. More... | |
void | set_width_chars (int n_chars) |
Sets the desired width in characters of label to n_chars. More... | |
int | get_width_chars () const |
Retrieves the desired width of label, in characters. More... | |
void | set_max_width_chars (int n_chars) |
Sets the desired maximum width in characters of label to n_chars. More... | |
int | get_max_width_chars () const |
Retrieves the desired maximum width of label, in characters. More... | |
void | set_lines (int lines) |
Sets the number of lines to which an ellipsized, wrapping label should be limited. More... | |
int | get_lines () const |
Gets the number of lines to which an ellipsized, wrapping label should be limited. More... | |
void | set_wrap (bool wrap=true) |
Toggles line wrapping within the Gtk::Label widget. More... | |
bool | get_wrap () const |
Returns whether lines in the label are automatically wrapped. More... | |
void | set_wrap_mode (Pango::WrapMode wrap_mode) |
If line wrapping is on (see set_wrap()) this controls how the line wrapping is done. More... | |
Pango::WrapMode | get_wrap_mode () const |
Returns line wrap mode used by the label. More... | |
void | set_selectable (bool setting=true) |
Selectable labels allow the user to select text from the label, for copy-and-paste. More... | |
bool | get_selectable () const |
Gets the value set by set_selectable(). More... | |
void | select_region (int start_offset, int end_offset) |
Selects a range of characters in the label, if the label is selectable. More... | |
void | select_region (int start_offset) |
Selects a range of characters in the label, from start_offset to the end, if the label is selectable. More... | |
bool | get_selection_bounds (int&start, int&end) const |
Gets the selected range of characters in the label, returning true if there’s a selection. More... | |
Glib::RefPtr< Pango::Layout > | get_layout () |
Gets the Pango::Layout used to display the label. More... | |
Glib::RefPtr< const Pango::Layout > | get_layout () const |
Gets the Pango::Layout used to display the label. More... | |
void | get_layout_offsets (int& x, int& y) const |
Obtains the coordinates where the label will draw the Pango::Layout representing the text in the label; useful to convert mouse events into coordinates inside the Pango::Layout, e.g. to take some action if some part of the label is clicked. More... | |
void | set_single_line_mode (bool single_line_mode=true) |
Sets whether the label is in single line mode. More... | |
bool | get_single_line_mode () const |
Returns whether the label is in single line mode. More... | |
Glib::ustring | get_current_uri () const |
Returns the URI for the currently active link in the label. More... | |
void | set_xalign (float xalign) |
Sets the Gtk::Label::property_xalign() property for label. More... | |
float | get_xalign () const |
Gets the Gtk::Label::property_xalign() property for label. More... | |
void | set_yalign (float yalign) |
Sets the Gtk::Label::property_yalign() property for label. More... | |
float | get_yalign () const |
Gets the Gtk::Label::property_yalign() property for label. More... | |
void | set_extra_menu (const Glib::RefPtr< Gio::MenuModel >& model) |
Sets a menu model to add when constructing the context menu for label. More... | |
Glib::RefPtr< Gio::MenuModel > | get_extra_menu () |
Gets the menu model set with set_extra_menu(). More... | |
Glib::RefPtr< const Gio::MenuModel > | get_extra_menu () const |
Gets the menu model set with set_extra_menu(). More... | |
Glib::SignalProxy< bool(const Glib::ustring&)> | signal_activate_link () |
Glib::PropertyProxy< Glib::ustring > | property_label () |
The contents of the label. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_label () const |
The contents of the label. More... | |
Glib::PropertyProxy< Pango::AttrList > | property_attributes () |
A list of style attributes to apply to the text of the label. More... | |
Glib::PropertyProxy_ReadOnly< Pango::AttrList > | property_attributes () const |
A list of style attributes to apply to the text of the label. More... | |
Glib::PropertyProxy< bool > | property_use_markup () |
The text of the label includes XML markup. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_use_markup () const |
The text of the label includes XML markup. More... | |
Glib::PropertyProxy< bool > | property_use_underline () |
If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_use_underline () const |
If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key. More... | |
Glib::PropertyProxy< Justification > | property_justify () |
The alignment of the lines in the text of the label relative to each other. More... | |
Glib::PropertyProxy_ReadOnly< Justification > | property_justify () const |
The alignment of the lines in the text of the label relative to each other. More... | |
Glib::PropertyProxy< bool > | property_wrap () |
If set, wrap lines if the text becomes too wide. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_wrap () const |
If set, wrap lines if the text becomes too wide. More... | |
Glib::PropertyProxy< Pango::WrapMode > | property_wrap_mode () |
If line wrapping is on (see the Gtk::Label::property_wrap() property) this controls how the line wrapping is done. More... | |
Glib::PropertyProxy_ReadOnly< Pango::WrapMode > | property_wrap_mode () const |
If line wrapping is on (see the Gtk::Label::property_wrap() property) this controls how the line wrapping is done. More... | |
Glib::PropertyProxy< bool > | property_selectable () |
Whether the label text can be selected with the mouse. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_selectable () const |
Whether the label text can be selected with the mouse. More... | |
Glib::PropertyProxy_ReadOnly< guint > | property_mnemonic_keyval () const |
The mnemonic accelerator key for this label. More... | |
Glib::PropertyProxy< Widget* > | property_mnemonic_widget () |
The widget to be activated when the label’s mnemonic key is pressed. More... | |
Glib::PropertyProxy_ReadOnly< Widget* > | property_mnemonic_widget () const |
The widget to be activated when the label’s mnemonic key is pressed. More... | |
Glib::PropertyProxy< Pango::EllipsizeMode > | property_ellipsize () |
The preferred place to ellipsize the string, if the label does not have enough room to display the entire string, specified as a Pango::EllipsizeMode. More... | |
Glib::PropertyProxy_ReadOnly< Pango::EllipsizeMode > | property_ellipsize () const |
The preferred place to ellipsize the string, if the label does not have enough room to display the entire string, specified as a Pango::EllipsizeMode. More... | |
Glib::PropertyProxy< int > | property_width_chars () |
The desired width of the label, in characters. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_width_chars () const |
The desired width of the label, in characters. More... | |
Glib::PropertyProxy< bool > | property_single_line_mode () |
Whether the label is in single line mode. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_single_line_mode () const |
Whether the label is in single line mode. More... | |
Glib::PropertyProxy< int > | property_max_width_chars () |
The desired maximum width of the label, in characters. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_max_width_chars () const |
The desired maximum width of the label, in characters. More... | |
Glib::PropertyProxy< int > | property_lines () |
The number of lines to which an ellipsized, wrapping label should be limited. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_lines () const |
The number of lines to which an ellipsized, wrapping label should be limited. More... | |
Glib::PropertyProxy< float > | property_xalign () |
The xalign property determines the horizontal alignment of the label text inside the labels size allocation. More... | |
Glib::PropertyProxy_ReadOnly< float > | property_xalign () const |
The xalign property determines the horizontal alignment of the label text inside the labels size allocation. More... | |
Glib::PropertyProxy< float > | property_yalign () |
The yalign property determines the vertical alignment of the label text inside the labels size allocation. More... | |
Glib::PropertyProxy_ReadOnly< float > | property_yalign () const |
The yalign property determines the vertical alignment of the label text inside the labels size allocation. More... | |
Glib::PropertyProxy< Glib::RefPtr< Gio::MenuModel > > | property_extra_menu () |
A menu model whose contents will be appended to the context menu. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gio::MenuModel > > | property_extra_menu () const |
A menu model whose contents will be appended to the context menu. More... | |
Public Member Functions inherited from Gtk::Widget | |
Widget (Widget&& src) noexcept | |
Widget& | operator= (Widget&& src) noexcept |
Widget (const Widget&)=delete | |
Widget& | operator= (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< ConstraintTarget > | make_refptr_constrainttarget () |
Converts this widget to a reference counted Gtk::ConstraintTarget. More... | |
Glib::RefPtr< const ConstraintTarget > | make_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(), causing the widget to be hidden (invisible to the user). More... | |
void | queue_draw () |
Schedules this widget to be redrawn in paint phase of the current or the next frame. More... | |
void | queue_resize () |
This function is only for use in widget implementations. More... | |
void | queue_allocate () |
This function is only for use in widget implementations. More... | |
void | size_allocate (const Allocation& allocation, int baseline) |
This is a simple form of allocate() that takes the new position of widget as part of 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< LayoutManager > | get_layout_manager () |
Retrieves the layout manager set using set_layout_manager(). More... | |
Glib::RefPtr< const LayoutManager > | get_layout_manager () const |
Retrieves the layout manager set using set_layout_manager(). More... | |
bool | mnemonic_activate (bool group_cycling) |
Emits the Gtk::Widget::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 (or one of its descendents) 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) |
Widgets can be named, which allows you to refer to them from a CSS file. 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) |
This function is for use in widget implementations. More... | |
void | unset_state_flags (StateFlags flags) |
This function is for use in widget implementations. 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 (in the sense of returning the value that has been set using set_sensitive()). More... | |
bool | is_sensitive () const |
Returns the widget’s effective sensitivity, which means it is sensitive itself and also its parent widget is sensitive. 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 when its parent is mapped and widget has been shown with show(). 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, as passed to its size-allocate implementation. More... | |
int | get_height () const |
Returns the content height of the widget, as passed to its size-allocate implementation. More... | |
int | get_size (Orientation orientation) const |
Returns the content width or height of the widget, depending on orientation. More... | |
Widget* | get_parent () |
Returns the parent widget of widget. More... | |
const Widget* | get_parent () const |
Returns the parent widget of widget. More... | |
Root* | get_root () |
Returns the Gtk::Root widget of widget or nullptr if the widget is not contained inside a widget tree with a root widget. More... | |
const Root* | get_root () const |
Returns the Gtk::Root widget of widget or nullptr if the widget is not contained inside a widget tree with a root widget. More... | |
Native* | get_native () |
Returns the GtkNative widget that contains widget, or nullptr if the widget is not contained inside a widget tree with a native ancestor. More... | |
const Native* | get_native () const |
Returns the GtkNative widget that contains widget, or nullptr if the widget is not contained inside a widget tree with a native ancestor. More... | |
bool | child_focus (DirectionType direction) |
This function is used by custom widget implementations; if you're writing an app, you’d use grab_focus() to move the focus to a particular widget. More... | |
bool | keynav_failed (DirectionType direction) |
This function should be called whenever keyboard navigation within a single widget hits a boundary. 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; that is, the widget’s size request will be at least width by height. 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, with opacity 0 being fully transparent and 1 fully opaque. 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 value set via set_overflow(). More... | |
Widget* | get_ancestor (GType widget_type) |
Gets the first ancestor of widget with type widget_type. More... | |
const Widget* | get_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::Display > | get_display () |
Get the Gdk::Display for the toplevel window associated with this widget. More... | |
Glib::RefPtr< const Gdk::Display > | get_display () const |
Get the Gdk::Display for the toplevel window associated with this widget. More... | |
Glib::RefPtr< Settings > | get_settings () |
Gets the settings object holding the settings used for this widget. More... | |
Glib::RefPtr< Gdk::Clipboard > | get_clipboard () |
This is a utility function to get the clipboard object for the Gdk::Display that widget is using. More... | |
Glib::RefPtr< const Gdk::Clipboard > | get_clipboard () const |
This is a utility function to get the clipboard object for the Gdk::Display that widget is using. More... | |
Glib::RefPtr< Gdk::Clipboard > | get_primary_clipboard () |
This is a utility function to get the primary clipboard object for the Gdk::Display that widget is using. More... | |
Glib::RefPtr< const Gdk::Clipboard > | get_primary_clipboard () const |
This is a utility function to get the primary clipboard object for the Gdk::Display that widget is using. 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 (see get_hexpand()) 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 (see get_vexpand()) 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 value of the Gtk::Widget::property_halign() property. More... | |
void | set_halign (Align align) |
Sets the horizontal alignment of widget. More... | |
Align | get_valign () const |
Gets the value of the Gtk::Widget::property_valign() property. More... | |
void | set_valign (Align align) |
Sets the vertical alignment of widget. More... | |
int | get_margin_start () const |
Gets the value of the Gtk::Widget::property_margin_start() property. More... | |
void | set_margin_start (int margin) |
Sets the start margin of widget. More... | |
int | get_margin_end () const |
Gets the value of the Gtk::Widget::property_margin_end() property. More... | |
void | set_margin_end (int margin) |
Sets the end margin of widget. More... | |
int | get_margin_top () const |
Gets the value of the Gtk::Widget::property_margin_top() property. More... | |
void | set_margin_top (int margin) |
Sets the top margin of widget. More... | |
int | get_margin_bottom () const |
Gets the value of the Gtk::Widget::property_margin_bottom() property. 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... | |
Widget* | pick (double x, double y, PickFlags flags=PickFlags::DEFAULT) |
Finds the descendant of widget (including widget itself) closest to the screen at the point ( x, y). More... | |
const Widget* | pick (double x, double y, PickFlags flags=PickFlags::DEFAULT) const |
Finds the descendant of widget (including widget itself) closest to the screen at 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 used for Pango rendering. 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::Cursor > | get_cursor () |
Queries the cursor set via set_cursor(). More... | |
Glib::RefPtr< const Gdk::Cursor > | get_cursor () const |
Queries the cursor set via set_cursor(). More... | |
std::vector< Widget* > | list_mnemonic_labels () |
Returns a newly allocated list of the widgets, normally labels, for which this widget is the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget()). More... | |
std::vector< const Widget* > | list_mnemonic_labels () const |
Returns a newly allocated list of the widgets, normally labels, for which this widget is the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget()). 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 mouse drag starting at ( start_x, start_y) and ending at ( current_x, current_y) has passed the GTK drag threshold, and thus should trigger the beginning of a drag-and-drop operation. More... | |
Glib::RefPtr< Gdk::FrameClock > | get_frame_clock () |
Obtains the frame clock for a widget. More... | |
Glib::RefPtr< const Gdk::FrameClock > | get_frame_clock () const |
Obtains the frame clock for a widget. More... | |
void | set_parent (Widget& parent) |
This function is useful only when implementing subclasses of Gtk::Widget. More... | |
void | unparent () |
This function is only for use in widget implementations. More... | |
void | map () |
This function is only for use in widget implementations. More... | |
void | unmap () |
This function is only for use in widget implementations. 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 set using set_tooltip_markup(). 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< StyleContext > | get_style_context () |
Returns the style context associated to widget. More... | |
Glib::RefPtr< const StyleContext > | get_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 () |
Activate 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 that has been set with set_font_map(). More... | |
Glib::RefPtr< const Pango::FontMap > | get_font_map () const |
Gets the font map that has been set with set_font_map(). More... | |
Widget* | get_first_child () |
Returns the widgets first child. More... | |
const Widget* | get_first_child () const |
Returns the widgets first child. More... | |
Widget* | get_last_child () |
Returns the widgets last child. More... | |
const Widget* | get_last_child () const |
Returns the widgets last child. More... | |
Widget* | get_next_sibling () |
Returns the widgets next sibling. More... | |
const Widget* | get_next_sibling () const |
Returns the widgets next sibling. More... | |
Widget* | get_prev_sibling () |
Returns the widgets previous sibling. More... | |
const Widget* | get_prev_sibling () const |
Returns the widgets previous sibling. More... | |
Glib::RefPtr< Gio::ListModel > | observe_children () |
Returns a ListModel to track the children of widget. More... | |
Glib::RefPtr< const Gio::ListModel > | observe_children () const |
Returns a ListModel to track the children of widget. More... | |
Glib::RefPtr< Gio::ListModel > | observe_controllers () |
Returns a ListModel to track the Gtk::EventControllers of widget. More... | |
Glib::RefPtr< const Gio::ListModel > | observe_controllers () const |
Returns a 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) |
When a widget receives a call to the snapshot function, it must send synthetic Gtk::WidgetClass.snapshot() calls to all children. 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 css_class to widget. More... | |
void | remove_css_class (const Glib::ustring& css_class) |
Removes css_class 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 css classes applied to widget. More... | |
void | set_css_classes (const std::vector< Glib::ustring >& classes) |
Will clear all css classes applied to widget and replace them with classes. 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< 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 or nullptr if the widget is not contained in a root widget. More... | |
Glib::PropertyProxy< int > | property_width_request () |
Override for width request of the widget, or -1 if natural request should be used. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_width_request () const |
Override for width request of the widget, or -1 if natural request should be used. More... | |
Glib::PropertyProxy< int > | property_height_request () |
Override for height request of the widget, or -1 if natural request should be used. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_height_request () const |
Override for height request of the widget, or -1 if natural request should be used. 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 () |
If true , the widget will receive the default action when it is focused. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_receives_default () const |
If true , 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 Gtk::Widget::signal_query_tooltip() on widget. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_has_tooltip () const |
Enables or disables the emission of Gtk::Widget::signal_query_tooltip() 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 the [Pango text markup language][PangoMarkupFormat]. 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 the [Pango text markup language][PangoMarkupFormat]. 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< Align > | property_halign () |
How to distribute horizontal space if widget gets extra space, see Gtk::Align. More... | |
Glib::PropertyProxy_ReadOnly< Align > | property_halign () const |
How to distribute horizontal space if widget gets extra space, see Gtk::Align. More... | |
Glib::PropertyProxy< Align > | property_valign () |
How to distribute vertical space if widget gets extra space, see Gtk::Align. More... | |
Glib::PropertyProxy_ReadOnly< Align > | property_valign () const |
How to distribute vertical space if widget gets extra space, see Gtk::Align. 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 Gtk::Widget::property_hexpand() property. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_hexpand_set () const |
Whether to use the Gtk::Widget::property_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 Gtk::Widget::property_vexpand() property. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_vexpand_set () const |
Whether to use the Gtk::Widget::property_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< Overflow > | property_overflow () |
How content outside the widget's content area is treated. More... | |
Glib::PropertyProxy_ReadOnly< Overflow > | property_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 | |
Object& | operator= (Object&& src) noexcept |
~Object () noexcept override | |
Public Member Functions inherited from Glib::Object | |
Object (const Object &)=delete | |
Object & | operator= (const Object &)=delete |
Object (Object &&src) noexcept | |
Object & | operator= (Object &&src) noexcept |
void * | get_data (const QueryQuark &key) |
void | set_data (const Quark &key, void *data) |
void | set_data (const Quark &key, void *data, DestroyNotify notify) |
void | remove_data (const QueryQuark &quark) |
void * | steal_data (const QueryQuark &quark) |
Glib::RefPtr< Glib::Object > | wrap (GObject *object, bool take_copy=false) |
Public Member Functions inherited from Glib::ObjectBase | |
ObjectBase (const ObjectBase &)=delete | |
ObjectBase & | operator= (const ObjectBase &)=delete |
void | set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value) |
void | get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const |
void | set_property (const Glib::ustring &property_name, const PropertyType &value) |
void | get_property (const Glib::ustring &property_name, PropertyType &value) const |
PropertyType | get_property (const Glib::ustring &property_name) const |
sigc::connection | connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot) |
sigc::connection | connect_property_changed (const Glib::ustring &property_name, sigc::slot< void()> &&slot) |
void | freeze_notify () |
void | thaw_notify () |
virtual void | reference () const |
virtual void | unreference () const |
GObject * | gobj () |
const GObject * | gobj () const |
GObject * | gobj_copy () const |
Public Member Functions inherited from sigc::trackable | |
trackable () noexcept | |
trackable (const trackable &src) noexcept | |
trackable (trackable &&src) noexcept | |
~trackable () | |
void | add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const |
void | notify_callbacks () |
trackable & | operator= (const trackable &src) |
trackable & | operator= (trackable &&src) noexcept |
void | remove_destroy_notify_callback (notifiable *data) const |
Public Member Functions inherited from Gtk::Accessible | |
Accessible (Accessible&& src) noexcept | |
Accessible& | operator= (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< Role > | property_accessible_role () |
The accessible role of the given Gtk::Accessible implementation. More... | |
Glib::PropertyProxy_ReadOnly< Role > | property_accessible_role () const |
The accessible role of the given Gtk::Accessible implementation. More... | |
Public Member Functions inherited from Glib::Interface | |
Interface () | |
Interface (Interface &&src) noexcept | |
Interface & | operator= (Interface &&src) noexcept |
Interface (const Glib::Interface_Class &interface_class) | |
Interface (GObject *castitem) | |
~Interface () noexcept override | |
Interface (const Interface &)=delete | |
Interface & | operator= (const Interface &)=delete |
GObject * | gobj () |
const GObject * | gobj () const |
Public Member Functions inherited from Gtk::Buildable | |
Buildable (Buildable&& src) noexcept | |
Buildable& | operator= (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 | |
ConstraintTarget& | operator= (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 where the direction has not been explicitly set by set_direction(). 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::Label* | wrap (GtkLabel* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::Widget | |
Gtk::Widget* | wrap (GtkWidget* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::Accessible | |
Glib::RefPtr< Gtk::Accessible > | wrap (GtkAccessible* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::Buildable | |
Glib::RefPtr< Gtk::Buildable > | wrap (GtkBuildable* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::ConstraintTarget | |
Glib::RefPtr< Gtk::ConstraintTarget > | wrap (GtkConstraintTarget* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Detailed Description
A widget that displays a small to medium amount of text.
A simple setable widget for holding a Glib::ustring.
Key values are the codes which are sent whenever a key is pressed or released. The complete list of key values can be found in the gdk/gdkkeysyms.h header file. They are prefixed with GDK_KEY_
.
The Label widget looks like this:
Constructor & Destructor Documentation
|
noexcept |
|
delete |
|
overridenoexcept |
Gtk::Label::Label | ( | ) |
|
explicit |
Gtk::Label::Label | ( | const Glib::ustring & | label, |
Align | halign, | ||
Align | valign = Align::CENTER , |
||
bool | mnemonic = false |
||
) |
This constructor is a shortcut to create a Label with Widget alignment properties different from the default Align::FILL.
is equivalent to:
Member Function Documentation
Pango::AttrList Gtk::Label::get_attributes | ( | ) | const |
Gets the attribute list that was set on the label using set_attributes(), if any.
This function does not reflect attributes that come from the labels markup (see set_markup()). If you want to get the effective attributes for the label, use pango_layout_get_attribute (gtk_label_get_layout (self)).
- Returns
- The attribute list, or
nullptr
if none was set.
Glib::ustring Gtk::Label::get_current_uri | ( | ) | const |
Returns the URI for the currently active link in the label.
The active link is the one under the mouse pointer or, in a selectable label, the link in which the text cursor is currently positioned.
This function is intended for use in a Gtk::Label::signal_activate_link() handler or for use in a Gtk::Widget::signal_query_tooltip() handler.
- Returns
- The currently active URI or
nullptr
if there is none. The string is owned by GTK and must not be freed or modified.
Pango::EllipsizeMode Gtk::Label::get_ellipsize | ( | ) | const |
Glib::RefPtr<Gio::MenuModel> Gtk::Label::get_extra_menu | ( | ) |
Gets the menu model set with set_extra_menu().
- Returns
- The menu model.
Glib::RefPtr<const Gio::MenuModel> Gtk::Label::get_extra_menu | ( | ) | const |
Gets the menu model set with set_extra_menu().
- Returns
- The menu model.
Justification Gtk::Label::get_justify | ( | ) | const |
Glib::ustring Gtk::Label::get_label | ( | ) | const |
Fetches the text from a label widget including any embedded underlines indicating mnemonics and Pango markup.
(See get_text()).
- Returns
- The text of the label widget.
Glib::RefPtr<Pango::Layout> Gtk::Label::get_layout | ( | ) |
Gets the Pango::Layout used to display the label.
The layout is useful to e.g. convert text positions to pixel positions, in combination with get_layout_offsets().
- Returns
- The Pango::Layout for this label.
Glib::RefPtr<const Pango::Layout> Gtk::Label::get_layout | ( | ) | const |
Gets the Pango::Layout used to display the label.
The layout is useful to e.g. convert text positions to pixel positions, in combination with get_layout_offsets().
- Returns
- The Pango::Layout for this label.
void Gtk::Label::get_layout_offsets | ( | int & | x, |
int & | y | ||
) | const |
Obtains the coordinates where the label will draw the Pango::Layout representing the text in the label; useful to convert mouse events into coordinates inside the Pango::Layout, e.g. to take some action if some part of the label is clicked.
Remember when using the Pango::Layout functions you need to convert to and from pixels using PANGO_PIXELS() or Pango::SCALE.
- Parameters
-
x Location to store X offset of layout, or nullptr
.y Location to store Y offset of layout, or nullptr
.
int Gtk::Label::get_lines | ( | ) | const |
Gets the number of lines to which an ellipsized, wrapping label should be limited.
See set_lines().
- Returns
- The number of lines.
int Gtk::Label::get_max_width_chars | ( | ) | const |
Retrieves the desired maximum width of label, in characters.
See set_width_chars().
- Returns
- The maximum width of the label in characters.
guint Gtk::Label::get_mnemonic_keyval | ( | ) | const |
If the label has been set so that it has a mnemonic key this function returns the keyval used for the mnemonic accelerator.
If there is no mnemonic set up it returns #GDK_KEY_VoidSymbol.
- Returns
- GDK keyval usable for accelerators, or #GDK_KEY_VoidSymbol.
Widget* Gtk::Label::get_mnemonic_widget | ( | ) |
Retrieves the target of the mnemonic (keyboard shortcut) of this label.
- Returns
- The target of the label’s mnemonic, or
nullptr
if none has been set and the default algorithm will be used.
const Widget* Gtk::Label::get_mnemonic_widget | ( | ) | const |
Retrieves the target of the mnemonic (keyboard shortcut) of this label.
- Returns
- The target of the label’s mnemonic, or
nullptr
if none has been set and the default algorithm will be used.
bool Gtk::Label::get_selectable | ( | ) | const |
Gets the value set by set_selectable().
- Returns
true
if the user can copy text from the label.
bool Gtk::Label::get_selection_bounds | ( | int & | start, |
int & | end | ||
) | const |
Gets the selected range of characters in the label, returning true
if there’s a selection.
- Parameters
-
start Return location for start of selection, as a character offset. end Return location for end of selection, as a character offset.
- Returns
true
if selection is non-empty.
bool Gtk::Label::get_single_line_mode | ( | ) | const |
Returns whether the label is in single line mode.
- Returns
true
when the label is in single line mode.
Glib::ustring Gtk::Label::get_text | ( | ) | const |
Fetches the text from a label widget, as displayed on the screen.
This does not include any embedded underlines indicating mnemonics or Pango markup. (See get_label())
- Returns
- The text in the label widget.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
bool Gtk::Label::get_use_markup | ( | ) | const |
Returns whether the label’s text is interpreted as marked up with the [Pango text markup language][PangoMarkupFormat].
See set_use_markup().
- Returns
true
if the label’s text will be parsed for markup.
bool Gtk::Label::get_use_underline | ( | ) | const |
Returns whether an embedded underline in the label indicates a mnemonic.
See set_use_underline().
- Returns
true
whether an embedded underline in the label indicates the mnemonic accelerator keys.
int Gtk::Label::get_width_chars | ( | ) | const |
Retrieves the desired width of label, in characters.
See set_width_chars().
- Returns
- The width of the label in characters.
bool Gtk::Label::get_wrap | ( | ) | const |
Returns whether lines in the label are automatically wrapped.
See set_wrap().
- Returns
true
if the lines of the label are automatically wrapped.
Pango::WrapMode Gtk::Label::get_wrap_mode | ( | ) | const |
Returns line wrap mode used by the label.
See set_wrap_mode().
- Returns
true
if the lines of the label are automatically wrapped.
float Gtk::Label::get_xalign | ( | ) | const |
Gets the Gtk::Label::property_xalign() property for label.
- Returns
- The xalign property.
float Gtk::Label::get_yalign | ( | ) | const |
Gets the Gtk::Label::property_yalign() property for label.
- Returns
- The yalign property.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
Glib::PropertyProxy< Pango::AttrList > Gtk::Label::property_attributes | ( | ) |
A list of style attributes to apply to the text of the label.
- 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.
Glib::PropertyProxy_ReadOnly< Pango::AttrList > Gtk::Label::property_attributes | ( | ) | const |
A list of style attributes to apply to the text of the label.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Pango::EllipsizeMode > Gtk::Label::property_ellipsize | ( | ) |
The preferred place to ellipsize the string, if the label does not have enough room to display the entire string, specified as a Pango::EllipsizeMode.
Note that setting this property to a value other than Pango::EllipsizeMode::NONE has the side-effect that the label requests only enough space to display the ellipsis "...". In particular, this means that ellipsizing labels do not work well in notebook tabs, unless the Gtk::Notebook tab-expand child property is set to true
. Other ways to set a label's width are Gtk::Widget::set_size_request() and Gtk::Label::set_width_chars().
Default value: Pango::EllipsizeMode::NONE
- 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.
Glib::PropertyProxy_ReadOnly< Pango::EllipsizeMode > Gtk::Label::property_ellipsize | ( | ) | const |
The preferred place to ellipsize the string, if the label does not have enough room to display the entire string, specified as a Pango::EllipsizeMode.
Note that setting this property to a value other than Pango::EllipsizeMode::NONE has the side-effect that the label requests only enough space to display the ellipsis "...". In particular, this means that ellipsizing labels do not work well in notebook tabs, unless the Gtk::Notebook tab-expand child property is set to true
. Other ways to set a label's width are Gtk::Widget::set_size_request() and Gtk::Label::set_width_chars().
Default value: Pango::EllipsizeMode::NONE
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::RefPtr<Gio::MenuModel> > Gtk::Label::property_extra_menu | ( | ) |
A menu model whose contents will be appended to the context menu.
- 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.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gio::MenuModel> > Gtk::Label::property_extra_menu | ( | ) | const |
A menu model whose contents will be appended to the context menu.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Justification > Gtk::Label::property_justify | ( | ) |
The alignment of the lines in the text of the label relative to each other.
This does NOT affect the alignment of the label within its allocation. See GtkLabel:xalign for that.
Default value: Gtk::Justification::LEFT
- 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.
Glib::PropertyProxy_ReadOnly< Justification > Gtk::Label::property_justify | ( | ) | const |
The alignment of the lines in the text of the label relative to each other.
This does NOT affect the alignment of the label within its allocation. See GtkLabel:xalign for that.
Default value: Gtk::Justification::LEFT
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::ustring > Gtk::Label::property_label | ( | ) |
The contents of the label.
If the string contains [Pango XML markup][PangoMarkupFormat], you will have to set the Gtk::Label::property_use_markup() property to true
in order for the label to display the markup attributes. See also Gtk::Label::set_markup() for a convenience function that sets both this property and the Gtk::Label::property_use_markup() property at the same time.
If the string contains underlines acting as mnemonics, you will have to set the Gtk::Label::property_use_underline() property to true
in order for the label to display them.
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.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::Label::property_label | ( | ) | const |
The contents of the label.
If the string contains [Pango XML markup][PangoMarkupFormat], you will have to set the Gtk::Label::property_use_markup() property to true
in order for the label to display the markup attributes. See also Gtk::Label::set_markup() for a convenience function that sets both this property and the Gtk::Label::property_use_markup() property at the same time.
If the string contains underlines acting as mnemonics, you will have to set the Gtk::Label::property_use_underline() property to true
in order for the label to display them.
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.
Glib::PropertyProxy< int > Gtk::Label::property_lines | ( | ) |
The number of lines to which an ellipsized, wrapping label should be limited.
This property has no effect if the label is not wrapping or ellipsized. Set this property to -1 if you don't want to limit the number of lines.
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.
Glib::PropertyProxy_ReadOnly< int > Gtk::Label::property_lines | ( | ) | const |
The number of lines to which an ellipsized, wrapping label should be limited.
This property has no effect if the label is not wrapping or ellipsized. Set this property to -1 if you don't want to limit the number of lines.
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.
Glib::PropertyProxy< int > Gtk::Label::property_max_width_chars | ( | ) |
The desired maximum width of the label, in characters.
If this property is set to -1, the width will be calculated automatically.
See the section on [text layout][label-text-layout] for details of how Gtk::Label::property_width_chars() and Gtk::Label::property_max_width_chars() determine the width of ellipsized and wrapped labels.
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.
Glib::PropertyProxy_ReadOnly< int > Gtk::Label::property_max_width_chars | ( | ) | const |
The desired maximum width of the label, in characters.
If this property is set to -1, the width will be calculated automatically.
See the section on [text layout][label-text-layout] for details of how Gtk::Label::property_width_chars() and Gtk::Label::property_max_width_chars() determine the width of ellipsized and wrapped labels.
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.
Glib::PropertyProxy_ReadOnly< guint > Gtk::Label::property_mnemonic_keyval | ( | ) | const |
The mnemonic accelerator key for this label.
Default value: 16777215
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Widget* > Gtk::Label::property_mnemonic_widget | ( | ) |
The widget to be activated when the label’s mnemonic key is pressed.
- 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.
Glib::PropertyProxy_ReadOnly< Widget* > Gtk::Label::property_mnemonic_widget | ( | ) | const |
The widget to be activated when the label’s mnemonic key is pressed.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::Label::property_selectable | ( | ) |
Whether the label text can be selected with the mouse.
Default value: false
- 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.
Glib::PropertyProxy_ReadOnly< bool > Gtk::Label::property_selectable | ( | ) | const |
Whether the label text can be selected with the mouse.
Default value: false
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::Label::property_single_line_mode | ( | ) |
Whether the label is in single line mode.
In single line mode, the height of the label does not depend on the actual text, it is always set to ascent + descent of the font. This can be an advantage in situations where resizing the label because of text changes would be distracting, e.g. in a statusbar.
Default value: false
- 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.
Glib::PropertyProxy_ReadOnly< bool > Gtk::Label::property_single_line_mode | ( | ) | const |
Whether the label is in single line mode.
In single line mode, the height of the label does not depend on the actual text, it is always set to ascent + descent of the font. This can be an advantage in situations where resizing the label because of text changes would be distracting, e.g. in a statusbar.
Default value: false
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::Label::property_use_markup | ( | ) |
The text of the label includes XML markup.
See pango_parse_markup().
Default value: false
- 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.
Glib::PropertyProxy_ReadOnly< bool > Gtk::Label::property_use_markup | ( | ) | const |
The text of the label includes XML markup.
See pango_parse_markup().
Default value: false
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::Label::property_use_underline | ( | ) |
If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key.
Default value: false
- 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.
Glib::PropertyProxy_ReadOnly< bool > Gtk::Label::property_use_underline | ( | ) | const |
If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key.
Default value: false
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > Gtk::Label::property_width_chars | ( | ) |
The desired width of the label, in characters.
If this property is set to -1, the width will be calculated automatically.
See the section on [text layout][label-text-layout] for details of how Gtk::Label::property_width_chars() and Gtk::Label::property_max_width_chars() determine the width of ellipsized and wrapped labels.
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.
Glib::PropertyProxy_ReadOnly< int > Gtk::Label::property_width_chars | ( | ) | const |
The desired width of the label, in characters.
If this property is set to -1, the width will be calculated automatically.
See the section on [text layout][label-text-layout] for details of how Gtk::Label::property_width_chars() and Gtk::Label::property_max_width_chars() determine the width of ellipsized and wrapped labels.
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.
Glib::PropertyProxy< bool > Gtk::Label::property_wrap | ( | ) |
If set, wrap lines if the text becomes too wide.
Default value: false
- 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.
Glib::PropertyProxy_ReadOnly< bool > Gtk::Label::property_wrap | ( | ) | const |
If set, wrap lines if the text becomes too wide.
Default value: false
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Pango::WrapMode > Gtk::Label::property_wrap_mode | ( | ) |
If line wrapping is on (see the Gtk::Label::property_wrap() property) this controls how the line wrapping is done.
The default is Pango::WrapMode::WORD, which means wrap on word boundaries.
Default value: Pango::WrapMode::WORD
- 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.
Glib::PropertyProxy_ReadOnly< Pango::WrapMode > Gtk::Label::property_wrap_mode | ( | ) | const |
If line wrapping is on (see the Gtk::Label::property_wrap() property) this controls how the line wrapping is done.
The default is Pango::WrapMode::WORD, which means wrap on word boundaries.
Default value: Pango::WrapMode::WORD
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< float > Gtk::Label::property_xalign | ( | ) |
The xalign property determines the horizontal alignment of the label text inside the labels size allocation.
Compare this to Gtk::Widget::property_halign(), which determines how the labels size allocation is positioned in the space available for the label.
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.
Glib::PropertyProxy_ReadOnly< float > Gtk::Label::property_xalign | ( | ) | const |
The xalign property determines the horizontal alignment of the label text inside the labels size allocation.
Compare this to Gtk::Widget::property_halign(), which determines how the labels size allocation is positioned in the space available for the label.
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.
Glib::PropertyProxy< float > Gtk::Label::property_yalign | ( | ) |
The yalign property determines the vertical alignment of the label text inside the labels size allocation.
Compare this to Gtk::Widget::property_valign(), which determines how the labels size allocation is positioned in the space available for the label.
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.
Glib::PropertyProxy_ReadOnly< float > Gtk::Label::property_yalign | ( | ) | const |
The yalign property determines the vertical alignment of the label text inside the labels size allocation.
Compare this to Gtk::Widget::property_valign(), which determines how the labels size allocation is positioned in the space available for the label.
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.
void Gtk::Label::select_region | ( | int | start_offset, |
int | end_offset | ||
) |
Selects a range of characters in the label, if the label is selectable.
See set_selectable(). If the label is not selectable, this function has no effect. If start_offset or end_offset are -1, then the end of the label will be substituted.
- Parameters
-
start_offset Start offset (in characters not bytes). end_offset End offset (in characters not bytes).
void Gtk::Label::select_region | ( | int | start_offset | ) |
Selects a range of characters in the label, from start_offset to the end, if the label is selectable.
See gtk_label_set_selectable(). If the label is not selectable, this function has no effect.
- Parameters
-
start_offset Start offset (in characters not bytes)
void Gtk::Label::set_attributes | ( | Pango::AttrList & | attrs | ) |
Sets a Pango::AttrList; the attributes in the list are applied to the label text.
The attributes set with this function will be applied and merged with any other attributes previously effected by way of the Gtk::Label::property_use_underline() or Gtk::Label::property_use_markup() properties. While it is not recommended to mix markup strings with manually set attributes, if you must; know that the attributes will be applied to the label after the markup string is parsed.
- Parameters
-
attrs A Pango::AttrList, or nullptr
.
void Gtk::Label::set_ellipsize | ( | Pango::EllipsizeMode | mode | ) |
Sets the mode used to ellipsize (add an ellipsis: "...") to the text if there is not enough space to render the entire string.
- Parameters
-
mode A Pango::EllipsizeMode.
void Gtk::Label::set_extra_menu | ( | const Glib::RefPtr< Gio::MenuModel > & | model | ) |
Sets a menu model to add when constructing the context menu for label.
- Parameters
-
model A Gio::MenuModel.
void Gtk::Label::set_justify | ( | Justification | jtype | ) |
Sets the alignment of the lines in the text of the label relative to each other.
Gtk::Justification::LEFT is the default value when the widget is first created with new(). If you instead want to set the alignment of the label as a whole, use Gtk::Widget::set_halign() instead. set_justify() has no effect on labels containing only a single line.
- Parameters
-
jtype A Gtk::Justification.
void Gtk::Label::set_label | ( | const Glib::ustring & | str | ) |
Sets the text of the label.
The label is interpreted as including embedded underlines and/or Pango markup depending on the values of the Gtk::Label::property_use_underline() and Gtk::Label::property_use_markup() properties.
- Parameters
-
str The new text to set for the label.
void Gtk::Label::set_lines | ( | int | lines | ) |
Sets the number of lines to which an ellipsized, wrapping label should be limited.
This has no effect if the label is not wrapping or ellipsized. Set this to -1 if you don’t want to limit the number of lines.
- Parameters
-
lines The desired number of lines, or -1.
void Gtk::Label::set_markup | ( | const Glib::ustring & | str | ) |
Parses str which is marked up with the [Pango text markup language][PangoMarkupFormat], setting the label’s text and attribute list based on the parse results.
If the str is external data, you may need to escape it with Glib::markup_escape_text() or Glib::markup_printf_escaped():
[C example ellipted]
This function will set the Gtk::Label::property_use_markup() property to true
as a side effect.
If you set the label contents using the Gtk::Label::property_label() property you should also ensure that you set the Gtk::Label::property_use_markup() property accordingly.
See also: set_text()
- Parameters
-
str A markup string (see [Pango markup format][PangoMarkupFormat]).
void Gtk::Label::set_markup_with_mnemonic | ( | const Glib::ustring & | str | ) |
Parses str which is marked up with the [Pango text markup language][PangoMarkupFormat], setting the label’s text and attribute list based on the parse results.
If characters in str are preceded by an underscore, they are underlined indicating that they represent a keyboard accelerator called a mnemonic.
The mnemonic key can be used to activate another widget, chosen automatically, or explicitly using set_mnemonic_widget().
- Parameters
-
str A markup string (see [Pango markup format][PangoMarkupFormat]).
void Gtk::Label::set_max_width_chars | ( | int | n_chars | ) |
Sets the desired maximum width in characters of label to n_chars.
- Parameters
-
n_chars The new desired maximum width, in characters.
void Gtk::Label::set_mnemonic_widget | ( | Widget& | widget | ) |
If the label has been set so that it has a mnemonic key (using i.e. set_markup_with_mnemonic(), set_text_with_mnemonic(), new_with_mnemonic() or the “use_underline” property) the label can be associated with a widget that is the target of the mnemonic.
When the label is inside a widget (like a Gtk::Button or a Gtk::Notebook tab) it is automatically associated with the correct widget, but sometimes (i.e. when the target is a Gtk::Entry next to the label) you need to set it explicitly using this function.
The target widget will be accelerated by emitting the GtkWidget::mnemonic-activate signal on it. The default handler for this signal will activate the widget if there are no mnemonic collisions and toggle focus between the colliding widgets otherwise.
- Parameters
-
widget The target Gtk::Widget, or nullptr
to unset.
void Gtk::Label::set_selectable | ( | bool | setting = true | ) |
Selectable labels allow the user to select text from the label, for copy-and-paste.
- Parameters
-
setting true
to allow selecting text in the label.
void Gtk::Label::set_single_line_mode | ( | bool | single_line_mode = true | ) |
Sets whether the label is in single line mode.
- Parameters
-
single_line_mode true
if the label should be in single line mode.
void Gtk::Label::set_text | ( | const Glib::ustring & | str | ) |
Sets the text within the Gtk::Label widget.
It overwrites any text that was there before.
This function will clear any previously set mnemonic accelerators, and set the Gtk::Label::property_use_underline() property to false
as a side effect.
This function will set the Gtk::Label::property_use_markup() property to false
as a side effect.
See also: set_markup()
- Parameters
-
str The text you want to set.
void Gtk::Label::set_text_with_mnemonic | ( | const Glib::ustring & | str | ) |
Sets the label’s text from the string str.
If characters in str are preceded by an underscore, they are underlined indicating that they represent a keyboard accelerator called a mnemonic. The mnemonic key can be used to activate another widget, chosen automatically, or explicitly using set_mnemonic_widget().
- Parameters
-
str A string.
void Gtk::Label::set_use_markup | ( | bool | setting = true | ) |
Sets whether the text of the label contains markup in [Pango’s text markup language][PangoMarkupFormat].
See set_markup().
- Parameters
-
setting true
if the label’s text should be parsed for markup.
void Gtk::Label::set_use_underline | ( | bool | setting = true | ) |
If true, an underline in the text indicates the next character should be used for the mnemonic accelerator key.
- Parameters
-
setting true
if underlines in the text indicate mnemonics.
void Gtk::Label::set_width_chars | ( | int | n_chars | ) |
Sets the desired width in characters of label to n_chars.
- Parameters
-
n_chars The new desired width, in characters.
void Gtk::Label::set_wrap | ( | bool | wrap = true | ) |
Toggles line wrapping within the Gtk::Label widget.
true
makes it break lines if text exceeds the widget’s size. false
lets the text get cut off by the edge of the widget if it exceeds the widget size.
Note that setting line wrapping to true
does not make the label wrap at its parent container’s width, because GTK widgets conceptually can’t make their requisition depend on the parent container’s size. For a label that wraps at a specific position, set the label’s width using Gtk::Widget::set_size_request().
- Parameters
-
wrap The setting.
void Gtk::Label::set_wrap_mode | ( | Pango::WrapMode | wrap_mode | ) |
If line wrapping is on (see set_wrap()) this controls how the line wrapping is done.
The default is Pango::WrapMode::WORD which means wrap on word boundaries.
- Parameters
-
wrap_mode The line wrapping mode.
void Gtk::Label::set_xalign | ( | float | xalign | ) |
Sets the Gtk::Label::property_xalign() property for label.
- Parameters
-
xalign The new xalign value, between 0 and 1.
void Gtk::Label::set_yalign | ( | float | yalign | ) |
Sets the Gtk::Label::property_yalign() property for label.
- Parameters
-
yalign The new yalign value, between 0 and 1.
Glib::SignalProxy<bool(const Glib::ustring&)> Gtk::Label::signal_activate_link | ( | ) |
- Slot Prototype:
bool on_my_activate_link(const Glib::ustring& uri)
Flags: Run Last
The signal which gets emitted to activate a URI. Applications may connect to it to override the default behaviour, which is to call gtk_show_uri().
- Parameters
-
uri The URI that is activated.
- Returns
true
if the link has been activated.
Friends And Related Function Documentation
|
related |
A Glib::wrap() method for this object.
- Parameters
-
object The C instance. take_copy False 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.