AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity
584a71ae96
gtk2/gtk/gtklabel.c
Timm Bäder 584a71ae96 cssstyle: Only create PangoAttrList if there are attribtues 
Don't allocate a new GString if we never need it and therefore don't
create the PangoAttrList if we have no attributes anyway. Update callers
to handle the possible NULL return value.
2020-04-17 15:21:00 +02:00

6309 lines
189 KiB
C
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/* GTK - The GIMP Toolkit
* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.Free
*/
/*
* Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
* file for a list of people on the GTK+ Team. See the ChangeLog
* files for a list of changes. These files are distributed with
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
#include "config.h"
#include "gtklabelprivate.h"
#include "gtkbuildable.h"
#include "gtkbuilderprivate.h"
#include "gtkcssnodeprivate.h"
#include "gtkcssstylepropertyprivate.h"
#include "gtkeventcontrollermotion.h"
#include "gtkgesturedrag.h"
#include "gtkgestureclick.h"
#include "gtkgesturesingle.h"
#include "gtkimage.h"
#include "gtkintl.h"
#include "gtkmain.h"
#include "gtkmarshalers.h"
#include "gtknotebook.h"
#include "gtkpango.h"
#include "gtkprivate.h"
#include "gtkshortcut.h"
#include "gtkshortcutcontroller.h"
#include "gtkshortcuttrigger.h"
#include "gtkshow.h"
#include "gtksnapshot.h"
#include "gtkstylecontextprivate.h"
#include "gtktextutil.h"
#include "gtktooltip.h"
#include "gtktypebuiltins.h"
#include "gtkwidgetprivate.h"
#include "gtkwindow.h"
#include "gtkpopovermenu.h"
#include "gtknative.h"
#include "gtkdragsource.h"
#include "gtkdragicon.h"
#include "gtkcsscolorvalueprivate.h"
#include "a11y/gtklabelaccessibleprivate.h"
#include <math.h>
#include <string.h>
/* this is in case rint() is not provided by the compiler,
* such as in the case of C89 compilers, like MSVC
*/
#include "fallback-c89.c"
/**
* SECTION:gtklabel
* @Short_description: A widget that displays a small to medium amount of text
* @Title: GtkLabel
*
* The #GtkLabel widget displays a small amount of text. As the name
* implies, most labels are used to label another widget such as a #GtkButton.
*
* # CSS nodes
*
* |[<!-- language="plain" -->
* label
* ├── [selection]
* ├── [link]
* ┊
* ╰── [link]
* ]|
*
* GtkLabel has a single CSS node with the name label. A wide variety
* of style classes may be applied to labels, such as .title, .subtitle,
* .dim-label, etc. In the #GtkShortcutsWindow, labels are used wth the
* .keycap style class.
*
* If the label has a selection, it gets a subnode with name selection.
*
* If the label has links, there is one subnode per link. These subnodes
* carry the link or visited state depending on whether they have been
* visited. In this case, label node also gets a .link style class.
*
* # GtkLabel as GtkBuildable
*
* The GtkLabel implementation of the GtkBuildable interface supports a
* custom <attributes> element, which supports any number of <attribute>
* elements. The <attribute> element has attributes named “name“, “value“,
* “start“ and “end“ and allows you to specify #PangoAttribute values for
* this label.
*
* An example of a UI definition fragment specifying Pango attributes:
* |[
* <object class="GtkLabel">
* <attributes>
* <attribute name="weight" value="PANGO_WEIGHT_BOLD"/>
* <attribute name="background" value="red" start="5" end="10"/>
* </attributes>
* </object>
* ]|
*
* The start and end attributes specify the range of characters to which the
* Pango attribute applies. If start and end are not specified, the attribute is
* applied to the whole text. Note that specifying ranges does not make much
* sense with translatable attributes. Use markup embedded in the translatable
* content instead.
*
* # Mnemonics
*
* Labels may contain “mnemonics”. Mnemonics are
* underlined characters in the label, used for keyboard navigation.
* Mnemonics are created by providing a string with an underscore before
* the mnemonic character, such as `"_File"`, to the
* functions gtk_label_new_with_mnemonic() or
* gtk_label_set_text_with_mnemonic().
*
* Mnemonics automatically activate any activatable widget the label is
* inside, such as a #GtkButton; if the label is not inside the
* mnemonic’s target widget, you have to tell the label about the target
* using gtk_label_set_mnemonic_widget(). Here’s a simple example where
* the label is inside a button:
*
* |[<!-- language="C" -->
* // Pressing Alt+H will activate this button
* GtkWidget *button = gtk_button_new ();
* GtkWidget *label = gtk_label_new_with_mnemonic ("_Hello");
* gtk_container_add (GTK_CONTAINER (button), label);
* ]|
*
* There’s a convenience function to create buttons with a mnemonic label
* already inside:
*
* |[<!-- language="C" -->
* // Pressing Alt+H will activate this button
* GtkWidget *button = gtk_button_new_with_mnemonic ("_Hello");
* ]|
*
* To create a mnemonic for a widget alongside the label, such as a
* #GtkEntry, you have to point the label at the entry with
* gtk_label_set_mnemonic_widget():
*
* |[<!-- language="C" -->
* // Pressing Alt+H will focus the entry
* GtkWidget *entry = gtk_entry_new ();
* GtkWidget *label = gtk_label_new_with_mnemonic ("_Hello");
* gtk_label_set_mnemonic_widget (GTK_LABEL (label), entry);
* ]|
*
* # Markup (styled text)
*
* To make it easy to format text in a label (changing colors,
* fonts, etc.), label text can be provided in a simple
* [markup format][PangoMarkupFormat].
*
* Here’s how to create a label with a small font:
* |[<!-- language="C" -->
* GtkWidget *label = gtk_label_new (NULL);
* gtk_label_set_markup (GTK_LABEL (label), "<small>Small text</small>");
* ]|
*
* (See [complete documentation][PangoMarkupFormat] of available
* tags in the Pango manual.)
*
* The markup passed to gtk_label_set_markup() must be valid; for example,
* literal <, > and & characters must be escaped as &lt;, &gt;, and &amp;.
* If you pass text obtained from the user, file, or a network to
* gtk_label_set_markup(), you’ll want to escape it with
* g_markup_escape_text() or g_markup_printf_escaped().
*
* Markup strings are just a convenient way to set the #PangoAttrList on
* a label; gtk_label_set_attributes() may be a simpler way to set
* attributes in some cases. Be careful though; #PangoAttrList tends to
* cause internationalization problems, unless you’re applying attributes
* to the entire string (i.e. unless you set the range of each attribute
* to [0, %G_MAXINT)). The reason is that specifying the start_index and
* end_index for a #PangoAttribute requires knowledge of the exact string
* being displayed, so translations will cause problems.
*
* # Selectable labels
*
* Labels can be made selectable with gtk_label_set_selectable().
* Selectable labels allow the user to copy the label contents to
* the clipboard. Only labels that contain useful-to-copy information
* — such as error messages — should be made selectable.
*
* # Text layout # {#label-text-layout}
*
* A label can contain any number of paragraphs, but will have
* performance problems if it contains more than a small number.
* Paragraphs are separated by newlines or other paragraph separators
* understood by Pango.
*
* Labels can automatically wrap text if you call
* gtk_label_set_wrap().
*
* gtk_label_set_justify() sets how the lines in a label align
* with one another. If you want to set how the label as a whole
* aligns in its available space, see the #GtkWidget:halign and
* #GtkWidget:valign properties.
*
* The #GtkLabel:width-chars and #GtkLabel:max-width-chars properties
* can be used to control the size allocation of ellipsized or wrapped
* labels. For ellipsizing labels, if either is specified (and less
* than the actual text size), it is used as the minimum width, and the actual
* text size is used as the natural width of the label. For wrapping labels,
* width-chars is used as the minimum width, if specified, and max-width-chars
* is used as the natural width. Even if max-width-chars specified, wrapping
* labels will be rewrapped to use all of the available width.
*
* Note that the interpretation of #GtkLabel:width-chars and
* #GtkLabel:max-width-chars has changed a bit with the introduction of
* [width-for-height geometry management.][geometry-management]
*
* # Links
*
* GTK+ supports markup for clickable hyperlinks in addition
* to regular Pango markup. The markup for links is borrowed from HTML,
* using the `<a>` with “href“, “title“ and “class“ attributes. GTK+ renders links
* similar to the way they appear in web browsers, with colored, underlined
* text. The “title“ attribute is displayed as a tooltip on the link. The “class“
* attribute is used as style class on the CSS node for the link.
*
* An example looks like this:
*
* |[<!-- language="C" -->
* const gchar *text =
* "Go to the"
* "<a href=\"http://www.gtk.org title=\"&lt;i&gt;Our&lt;/i&gt; website\">"
* "GTK+ website</a> for more...";
* GtkWidget *label = gtk_label_new (NULL);
* gtk_label_set_markup (GTK_LABEL (label), text);
* ]|
*
* It is possible to implement custom handling for links and their tooltips with
* the #GtkLabel::activate-link signal and the gtk_label_get_current_uri() function.
*/
typedef struct _GtkLabelPrivate GtkLabelPrivate;
typedef struct _GtkLabelClass GtkLabelClass;
typedef struct _GtkLabelSelectionInfo GtkLabelSelectionInfo;
struct _GtkLabel
{
GtkWidget parent_instance;
};
struct _GtkLabelClass
{
GtkWidgetClass parent_class;
void (* move_cursor) (GtkLabel *label,
GtkMovementStep step,
gint count,
gboolean extend_selection);
void (* copy_clipboard) (GtkLabel *label);
gboolean (*activate_link) (GtkLabel *label,
const gchar *uri);
};
struct _GtkLabelPrivate
{
GtkLabelSelectionInfo *select_info;
GtkWidget *mnemonic_widget;
GtkEventController *mnemonic_controller;
PangoAttrList *attrs;
PangoAttrList *markup_attrs;
PangoLayout *layout;
GtkWidget *popup_menu;
GMenuModel *extra_menu;
gchar *label;
gchar *text;
gfloat xalign;
gfloat yalign;
guint mnemonics_visible : 1;
guint jtype : 2;
guint wrap : 1;
guint use_underline : 1;
guint ellipsize : 3;
guint use_markup : 1;
guint wrap_mode : 3;
guint single_line_mode : 1;
guint in_click : 1;
guint pattern_set : 1;
guint track_links : 1;
guint mnemonic_keyval;
gint width_chars;
gint max_width_chars;
gint lines;
};
/* Notes about the handling of links:
*
* Links share the GtkLabelSelectionInfo struct with selectable labels.
* There are some new fields for links. The links field contains the list
* of GtkLabelLink structs that describe the links which are embedded in
* the label. The active_link field points to the link under the mouse
* pointer. For keyboard navigation, the “focus” link is determined by
* finding the link which contains the selection_anchor position.
* The link_clicked field is used with button press and release events
* to ensure that pressing inside a link and releasing outside of it
* does not activate the link.
*
* Links are rendered with the #GTK_STATE_FLAG_LINK/#GTK_STATE_FLAG_VISITED
* state flags. When the mouse pointer is over a link, the pointer is changed
* to indicate the link.
*
* Labels with links accept keyboard focus, and it is possible to move
* the focus between the embedded links using Tab/Shift-Tab. The focus
* is indicated by a focus rectangle that is drawn around the link text.
* Pressing Enter activates the focused link, and there is a suitable
* context menu for links that can be opened with the Menu key. Pressing
* Control-C copies the link URI to the clipboard.
*
* In selectable labels with links, link functionality is only available
* when the selection is empty.
*/
typedef struct
{
gchar *uri;
gchar *title; /* the title attribute, used as tooltip */
GtkCssNode *cssnode;
gboolean visited; /* get set when the link is activated; this flag
* gets preserved over later set_markup() calls
*/
gint start; /* position of the link in the PangoLayout */
gint end;
} GtkLabelLink;
struct _GtkLabelSelectionInfo
{
gint selection_anchor;
gint selection_end;
GtkCssNode *selection_node;
GdkContentProvider *provider;
GtkLabelLink *links;
guint n_links;
GtkLabelLink *active_link;
GtkLabelLink *context_link;
GtkGesture *drag_gesture;
GtkGesture *click_gesture;
GtkEventController *motion_controller;
gint drag_start_x;
gint drag_start_y;
guint in_drag : 1;
guint select_words : 1;
guint selectable : 1;
guint link_clicked : 1;
};
enum {
MOVE_CURSOR,
COPY_CLIPBOARD,
ACTIVATE_LINK,
ACTIVATE_CURRENT_LINK,
LAST_SIGNAL
};
enum {
PROP_0,
PROP_LABEL,
PROP_ATTRIBUTES,
PROP_USE_MARKUP,
PROP_USE_UNDERLINE,
PROP_JUSTIFY,
PROP_WRAP,
PROP_WRAP_MODE,
PROP_SELECTABLE,
PROP_MNEMONIC_KEYVAL,
PROP_MNEMONIC_WIDGET,
PROP_CURSOR_POSITION,
PROP_SELECTION_BOUND,
PROP_ELLIPSIZE,
PROP_WIDTH_CHARS,
PROP_SINGLE_LINE_MODE,
PROP_MAX_WIDTH_CHARS,
PROP_TRACK_VISITED_LINKS,
PROP_LINES,
PROP_XALIGN,
PROP_YALIGN,
PROP_EXTRA_MENU,
NUM_PROPERTIES
};
static GParamSpec *label_props[NUM_PROPERTIES] = { NULL, };
static guint signals[LAST_SIGNAL] = { 0 };
static GQuark quark_shortcuts_connected;
static GQuark quark_mnemonics_visible_connected;
static GQuark quark_gtk_signal;
static GQuark quark_link;
static void gtk_label_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec);
static void gtk_label_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec);
static void gtk_label_finalize (GObject *object);
static void gtk_label_destroy (GtkWidget *widget);
static void gtk_label_size_allocate (GtkWidget *widget,
int width,
int height,
int baseline);
static void gtk_label_state_flags_changed (GtkWidget *widget,
GtkStateFlags prev_state);
static void gtk_label_css_changed (GtkWidget *widget,
GtkCssStyleChange *change);
static void gtk_label_snapshot (GtkWidget *widget,
GtkSnapshot *snapshot);
static gboolean gtk_label_focus (GtkWidget *widget,
GtkDirectionType direction);
static void gtk_label_unrealize (GtkWidget *widget);
static void gtk_label_motion (GtkEventControllerMotion *controller,
double x,
double y,
gpointer data);
static void gtk_label_leave (GtkEventControllerMotion *controller,
GdkCrossingMode mode,
gpointer data);
static gboolean gtk_label_grab_focus (GtkWidget *widget);
static gboolean gtk_label_query_tooltip (GtkWidget *widget,
gint x,
gint y,
gboolean keyboard_tip,
GtkTooltip *tooltip);
static void gtk_label_set_text_internal (GtkLabel *label,
gchar *str);
static void gtk_label_set_label_internal (GtkLabel *label,
gchar *str);
static gboolean gtk_label_set_use_markup_internal (GtkLabel *label,
gboolean val);
static gboolean gtk_label_set_use_underline_internal (GtkLabel *label,
gboolean val);
static void gtk_label_set_uline_text_internal (GtkLabel *label,
const gchar *str);
static void gtk_label_set_pattern_internal (GtkLabel *label,
const gchar *pattern,
gboolean is_mnemonic);
static void gtk_label_set_markup_internal (GtkLabel *label,
const gchar *str,
gboolean with_uline);
static void gtk_label_recalculate (GtkLabel *label);
static void gtk_label_root (GtkWidget *widget);
static void gtk_label_unroot (GtkWidget *widget);
static void gtk_label_popup_menu (GtkWidget *widget,
const char *action_name,
GVariant *parameters);
static void gtk_label_do_popup (GtkLabel *label,
double x,
double y);
static void gtk_label_ensure_select_info (GtkLabel *label);
static void gtk_label_clear_select_info (GtkLabel *label);
static void gtk_label_update_cursor (GtkLabel *label);
static void gtk_label_clear_layout (GtkLabel *label);
static void gtk_label_ensure_layout (GtkLabel *label);
static void gtk_label_select_region_index (GtkLabel *label,
gint anchor_index,
gint end_index);
static void gtk_label_update_active_link (GtkWidget *widget,
gdouble x,
gdouble y);
static gboolean gtk_label_mnemonic_activate (GtkWidget *widget,
gboolean group_cycling);
static void gtk_label_setup_mnemonic (GtkLabel *label);
static void gtk_label_buildable_interface_init (GtkBuildableIface *iface);
static gboolean gtk_label_buildable_custom_tag_start (GtkBuildable *buildable,
GtkBuilder *builder,
GObject *child,
const gchar *tagname,
GtkBuildableParser *parser,
gpointer *data);
static void gtk_label_buildable_custom_finished (GtkBuildable *buildable,
GtkBuilder *builder,
GObject *child,
const gchar *tagname,
gpointer user_data);
static void connect_mnemonics_visible_notify (GtkLabel *label);
static gboolean separate_uline_pattern (const gchar *str,
guint *accel_key,
gchar **new_str,
gchar **pattern);
/* For selectable labels: */
static void gtk_label_move_cursor (GtkLabel *label,
GtkMovementStep step,
gint count,
gboolean extend_selection);
static void gtk_label_copy_clipboard (GtkLabel *label);
static void gtk_label_select_all (GtkLabel *label);
static gint gtk_label_move_forward_word (GtkLabel *label,
gint start);
static gint gtk_label_move_backward_word (GtkLabel *label,
gint start);
/* For links: */
static void gtk_label_clear_links (GtkLabel *label);
static gboolean gtk_label_activate_link (GtkLabel *label,
const gchar *uri);
static void gtk_label_activate_current_link (GtkLabel *label);
static GtkLabelLink *gtk_label_get_current_link (GtkLabel *label);
static void emit_activate_link (GtkLabel *label,
GtkLabelLink *link);
/* Event controller callbacks */
static void gtk_label_click_gesture_pressed (GtkGestureClick *gesture,
gint n_press,
gdouble x,
gdouble y,
GtkLabel *label);
static void gtk_label_click_gesture_released (GtkGestureClick *gesture,
gint n_press,
gdouble x,
gdouble y,
GtkLabel *label);
static void gtk_label_drag_gesture_begin (GtkGestureDrag *gesture,
gdouble start_x,
gdouble start_y,
GtkLabel *label);
static void gtk_label_drag_gesture_update (GtkGestureDrag *gesture,
gdouble offset_x,
gdouble offset_y,
GtkLabel *label);
/* Actions */
static void gtk_label_activate_clipboard_copy (GtkWidget *label,
const char *name,
GVariant *parameter);
static void gtk_label_activate_selection_select_all (GtkWidget *label,
const char *name,
GVariant *parameter);
static void gtk_label_activate_link_open (GtkWidget *label,
const char *name,
GVariant *parameter);
static void gtk_label_activate_link_copy (GtkWidget *label,
const char *name,
GVariant *parameter);
static void gtk_label_nop (GtkWidget *label,
const char *name,
GVariant *parameter);
static void gtk_label_update_actions (GtkLabel *label);
static GtkSizeRequestMode gtk_label_get_request_mode (GtkWidget *widget);
static void gtk_label_measure (GtkWidget *widget,
GtkOrientation orientation,
int for_size,
int *minimum,
int *natural,
int *minimum_baseline,
int *natural_baseline);
static GtkBuildableIface *buildable_parent_iface = NULL;
G_DEFINE_TYPE_WITH_CODE (GtkLabel, gtk_label, GTK_TYPE_WIDGET,
G_ADD_PRIVATE (GtkLabel)
G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
gtk_label_buildable_interface_init))
static void
add_move_binding (GtkWidgetClass *widget_class,
guint keyval,
guint modmask,
GtkMovementStep step,
gint count)
{
g_return_if_fail ((modmask & GDK_SHIFT_MASK) == 0);
gtk_widget_class_add_binding_signal (widget_class,
keyval, modmask,
"move-cursor",
"(iib)", step, count, FALSE);
/* Selection-extending version */
gtk_widget_class_add_binding_signal (widget_class,
keyval, modmask | GDK_SHIFT_MASK,
"move-cursor",
"(iib)", step, count, TRUE);
}
static void
gtk_label_class_init (GtkLabelClass *class)
{
GObjectClass *gobject_class = G_OBJECT_CLASS (class);
GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
gobject_class->set_property = gtk_label_set_property;
gobject_class->get_property = gtk_label_get_property;
gobject_class->finalize = gtk_label_finalize;
widget_class->destroy = gtk_label_destroy;
widget_class->size_allocate = gtk_label_size_allocate;
widget_class->state_flags_changed = gtk_label_state_flags_changed;
widget_class->css_changed = gtk_label_css_changed;
widget_class->query_tooltip = gtk_label_query_tooltip;
widget_class->snapshot = gtk_label_snapshot;
widget_class->unrealize = gtk_label_unrealize;
widget_class->root = gtk_label_root;
widget_class->unroot = gtk_label_unroot;
widget_class->mnemonic_activate = gtk_label_mnemonic_activate;
widget_class->grab_focus = gtk_label_grab_focus;
widget_class->focus = gtk_label_focus;
widget_class->get_request_mode = gtk_label_get_request_mode;
widget_class->measure = gtk_label_measure;
class->move_cursor = gtk_label_move_cursor;
class->copy_clipboard = gtk_label_copy_clipboard;
class->activate_link = gtk_label_activate_link;
/**
* GtkLabel::move-cursor:
* @entry: the object which received the signal
* @step: the granularity of the move, as a #GtkMovementStep
* @count: the number of @step units to move
* @extend_selection: %TRUE if the move should extend the selection
*
* The ::move-cursor signal is a
* [keybinding signal][GtkBindingSignal]
* which gets emitted when the user initiates a cursor movement.
* If the cursor is not visible in @entry, this signal causes
* the viewport to be moved instead.
*
* Applications should not connect to it, but may emit it with
* g_signal_emit_by_name() if they need to control the cursor
* programmatically.
*
* The default bindings for this signal come in two variants,
* the variant with the Shift modifier extends the selection,
* the variant without the Shift modifer does not.
* There are too many key combinations to list them all here.
* - Arrow keys move by individual characters/lines
* - Ctrl-arrow key combinations move by words/paragraphs
* - Home/End keys move to the ends of the buffer
*/
signals[MOVE_CURSOR] =
g_signal_new (I_("move-cursor"),
G_OBJECT_CLASS_TYPE (gobject_class),
G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
G_STRUCT_OFFSET (GtkLabelClass, move_cursor),
NULL, NULL,
_gtk_marshal_VOID__ENUM_INT_BOOLEAN,
G_TYPE_NONE, 3,
GTK_TYPE_MOVEMENT_STEP,
G_TYPE_INT,
G_TYPE_BOOLEAN);
/**
* GtkLabel::copy-clipboard:
* @label: the object which received the signal
*
* The ::copy-clipboard signal is a
* [keybinding signal][GtkBindingSignal]
* which gets emitted to copy the selection to the clipboard.
*
* The default binding for this signal is Ctrl-c.
*/
signals[COPY_CLIPBOARD] =
g_signal_new (I_("copy-clipboard"),
G_OBJECT_CLASS_TYPE (gobject_class),
G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
G_STRUCT_OFFSET (GtkLabelClass, copy_clipboard),
NULL, NULL,
NULL,
G_TYPE_NONE, 0);
/**
* GtkLabel::activate-current-link:
* @label: The label on which the signal was emitted
*
* A [keybinding signal][GtkBindingSignal]
* which gets emitted when the user activates a link in the label.
*
* Applications may also emit the signal with g_signal_emit_by_name()
* if they need to control activation of URIs programmatically.
*
* The default bindings for this signal are all forms of the Enter key.
*/
signals[ACTIVATE_CURRENT_LINK] =
g_signal_new_class_handler (I_("activate-current-link"),
G_TYPE_FROM_CLASS (gobject_class),
G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
G_CALLBACK (gtk_label_activate_current_link),
NULL, NULL,
NULL,
G_TYPE_NONE, 0);
/**
* GtkLabel::activate-link:
* @label: The label on which the signal was emitted
* @uri: the URI that is activated
*
* 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().
*
* Returns: %TRUE if the link has been activated
*/
signals[ACTIVATE_LINK] =
g_signal_new (I_("activate-link"),
G_TYPE_FROM_CLASS (gobject_class),
G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GtkLabelClass, activate_link),
_gtk_boolean_handled_accumulator, NULL,
_gtk_marshal_BOOLEAN__STRING,
G_TYPE_BOOLEAN, 1, G_TYPE_STRING);
/**
* GtkLabel:label:
*
* The contents of the label.
*
* If the string contains [Pango XML markup][PangoMarkupFormat], you will
* have to set the #GtkLabel: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
* #GtkLabel:use-markup property at the same time.
*
* If the string contains underlines acting as mnemonics, you will have to
* set the #GtkLabel:use-underline property to %TRUE in order for the label
* to display them.
*/
label_props[PROP_LABEL] =
g_param_spec_string ("label",
P_("Label"),
P_("The text of the label"),
"",
GTK_PARAM_READWRITE);
label_props[PROP_ATTRIBUTES] =
g_param_spec_boxed ("attributes",
P_("Attributes"),
P_("A list of style attributes to apply to the text of the label"),
PANGO_TYPE_ATTR_LIST,
GTK_PARAM_READWRITE);
label_props[PROP_USE_MARKUP] =
g_param_spec_boolean ("use-markup",
P_("Use markup"),
P_("The text of the label includes XML markup. See pango_parse_markup()"),
FALSE,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
label_props[PROP_USE_UNDERLINE] =
g_param_spec_boolean ("use-underline",
P_("Use underline"),
P_("If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key"),
FALSE,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
label_props[PROP_JUSTIFY] =
g_param_spec_enum ("justify",
P_("Justification"),
P_("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"),
GTK_TYPE_JUSTIFICATION,
GTK_JUSTIFY_LEFT,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
/**
* GtkLabel:xalign:
*
* The xalign property determines the horizontal aligment of the label text
* inside the labels size allocation. Compare this to #GtkWidget:halign,
* which determines how the labels size allocation is positioned in the
* space available for the label.
*/
label_props[PROP_XALIGN] =
g_param_spec_float ("xalign",
P_("X align"),
P_("The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts."),
0.0, 1.0,
0.5,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
/**
* GtkLabel:yalign:
*
* The yalign property determines the vertical aligment of the label text
* inside the labels size allocation. Compare this to #GtkWidget:valign,
* which determines how the labels size allocation is positioned in the
* space available for the label.
*/
label_props[PROP_YALIGN] =
g_param_spec_float ("yalign",
P_("Y align"),
P_("The vertical alignment, from 0 (top) to 1 (bottom)"),
0.0, 1.0,
0.5,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
label_props[PROP_WRAP] =
g_param_spec_boolean ("wrap",
P_("Line wrap"),
P_("If set, wrap lines if the text becomes too wide"),
FALSE,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
/**
* GtkLabel:wrap-mode:
*
* If line wrapping is on (see the #GtkLabel:wrap property) this controls
* how the line wrapping is done. The default is %PANGO_WRAP_WORD, which
* means wrap on word boundaries.
*/
label_props[PROP_WRAP_MODE] =
g_param_spec_enum ("wrap-mode",
P_("Line wrap mode"),
P_("If wrap is set, controls how linewrapping is done"),
PANGO_TYPE_WRAP_MODE,
PANGO_WRAP_WORD,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
label_props[PROP_SELECTABLE] =
g_param_spec_boolean ("selectable",
P_("Selectable"),
P_("Whether the label text can be selected with the mouse"),
FALSE,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
label_props[PROP_MNEMONIC_KEYVAL] =
g_param_spec_uint ("mnemonic-keyval",
P_("Mnemonic key"),
P_("The mnemonic accelerator key for this label"),
0, G_MAXUINT,
GDK_KEY_VoidSymbol,
GTK_PARAM_READABLE);
label_props[PROP_MNEMONIC_WIDGET] =
g_param_spec_object ("mnemonic-widget",
P_("Mnemonic widget"),
P_("The widget to be activated when the label’s mnemonic key is pressed"),
GTK_TYPE_WIDGET,
GTK_PARAM_READWRITE);
label_props[PROP_CURSOR_POSITION] =
g_param_spec_int ("cursor-position",
P_("Cursor Position"),
P_("The current position of the insertion cursor in chars"),
0, G_MAXINT,
0,
GTK_PARAM_READABLE);
label_props[PROP_SELECTION_BOUND] =
g_param_spec_int ("selection-bound",
P_("Selection Bound"),
P_("The position of the opposite end of the selection from the cursor in chars"),
0, G_MAXINT,
0,
GTK_PARAM_READABLE);
/**
* GtkLabel:ellipsize:
*
* The preferred place to ellipsize the string, if the label does
* not have enough room to display the entire string, specified as a
* #PangoEllipsizeMode.
*
* Note that setting this property to a value other than
* %PANGO_ELLIPSIZE_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 #GtkNotebook 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().
*/
label_props[PROP_ELLIPSIZE] =
g_param_spec_enum ("ellipsize",
P_("Ellipsize"),
P_("The preferred place to ellipsize the string, if the label does not have enough room to display the entire string"),
PANGO_TYPE_ELLIPSIZE_MODE,
PANGO_ELLIPSIZE_NONE,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
/**
* GtkLabel: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 #GtkLabel:width-chars and #GtkLabel:max-width-chars
* determine the width of ellipsized and wrapped labels.
**/
label_props[PROP_WIDTH_CHARS] =
g_param_spec_int ("width-chars",
P_("Width In Characters"),
P_("The desired width of the label, in characters"),
-1, G_MAXINT,
-1,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
/**
* GtkLabel: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.
**/
label_props[PROP_SINGLE_LINE_MODE] =
g_param_spec_boolean ("single-line-mode",
P_("Single Line Mode"),
P_("Whether the label is in single line mode"),
FALSE,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
/**
* GtkLabel: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 #GtkLabel:width-chars and #GtkLabel:max-width-chars
* determine the width of ellipsized and wrapped labels.
**/
label_props[PROP_MAX_WIDTH_CHARS] =
g_param_spec_int ("max-width-chars",
P_("Maximum Width In Characters"),
P_("The desired maximum width of the label, in characters"),
-1, G_MAXINT,
-1,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
/**
* GtkLabel:track-visited-links:
*
* Set this property to %TRUE to make the label track which links
* have been visited. It will then apply the #GTK_STATE_FLAG_VISITED
* when rendering this link, in addition to #GTK_STATE_FLAG_LINK.
*/
label_props[PROP_TRACK_VISITED_LINKS] =
g_param_spec_boolean ("track-visited-links",
P_("Track visited links"),
P_("Whether visited links should be tracked"),
TRUE,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
/**
* GtkLabel: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.
*/
label_props[PROP_LINES] =
g_param_spec_int ("lines",
P_("Number of lines"),
P_("The desired number of lines, when ellipsizing a wrapping label"),
-1, G_MAXINT,
-1,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
/**
* GtkLabel:extra-menu:
*
* A menu model whose contents will be appended to
* the context menu.
*/
label_props[PROP_EXTRA_MENU] =
g_param_spec_object ("extra-menu",
P_("Extra menu"),
P_("Menu model to append to the context menu"),
G_TYPE_MENU_MODEL,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
g_object_class_install_properties (gobject_class, NUM_PROPERTIES, label_props);
/**
* GtkLabel|menu.popup:
*
* Opens the context menu.
*/
gtk_widget_class_install_action (widget_class, "menu.popup", NULL, gtk_label_popup_menu);
/*
* Key bindings
*/
gtk_widget_class_add_binding_action (widget_class,
GDK_KEY_F10, GDK_SHIFT_MASK,
"menu.popup",
NULL);
gtk_widget_class_add_binding_action (widget_class,
GDK_KEY_Menu, 0,
"menu.popup",
NULL);
/* Moving the insertion point */
add_move_binding (widget_class, GDK_KEY_Right, 0,
GTK_MOVEMENT_VISUAL_POSITIONS, 1);
add_move_binding (widget_class, GDK_KEY_Left, 0,
GTK_MOVEMENT_VISUAL_POSITIONS, -1);
add_move_binding (widget_class, GDK_KEY_KP_Right, 0,
GTK_MOVEMENT_VISUAL_POSITIONS, 1);
add_move_binding (widget_class, GDK_KEY_KP_Left, 0,
GTK_MOVEMENT_VISUAL_POSITIONS, -1);
add_move_binding (widget_class, GDK_KEY_f, GDK_CONTROL_MASK,
GTK_MOVEMENT_LOGICAL_POSITIONS, 1);
add_move_binding (widget_class, GDK_KEY_b, GDK_CONTROL_MASK,
GTK_MOVEMENT_LOGICAL_POSITIONS, -1);
add_move_binding (widget_class, GDK_KEY_Right, GDK_CONTROL_MASK,
GTK_MOVEMENT_WORDS, 1);
add_move_binding (widget_class, GDK_KEY_Left, GDK_CONTROL_MASK,
GTK_MOVEMENT_WORDS, -1);
add_move_binding (widget_class, GDK_KEY_KP_Right, GDK_CONTROL_MASK,
GTK_MOVEMENT_WORDS, 1);
add_move_binding (widget_class, GDK_KEY_KP_Left, GDK_CONTROL_MASK,
GTK_MOVEMENT_WORDS, -1);
/* select all */
gtk_widget_class_add_binding (widget_class,
GDK_KEY_a, GDK_CONTROL_MASK,
(GtkShortcutFunc) gtk_label_select_all,
NULL);
gtk_widget_class_add_binding (widget_class,
GDK_KEY_slash, GDK_CONTROL_MASK,
(GtkShortcutFunc) gtk_label_select_all,
NULL);
/* unselect all */
gtk_widget_class_add_binding_signal (widget_class,
GDK_KEY_a, GDK_SHIFT_MASK | GDK_CONTROL_MASK,
"move-cursor",
"(iib)", GTK_MOVEMENT_PARAGRAPH_ENDS, 0, FALSE);
gtk_widget_class_add_binding_signal (widget_class,
GDK_KEY_backslash, GDK_CONTROL_MASK,
"move-cursor",
"(iib)", GTK_MOVEMENT_PARAGRAPH_ENDS, 0, FALSE);
add_move_binding (widget_class, GDK_KEY_f, GDK_ALT_MASK,
GTK_MOVEMENT_WORDS, 1);
add_move_binding (widget_class, GDK_KEY_b, GDK_ALT_MASK,
GTK_MOVEMENT_WORDS, -1);
add_move_binding (widget_class, GDK_KEY_Home, 0,
GTK_MOVEMENT_DISPLAY_LINE_ENDS, -1);
add_move_binding (widget_class, GDK_KEY_End, 0,
GTK_MOVEMENT_DISPLAY_LINE_ENDS, 1);
add_move_binding (widget_class, GDK_KEY_KP_Home, 0,
GTK_MOVEMENT_DISPLAY_LINE_ENDS, -1);
add_move_binding (widget_class, GDK_KEY_KP_End, 0,
GTK_MOVEMENT_DISPLAY_LINE_ENDS, 1);
add_move_binding (widget_class, GDK_KEY_Home, GDK_CONTROL_MASK,
GTK_MOVEMENT_BUFFER_ENDS, -1);
add_move_binding (widget_class, GDK_KEY_End, GDK_CONTROL_MASK,
GTK_MOVEMENT_BUFFER_ENDS, 1);
add_move_binding (widget_class, GDK_KEY_KP_Home, GDK_CONTROL_MASK,
GTK_MOVEMENT_BUFFER_ENDS, -1);
add_move_binding (widget_class, GDK_KEY_KP_End, GDK_CONTROL_MASK,
GTK_MOVEMENT_BUFFER_ENDS, 1);
/* copy */
gtk_widget_class_add_binding_signal (widget_class,
GDK_KEY_c, GDK_CONTROL_MASK,
"copy-clipboard",
NULL);
gtk_widget_class_add_binding_signal (widget_class,
GDK_KEY_Return, 0,
"activate-current-link",
NULL);
gtk_widget_class_add_binding_signal (widget_class,
GDK_KEY_ISO_Enter, 0,
"activate-current-link",
NULL);
gtk_widget_class_add_binding_signal (widget_class,
GDK_KEY_KP_Enter, 0,
"activate-current-link",
NULL);
gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_LABEL_ACCESSIBLE);
gtk_widget_class_set_css_name (widget_class, I_("label"));
quark_shortcuts_connected = g_quark_from_static_string ("gtk-label-shortcuts-connected");
quark_mnemonics_visible_connected = g_quark_from_static_string ("gtk-label-mnemonics-visible-connected");
quark_gtk_signal = g_quark_from_static_string ("gtk-signal");
quark_link = g_quark_from_static_string ("link");
gtk_widget_class_install_action (widget_class, "clipboard.cut", NULL,
gtk_label_nop);
gtk_widget_class_install_action (widget_class, "clipboard.copy", NULL,
gtk_label_activate_clipboard_copy);
gtk_widget_class_install_action (widget_class, "clipboard.paste", NULL,
gtk_label_nop);
gtk_widget_class_install_action (widget_class, "selection.delete", NULL,
gtk_label_nop);
gtk_widget_class_install_action (widget_class, "selection.select-all", NULL,
gtk_label_activate_selection_select_all);
gtk_widget_class_install_action (widget_class, "link.open", NULL,
gtk_label_activate_link_open);
gtk_widget_class_install_action (widget_class, "link.copy", NULL,
gtk_label_activate_link_copy);
}
static void
gtk_label_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec)
{
GtkLabel *label = GTK_LABEL (object);
switch (prop_id)
{
case PROP_LABEL:
gtk_label_set_label (label, g_value_get_string (value));
break;
case PROP_ATTRIBUTES:
gtk_label_set_attributes (label, g_value_get_boxed (value));
break;
case PROP_USE_MARKUP:
gtk_label_set_use_markup (label, g_value_get_boolean (value));
break;
case PROP_USE_UNDERLINE:
gtk_label_set_use_underline (label, g_value_get_boolean (value));
break;
case PROP_JUSTIFY:
gtk_label_set_justify (label, g_value_get_enum (value));
break;
case PROP_WRAP:
gtk_label_set_wrap (label, g_value_get_boolean (value));
break;
case PROP_WRAP_MODE:
gtk_label_set_wrap_mode (label, g_value_get_enum (value));
break;
case PROP_SELECTABLE:
gtk_label_set_selectable (label, g_value_get_boolean (value));
break;
case PROP_MNEMONIC_WIDGET:
gtk_label_set_mnemonic_widget (label, (GtkWidget*) g_value_get_object (value));
break;
case PROP_ELLIPSIZE:
gtk_label_set_ellipsize (label, g_value_get_enum (value));
break;
case PROP_WIDTH_CHARS:
gtk_label_set_width_chars (label, g_value_get_int (value));
break;
case PROP_SINGLE_LINE_MODE:
gtk_label_set_single_line_mode (label, g_value_get_boolean (value));
break;
case PROP_MAX_WIDTH_CHARS:
gtk_label_set_max_width_chars (label, g_value_get_int (value));
break;
case PROP_TRACK_VISITED_LINKS:
gtk_label_set_track_visited_links (label, g_value_get_boolean (value));
break;
case PROP_LINES:
gtk_label_set_lines (label, g_value_get_int (value));
break;
case PROP_XALIGN:
gtk_label_set_xalign (label, g_value_get_float (value));
break;
case PROP_YALIGN:
gtk_label_set_yalign (label, g_value_get_float (value));
break;
case PROP_EXTRA_MENU:
gtk_label_set_extra_menu (label, g_value_get_object (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
gtk_label_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
GtkLabel *label = GTK_LABEL (object);
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
switch (prop_id)
{
case PROP_LABEL:
g_value_set_string (value, priv->label);
break;
case PROP_ATTRIBUTES:
g_value_set_boxed (value, priv->attrs);
break;
case PROP_USE_MARKUP:
g_value_set_boolean (value, priv->use_markup);
break;
case PROP_USE_UNDERLINE:
g_value_set_boolean (value, priv->use_underline);
break;
case PROP_JUSTIFY:
g_value_set_enum (value, priv->jtype);
break;
case PROP_WRAP:
g_value_set_boolean (value, priv->wrap);
break;
case PROP_WRAP_MODE:
g_value_set_enum (value, priv->wrap_mode);
break;
case PROP_SELECTABLE:
g_value_set_boolean (value, gtk_label_get_selectable (label));
break;
case PROP_MNEMONIC_KEYVAL:
g_value_set_uint (value, priv->mnemonic_keyval);
break;
case PROP_MNEMONIC_WIDGET:
g_value_set_object (value, (GObject*) priv->mnemonic_widget);
break;
case PROP_CURSOR_POSITION:
g_value_set_int (value, _gtk_label_get_cursor_position (label));
break;
case PROP_SELECTION_BOUND:
g_value_set_int (value, _gtk_label_get_selection_bound (label));
break;
case PROP_ELLIPSIZE:
g_value_set_enum (value, priv->ellipsize);
break;
case PROP_WIDTH_CHARS:
g_value_set_int (value, gtk_label_get_width_chars (label));
break;
case PROP_SINGLE_LINE_MODE:
g_value_set_boolean (value, gtk_label_get_single_line_mode (label));
break;
case PROP_MAX_WIDTH_CHARS:
g_value_set_int (value, gtk_label_get_max_width_chars (label));
break;
case PROP_TRACK_VISITED_LINKS:
g_value_set_boolean (value, gtk_label_get_track_visited_links (label));
break;
case PROP_LINES:
g_value_set_int (value, gtk_label_get_lines (label));
break;
case PROP_XALIGN:
g_value_set_float (value, gtk_label_get_xalign (label));
break;
case PROP_YALIGN:
g_value_set_float (value, gtk_label_get_yalign (label));
break;
case PROP_EXTRA_MENU:
g_value_set_object (value, gtk_label_get_extra_menu (label));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
gtk_label_init (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
priv->width_chars = -1;
priv->max_width_chars = -1;
priv->label = g_strdup ("");
priv->lines = -1;
priv->xalign = 0.5;
priv->yalign = 0.5;
priv->jtype = GTK_JUSTIFY_LEFT;
priv->wrap = FALSE;
priv->wrap_mode = PANGO_WRAP_WORD;
priv->ellipsize = PANGO_ELLIPSIZE_NONE;
priv->use_underline = FALSE;
priv->use_markup = FALSE;
priv->track_links = TRUE;
priv->mnemonic_keyval = GDK_KEY_VoidSymbol;
priv->layout = NULL;
priv->text = g_strdup ("");
priv->attrs = NULL;
priv->mnemonic_widget = NULL;
priv->mnemonics_visible = FALSE;
}
static void
gtk_label_buildable_interface_init (GtkBuildableIface *iface)
{
buildable_parent_iface = g_type_interface_peek_parent (iface);
iface->custom_tag_start = gtk_label_buildable_custom_tag_start;
iface->custom_finished = gtk_label_buildable_custom_finished;
}
static const GtkBuildableParser pango_parser =
{
gtk_pango_attribute_start_element,
};
static gboolean
gtk_label_buildable_custom_tag_start (GtkBuildable *buildable,
GtkBuilder *builder,
GObject *child,
const gchar *tagname,
GtkBuildableParser *parser,
gpointer *data)
{
if (buildable_parent_iface->custom_tag_start (buildable, builder, child,
tagname, parser, data))
return TRUE;
if (strcmp (tagname, "attributes") == 0)
{
GtkPangoAttributeParserData *parser_data;
parser_data = g_slice_new0 (GtkPangoAttributeParserData);
parser_data->builder = g_object_ref (builder);
parser_data->object = (GObject *) g_object_ref (buildable);
*parser = pango_parser;
*data = parser_data;
return TRUE;
}
return FALSE;
}
static void
gtk_label_buildable_custom_finished (GtkBuildable *buildable,
GtkBuilder *builder,
GObject *child,
const gchar *tagname,
gpointer user_data)
{
GtkPangoAttributeParserData *data = user_data;
buildable_parent_iface->custom_finished (buildable, builder, child,
tagname, user_data);
if (strcmp (tagname, "attributes") == 0)
{
if (data->attrs)
{
gtk_label_set_attributes (GTK_LABEL (buildable), data->attrs);
pango_attr_list_unref (data->attrs);
}
g_object_unref (data->object);
g_object_unref (data->builder);
g_slice_free (GtkPangoAttributeParserData, data);
}
}
/**
* gtk_label_new:
* @str: (nullable): The text of the label
*
* Creates a new label with the given text inside it. You can
* pass %NULL to get an empty label widget.
*
* Returns: the new #GtkLabel
**/
GtkWidget*
gtk_label_new (const gchar *str)
{
GtkLabel *label;
label = g_object_new (GTK_TYPE_LABEL, NULL);
if (str && *str)
gtk_label_set_text (label, str);
return GTK_WIDGET (label);
}
/**
* gtk_label_new_with_mnemonic:
* @str: (nullable): The text of the label, with an underscore in front of the
* mnemonic character
*
* Creates a new #GtkLabel, containing the text in @str.
*
* If characters in @str are preceded by an underscore, they are
* underlined. If you need a literal underscore character in a label, use
* '__' (two underscores). The first underlined character represents a
* keyboard accelerator called a mnemonic. The mnemonic key can be used
* to activate another widget, chosen automatically, or explicitly using
* gtk_label_set_mnemonic_widget().
*
* If gtk_label_set_mnemonic_widget() is not called, then the first
* activatable ancestor of the #GtkLabel will be chosen as the mnemonic
* widget. For instance, if the label is inside a button or menu item,
* the button or menu item will automatically become the mnemonic widget
* and be activated by the mnemonic.
*
* Returns: the new #GtkLabel
**/
GtkWidget*
gtk_label_new_with_mnemonic (const gchar *str)
{
GtkLabel *label;
label = g_object_new (GTK_TYPE_LABEL, NULL);
if (str && *str)
gtk_label_set_text_with_mnemonic (label, str);
return GTK_WIDGET (label);
}
static gboolean
gtk_label_mnemonic_activate (GtkWidget *widget,
gboolean group_cycling)
{
GtkLabel *label = GTK_LABEL (widget);
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GtkWidget *parent;
if (priv->mnemonic_widget)
return gtk_widget_mnemonic_activate (priv->mnemonic_widget, group_cycling);
/* Try to find the widget to activate by traversing the
* widget's ancestry.
*/
parent = gtk_widget_get_parent (widget);
if (GTK_IS_NOTEBOOK (parent))
return FALSE;
while (parent)
{
if (gtk_widget_get_can_focus (parent) ||
(!group_cycling && GTK_WIDGET_GET_CLASS (parent)->activate_signal) ||
GTK_IS_NOTEBOOK (gtk_widget_get_parent (parent)))
return gtk_widget_mnemonic_activate (parent, group_cycling);
parent = gtk_widget_get_parent (parent);
}
/* barf if there was nothing to activate */
g_warning ("Couldn't find a target for a mnemonic activation.");
gtk_widget_error_bell (widget);
return FALSE;
}
static void
gtk_label_setup_mnemonic (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GtkWidget *widget = GTK_WIDGET (label);
GtkShortcut *shortcut;
if (priv->mnemonic_keyval == GDK_KEY_VoidSymbol)
{
if (priv->mnemonic_controller)
{
gtk_widget_remove_controller (widget, priv->mnemonic_controller);
priv->mnemonic_controller = NULL;
}
return;
}
if (priv->mnemonic_controller == NULL)
{
priv->mnemonic_controller = gtk_shortcut_controller_new ();
gtk_event_controller_set_propagation_phase (priv->mnemonic_controller, GTK_PHASE_CAPTURE);
gtk_shortcut_controller_set_scope (GTK_SHORTCUT_CONTROLLER (priv->mnemonic_controller), GTK_SHORTCUT_SCOPE_MANAGED);
shortcut = gtk_shortcut_new (gtk_mnemonic_trigger_new (priv->mnemonic_keyval),
g_object_ref (gtk_mnemonic_action_get ()));
gtk_shortcut_controller_add_shortcut (GTK_SHORTCUT_CONTROLLER (priv->mnemonic_controller), shortcut);
gtk_widget_add_controller (GTK_WIDGET (label), priv->mnemonic_controller);
}
else
{
shortcut = g_list_model_get_item (G_LIST_MODEL (priv->mnemonic_controller), 0);
gtk_shortcut_set_trigger (shortcut, gtk_mnemonic_trigger_new (priv->mnemonic_keyval));
g_object_unref (shortcut);
}
connect_mnemonics_visible_notify (GTK_LABEL (widget));
}
static void
label_shortcut_setting_apply (GtkLabel *label)
{
gtk_label_recalculate (label);
}
static void
label_shortcut_setting_traverse_container (GtkWidget *widget,
gpointer data)
{
if (GTK_IS_LABEL (widget))
label_shortcut_setting_apply (GTK_LABEL (widget));
else if (GTK_IS_CONTAINER (widget))
gtk_container_forall (GTK_CONTAINER (widget),
label_shortcut_setting_traverse_container, data);
}
static void
label_shortcut_setting_changed (GtkSettings *settings)
{
GList *list, *l;
list = gtk_window_list_toplevels ();
for (l = list; l ; l = l->next)
{
GtkWidget *widget = l->data;
if (gtk_widget_get_settings (widget) == settings)
gtk_container_forall (GTK_CONTAINER (widget),
label_shortcut_setting_traverse_container, NULL);
}
g_list_free (list);
}
static void
gtk_label_root (GtkWidget *widget)
{
GtkLabel *label = GTK_LABEL (widget);
GtkSettings *settings;
gboolean shortcuts_connected;
GTK_WIDGET_CLASS (gtk_label_parent_class)->root (widget);
gtk_label_setup_mnemonic (label);
/* The PangoContext is replaced when the display changes, so clear the layouts */
gtk_label_clear_layout (GTK_LABEL (widget));
settings = gtk_widget_get_settings (widget);
shortcuts_connected =
GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (settings), quark_shortcuts_connected));
if (! shortcuts_connected)
{
g_signal_connect (settings, "notify::gtk-enable-accels",
G_CALLBACK (label_shortcut_setting_changed),
NULL);
g_object_set_qdata (G_OBJECT (settings), quark_shortcuts_connected,
GINT_TO_POINTER (TRUE));
}
label_shortcut_setting_apply (GTK_LABEL (widget));
}
static void
gtk_label_unroot (GtkWidget *widget)
{
GtkLabel *label = GTK_LABEL (widget);
gtk_label_setup_mnemonic (label);
GTK_WIDGET_CLASS (gtk_label_parent_class)->unroot (widget);
}
void
_gtk_label_mnemonics_visible_apply_recursively (GtkWidget *widget,
gboolean visible)
{
if (GTK_IS_LABEL (widget))
{
GtkLabel *label = GTK_LABEL (widget);
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
if (priv->mnemonics_visible != visible)
{
priv->mnemonics_visible = visible;
gtk_label_recalculate (label);
}
}
else
{
GtkWidget *child;
for (child = gtk_widget_get_first_child (widget);
child;
child = gtk_widget_get_next_sibling (child))
{
if (GTK_IS_NATIVE (child))
continue;
_gtk_label_mnemonics_visible_apply_recursively (child, visible);
}
}
}
static void
label_mnemonics_visible_changed (GtkWidget *widget,
GParamSpec *pspec,
gpointer data)
{
gboolean visible;
g_object_get (widget, "mnemonics-visible", &visible, NULL);
_gtk_label_mnemonics_visible_apply_recursively (widget, visible);
}
static void
label_mnemonic_widget_weak_notify (gpointer data,
GObject *where_the_object_was)
{
GtkLabel *label = data;
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
priv->mnemonic_widget = NULL;
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_MNEMONIC_WIDGET]);
}
/**
* gtk_label_set_mnemonic_widget:
* @label: a #GtkLabel
* @widget: (nullable): the target #GtkWidget, or %NULL to unset
*
* If the label has been set so that it has a mnemonic key (using
* i.e. gtk_label_set_markup_with_mnemonic(),
* gtk_label_set_text_with_mnemonic(), gtk_label_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 #GtkButton or a #GtkNotebook tab) it is
* automatically associated with the correct widget, but sometimes
* (i.e. when the target is a #GtkEntry 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.
**/
void
gtk_label_set_mnemonic_widget (GtkLabel *label,
GtkWidget *widget)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_if_fail (GTK_IS_LABEL (label));
if (widget)
g_return_if_fail (GTK_IS_WIDGET (widget));
if (priv->mnemonic_widget)
{
gtk_widget_remove_mnemonic_label (priv->mnemonic_widget, GTK_WIDGET (label));
g_object_weak_unref (G_OBJECT (priv->mnemonic_widget),
label_mnemonic_widget_weak_notify,
label);
}
priv->mnemonic_widget = widget;
if (priv->mnemonic_widget)
{
g_object_weak_ref (G_OBJECT (priv->mnemonic_widget),
label_mnemonic_widget_weak_notify,
label);
gtk_widget_add_mnemonic_label (priv->mnemonic_widget, GTK_WIDGET (label));
}
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_MNEMONIC_WIDGET]);
}
/**
* gtk_label_get_mnemonic_widget:
* @label: a #GtkLabel
*
* Retrieves the target of the mnemonic (keyboard shortcut) of this
* label. See gtk_label_set_mnemonic_widget().
*
* Returns: (nullable) (transfer none): the target of the label’s mnemonic,
* or %NULL if none has been set and the default algorithm will be used.
**/
GtkWidget *
gtk_label_get_mnemonic_widget (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
return priv->mnemonic_widget;
}
/**
* gtk_label_get_mnemonic_keyval:
* @label: a #GtkLabel
*
* 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
**/
guint
gtk_label_get_mnemonic_keyval (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_val_if_fail (GTK_IS_LABEL (label), GDK_KEY_VoidSymbol);
return priv->mnemonic_keyval;
}
static void
gtk_label_set_text_internal (GtkLabel *label,
gchar *str)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
if (g_strcmp0 (priv->text, str) == 0)
{
g_free (str);
return;
}
_gtk_label_accessible_text_deleted (label);
g_free (priv->text);
priv->text = str;
_gtk_label_accessible_text_inserted (label);
gtk_label_select_region_index (label, 0, 0);
}
static void
gtk_label_set_label_internal (GtkLabel *label,
gchar *str)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_free (priv->label);
priv->label = str;
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_LABEL]);
}
static gboolean
gtk_label_set_use_markup_internal (GtkLabel *label,
gboolean val)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
val = val != FALSE;
if (priv->use_markup != val)
{
priv->use_markup = val;
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_USE_MARKUP]);
return TRUE;
}
return FALSE;
}
static gboolean
gtk_label_set_use_underline_internal (GtkLabel *label,
gboolean val)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
val = val != FALSE;
if (priv->use_underline != val)
{
priv->use_underline = val;
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_USE_UNDERLINE]);
return TRUE;
}
return FALSE;
}
/* Calculates text, attrs and mnemonic_keyval from
* label, use_underline and use_markup
*/
static void
gtk_label_recalculate (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
guint keyval = priv->mnemonic_keyval;
gtk_label_clear_links (label);
gtk_label_clear_layout (label);
gtk_label_clear_select_info (label);
if (priv->use_markup)
gtk_label_set_markup_internal (label, priv->label, priv->use_underline);
else if (priv->use_underline)
gtk_label_set_uline_text_internal (label, priv->label);
else
{
g_clear_pointer (&priv->markup_attrs, pango_attr_list_unref);
gtk_label_set_text_internal (label, g_strdup (priv->label));
}
if (!priv->use_underline)
priv->mnemonic_keyval = GDK_KEY_VoidSymbol;
if (keyval != priv->mnemonic_keyval)
{
gtk_label_setup_mnemonic (label);
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_MNEMONIC_KEYVAL]);
}
gtk_widget_queue_resize (GTK_WIDGET (label));
}
/**
* gtk_label_set_text:
* @label: a #GtkLabel
* @str: The text you want to set
*
* Sets the text within the #GtkLabel widget. It overwrites any text that
* was there before.
*
* This function will clear any previously set mnemonic accelerators, and
* set the #GtkLabel:use-underline property to %FALSE as a side effect.
*
* This function will set the #GtkLabel:use-markup property to %FALSE
* as a side effect.
*
* See also: gtk_label_set_markup()
**/
void
gtk_label_set_text (GtkLabel *label,
const gchar *str)
{
g_return_if_fail (GTK_IS_LABEL (label));
g_object_freeze_notify (G_OBJECT (label));
gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
gtk_label_set_use_markup_internal (label, FALSE);
gtk_label_set_use_underline_internal (label, FALSE);
gtk_label_recalculate (label);
g_object_thaw_notify (G_OBJECT (label));
}
/**
* gtk_label_set_attributes:
* @label: a #GtkLabel
* @attrs: (nullable): a #PangoAttrList, or %NULL
*
* Sets a #PangoAttrList; 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 #GtkLabel:use-underline or #GtkLabel: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.
**/
void
gtk_label_set_attributes (GtkLabel *label,
PangoAttrList *attrs)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_if_fail (GTK_IS_LABEL (label));
if (attrs)
pango_attr_list_ref (attrs);
if (priv->attrs)
pango_attr_list_unref (priv->attrs);
priv->attrs = attrs;
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_ATTRIBUTES]);
gtk_label_clear_layout (label);
gtk_widget_queue_resize (GTK_WIDGET (label));
}
/**
* gtk_label_get_attributes:
* @label: a #GtkLabel
*
* Gets the attribute list that was set on the label using
* gtk_label_set_attributes(), if any. This function does
* not reflect attributes that come from the labels markup
* (see gtk_label_set_markup()). If you want to get the
* effective attributes for the label, use
* pango_layout_get_attribute (gtk_label_get_layout (label)).
*
* Returns: (nullable) (transfer none): the attribute list, or %NULL
* if none was set.
**/
PangoAttrList *
gtk_label_get_attributes (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
return priv->attrs;
}
/**
* gtk_label_set_label:
* @label: a #GtkLabel
* @str: the new text to set for the label
*
* Sets the text of the label. The label is interpreted as
* including embedded underlines and/or Pango markup depending
* on the values of the #GtkLabel:use-underline and
* #GtkLabel:use-markup properties.
**/
void
gtk_label_set_label (GtkLabel *label,
const gchar *str)
{
g_return_if_fail (GTK_IS_LABEL (label));
g_object_freeze_notify (G_OBJECT (label));
gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
gtk_label_recalculate (label);
g_object_thaw_notify (G_OBJECT (label));
}
/**
* gtk_label_get_label:
* @label: a #GtkLabel
*
* Fetches the text from a label widget including any embedded
* underlines indicating mnemonics and Pango markup. (See
* gtk_label_get_text()).
*
* Returns: the text of the label widget. This string is
* owned by the widget and must not be modified or freed.
**/
const gchar *
gtk_label_get_label (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
return priv->label;
}
typedef struct
{
GtkLabel *label;
GArray *links;
GString *new_str;
gsize text_len;
} UriParserData;
static void
start_element_handler (GMarkupParseContext *context,
const gchar *element_name,
const gchar **attribute_names,
const gchar **attribute_values,
gpointer user_data,
GError **error)
{
UriParserData *pdata = user_data;
GtkLabelPrivate *priv = gtk_label_get_instance_private (pdata->label);
if (strcmp (element_name, "a") == 0)
{
GtkLabelLink link;
const gchar *uri = NULL;
const gchar *title = NULL;
const gchar *class = NULL;
gboolean visited = FALSE;
gint line_number;
gint char_number;
gint i;
GtkCssNode *widget_node;
GtkStateFlags state;
g_markup_parse_context_get_position (context, &line_number, &char_number);
for (i = 0; attribute_names[i] != NULL; i++)
{
const gchar *attr = attribute_names[i];
if (strcmp (attr, "href") == 0)
uri = attribute_values[i];
else if (strcmp (attr, "title") == 0)
title = attribute_values[i];
else if (strcmp (attr, "class") == 0)
class = attribute_values[i];
else
{
g_set_error (error,
G_MARKUP_ERROR,
G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE,
"Attribute '%s' is not allowed on the <a> tag "
"on line %d char %d",
attr, line_number, char_number);
return;
}
}
if (uri == NULL)
{
g_set_error (error,
G_MARKUP_ERROR,
G_MARKUP_ERROR_INVALID_CONTENT,
"Attribute 'href' was missing on the <a> tag "
"on line %d char %d",
line_number, char_number);
return;
}
visited = FALSE;
if (priv->track_links && priv->select_info)
{
for (i = 0; i < priv->select_info->n_links; i++)
{
const GtkLabelLink *l = &priv->select_info->links[i];
if (strcmp (uri, l->uri) == 0)
{
visited = l->visited;
break;
}
}
}
if (!pdata->links)
pdata->links = g_array_new (FALSE, TRUE, sizeof (GtkLabelLink));
link.uri = g_strdup (uri);
link.title = g_strdup (title);
widget_node = gtk_widget_get_css_node (GTK_WIDGET (pdata->label));
link.cssnode = gtk_css_node_new ();
gtk_css_node_set_name (link.cssnode, g_quark_from_static_string ("link"));
gtk_css_node_set_parent (link.cssnode, widget_node);
if (class)
gtk_css_node_add_class (link.cssnode, g_quark_from_string (class));
state = gtk_css_node_get_state (widget_node);
if (visited)
state |= GTK_STATE_FLAG_VISITED;
else
state |= GTK_STATE_FLAG_LINK;
gtk_css_node_set_state (link.cssnode, state);
g_object_unref (link.cssnode);
link.visited = visited;
link.start = pdata->text_len;
g_array_append_val (pdata->links, link);
}
else
{
gint i;
g_string_append_c (pdata->new_str, '<');
g_string_append (pdata->new_str, element_name);
for (i = 0; attribute_names[i] != NULL; i++)
{
const gchar *attr = attribute_names[i];
const gchar *value = attribute_values[i];
gchar *newvalue;
newvalue = g_markup_escape_text (value, -1);
g_string_append_c (pdata->new_str, ' ');
g_string_append (pdata->new_str, attr);
g_string_append (pdata->new_str, "=\"");
g_string_append (pdata->new_str, newvalue);
g_string_append_c (pdata->new_str, '\"');
g_free (newvalue);
}
g_string_append_c (pdata->new_str, '>');
}
}
static void
end_element_handler (GMarkupParseContext *context,
const gchar *element_name,
gpointer user_data,
GError **error)
{
UriParserData *pdata = user_data;
if (!strcmp (element_name, "a"))
{
GtkLabelLink *link = &g_array_index (pdata->links, GtkLabelLink, pdata->links->len - 1);
link->end = pdata->text_len;
}
else
{
g_string_append (pdata->new_str, "</");
g_string_append (pdata->new_str, element_name);
g_string_append_c (pdata->new_str, '>');
}
}
static void
text_handler (GMarkupParseContext *context,
const gchar *text,
gsize text_len,
gpointer user_data,
GError **error)
{
UriParserData *pdata = user_data;
gchar *newtext;
newtext = g_markup_escape_text (text, text_len);
g_string_append (pdata->new_str, newtext);
pdata->text_len += text_len;
g_free (newtext);
}
static const GMarkupParser markup_parser =
{
start_element_handler,
end_element_handler,
text_handler,
NULL,
NULL
};
static gboolean
xml_isspace (gchar c)
{
return (c == ' ' || c == '\t' || c == '\n' || c == '\r');
}
static void
link_free (GtkLabelLink *link)
{
gtk_css_node_set_parent (link->cssnode, NULL);
g_free (link->uri);
g_free (link->title);
}
static gboolean
parse_uri_markup (GtkLabel *label,
const gchar *str,
gchar **new_str,
GtkLabelLink **links,
guint *out_n_links,
GError **error)
{
GMarkupParseContext *context;
const char *p, *end;
gsize length;
UriParserData pdata;
length = strlen (str);
p = str;
end = str + length;
pdata.label = label;
pdata.links = NULL;
pdata.new_str = g_string_sized_new (length);
pdata.text_len = 0;
while (p != end && xml_isspace (*p))
p++;
context = g_markup_parse_context_new (&markup_parser, 0, &pdata, NULL);
if (end - p >= 8 && strncmp (p, "<markup>", 8) == 0)
{
if (!g_markup_parse_context_parse (context, str, length, error))
goto failed;
}
else
{
if (!g_markup_parse_context_parse (context, "<markup>", 8, error))
goto failed;
if (!g_markup_parse_context_parse (context, str, length, error))
goto failed;
if (!g_markup_parse_context_parse (context, "</markup>", 9, error))
goto failed;
}
if (!g_markup_parse_context_end_parse (context, error))
goto failed;
g_markup_parse_context_free (context);
*new_str = g_string_free (pdata.new_str, FALSE);
if (pdata.links)
{
*out_n_links = pdata.links->len;
*links = (GtkLabelLink *)g_array_free (pdata.links, FALSE);
}
else
{
*links = NULL;
}
return TRUE;
failed:
g_markup_parse_context_free (context);
g_string_free (pdata.new_str, TRUE);
if (pdata.links)
g_array_free (pdata.links, TRUE);
return FALSE;
}
static void
gtk_label_ensure_has_tooltip (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
guint i;
gboolean has_tooltip = FALSE;
for (i = 0; i < priv->select_info->n_links; i++)
{
const GtkLabelLink *link = &priv->select_info->links[i];
if (link->title)
{
has_tooltip = TRUE;
break;
}
}
gtk_widget_set_has_tooltip (GTK_WIDGET (label), has_tooltip);
}
static void
gtk_label_set_markup_internal (GtkLabel *label,
const gchar *str,
gboolean with_uline)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
gchar *text = NULL;
GError *error = NULL;
PangoAttrList *attrs = NULL;
gunichar accel_char = 0;
gchar *str_for_display = NULL;
gchar *str_for_accel = NULL;
GtkLabelLink *links = NULL;
guint n_links = 0;
if (!parse_uri_markup (label, str, &str_for_display, &links, &n_links, &error))
{
g_warning ("Failed to set text '%s' from markup due to error parsing markup: %s",
str, error->message);
g_error_free (error);
return;
}
if (links)
{
gtk_label_ensure_select_info (label);
priv->select_info->links = g_steal_pointer (&links);
priv->select_info->n_links = n_links;
_gtk_label_accessible_update_links (label);
gtk_label_ensure_has_tooltip (label);
gtk_widget_add_css_class (GTK_WIDGET (label), "link");
}
if (with_uline)
{
gboolean enable_mnemonics = TRUE;
gboolean auto_mnemonics = TRUE;
str_for_accel = g_strdup (str_for_display);
if (!(enable_mnemonics && priv->mnemonics_visible &&
(!auto_mnemonics ||
(gtk_widget_is_sensitive (GTK_WIDGET (label)) &&
(!priv->mnemonic_widget ||
gtk_widget_is_sensitive (priv->mnemonic_widget))))))
{
gchar *tmp;
gchar *pattern;
guint key;
if (separate_uline_pattern (str_for_display, &key, &tmp, &pattern))
{
g_free (str_for_display);
str_for_display = tmp;
g_free (pattern);
}
}
}
/* Extract the text to display */
if (!pango_parse_markup (str_for_display,
-1,
with_uline ? '_' : 0,
&attrs,
&text,
NULL,
&error))
{
g_warning ("Failed to set text '%s' from markup due to error parsing markup: %s",
str_for_display, error->message);
g_free (str_for_display);
g_free (str_for_accel);
g_error_free (error);
return;
}
/* Extract the accelerator character */
if (with_uline && !pango_parse_markup (str_for_accel,
-1,
'_',
NULL,
NULL,
&accel_char,
&error))
{
g_warning ("Failed to set text from markup due to error parsing markup: %s",
error->message);
g_free (str_for_display);
g_free (str_for_accel);
g_error_free (error);
return;
}
g_free (str_for_display);
g_free (str_for_accel);
if (text)
gtk_label_set_text_internal (label, text);
if (attrs)
{
g_clear_pointer (&priv->markup_attrs, pango_attr_list_unref);
priv->markup_attrs = attrs;
}
if (accel_char != 0)
priv->mnemonic_keyval = gdk_keyval_to_lower (gdk_unicode_to_keyval (accel_char));
else
priv->mnemonic_keyval = GDK_KEY_VoidSymbol;
}
/**
* gtk_label_set_markup:
* @label: a #GtkLabel
* @str: a markup string (see [Pango markup format][PangoMarkupFormat])
*
* 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
* g_markup_escape_text() or g_markup_printf_escaped():
*
* |[<!-- language="C" -->
* GtkWidget *label = gtk_label_new (NULL);
* const char *str = "...";
* const char *format = "<span style=\"italic\">\%s</span>";
* char *markup;
*
* markup = g_markup_printf_escaped (format, str);
* gtk_label_set_markup (GTK_LABEL (label), markup);
* g_free (markup);
* ]|
*
* This function will set the #GtkLabel:use-markup property to %TRUE as
* a side effect.
*
* If you set the label contents using the #GtkLabel:label property you
* should also ensure that you set the #GtkLabel:use-markup property
* accordingly.
*
* See also: gtk_label_set_text()
**/
void
gtk_label_set_markup (GtkLabel *label,
const gchar *str)
{
g_return_if_fail (GTK_IS_LABEL (label));
g_object_freeze_notify (G_OBJECT (label));
gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
gtk_label_set_use_markup_internal (label, TRUE);
gtk_label_set_use_underline_internal (label, FALSE);
gtk_label_recalculate (label);
g_object_thaw_notify (G_OBJECT (label));
}
/**
* gtk_label_set_markup_with_mnemonic:
* @label: a #GtkLabel
* @str: a markup string (see
* [Pango markup format][PangoMarkupFormat])
*
* 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 gtk_label_set_mnemonic_widget().
*/
void
gtk_label_set_markup_with_mnemonic (GtkLabel *label,
const gchar *str)
{
g_return_if_fail (GTK_IS_LABEL (label));
g_object_freeze_notify (G_OBJECT (label));
gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
gtk_label_set_use_markup_internal (label, TRUE);
gtk_label_set_use_underline_internal (label, TRUE);
gtk_label_recalculate (label);
g_object_thaw_notify (G_OBJECT (label));
}
/**
* gtk_label_get_text:
* @label: a #GtkLabel
*
* 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 gtk_label_get_label())
*
* Returns: the text in the label widget. This is the internal
* string used by the label, and must not be modified.
**/
const gchar *
gtk_label_get_text (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
return priv->text;
}
static PangoAttrList *
gtk_label_pattern_to_attrs (GtkLabel *label,
const gchar *pattern)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
const char *start;
const char *p = priv->text;
const char *q = pattern;
PangoAttrList *attrs;
attrs = pango_attr_list_new ();
while (1)
{
while (*p && *q && *q != '_')
{
p = g_utf8_next_char (p);
q++;
}
start = p;
while (*p && *q && *q == '_')
{
p = g_utf8_next_char (p);
q++;
}
if (p > start)
{
PangoAttribute *attr = pango_attr_underline_new (PANGO_UNDERLINE_LOW);
attr->start_index = start - priv->text;
attr->end_index = p - priv->text;
pango_attr_list_insert (attrs, attr);
}
else
break;
}
return attrs;
}
static void
gtk_label_set_pattern_internal (GtkLabel *label,
const gchar *pattern,
gboolean is_mnemonic)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
PangoAttrList *attrs;
gboolean auto_mnemonics = TRUE;
if (is_mnemonic)
{
if (priv->mnemonics_visible && pattern &&
(!auto_mnemonics ||
(gtk_widget_is_sensitive (GTK_WIDGET (label)) &&
(!priv->mnemonic_widget ||
gtk_widget_is_sensitive (priv->mnemonic_widget)))))
attrs = gtk_label_pattern_to_attrs (label, pattern);
else
attrs = NULL;
}
else
attrs = gtk_label_pattern_to_attrs (label, pattern);
if (priv->markup_attrs)
pango_attr_list_unref (priv->markup_attrs);
priv->markup_attrs = attrs;
}
/**
* gtk_label_set_justify:
* @label: a #GtkLabel
* @jtype: a #GtkJustification
*
* Sets the alignment of the lines in the text of the label relative to
* each other. %GTK_JUSTIFY_LEFT is the default value when the widget is
* first created with gtk_label_new(). If you instead want to set the
* alignment of the label as a whole, use gtk_widget_set_halign() instead.
* gtk_label_set_justify() has no effect on labels containing only a
* single line.
*/
void
gtk_label_set_justify (GtkLabel *label,
GtkJustification jtype)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_if_fail (GTK_IS_LABEL (label));
g_return_if_fail (jtype >= GTK_JUSTIFY_LEFT && jtype <= GTK_JUSTIFY_FILL);
if ((GtkJustification) priv->jtype != jtype)
{
priv->jtype = jtype;
/* No real need to be this drastic, but easier than duplicating the code */
gtk_label_clear_layout (label);
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_JUSTIFY]);
gtk_widget_queue_resize (GTK_WIDGET (label));
}
}
/**
* gtk_label_get_justify:
* @label: a #GtkLabel
*
* Returns the justification of the label. See gtk_label_set_justify().
*
* Returns: #GtkJustification
**/
GtkJustification
gtk_label_get_justify (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_val_if_fail (GTK_IS_LABEL (label), 0);
return priv->jtype;
}
/**
* gtk_label_set_ellipsize:
* @label: a #GtkLabel
* @mode: a #PangoEllipsizeMode
*
* Sets the mode used to ellipsize (add an ellipsis: "...") to the text
* if there is not enough space to render the entire string.
**/
void
gtk_label_set_ellipsize (GtkLabel *label,
PangoEllipsizeMode mode)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_if_fail (GTK_IS_LABEL (label));
g_return_if_fail (mode >= PANGO_ELLIPSIZE_NONE && mode <= PANGO_ELLIPSIZE_END);
if ((PangoEllipsizeMode) priv->ellipsize != mode)
{
priv->ellipsize = mode;
/* No real need to be this drastic, but easier than duplicating the code */
gtk_label_clear_layout (label);
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_ELLIPSIZE]);
gtk_widget_queue_resize (GTK_WIDGET (label));
}
}
/**
* gtk_label_get_ellipsize:
* @label: a #GtkLabel
*
* Returns the ellipsizing position of the label. See gtk_label_set_ellipsize().
*
* Returns: #PangoEllipsizeMode
**/
PangoEllipsizeMode
gtk_label_get_ellipsize (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_val_if_fail (GTK_IS_LABEL (label), PANGO_ELLIPSIZE_NONE);
return priv->ellipsize;
}
/**
* gtk_label_set_width_chars:
* @label: a #GtkLabel
* @n_chars: the new desired width, in characters.
*
* Sets the desired width in characters of @label to @n_chars.
**/
void
gtk_label_set_width_chars (GtkLabel *label,
gint n_chars)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_if_fail (GTK_IS_LABEL (label));
if (priv->width_chars != n_chars)
{
priv->width_chars = n_chars;
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_WIDTH_CHARS]);
gtk_widget_queue_resize (GTK_WIDGET (label));
}
}
/**
* gtk_label_get_width_chars:
* @label: a #GtkLabel
*
* Retrieves the desired width of @label, in characters. See
* gtk_label_set_width_chars().
*
* Returns: the width of the label in characters.
**/
gint
gtk_label_get_width_chars (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_val_if_fail (GTK_IS_LABEL (label), -1);
return priv->width_chars;
}
/**
* gtk_label_set_max_width_chars:
* @label: a #GtkLabel
* @n_chars: the new desired maximum width, in characters.
*
* Sets the desired maximum width in characters of @label to @n_chars.
**/
void
gtk_label_set_max_width_chars (GtkLabel *label,
gint n_chars)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_if_fail (GTK_IS_LABEL (label));
if (priv->max_width_chars != n_chars)
{
priv->max_width_chars = n_chars;
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_MAX_WIDTH_CHARS]);
gtk_widget_queue_resize (GTK_WIDGET (label));
}
}
/**
* gtk_label_get_max_width_chars:
* @label: a #GtkLabel
*
* Retrieves the desired maximum width of @label, in characters. See
* gtk_label_set_width_chars().
*
* Returns: the maximum width of the label in characters.
**/
gint
gtk_label_get_max_width_chars (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_val_if_fail (GTK_IS_LABEL (label), -1);
return priv->max_width_chars;
}
/**
* gtk_label_set_wrap:
* @label: a #GtkLabel
* @wrap: the setting
*
* Toggles line wrapping within the #GtkLabel 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().
**/
void
gtk_label_set_wrap (GtkLabel *label,
gboolean wrap)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_if_fail (GTK_IS_LABEL (label));
wrap = wrap != FALSE;
if (priv->wrap != wrap)
{
priv->wrap = wrap;
gtk_label_clear_layout (label);
gtk_widget_queue_resize (GTK_WIDGET (label));
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_WRAP]);
}
}
/**
* gtk_label_get_wrap:
* @label: a #GtkLabel
*
* Returns whether lines in the label are automatically wrapped.
* See gtk_label_set_wrap().
*
* Returns: %TRUE if the lines of the label are automatically wrapped.
*/
gboolean
gtk_label_get_wrap (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
return priv->wrap;
}
/**
* gtk_label_set_wrap_mode:
* @label: a #GtkLabel
* @wrap_mode: the line wrapping mode
*
* If line wrapping is on (see gtk_label_set_wrap()) this controls how
* the line wrapping is done. The default is %PANGO_WRAP_WORD which means
* wrap on word boundaries.
**/
void
gtk_label_set_wrap_mode (GtkLabel *label,
PangoWrapMode wrap_mode)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_if_fail (GTK_IS_LABEL (label));
if (priv->wrap_mode != wrap_mode)
{
priv->wrap_mode = wrap_mode;
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_WRAP_MODE]);
gtk_widget_queue_resize (GTK_WIDGET (label));
}
}
/**
* gtk_label_get_wrap_mode:
* @label: a #GtkLabel
*
* Returns line wrap mode used by the label. See gtk_label_set_wrap_mode().
*
* Returns: %TRUE if the lines of the label are automatically wrapped.
*/
PangoWrapMode
gtk_label_get_wrap_mode (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
return priv->wrap_mode;
}
static void
gtk_label_destroy (GtkWidget *widget)
{
GtkLabel *label = GTK_LABEL (widget);
gtk_label_set_mnemonic_widget (label, NULL);
GTK_WIDGET_CLASS (gtk_label_parent_class)->destroy (widget);
}
static void
gtk_label_finalize (GObject *object)
{
GtkLabel *label = GTK_LABEL (object);
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_free (priv->label);
g_free (priv->text);
g_clear_object (&priv->layout);
g_clear_pointer (&priv->attrs, pango_attr_list_unref);
g_clear_pointer (&priv->markup_attrs, pango_attr_list_unref);
if (priv->select_info)
g_object_unref (priv->select_info->provider);
gtk_label_clear_links (label);
g_free (priv->select_info);
g_clear_pointer (&priv->popup_menu, gtk_widget_unparent);
g_clear_object (&priv->extra_menu);
G_OBJECT_CLASS (gtk_label_parent_class)->finalize (object);
}
static void
gtk_label_clear_layout (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_clear_object (&priv->layout);
}
/**
* gtk_label_get_measuring_layout:
* @label: the label
* @existing_layout: %NULL or an existing layout already in use.
* @width: the width to measure with in pango units, or -1 for infinite
*
* Gets a layout that can be used for measuring sizes. The returned
* layout will be identical to the label’s layout except for the
* layout’s width, which will be set to @width. Do not modify the returned
* layout.
*
* Returns: a new reference to a pango layout
**/
static PangoLayout *
gtk_label_get_measuring_layout (GtkLabel * label,
PangoLayout *existing_layout,
int width)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
PangoRectangle rect;
PangoLayout *copy;
if (existing_layout != NULL)
{
if (existing_layout != priv->layout)
{
pango_layout_set_width (existing_layout, width);
return existing_layout;
}
g_object_unref (existing_layout);
}
gtk_label_ensure_layout (label);
if (pango_layout_get_width (priv->layout) == width)
{
g_object_ref (priv->layout);
return priv->layout;
}
/* We can use the label's own layout if we're not allocated a size yet,
* because we don't need it to be properly setup at that point.
* This way we can make use of caching upon the label's creation.
*/
if (gtk_widget_get_width (GTK_WIDGET (label)) <= 1)
{
g_object_ref (priv->layout);
pango_layout_set_width (priv->layout, width);
return priv->layout;
}
/* oftentimes we want to measure a width that is far wider than the current width,
* even though the layout would not change if we made it wider. In that case, we
* can just return the current layout, because for measuring purposes, it will be
* identical.
*/
pango_layout_get_extents (priv->layout, NULL, &rect);
if ((width == -1 || rect.width <= width) &&
!pango_layout_is_wrapped (priv->layout) &&
!pango_layout_is_ellipsized (priv->layout))
{
g_object_ref (priv->layout);
return priv->layout;
}
copy = pango_layout_copy (priv->layout);
pango_layout_set_width (copy, width);
return copy;
}
static void
gtk_label_update_layout_attributes (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GtkWidget *widget = GTK_WIDGET (label);
GtkCssStyle *style;
PangoAttrList *attrs;
PangoAttrList *style_attrs;
if (priv->layout == NULL)
return;
if (priv->select_info && priv->select_info->links)
{
guint i;
attrs = pango_attr_list_new ();
for (i = 0; i < priv->select_info->n_links; i++)
{
const GtkLabelLink *link = &priv->select_info->links[i];
const GdkRGBA *link_color;
PangoAttrList *link_attrs;
PangoAttribute *attr;
style = gtk_css_node_get_style (link->cssnode);
link_attrs = gtk_css_style_get_pango_attributes (style);
if (link_attrs)
{
GSList *attributes = pango_attr_list_get_attributes (link_attrs);
GSList *l;
for (l = attributes; l; l = l->next)
{
attr = l->data;
attr->start_index = link->start;
attr->end_index = link->end;
pango_attr_list_insert (attrs, attr);
}
g_slist_free (attributes);
}
link_color = gtk_css_color_value_get_rgba (style->core->color);
attr = pango_attr_foreground_new (link_color->red * 65535,
link_color->green * 65535,
link_color->blue * 65535);
attr->start_index = link->start;
attr->end_index = link->end;
pango_attr_list_insert (attrs, attr);
pango_attr_list_unref (link_attrs);
}
}
else if (priv->markup_attrs && priv->attrs)
attrs = pango_attr_list_new ();
else
attrs = NULL;
style = gtk_css_node_get_style (gtk_widget_get_css_node (widget));
style_attrs = gtk_css_style_get_pango_attributes (style);
if (style_attrs)
{
attrs = _gtk_pango_attr_list_merge (attrs, style_attrs);
pango_attr_list_unref (style_attrs);
}
attrs = _gtk_pango_attr_list_merge (attrs, priv->markup_attrs);
attrs = _gtk_pango_attr_list_merge (attrs, priv->attrs);
pango_layout_set_attributes (priv->layout, attrs);
if (attrs)
pango_attr_list_unref (attrs);
}
static void
gtk_label_ensure_layout (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
PangoAlignment align;
gboolean rtl;
if (priv->layout)
return;
align = PANGO_ALIGN_LEFT; /* Quiet gcc */
rtl = _gtk_widget_get_direction (GTK_WIDGET (label)) == GTK_TEXT_DIR_RTL;
priv->layout = gtk_widget_create_pango_layout (GTK_WIDGET (label), priv->text);
gtk_label_update_layout_attributes (label);
switch (priv->jtype)
{
case GTK_JUSTIFY_LEFT:
align = rtl ? PANGO_ALIGN_RIGHT : PANGO_ALIGN_LEFT;
break;
case GTK_JUSTIFY_RIGHT:
align = rtl ? PANGO_ALIGN_LEFT : PANGO_ALIGN_RIGHT;
break;
case GTK_JUSTIFY_CENTER:
align = PANGO_ALIGN_CENTER;
break;
case GTK_JUSTIFY_FILL:
align = rtl ? PANGO_ALIGN_RIGHT : PANGO_ALIGN_LEFT;
pango_layout_set_justify (priv->layout, TRUE);
break;
default:
g_assert_not_reached();
}
pango_layout_set_alignment (priv->layout, align);
pango_layout_set_ellipsize (priv->layout, priv->ellipsize);
pango_layout_set_wrap (priv->layout, priv->wrap_mode);
pango_layout_set_single_paragraph_mode (priv->layout, priv->single_line_mode);
if (priv->lines > 0)
pango_layout_set_height (priv->layout, - priv->lines);
if (priv->ellipsize || priv->wrap)
pango_layout_set_width (priv->layout, gtk_widget_get_width (GTK_WIDGET (label)) * PANGO_SCALE);
}
static GtkSizeRequestMode
gtk_label_get_request_mode (GtkWidget *widget)
{
GtkLabel *label = GTK_LABEL (widget);
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
if (priv->wrap)
return GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH;
return GTK_SIZE_REQUEST_CONSTANT_SIZE;
}
static void
get_height_for_width (GtkLabel *label,
gint width,
gint *minimum_height,
gint *natural_height,
gint *minimum_baseline,
gint *natural_baseline)
{
PangoLayout *layout;
gint text_height, baseline;
layout = gtk_label_get_measuring_layout (label, NULL, width * PANGO_SCALE);
pango_layout_get_pixel_size (layout, NULL, &text_height);
*minimum_height = text_height;
*natural_height = text_height;
baseline = pango_layout_get_baseline (layout) / PANGO_SCALE;
*minimum_baseline = baseline;
*natural_baseline = baseline;
g_object_unref (layout);
}
static gint
get_char_pixels (GtkWidget *label,
PangoLayout *layout)
{
PangoContext *context;
PangoFontMetrics *metrics;
gint char_width, digit_width;
context = pango_layout_get_context (layout);
metrics = pango_context_get_metrics (context,
pango_context_get_font_description (context),
pango_context_get_language (context));
char_width = pango_font_metrics_get_approximate_char_width (metrics);
digit_width = pango_font_metrics_get_approximate_digit_width (metrics);
pango_font_metrics_unref (metrics);
return MAX (char_width, digit_width);;
}
static void
gtk_label_get_preferred_layout_size (GtkLabel *label,
PangoRectangle *smallest,
PangoRectangle *widest,
int *smallest_baseline,
int *widest_baseline)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
PangoLayout *layout;
gint char_pixels;
/* "width-chars" Hard-coded minimum width:
* - minimum size should be MAX (width-chars, strlen ("..."));
* - natural size should be MAX (width-chars, strlen (priv->text));
*
* "max-width-chars" User specified maximum size requisition
* - minimum size should be MAX (width-chars, 0)
* - natural size should be MIN (max-width-chars, strlen (priv->text))
*
* For ellipsizing labels; if max-width-chars is specified: either it is used as
* a minimum size or the label text as a minimum size (natural size still overflows).
*
* For wrapping labels; A reasonable minimum size is useful to naturally layout
* interfaces automatically. In this case if no "width-chars" is specified, the minimum
* width will default to the wrap guess that gtk_label_ensure_layout() does.
*/
/* Start off with the pixel extents of an as-wide-as-possible layout */
layout = gtk_label_get_measuring_layout (label, NULL, -1);
if (priv->width_chars > -1 || priv->max_width_chars > -1)
char_pixels = get_char_pixels (GTK_WIDGET (label), layout);
else
char_pixels = 0;
pango_layout_get_extents (layout, NULL, widest);
widest->width = MAX (widest->width, char_pixels * priv->width_chars);
widest->x = widest->y = 0;
*widest_baseline = pango_layout_get_baseline (layout) / PANGO_SCALE;
if (priv->ellipsize || priv->wrap)
{
/* a layout with width 0 will be as small as humanly possible */
layout = gtk_label_get_measuring_layout (label,
layout,
priv->width_chars > -1 ? char_pixels * priv->width_chars
: 0);
pango_layout_get_extents (layout, NULL, smallest);
smallest->width = MAX (smallest->width, char_pixels * priv->width_chars);
smallest->x = smallest->y = 0;
*smallest_baseline = pango_layout_get_baseline (layout) / PANGO_SCALE;
if (priv->max_width_chars > -1 && widest->width > char_pixels * priv->max_width_chars)
{
layout = gtk_label_get_measuring_layout (label,
layout,
MAX (smallest->width, char_pixels * priv->max_width_chars));
pango_layout_get_extents (layout, NULL, widest);
widest->width = MAX (widest->width, char_pixels * priv->width_chars);
widest->x = widest->y = 0;
*widest_baseline = pango_layout_get_baseline (layout) / PANGO_SCALE;
}
if (widest->width < smallest->width)
{
*smallest = *widest;
*smallest_baseline = *widest_baseline;
}
}
else
{
*smallest = *widest;
*smallest_baseline = *widest_baseline;
}
g_object_unref (layout);
}
static void
gtk_label_get_preferred_size (GtkWidget *widget,
GtkOrientation orientation,
gint *minimum_size,
gint *natural_size,
gint *minimum_baseline,
gint *natural_baseline)
{
GtkLabel *label = GTK_LABEL (widget);
PangoRectangle widest_rect;
PangoRectangle smallest_rect;
int smallest_baseline;
int widest_baseline;
gtk_label_get_preferred_layout_size (label,
&smallest_rect, &widest_rect,
&smallest_baseline, &widest_baseline);
widest_rect.width = PANGO_PIXELS_CEIL (widest_rect.width);
widest_rect.height = PANGO_PIXELS_CEIL (widest_rect.height);
smallest_rect.width = PANGO_PIXELS_CEIL (smallest_rect.width);
smallest_rect.height = PANGO_PIXELS_CEIL (smallest_rect.height);
if (orientation == GTK_ORIENTATION_HORIZONTAL)
{
/* Normal desired width */
*minimum_size = smallest_rect.width;
*natural_size = widest_rect.width;
if (minimum_baseline)
*minimum_baseline = -1;
if (natural_baseline)
*natural_baseline = -1;
}
else /* GTK_ORIENTATION_VERTICAL */
{
if (smallest_rect.height < widest_rect.height)
{
*minimum_size = smallest_rect.height;
*natural_size = widest_rect.height;
if (minimum_baseline)
*minimum_baseline = smallest_baseline;
if (natural_baseline)
*natural_baseline = widest_baseline;
}
else
{
*minimum_size = widest_rect.height;
*natural_size = smallest_rect.height;
if (minimum_baseline)
*minimum_baseline = widest_baseline;
if (natural_baseline)
*natural_baseline = smallest_baseline;
}
}
}
static void
gtk_label_measure (GtkWidget *widget,
GtkOrientation orientation,
int for_size,
int *minimum,
int *natural,
int *minimum_baseline,
int *natural_baseline)
{
GtkLabel *label = GTK_LABEL (widget);
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
if (orientation == GTK_ORIENTATION_VERTICAL && for_size != -1 && priv->wrap)
{
gtk_label_clear_layout (label);
get_height_for_width (label, for_size, minimum, natural, minimum_baseline, natural_baseline);
}
else
gtk_label_get_preferred_size (widget, orientation, minimum, natural, minimum_baseline, natural_baseline);
}
static void
get_layout_location (GtkLabel *label,
gint *xp,
gint *yp)
{
GtkWidget *widget = GTK_WIDGET (label);
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
gint req_width, x, y;
gint req_height;
gfloat xalign, yalign;
PangoRectangle logical;
gint baseline, layout_baseline, baseline_offset;
int label_width, label_height;
xalign = priv->xalign;
yalign = priv->yalign;
if (_gtk_widget_get_direction (widget) != GTK_TEXT_DIR_LTR)
xalign = 1.0 - xalign;
pango_layout_get_extents (priv->layout, NULL, &logical);
pango_extents_to_pixels (&logical, NULL);
req_width = logical.width;
req_height = logical.height;
label_width = gtk_widget_get_width (widget);
label_height = gtk_widget_get_height (widget);
baseline = gtk_widget_get_allocated_baseline (widget);
x = floor ((xalign * (label_width - req_width)) - logical.x);
baseline_offset = 0;
if (baseline != -1)
{
layout_baseline = pango_layout_get_baseline (priv->layout) / PANGO_SCALE;
baseline_offset = baseline - layout_baseline;
yalign = 0.0; /* Can't support yalign while baseline aligning */
}
/* bgo#315462 - For single-line labels, *do* align the requisition with
* respect to the allocation, even if we are under-allocated. For multi-line
* labels, always show the top of the text when they are under-allocated. The
* rationale is this:
*
* - Single-line labels appear in GtkButtons, and it is very easy to get them
* to be smaller than their requisition. The button may clip the label, but
* the label will still be able to show most of itself and the focus
* rectangle. Also, it is fairly easy to read a single line of clipped text.
*
* - Multi-line labels should not be clipped to showing "something in the
* middle". You want to read the first line, at least, to get some context.
*/
if (pango_layout_get_line_count (priv->layout) == 1)
y = floor ((label_height - req_height) * yalign) + baseline_offset;
else
y = floor (MAX ((label_height - req_height) * yalign, 0)) + baseline_offset;
if (xp)
*xp = x;
if (yp)
*yp = y;
}
static void
gtk_label_size_allocate (GtkWidget *widget,
int width,
int height,
int baseline)
{
GtkLabel *label = GTK_LABEL (widget);
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
if (priv->layout)
{
if (priv->ellipsize || priv->wrap)
pango_layout_set_width (priv->layout, width * PANGO_SCALE);
else
pango_layout_set_width (priv->layout, -1);
}
if (priv->popup_menu)
gtk_native_check_resize (GTK_NATIVE (priv->popup_menu));
}
static void
gtk_label_update_cursor (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GtkWidget *widget = GTK_WIDGET (label);
if (!priv->select_info)
return;
if (gtk_widget_is_sensitive (widget))
{
if (priv->select_info->active_link)
gtk_widget_set_cursor_from_name (widget, "pointer");
else if (priv->select_info->selectable)
gtk_widget_set_cursor_from_name (widget, "text");
else
gtk_widget_set_cursor (widget, NULL);
}
else
gtk_widget_set_cursor (widget, NULL);
}
static void
update_link_state (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GtkStateFlags state;
guint i;
if (!priv->select_info)
return;
for (i = 0; i < priv->select_info->n_links; i++)
{
const GtkLabelLink *link = &priv->select_info->links[i];
state = gtk_widget_get_state_flags (GTK_WIDGET (label));
if (link->visited)
state |= GTK_STATE_FLAG_VISITED;
else
state |= GTK_STATE_FLAG_LINK;
if (link == priv->select_info->active_link)
{
if (priv->select_info->link_clicked)
state |= GTK_STATE_FLAG_ACTIVE;
else
state |= GTK_STATE_FLAG_PRELIGHT;
}
gtk_css_node_set_state (link->cssnode, state);
}
}
static void
gtk_label_state_flags_changed (GtkWidget *widget,
GtkStateFlags prev_state)
{
GtkLabel *label = GTK_LABEL (widget);
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
if (priv->select_info)
{
if (!gtk_widget_is_sensitive (widget))
gtk_label_select_region (label, 0, 0);
gtk_label_update_cursor (label);
update_link_state (label);
}
if (GTK_WIDGET_CLASS (gtk_label_parent_class)->state_flags_changed)
GTK_WIDGET_CLASS (gtk_label_parent_class)->state_flags_changed (widget, prev_state);
}
static void
gtk_label_css_changed (GtkWidget *widget,
GtkCssStyleChange *change)
{
GtkLabel *label = GTK_LABEL (widget);
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GTK_WIDGET_CLASS (gtk_label_parent_class)->css_changed (widget, change);
if (change == NULL || gtk_css_style_change_affects (change, GTK_CSS_AFFECTS_TEXT_ATTRS) ||
(priv->select_info && priv->select_info->links))
gtk_label_update_layout_attributes (label);
}
static PangoDirection
get_cursor_direction (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GSList *l;
g_assert (priv->select_info);
gtk_label_ensure_layout (label);
for (l = pango_layout_get_lines_readonly (priv->layout); l; l = l->next)
{
PangoLayoutLine *line = l->data;
/* If priv->select_info->selection_end is at the very end of
* the line, we don't know if the cursor is on this line or
* the next without looking ahead at the next line. (End
* of paragraph is different from line break.) But it's
* definitely in this paragraph, which is good enough
* to figure out the resolved direction.
*/
if (line->start_index + line->length >= priv->select_info->selection_end)
return line->resolved_dir;
}
return PANGO_DIRECTION_LTR;
}
static GtkLabelLink *
gtk_label_get_focus_link (GtkLabel *label,
int *out_index)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GtkLabelSelectionInfo *info = priv->select_info;
int link_index;
if (!info ||
info->selection_anchor != info->selection_end)
goto nope;
link_index = _gtk_label_get_link_at (label, info->selection_anchor);
if (link_index != -1)
{
if (out_index)
*out_index = link_index;
return &info->links[link_index];
}
nope:
if (out_index)
*out_index = -1;
return NULL;
}
#define GRAPHENE_RECT_FROM_RECT(_r) (GRAPHENE_RECT_INIT ((_r)->x, (_r)->y, (_r)->width, (_r)->height))
static void
gtk_label_snapshot (GtkWidget *widget,
GtkSnapshot *snapshot)
{
GtkLabel *label = GTK_LABEL (widget);
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GtkLabelSelectionInfo *info;
GtkStyleContext *context;
gint lx, ly;
int width, height, x;
info = priv->select_info;
gtk_label_ensure_layout (label);
context = _gtk_widget_get_style_context (widget);
width = gtk_widget_get_width (widget);
height = gtk_widget_get_height (widget);
x = 0;
if (priv->text && (*priv->text != '\0'))
{
get_layout_location (label, &lx, &ly);
gtk_snapshot_render_layout (snapshot, context, lx, ly, priv->layout);
if (info && (info->selection_anchor != info->selection_end))
{
gint range[2];
cairo_region_t *range_clip;
cairo_rectangle_int_t clip_rect;
int i;
range[0] = info->selection_anchor;
range[1] = info->selection_end;
if (range[0] > range[1])
{
gint tmp = range[0];
range[0] = range[1];
range[1] = tmp;
}
gtk_style_context_save_to_node (context, info->selection_node);
range_clip = gdk_pango_layout_get_clip_region (priv->layout, lx, ly, range, 1);
for (i = 0; i < cairo_region_num_rectangles (range_clip); i++)
{
cairo_region_get_rectangle (range_clip, i, &clip_rect);
gtk_snapshot_push_clip (snapshot, &GRAPHENE_RECT_FROM_RECT (&clip_rect));
gtk_snapshot_render_background (snapshot, context, x, 0, width, height);
gtk_snapshot_render_layout (snapshot, context, lx, ly, priv->layout);
gtk_snapshot_pop (snapshot);
}
cairo_region_destroy (range_clip);
gtk_style_context_restore (context);
}
else if (info)
{
GtkLabelLink *focus_link;
GtkLabelLink *active_link;
gint range[2];
cairo_region_t *range_clip;
cairo_rectangle_int_t clip_rect;
int i;
GdkRectangle rect;
if (info->selectable &&
gtk_widget_has_focus (widget) &&
gtk_widget_is_drawable (widget))
{
PangoDirection cursor_direction;
cursor_direction = get_cursor_direction (label);
gtk_snapshot_render_insertion_cursor (snapshot, context,
lx, ly,
priv->layout, priv->select_info->selection_end,
cursor_direction);
}
focus_link = gtk_label_get_focus_link (label, NULL);
active_link = info->active_link;
if (active_link)
{
range[0] = active_link->start;
range[1] = active_link->end;
gtk_style_context_save_to_node (context, active_link->cssnode);
range_clip = gdk_pango_layout_get_clip_region (priv->layout, lx, ly, range, 1);
for (i = 0; i < cairo_region_num_rectangles (range_clip); i++)
{
cairo_region_get_rectangle (range_clip, i, &clip_rect);
gtk_snapshot_push_clip (snapshot, &GRAPHENE_RECT_FROM_RECT (&clip_rect));
gtk_snapshot_render_background (snapshot, context, x, 0, width, height);
gtk_snapshot_render_layout (snapshot, context, lx, ly, priv->layout);
gtk_snapshot_pop (snapshot);
}
cairo_region_destroy (range_clip);
gtk_style_context_restore (context);
}
if (focus_link && gtk_widget_has_visible_focus (widget))
{
range[0] = focus_link->start;
range[1] = focus_link->end;
gtk_style_context_save_to_node (context, focus_link->cssnode);
range_clip = gdk_pango_layout_get_clip_region (priv->layout, lx, ly, range, 1);
cairo_region_get_extents (range_clip, &rect);
gtk_snapshot_render_focus (snapshot, context, rect.x, rect.y, rect.width, rect.height);
cairo_region_destroy (range_clip);
gtk_style_context_restore (context);
}
}
}
}
static gboolean
separate_uline_pattern (const gchar *str,
guint *accel_key,
gchar **new_str,
gchar **pattern)
{
gboolean underscore;
const gchar *src;
gchar *dest;
gchar *pattern_dest;
*accel_key = GDK_KEY_VoidSymbol;
*new_str = g_new (gchar, strlen (str) + 1);
*pattern = g_new (gchar, g_utf8_strlen (str, -1) + 1);
underscore = FALSE;
src = str;
dest = *new_str;
pattern_dest = *pattern;
while (*src)
{
gunichar c;
const gchar *next_src;
c = g_utf8_get_char (src);
if (c == (gunichar)-1)
{
g_warning ("Invalid input string");
g_free (*new_str);
g_free (*pattern);
return FALSE;
}
next_src = g_utf8_next_char (src);
if (underscore)
{
if (c == '_')
*pattern_dest++ = ' ';
else
{
*pattern_dest++ = '_';
if (*accel_key == GDK_KEY_VoidSymbol)
*accel_key = gdk_keyval_to_lower (gdk_unicode_to_keyval (c));
}
while (src < next_src)
*dest++ = *src++;
underscore = FALSE;
}
else
{
if (c == '_')
{
underscore = TRUE;
src = next_src;
}
else
{
while (src < next_src)
*dest++ = *src++;
*pattern_dest++ = ' ';
}
}
}
*dest = 0;
*pattern_dest = 0;
return TRUE;
}
static void
gtk_label_set_uline_text_internal (GtkLabel *label,
const gchar *str)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
guint accel_key = GDK_KEY_VoidSymbol;
gchar *new_str;
gchar *pattern;
g_return_if_fail (GTK_IS_LABEL (label));
g_return_if_fail (str != NULL);
/* Split text into the base text and a separate pattern
* of underscores.
*/
if (!separate_uline_pattern (str, &accel_key, &new_str, &pattern))
return;
gtk_label_set_text_internal (label, new_str);
gtk_label_set_pattern_internal (label, pattern, TRUE);
priv->mnemonic_keyval = accel_key;
g_free (pattern);
}
/**
* gtk_label_set_text_with_mnemonic:
* @label: a #GtkLabel
* @str: a string
*
* 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 gtk_label_set_mnemonic_widget().
**/
void
gtk_label_set_text_with_mnemonic (GtkLabel *label,
const gchar *str)
{
g_return_if_fail (GTK_IS_LABEL (label));
g_return_if_fail (str != NULL);
g_object_freeze_notify (G_OBJECT (label));
gtk_label_set_label_internal (label, g_strdup (str));
gtk_label_set_use_markup_internal (label, FALSE);
gtk_label_set_use_underline_internal (label, TRUE);
gtk_label_recalculate (label);
g_object_thaw_notify (G_OBJECT (label));
}
static void
gtk_label_unrealize (GtkWidget *widget)
{
GtkLabel *label = GTK_LABEL (widget);
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GdkClipboard *clipboard;
clipboard = gtk_widget_get_primary_clipboard (widget);
if (priv->select_info &&
gdk_clipboard_get_content (clipboard) == priv->select_info->provider)
gdk_clipboard_set_content (clipboard, NULL);
GTK_WIDGET_CLASS (gtk_label_parent_class)->unrealize (widget);
}
static gboolean
get_layout_index (GtkLabel *label,
gint x,
gint y,
gint *index)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
gint trailing = 0;
const gchar *cluster;
const gchar *cluster_end;
gboolean inside;
int lx, ly;
*index = 0;
gtk_label_ensure_layout (label);
get_layout_location (label, &lx, &ly);
/* Translate x/y to layout position */
x -= lx;
y -= ly;
x *= PANGO_SCALE;
y *= PANGO_SCALE;
inside = pango_layout_xy_to_index (priv->layout,
x, y,
index, &trailing);
cluster = priv->text + *index;
cluster_end = cluster;
while (trailing)
{
cluster_end = g_utf8_next_char (cluster_end);
--trailing;
}
*index += (cluster_end - cluster);
return inside;
}
static gboolean
range_is_in_ellipsis_full (GtkLabel *label,
gint range_start,
gint range_end,
gint *ellipsis_start,
gint *ellipsis_end)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
PangoLayoutIter *iter;
gboolean in_ellipsis;
if (!priv->ellipsize)
return FALSE;
gtk_label_ensure_layout (label);
if (!pango_layout_is_ellipsized (priv->layout))
return FALSE;
iter = pango_layout_get_iter (priv->layout);
in_ellipsis = FALSE;
do {
PangoLayoutRun *run;
run = pango_layout_iter_get_run_readonly (iter);
if (run)
{
PangoItem *item;
item = ((PangoGlyphItem*)run)->item;
if (item->offset <= range_start && range_end <= item->offset + item->length)
{
if (item->analysis.flags & PANGO_ANALYSIS_FLAG_IS_ELLIPSIS)
{
if (ellipsis_start)
*ellipsis_start = item->offset;
if (ellipsis_end)
*ellipsis_end = item->offset + item->length;
in_ellipsis = TRUE;
}
break;
}
else if (item->offset + item->length >= range_end)
break;
}
} while (pango_layout_iter_next_run (iter));
pango_layout_iter_free (iter);
return in_ellipsis;
}
static gboolean
range_is_in_ellipsis (GtkLabel *label,
gint range_start,
gint range_end)
{
return range_is_in_ellipsis_full (label, range_start, range_end, NULL, NULL);
}
static void
gtk_label_select_word (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
gint min, max;
gint start_index = gtk_label_move_backward_word (label, priv->select_info->selection_end);
gint end_index = gtk_label_move_forward_word (label, priv->select_info->selection_end);
min = MIN (priv->select_info->selection_anchor,
priv->select_info->selection_end);
max = MAX (priv->select_info->selection_anchor,
priv->select_info->selection_end);
min = MIN (min, start_index);
max = MAX (max, end_index);
gtk_label_select_region_index (label, min, max);
}
static gboolean
gtk_label_grab_focus (GtkWidget *widget)
{
GtkLabel *label = GTK_LABEL (widget);
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
gboolean select_on_focus;
if (priv->select_info == NULL)
return FALSE;
if (!GTK_WIDGET_CLASS (gtk_label_parent_class)->grab_focus (widget))
return FALSE;
if (priv->select_info->selectable)
{
g_object_get (gtk_widget_get_settings (widget),
"gtk-label-select-on-focus",
&select_on_focus,
NULL);
if (select_on_focus && !priv->in_click)
gtk_label_select_region (label, 0, -1);
}
else
{
if (priv->select_info->links && !priv->in_click)
{
guint i;
for (i = 0; i < priv->select_info->n_links; i++)
{
const GtkLabelLink *link = &priv->select_info->links[i];
if (!range_is_in_ellipsis (label, link->start, link->end))
{
priv->select_info->selection_anchor = link->start;
priv->select_info->selection_end = link->start;
_gtk_label_accessible_focus_link_changed (label);
break;
}
}
}
}
return TRUE;
}
static gboolean
gtk_label_focus (GtkWidget *widget,
GtkDirectionType direction)
{
GtkLabel *label = GTK_LABEL (widget);
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GtkLabelSelectionInfo *info = priv->select_info;
GtkLabelLink *focus_link;
if (!gtk_widget_is_focus (widget))
{
gtk_widget_grab_focus (widget);
if (info)
{
focus_link = gtk_label_get_focus_link (label, NULL);
if (focus_link && direction == GTK_DIR_TAB_BACKWARD)
{
int i;
for (i = info->n_links - 1; i >= 0; i--)
{
focus_link = &info->links[i];
if (!range_is_in_ellipsis (label, focus_link->start, focus_link->end))
{
info->selection_anchor = focus_link->start;
info->selection_end = focus_link->start;
_gtk_label_accessible_focus_link_changed (label);
}
}
}
return TRUE;
}
return FALSE;
}
if (!info)
return FALSE;
if (info->selectable)
{
gint index;
if (info->selection_anchor != info->selection_end)
goto out;
index = info->selection_anchor;
if (direction == GTK_DIR_TAB_FORWARD)
{
guint i;
for (i = 0; i < info->n_links; i++)
{
const GtkLabelLink *link = &info->links[i];
if (link->start > index)
{
if (!range_is_in_ellipsis (label, link->start, link->end))
{
gtk_label_select_region_index (label, link->start, link->start);
_gtk_label_accessible_focus_link_changed (label);
return TRUE;
}
}
}
}
else if (direction == GTK_DIR_TAB_BACKWARD)
{
int i;
for (i = info->n_links - 1; i >= 0; i--)
{
GtkLabelLink *link = &info->links[i];
if (link->end < index)
{
if (!range_is_in_ellipsis (label, link->start, link->end))
{
gtk_label_select_region_index (label, link->start, link->start);
_gtk_label_accessible_focus_link_changed (label);
return TRUE;
}
}
}
}
goto out;
}
else
{
int focus_link_index;
int new_index = -1;
int i;
focus_link = gtk_label_get_focus_link (label, &focus_link_index);
switch (direction)
{
case GTK_DIR_TAB_FORWARD:
if (focus_link)
new_index = (focus_link_index + 1) % info->n_links;
else
new_index = 0;
for (i = new_index; i < info->n_links; i++)
{
const GtkLabelLink *link = &info->links[i];
if (!range_is_in_ellipsis (label, link->start, link->end))
break;
}
break;
case GTK_DIR_TAB_BACKWARD:
if (focus_link)
new_index = focus_link_index == 0 ? info->n_links - 1 : focus_link_index - 1;
else
new_index = info->n_links - 1;
for (i = new_index; i >= 0; i--)
{
const GtkLabelLink *link = &info->links[i];
if (!range_is_in_ellipsis (label, link->start, link->end))
break;
}
break;
default:
case GTK_DIR_UP:
case GTK_DIR_DOWN:
case GTK_DIR_LEFT:
case GTK_DIR_RIGHT:
goto out;
}
if (new_index != -1)
{
focus_link = &info->links[new_index];
info->selection_anchor = focus_link->start;
info->selection_end = focus_link->start;
_gtk_label_accessible_focus_link_changed (label);
gtk_widget_queue_draw (widget);
return TRUE;
}
}
out:
return FALSE;
}
static void
gtk_label_click_gesture_pressed (GtkGestureClick *gesture,
gint n_press,
gdouble widget_x,
gdouble widget_y,
GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GtkLabelSelectionInfo *info = priv->select_info;
GtkWidget *widget = GTK_WIDGET (label);
GdkEventSequence *sequence;
GdkEvent *event;
guint button;
button = gtk_gesture_single_get_current_button (GTK_GESTURE_SINGLE (gesture));
sequence = gtk_gesture_single_get_current_sequence (GTK_GESTURE_SINGLE (gesture));
event = gtk_gesture_get_last_event (GTK_GESTURE (gesture), sequence);
gtk_label_update_active_link (widget, widget_x, widget_y);
gtk_gesture_set_state (GTK_GESTURE (gesture), GTK_EVENT_SEQUENCE_CLAIMED);
if (info->active_link)
{
if (gdk_event_triggers_context_menu (event))
{
info->link_clicked = TRUE;
update_link_state (label);
gtk_label_do_popup (label, widget_x, widget_y);
return;
}
else if (button == GDK_BUTTON_PRIMARY)
{
info->link_clicked = TRUE;
update_link_state (label);
gtk_widget_queue_draw (widget);
if (!info->selectable)
return;
}
}
if (!info->selectable)
{
gtk_gesture_set_state (GTK_GESTURE (gesture), GTK_EVENT_SEQUENCE_DENIED);
return;
}
info->in_drag = FALSE;
info->select_words = FALSE;
if (gdk_event_triggers_context_menu (event))
gtk_label_do_popup (label, widget_x, widget_y);
else if (button == GDK_BUTTON_PRIMARY)
{
if (!gtk_widget_has_focus (widget))
{
priv->in_click = TRUE;
gtk_widget_grab_focus (widget);
priv->in_click = FALSE;
}
if (n_press == 3)
gtk_label_select_region_index (label, 0, strlen (priv->text));
else if (n_press == 2)
{
info->select_words = TRUE;
gtk_label_select_word (label);
}
}
else
{
gtk_gesture_set_state (GTK_GESTURE (gesture), GTK_EVENT_SEQUENCE_DENIED);
return;
}
if (n_press >= 3)
gtk_event_controller_reset (GTK_EVENT_CONTROLLER (gesture));
}
static void
gtk_label_click_gesture_released (GtkGestureClick *gesture,
gint n_press,
gdouble x,
gdouble y,
GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GtkLabelSelectionInfo *info = priv->select_info;
GdkEventSequence *sequence;
gint index;
if (info == NULL)
return;
sequence = gtk_gesture_single_get_current_sequence (GTK_GESTURE_SINGLE (gesture));
if (!gtk_gesture_handles_sequence (GTK_GESTURE (gesture), sequence))
return;
if (n_press != 1)
return;
if (info->in_drag)
{
info->in_drag = 0;
get_layout_index (label, x, y, &index);
gtk_label_select_region_index (label, index, index);
}
else if (info->active_link &&
info->selection_anchor == info->selection_end &&
info->link_clicked)
{
emit_activate_link (label, info->active_link);
info->link_clicked = FALSE;
}
}
static void
connect_mnemonics_visible_notify (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GtkNative *native;
gboolean connected;
gboolean mnemonics_visible;
native = gtk_widget_get_native (GTK_WIDGET (label));
if (!GTK_IS_WINDOW (native) && !GTK_IS_POPOVER (native))
return;
/* always set up this widgets initial value */
g_object_get (native, "mnemonics-visible", &mnemonics_visible, NULL);
priv->mnemonics_visible = mnemonics_visible;
connected =
GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (native), quark_mnemonics_visible_connected));
if (!connected)
{
g_signal_connect (native,
"notify::mnemonics-visible",
G_CALLBACK (label_mnemonics_visible_changed),
label);
g_object_set_qdata (G_OBJECT (native),
quark_mnemonics_visible_connected,
GINT_TO_POINTER (1));
}
}
static GdkPaintable *
get_selection_paintable (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
if ((priv->select_info->selection_anchor !=
priv->select_info->selection_end) &&
priv->text)
{
gint start, end;
gint len;
start = MIN (priv->select_info->selection_anchor,
priv->select_info->selection_end);
end = MAX (priv->select_info->selection_anchor,
priv->select_info->selection_end);
len = strlen (priv->text);
if (end > len)
end = len;
if (start > len)
start = len;
return gtk_text_util_create_drag_icon (GTK_WIDGET (label), priv->text + start, end - start);
}
return NULL;
}
static void
gtk_label_drag_gesture_begin (GtkGestureDrag *gesture,
gdouble start_x,
gdouble start_y,
GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GtkLabelSelectionInfo *info = priv->select_info;
GdkModifierType state_mask;
GdkEventSequence *sequence;
GdkEvent *event;
gint min, max, index;
if (!info || !info->selectable)
{
gtk_gesture_set_state (GTK_GESTURE (gesture), GTK_EVENT_SEQUENCE_DENIED);
return;
}
get_layout_index (label, start_x, start_y, &index);
min = MIN (info->selection_anchor, info->selection_end);
max = MAX (info->selection_anchor, info->selection_end);
sequence = gtk_gesture_single_get_current_sequence (GTK_GESTURE_SINGLE (gesture));
event = gtk_gesture_get_last_event (GTK_GESTURE (gesture), sequence);
state_mask = gdk_event_get_modifier_state (event);
if ((info->selection_anchor != info->selection_end) &&
(state_mask & GDK_SHIFT_MASK))
{
if (index > min && index < max)
{
/* truncate selection, but keep it as big as possible */
if (index - min > max - index)
max = index;
else
min = index;
}
else
{
/* extend (same as motion) */
min = MIN (min, index);
max = MAX (max, index);
}
/* ensure the anchor is opposite index */
if (index == min)
{
gint tmp = min;
min = max;
max = tmp;
}
gtk_label_select_region_index (label, min, max);
}
else
{
if (min < max && min <= index && index <= max)
{
info->in_drag = TRUE;
info->drag_start_x = start_x;
info->drag_start_y = start_y;
}
else
/* start a replacement */
gtk_label_select_region_index (label, index, index);
}
}
static void
gtk_label_drag_gesture_update (GtkGestureDrag *gesture,
gdouble offset_x,
gdouble offset_y,
GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GtkLabelSelectionInfo *info = priv->select_info;
GtkWidget *widget = GTK_WIDGET (label);
GdkEventSequence *sequence;
gdouble x, y;
gint index;
if (info == NULL || !info->selectable)
return;
sequence = gtk_gesture_single_get_current_sequence (GTK_GESTURE_SINGLE (gesture));
gtk_gesture_get_point (GTK_GESTURE (gesture), sequence, &x, &y);
if (info->in_drag)
{
if (gtk_drag_check_threshold (widget, info->drag_start_x, info->drag_start_y, x, y))
{
GdkDrag *drag;
GdkSurface *surface;
GdkDevice *device;
surface = gtk_native_get_surface (gtk_widget_get_native (widget));
device = gtk_gesture_get_device (GTK_GESTURE (gesture));
drag = gdk_drag_begin (surface,
device,
info->provider,
GDK_ACTION_COPY,
info->drag_start_x,
info->drag_start_y);
gtk_drag_icon_set_from_paintable (drag, get_selection_paintable (label), 0, 0);
g_object_unref (drag);
info->in_drag = FALSE;
}
}
else
{
get_layout_index (label, x, y, &index);
if (index != info->selection_anchor)
gtk_gesture_set_state (GTK_GESTURE (gesture), GTK_EVENT_SEQUENCE_CLAIMED);
if (info->select_words)
{
gint min, max;
gint old_min, old_max;
gint anchor, end;
min = gtk_label_move_backward_word (label, index);
max = gtk_label_move_forward_word (label, index);
anchor = info->selection_anchor;
end = info->selection_end;
old_min = MIN (anchor, end);
old_max = MAX (anchor, end);
if (min < old_min)
{
anchor = min;
end = old_max;
}
else if (old_max < max)
{
anchor = max;
end = old_min;
}
else if (anchor == old_min)
{
if (anchor != min)
anchor = max;
}
else
{
if (anchor != max)
anchor = min;
}
gtk_label_select_region_index (label, anchor, end);
}
else
gtk_label_select_region_index (label, info->selection_anchor, index);
}
}
static void
gtk_label_update_active_link (GtkWidget *widget,
gdouble x,
gdouble y)
{
GtkLabel *label = GTK_LABEL (widget);
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GtkLabelSelectionInfo *info = priv->select_info;
gint index;
if (info == NULL)
return;
if (info->links && !info->in_drag)
{
GtkLabelLink *link;
gboolean found = FALSE;
if (info->selection_anchor == info->selection_end)
{
if (get_layout_index (label, x, y, &index))
{
const int link_index = _gtk_label_get_link_at (label, index);
if (link_index != -1)
{
link = &info->links[link_index];
if (!range_is_in_ellipsis (label, link->start, link->end))
found = TRUE;
}
}
}
if (found)
{
if (info->active_link != link)
{
info->link_clicked = FALSE;
info->active_link = link;
update_link_state (label);
gtk_label_update_cursor (label);
gtk_widget_queue_draw (widget);
}
}
else
{
if (info->active_link != NULL)
{
info->link_clicked = FALSE;
info->active_link = NULL;
update_link_state (label);
gtk_label_update_cursor (label);
gtk_widget_queue_draw (widget);
}
}
gtk_label_update_actions (label);
}
}
static void
gtk_label_motion (GtkEventControllerMotion *controller,
double x,
double y,
gpointer data)
{
gtk_label_update_active_link (GTK_WIDGET (data), x, y);
}
static void
gtk_label_leave (GtkEventControllerMotion *controller,
GdkCrossingMode mode,
gpointer data)
{
GtkLabel *label = GTK_LABEL (data);
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
if (priv->select_info)
{
priv->select_info->active_link = NULL;
gtk_label_update_cursor (label);
gtk_widget_queue_draw (GTK_WIDGET (label));
}
}
#define GTK_TYPE_LABEL_CONTENT (gtk_label_content_get_type ())
#define GTK_LABEL_CONTENT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_LABEL_CONTENT, GtkLabelContent))
#define GTK_IS_LABEL_CONTENT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_LABEL_CONTENT))
#define GTK_LABEL_CONTENT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_LABEL_CONTENT, GtkLabelContentClass))
#define GTK_IS_LABEL_CONTENT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_LABEL_CONTENT))
#define GTK_LABEL_CONTENT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_LABEL_CONTENT, GtkLabelContentClass))
typedef struct _GtkLabelContent GtkLabelContent;
typedef struct _GtkLabelContentClass GtkLabelContentClass;
struct _GtkLabelContent
{
GdkContentProvider parent;
GtkLabel *label;
};
struct _GtkLabelContentClass
{
GdkContentProviderClass parent_class;
};
GType gtk_label_content_get_type (void) G_GNUC_CONST;
G_DEFINE_TYPE (GtkLabelContent, gtk_label_content, GDK_TYPE_CONTENT_PROVIDER)
static GdkContentFormats *
gtk_label_content_ref_formats (GdkContentProvider *provider)
{
GtkLabelContent *content = GTK_LABEL_CONTENT (provider);
if (content->label)
return gdk_content_formats_new_for_gtype (G_TYPE_STRING);
else
return gdk_content_formats_new (NULL, 0);
}
static gboolean
gtk_label_content_get_value (GdkContentProvider *provider,
GValue *value,
GError **error)
{
GtkLabelContent *content = GTK_LABEL_CONTENT (provider);
if (G_VALUE_HOLDS (value, G_TYPE_STRING) &&
content->label != NULL)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (content->label);
if (priv->select_info &&
(priv->select_info->selection_anchor !=
priv->select_info->selection_end) &&
priv->text)
{
gint start, end;
gint len;
char *str;
start = MIN (priv->select_info->selection_anchor,
priv->select_info->selection_end);
end = MAX (priv->select_info->selection_anchor,
priv->select_info->selection_end);
len = strlen (priv->text);
if (end > len)
end = len;
if (start > len)
start = len;
str = g_strndup (priv->text + start, end - start);
g_value_take_string (value, str);
return TRUE;
}
}
return GDK_CONTENT_PROVIDER_CLASS (gtk_label_content_parent_class)->get_value (provider, value, error);
}
static void
gtk_label_content_detach (GdkContentProvider *provider,
GdkClipboard *clipboard)
{
GtkLabelContent *content = GTK_LABEL_CONTENT (provider);
GtkLabel *label = content->label;
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
if (label == NULL || priv->select_info == NULL)
return;
priv->select_info->selection_anchor = priv->select_info->selection_end;
gtk_widget_queue_draw (GTK_WIDGET (label));
}
static void
gtk_label_content_class_init (GtkLabelContentClass *class)
{
GdkContentProviderClass *provider_class = GDK_CONTENT_PROVIDER_CLASS (class);
provider_class->ref_formats = gtk_label_content_ref_formats;
provider_class->get_value = gtk_label_content_get_value;
provider_class->detach_clipboard = gtk_label_content_detach;
}
static void
gtk_label_content_init (GtkLabelContent *content)
{
}
static void
gtk_label_ensure_select_info (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
if (priv->select_info == NULL)
{
priv->select_info = g_new0 (GtkLabelSelectionInfo, 1);
gtk_widget_set_can_focus (GTK_WIDGET (label), TRUE);
priv->select_info->drag_gesture = gtk_gesture_drag_new ();
g_signal_connect (priv->select_info->drag_gesture, "drag-begin",
G_CALLBACK (gtk_label_drag_gesture_begin), label);
g_signal_connect (priv->select_info->drag_gesture, "drag-update",
G_CALLBACK (gtk_label_drag_gesture_update), label);
gtk_gesture_single_set_exclusive (GTK_GESTURE_SINGLE (priv->select_info->drag_gesture), TRUE);
gtk_widget_add_controller (GTK_WIDGET (label), GTK_EVENT_CONTROLLER (priv->select_info->drag_gesture));
priv->select_info->click_gesture = gtk_gesture_click_new ();
g_signal_connect (priv->select_info->click_gesture, "pressed",
G_CALLBACK (gtk_label_click_gesture_pressed), label);
g_signal_connect (priv->select_info->click_gesture, "released",
G_CALLBACK (gtk_label_click_gesture_released), label);
gtk_gesture_single_set_button (GTK_GESTURE_SINGLE (priv->select_info->click_gesture), 0);
gtk_gesture_single_set_exclusive (GTK_GESTURE_SINGLE (priv->select_info->click_gesture), TRUE);
gtk_widget_add_controller (GTK_WIDGET (label), GTK_EVENT_CONTROLLER (priv->select_info->click_gesture));
priv->select_info->motion_controller = gtk_event_controller_motion_new ();
g_signal_connect (priv->select_info->motion_controller, "motion",
G_CALLBACK (gtk_label_motion), label);
g_signal_connect (priv->select_info->motion_controller, "leave",
G_CALLBACK (gtk_label_leave), label);
gtk_widget_add_controller (GTK_WIDGET (label), priv->select_info->motion_controller);
priv->select_info->provider = g_object_new (GTK_TYPE_LABEL_CONTENT, NULL);
GTK_LABEL_CONTENT (priv->select_info->provider)->label = label;
gtk_label_update_cursor (label);
}
}
static void
gtk_label_clear_select_info (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
if (priv->select_info == NULL)
return;
if (!priv->select_info->selectable && !priv->select_info->links)
{
gtk_widget_remove_controller (GTK_WIDGET (label), GTK_EVENT_CONTROLLER (priv->select_info->drag_gesture));
gtk_widget_remove_controller (GTK_WIDGET (label), GTK_EVENT_CONTROLLER (priv->select_info->click_gesture));
gtk_widget_remove_controller (GTK_WIDGET (label), priv->select_info->motion_controller);
GTK_LABEL_CONTENT (priv->select_info->provider)->label = NULL;
g_object_unref (priv->select_info->provider);
g_free (priv->select_info);
priv->select_info = NULL;
gtk_widget_set_cursor (GTK_WIDGET (label), NULL);
gtk_widget_set_can_focus (GTK_WIDGET (label), FALSE);
}
}
/**
* gtk_label_set_selectable:
* @label: a #GtkLabel
* @setting: %TRUE to allow selecting text in the label
*
* Selectable labels allow the user to select text from the label, for
* copy-and-paste.
**/
void
gtk_label_set_selectable (GtkLabel *label,
gboolean setting)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
gboolean old_setting;
g_return_if_fail (GTK_IS_LABEL (label));
setting = setting != FALSE;
old_setting = priv->select_info && priv->select_info->selectable;
if (setting)
{
gtk_label_ensure_select_info (label);
priv->select_info->selectable = TRUE;
gtk_label_update_cursor (label);
}
else
{
if (old_setting)
{
/* unselect, to give up the selection */
gtk_label_select_region (label, 0, 0);
priv->select_info->selectable = FALSE;
gtk_label_clear_select_info (label);
}
}
if (setting != old_setting)
{
g_object_freeze_notify (G_OBJECT (label));
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_SELECTABLE]);
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_CURSOR_POSITION]);
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_SELECTION_BOUND]);
g_object_thaw_notify (G_OBJECT (label));
gtk_widget_queue_draw (GTK_WIDGET (label));
}
}
/**
* gtk_label_get_selectable:
* @label: a #GtkLabel
*
* Gets the value set by gtk_label_set_selectable().
*
* Returns: %TRUE if the user can copy text from the label
**/
gboolean
gtk_label_get_selectable (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
return priv->select_info && priv->select_info->selectable;
}
static void
gtk_label_select_region_index (GtkLabel *label,
gint anchor_index,
gint end_index)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_if_fail (GTK_IS_LABEL (label));
if (priv->select_info && priv->select_info->selectable)
{
GdkClipboard *clipboard;
gint s, e;
/* Ensure that we treat an ellipsized region like a single
* character with respect to selection.
*/
if (anchor_index < end_index)
{
if (range_is_in_ellipsis_full (label, anchor_index, anchor_index + 1, &s, &e))
{
if (priv->select_info->selection_anchor == s)
anchor_index = e;
else
anchor_index = s;
}
if (range_is_in_ellipsis_full (label, end_index - 1, end_index, &s, &e))
{
if (priv->select_info->selection_end == e)
end_index = s;
else
end_index = e;
}
}
else if (end_index < anchor_index)
{
if (range_is_in_ellipsis_full (label, end_index, end_index + 1, &s, &e))
{
if (priv->select_info->selection_end == s)
end_index = e;
else
end_index = s;
}
if (range_is_in_ellipsis_full (label, anchor_index - 1, anchor_index, &s, &e))
{
if (priv->select_info->selection_anchor == e)
anchor_index = s;
else
anchor_index = e;
}
}
else
{
if (range_is_in_ellipsis_full (label, anchor_index, anchor_index, &s, &e))
{
if (priv->select_info->selection_anchor == s)
anchor_index = e;
else if (priv->select_info->selection_anchor == e)
anchor_index = s;
else if (anchor_index - s < e - anchor_index)
anchor_index = s;
else
anchor_index = e;
end_index = anchor_index;
}
}
if (priv->select_info->selection_anchor == anchor_index &&
priv->select_info->selection_end == end_index)
return;
g_object_freeze_notify (G_OBJECT (label));
if (priv->select_info->selection_anchor != anchor_index)
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_SELECTION_BOUND]);
if (priv->select_info->selection_end != end_index)
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_CURSOR_POSITION]);
priv->select_info->selection_anchor = anchor_index;
priv->select_info->selection_end = end_index;
clipboard = gtk_widget_get_primary_clipboard (GTK_WIDGET (label));
if (anchor_index != end_index)
{
gdk_content_provider_content_changed (priv->select_info->provider);
gdk_clipboard_set_content (clipboard, priv->select_info->provider);
if (!priv->select_info->selection_node)
{
GtkCssNode *widget_node;
widget_node = gtk_widget_get_css_node (GTK_WIDGET (label));
priv->select_info->selection_node = gtk_css_node_new ();
gtk_css_node_set_name (priv->select_info->selection_node, g_quark_from_static_string ("selection"));
gtk_css_node_set_parent (priv->select_info->selection_node, widget_node);
gtk_css_node_set_state (priv->select_info->selection_node, gtk_css_node_get_state (widget_node));
g_object_unref (priv->select_info->selection_node);
}
}
else
{
if (gdk_clipboard_get_content (clipboard) == priv->select_info->provider)
gdk_clipboard_set_content (clipboard, NULL);
if (priv->select_info->selection_node)
{
gtk_css_node_set_parent (priv->select_info->selection_node, NULL);
priv->select_info->selection_node = NULL;
}
}
gtk_label_update_actions (label);
gtk_widget_queue_draw (GTK_WIDGET (label));
g_object_thaw_notify (G_OBJECT (label));
}
}
/**
* gtk_label_select_region:
* @label: a #GtkLabel
* @start_offset: start offset (in characters not bytes)
* @end_offset: end offset (in characters not bytes)
*
* Selects a range of characters in the label, if the label is selectable.
* See gtk_label_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.
**/
void
gtk_label_select_region (GtkLabel *label,
gint start_offset,
gint end_offset)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_if_fail (GTK_IS_LABEL (label));
if (priv->text && priv->select_info)
{
if (start_offset < 0)
start_offset = g_utf8_strlen (priv->text, -1);
if (end_offset < 0)
end_offset = g_utf8_strlen (priv->text, -1);
gtk_label_select_region_index (label,
g_utf8_offset_to_pointer (priv->text, start_offset) - priv->text,
g_utf8_offset_to_pointer (priv->text, end_offset) - priv->text);
}
}
/**
* gtk_label_get_selection_bounds:
* @label: a #GtkLabel
* @start: (out): return location for start of selection, as a character offset
* @end: (out): return location for end of selection, as a character offset
*
* Gets the selected range of characters in the label, returning %TRUE
* if there’s a selection.
*
* Returns: %TRUE if selection is non-empty
**/
gboolean
gtk_label_get_selection_bounds (GtkLabel *label,
gint *start,
gint *end)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
if (priv->select_info == NULL)
{
/* not a selectable label */
if (start)
*start = 0;
if (end)
*end = 0;
return FALSE;
}
else
{
gint start_index, end_index;
gint start_offset, end_offset;
gint len;
start_index = MIN (priv->select_info->selection_anchor,
priv->select_info->selection_end);
end_index = MAX (priv->select_info->selection_anchor,
priv->select_info->selection_end);
len = strlen (priv->text);
if (end_index > len)
end_index = len;
if (start_index > len)
start_index = len;
start_offset = g_utf8_strlen (priv->text, start_index);
end_offset = g_utf8_strlen (priv->text, end_index);
if (start_offset > end_offset)
{
gint tmp = start_offset;
start_offset = end_offset;
end_offset = tmp;
}
if (start)
*start = start_offset;
if (end)
*end = end_offset;
return start_offset != end_offset;
}
}
/**
* gtk_label_get_layout:
* @label: a #GtkLabel
*
* Gets the #PangoLayout used to display the label.
* The layout is useful to e.g. convert text positions to
* pixel positions, in combination with gtk_label_get_layout_offsets().
* The returned layout is owned by the @label so need not be
* freed by the caller. The @label is free to recreate its layout at
* any time, so it should be considered read-only.
*
* Returns: (transfer none): the #PangoLayout for this label
**/
PangoLayout*
gtk_label_get_layout (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
gtk_label_ensure_layout (label);
return priv->layout;
}
/**
* gtk_label_get_layout_offsets:
* @label: a #GtkLabel
* @x: (out) (optional): location to store X offset of layout, or %NULL
* @y: (out) (optional): location to store Y offset of layout, or %NULL
*
* Obtains the coordinates where the label will draw the #PangoLayout
* representing the text in the label; useful to convert mouse events
* into coordinates inside the #PangoLayout, e.g. to take some action
* if some part of the label is clicked. Remember
* when using the #PangoLayout functions you need to convert to
* and from pixels using PANGO_PIXELS() or #PANGO_SCALE.
**/
void
gtk_label_get_layout_offsets (GtkLabel *label,
gint *x,
gint *y)
{
g_return_if_fail (GTK_IS_LABEL (label));
gtk_label_ensure_layout (label);
get_layout_location (label, x, y);
}
/**
* gtk_label_set_use_markup:
* @label: a #GtkLabel
* @setting: %TRUE if the label’s text should be parsed for markup.
*
* Sets whether the text of the label contains markup in
* [Pango’s text markup language][PangoMarkupFormat].
* See gtk_label_set_markup().
**/
void
gtk_label_set_use_markup (GtkLabel *label,
gboolean setting)
{
g_return_if_fail (GTK_IS_LABEL (label));
g_object_freeze_notify (G_OBJECT (label));
if (gtk_label_set_use_markup_internal (label, setting))
gtk_label_recalculate (label);
g_object_thaw_notify (G_OBJECT (label));
}
/**
* gtk_label_get_use_markup:
* @label: a #GtkLabel
*
* Returns whether the label’s text is interpreted as marked up with
* the [Pango text markup language][PangoMarkupFormat].
* See gtk_label_set_use_markup ().
*
* Returns: %TRUE if the label’s text will be parsed for markup.
**/
gboolean
gtk_label_get_use_markup (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
return priv->use_markup;
}
/**
* gtk_label_set_use_underline:
* @label: a #GtkLabel
* @setting: %TRUE if underlines in the text indicate mnemonics
*
* If true, an underline in the text indicates the next character should be
* used for the mnemonic accelerator key.
*/
void
gtk_label_set_use_underline (GtkLabel *label,
gboolean setting)
{
g_return_if_fail (GTK_IS_LABEL (label));
g_object_freeze_notify (G_OBJECT (label));
if (gtk_label_set_use_underline_internal (label, setting))
gtk_label_recalculate (label);
g_object_thaw_notify (G_OBJECT (label));
}
/**
* gtk_label_get_use_underline:
* @label: a #GtkLabel
*
* Returns whether an embedded underline in the label indicates a
* mnemonic. See gtk_label_set_use_underline().
*
* Returns: %TRUE whether an embedded underline in the label indicates
* the mnemonic accelerator keys.
**/
gboolean
gtk_label_get_use_underline (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
return priv->use_underline;
}
/**
* gtk_label_set_single_line_mode:
* @label: a #GtkLabel
* @single_line_mode: %TRUE if the label should be in single line mode
*
* Sets whether the label is in single line mode.
*/
void
gtk_label_set_single_line_mode (GtkLabel *label,
gboolean single_line_mode)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_if_fail (GTK_IS_LABEL (label));
single_line_mode = single_line_mode != FALSE;
if (priv->single_line_mode != single_line_mode)
{
priv->single_line_mode = single_line_mode;
gtk_label_clear_layout (label);
gtk_widget_queue_resize (GTK_WIDGET (label));
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_SINGLE_LINE_MODE]);
}
}
/**
* gtk_label_get_single_line_mode:
* @label: a #GtkLabel
*
* Returns whether the label is in single line mode.
*
* Returns: %TRUE when the label is in single line mode.
**/
gboolean
gtk_label_get_single_line_mode (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
return priv->single_line_mode;
}
/* Compute the X position for an offset that corresponds to the "more important
* cursor position for that offset. We use this when trying to guess to which
* end of the selection we should go to when the user hits the left or
* right arrow key.
*/
static void
get_better_cursor (GtkLabel *label,
gint index,
gint *x,
gint *y)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GdkSeat *seat = gdk_display_get_default_seat (gtk_widget_get_display (GTK_WIDGET (label)));
GdkDevice *device = gdk_seat_get_keyboard (seat);
PangoDirection keymap_direction = gdk_device_get_direction (device);
PangoDirection cursor_direction = get_cursor_direction (label);
gboolean split_cursor;
PangoRectangle strong_pos, weak_pos;
g_object_get (gtk_widget_get_settings (GTK_WIDGET (label)),
"gtk-split-cursor", &split_cursor,
NULL);
gtk_label_ensure_layout (label);
pango_layout_get_cursor_pos (priv->layout, index,
&strong_pos, &weak_pos);
if (split_cursor)
{
*x = strong_pos.x / PANGO_SCALE;
*y = strong_pos.y / PANGO_SCALE;
}
else
{
if (keymap_direction == cursor_direction)
{
*x = strong_pos.x / PANGO_SCALE;
*y = strong_pos.y / PANGO_SCALE;
}
else
{
*x = weak_pos.x / PANGO_SCALE;
*y = weak_pos.y / PANGO_SCALE;
}
}
}
static gint
gtk_label_move_logically (GtkLabel *label,
gint start,
gint count)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
gint offset = g_utf8_pointer_to_offset (priv->text,
priv->text + start);
if (priv->text)
{
const PangoLogAttr *log_attrs;
gint n_attrs;
gint length;
gtk_label_ensure_layout (label);
length = g_utf8_strlen (priv->text, -1);
log_attrs = pango_layout_get_log_attrs_readonly (priv->layout, &n_attrs);
while (count > 0 && offset < length)
{
do
offset++;
while (offset < length && !log_attrs[offset].is_cursor_position);
count--;
}
while (count < 0 && offset > 0)
{
do
offset--;
while (offset > 0 && !log_attrs[offset].is_cursor_position);
count++;
}
}
return g_utf8_offset_to_pointer (priv->text, offset) - priv->text;
}
static gint
gtk_label_move_visually (GtkLabel *label,
gint start,
gint count)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
gint index;
index = start;
while (count != 0)
{
int new_index, new_trailing;
gboolean split_cursor;
gboolean strong;
gtk_label_ensure_layout (label);
g_object_get (gtk_widget_get_settings (GTK_WIDGET (label)),
"gtk-split-cursor", &split_cursor,
NULL);
if (split_cursor)
strong = TRUE;
else
{
GdkSeat *seat = gdk_display_get_default_seat (gtk_widget_get_display (GTK_WIDGET (label)));
GdkDevice *device = gdk_seat_get_keyboard (seat);
PangoDirection keymap_direction = gdk_device_get_direction (device);
strong = keymap_direction == get_cursor_direction (label);
}
if (count > 0)
{
pango_layout_move_cursor_visually (priv->layout, strong, index, 0, 1, &new_index, &new_trailing);
count--;
}
else
{
pango_layout_move_cursor_visually (priv->layout, strong, index, 0, -1, &new_index, &new_trailing);
count++;
}
if (new_index < 0 || new_index == G_MAXINT)
break;
index = new_index;
while (new_trailing--)
index = g_utf8_next_char (priv->text + new_index) - priv->text;
}
return index;
}
static gint
gtk_label_move_forward_word (GtkLabel *label,
gint start)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
gint new_pos = g_utf8_pointer_to_offset (priv->text,
priv->text + start);
gint length;
length = g_utf8_strlen (priv->text, -1);
if (new_pos < length)
{
const PangoLogAttr *log_attrs;
gint n_attrs;
gtk_label_ensure_layout (label);
log_attrs = pango_layout_get_log_attrs_readonly (priv->layout, &n_attrs);
/* Find the next word end */
new_pos++;
while (new_pos < n_attrs && !log_attrs[new_pos].is_word_end)
new_pos++;
}
return g_utf8_offset_to_pointer (priv->text, new_pos) - priv->text;
}
static gint
gtk_label_move_backward_word (GtkLabel *label,
gint start)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
gint new_pos = g_utf8_pointer_to_offset (priv->text,
priv->text + start);
if (new_pos > 0)
{
const PangoLogAttr *log_attrs;
gint n_attrs;
gtk_label_ensure_layout (label);
log_attrs = pango_layout_get_log_attrs_readonly (priv->layout, &n_attrs);
new_pos -= 1;
/* Find the previous word beginning */
while (new_pos > 0 && !log_attrs[new_pos].is_word_start)
new_pos--;
}
return g_utf8_offset_to_pointer (priv->text, new_pos) - priv->text;
}
static void
gtk_label_move_cursor (GtkLabel *label,
GtkMovementStep step,
gint count,
gboolean extend_selection)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
gint old_pos;
gint new_pos;
if (priv->select_info == NULL)
return;
old_pos = new_pos = priv->select_info->selection_end;
if (priv->select_info->selection_end != priv->select_info->selection_anchor &&
!extend_selection)
{
/* If we have a current selection and aren't extending it, move to the
* start/or end of the selection as appropriate
*/
switch (step)
{
case GTK_MOVEMENT_VISUAL_POSITIONS:
{
gint end_x, end_y;
gint anchor_x, anchor_y;
gboolean end_is_left;
get_better_cursor (label, priv->select_info->selection_end, &end_x, &end_y);
get_better_cursor (label, priv->select_info->selection_anchor, &anchor_x, &anchor_y);
end_is_left = (end_y < anchor_y) || (end_y == anchor_y && end_x < anchor_x);
if (count < 0)
new_pos = end_is_left ? priv->select_info->selection_end : priv->select_info->selection_anchor;
else
new_pos = !end_is_left ? priv->select_info->selection_end : priv->select_info->selection_anchor;
break;
}
case GTK_MOVEMENT_LOGICAL_POSITIONS:
case GTK_MOVEMENT_WORDS:
if (count < 0)
new_pos = MIN (priv->select_info->selection_end, priv->select_info->selection_anchor);
else
new_pos = MAX (priv->select_info->selection_end, priv->select_info->selection_anchor);
break;
case GTK_MOVEMENT_DISPLAY_LINE_ENDS:
case GTK_MOVEMENT_PARAGRAPH_ENDS:
case GTK_MOVEMENT_BUFFER_ENDS:
/* FIXME: Can do better here */
new_pos = count < 0 ? 0 : strlen (priv->text);
break;
case GTK_MOVEMENT_DISPLAY_LINES:
case GTK_MOVEMENT_PARAGRAPHS:
case GTK_MOVEMENT_PAGES:
case GTK_MOVEMENT_HORIZONTAL_PAGES:
default:
break;
}
}
else
{
switch (step)
{
case GTK_MOVEMENT_LOGICAL_POSITIONS:
new_pos = gtk_label_move_logically (label, new_pos, count);
break;
case GTK_MOVEMENT_VISUAL_POSITIONS:
new_pos = gtk_label_move_visually (label, new_pos, count);
if (new_pos == old_pos)
{
if (!extend_selection)
{
if (!gtk_widget_keynav_failed (GTK_WIDGET (label),
count > 0 ?
GTK_DIR_RIGHT : GTK_DIR_LEFT))
{
GtkRoot *root = gtk_widget_get_root (GTK_WIDGET (label));
if (root)
gtk_widget_child_focus (GTK_WIDGET (root), count > 0 ? GTK_DIR_RIGHT : GTK_DIR_LEFT);
}
}
else
{
gtk_widget_error_bell (GTK_WIDGET (label));
}
}
break;
case GTK_MOVEMENT_WORDS:
while (count > 0)
{
new_pos = gtk_label_move_forward_word (label, new_pos);
count--;
}
while (count < 0)
{
new_pos = gtk_label_move_backward_word (label, new_pos);
count++;
}
if (new_pos == old_pos)
gtk_widget_error_bell (GTK_WIDGET (label));
break;
case GTK_MOVEMENT_DISPLAY_LINE_ENDS:
case GTK_MOVEMENT_PARAGRAPH_ENDS:
case GTK_MOVEMENT_BUFFER_ENDS:
/* FIXME: Can do better here */
new_pos = count < 0 ? 0 : strlen (priv->text);
if (new_pos == old_pos)
gtk_widget_error_bell (GTK_WIDGET (label));
break;
case GTK_MOVEMENT_DISPLAY_LINES:
case GTK_MOVEMENT_PARAGRAPHS:
case GTK_MOVEMENT_PAGES:
case GTK_MOVEMENT_HORIZONTAL_PAGES:
default:
break;
}
}
if (extend_selection)
gtk_label_select_region_index (label,
priv->select_info->selection_anchor,
new_pos);
else
gtk_label_select_region_index (label, new_pos, new_pos);
}
static void
gtk_label_copy_clipboard (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
if (priv->text && priv->select_info)
{
gint start, end;
gint len;
GdkClipboard *clipboard;
start = MIN (priv->select_info->selection_anchor,
priv->select_info->selection_end);
end = MAX (priv->select_info->selection_anchor,
priv->select_info->selection_end);
len = strlen (priv->text);
if (end > len)
end = len;
if (start > len)
start = len;
clipboard = gtk_widget_get_clipboard (GTK_WIDGET (label));
if (start != end)
{
char *str = g_strndup (priv->text + start, end - start);
gdk_clipboard_set_text (clipboard, str);
g_free (str);
}
else
{
GtkLabelLink *link;
link = gtk_label_get_focus_link (label, NULL);
if (link)
gdk_clipboard_set_text (clipboard, link->uri);
}
}
}
static void
gtk_label_select_all (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
gtk_label_select_region_index (label, 0, strlen (priv->text));
}
static void
gtk_label_activate_link_open (GtkWidget *widget,
const char *name,
GVariant *parameter)
{
GtkLabel *label = GTK_LABEL (widget);
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GtkLabelLink *link = priv->select_info->context_link;
if (link)
emit_activate_link (label, link);
}
static void
gtk_label_activate_link_copy (GtkWidget *widget,
const char *name,
GVariant *parameter)
{
GtkLabel *label = GTK_LABEL (widget);
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GtkLabelLink *link = priv->select_info->context_link;
if (link)
{
GdkClipboard *clipboard;
clipboard = gtk_widget_get_clipboard (widget);
gdk_clipboard_set_text (clipboard, link->uri);
}
else
g_print ("no link ?!\n");
}
static void
gtk_label_activate_clipboard_copy (GtkWidget *widget,
const char *name,
GVariant *parameter)
{
g_signal_emit_by_name (widget, "copy-clipboard");
}
static void
gtk_label_activate_selection_select_all (GtkWidget *widget,
const char *name,
GVariant *parameter)
{
gtk_label_select_all (GTK_LABEL (widget));
}
static void
gtk_label_nop (GtkWidget *widget,
const char *name,
GVariant *parameter)
{
}
static void
gtk_label_update_actions (GtkLabel *label)
{
GtkWidget *widget = GTK_WIDGET (label);
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
gboolean has_selection;
GtkLabelLink *link;
if (priv->select_info)
{
has_selection = priv->select_info->selection_anchor != priv->select_info->selection_end;
link = priv->select_info->active_link;
}
else
{
has_selection = FALSE;
link = gtk_label_get_focus_link (label, NULL);
}
gtk_widget_action_set_enabled (widget, "clipboard.copy", has_selection);
gtk_widget_action_set_enabled (widget, "selection.select-all",
gtk_label_get_selectable (label));
gtk_widget_action_set_enabled (widget, "link.open", !has_selection && link);
gtk_widget_action_set_enabled (widget, "link.copy", !has_selection && link);
}
static GMenuModel *
gtk_label_get_menu_model (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GMenu *menu, *section;
GMenuItem *item;
menu = g_menu_new ();
section = g_menu_new ();
g_menu_append (section, _("Cu_t"), "clipboard.cut");
g_menu_append (section, _("_Copy"), "clipboard.copy");
g_menu_append (section, _("_Paste"), "clipboard.paste");
g_menu_append (section, _("_Delete"), "selection.delete");
g_menu_append_section (menu, NULL, G_MENU_MODEL (section));
g_object_unref (section);
section = g_menu_new ();
g_menu_append (section, _("Select _All"), "selection.select-all");
g_menu_append_section (menu, NULL, G_MENU_MODEL (section));
g_object_unref (section);
section = g_menu_new ();
item = g_menu_item_new (_("_Open Link"), "link.open");
g_menu_item_set_attribute (item, "hidden-when", "s", "action-disabled");
g_menu_append_item (section, item);
g_object_unref (item);
item = g_menu_item_new (_("Copy _Link Address"), "link.copy");
g_menu_item_set_attribute (item, "hidden-when", "s", "action-disabled");
g_menu_append_item (section, item);
g_object_unref (item);
g_menu_append_section (menu, NULL, G_MENU_MODEL (section));
g_object_unref (section);
if (priv->extra_menu)
g_menu_append_section (menu, NULL, priv->extra_menu);
return G_MENU_MODEL (menu);
}
static void
gtk_label_do_popup (GtkLabel *label,
double x,
double y)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
if (!priv->select_info)
return;
if (priv->select_info->link_clicked)
priv->select_info->context_link = priv->select_info->active_link;
else
priv->select_info->context_link = gtk_label_get_focus_link (label, NULL);
gtk_label_update_actions (label);
if (!priv->popup_menu)
{
GMenuModel *model;
model = gtk_label_get_menu_model (label);
priv->popup_menu = gtk_popover_menu_new_from_model (model);
gtk_widget_set_parent (priv->popup_menu, GTK_WIDGET (label));
gtk_popover_set_position (GTK_POPOVER (priv->popup_menu), GTK_POS_BOTTOM);
gtk_popover_set_has_arrow (GTK_POPOVER (priv->popup_menu), FALSE);
gtk_widget_set_halign (priv->popup_menu, GTK_ALIGN_START);
g_object_unref (model);
}
if (x != -1 && y != -1)
{
GdkRectangle rect = { x, y, 1, 1 };
gtk_popover_set_pointing_to (GTK_POPOVER (priv->popup_menu), &rect);
}
else
gtk_popover_set_pointing_to (GTK_POPOVER (priv->popup_menu), NULL);
gtk_popover_popup (GTK_POPOVER (priv->popup_menu));
}
static void
gtk_label_popup_menu (GtkWidget *widget,
const char *action_name,
GVariant *parameters)
{
GtkLabel *label = GTK_LABEL (widget);
gtk_label_do_popup (label, -1, -1);
}
static void
gtk_label_clear_links (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
guint i;
if (!priv->select_info)
return;
for (i = 0; i < self->select_info->n_links; i++)
link_free (&self->select_info->links[i]);
g_free (self->select_info->links);
self->select_info->links = NULL;
self->select_info->n_links = 0;
self->select_info->active_link = NULL;
gtk_widget_remove_css_class (GTK_WIDGET (label), "link");
_gtk_label_accessible_update_links (label);
}
static gboolean
gtk_label_activate_link (GtkLabel *label,
const gchar *uri)
{
GtkWidget *widget = GTK_WIDGET (label);
GtkWidget *toplevel = GTK_WIDGET (gtk_widget_get_root (widget));
if (!GTK_IS_WINDOW (toplevel))
return FALSE;
gtk_show_uri (GTK_WINDOW (toplevel), uri, GDK_CURRENT_TIME);
return TRUE;
}
static void
emit_activate_link (GtkLabel *label,
GtkLabelLink *link)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
gboolean handled;
g_signal_emit (label, signals[ACTIVATE_LINK], 0, link->uri, &handled);
/* signal handler might have invalidated the layout */
if (!priv->layout)
return;
if (handled && priv->track_links && !link->visited &&
priv->select_info && priv->select_info->links)
{
link->visited = TRUE;
update_link_state (label);
}
}
static void
gtk_label_activate_current_link (GtkLabel *label)
{
GtkLabelLink *link;
GtkWidget *widget = GTK_WIDGET (label);
link = gtk_label_get_focus_link (label, NULL);
if (link)
emit_activate_link (label, link);
else
gtk_widget_activate_default (widget);
}
static GtkLabelLink *
gtk_label_get_current_link (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GtkLabelLink *link;
if (!priv->select_info)
return NULL;
if (priv->select_info->link_clicked)
link = priv->select_info->active_link;
else
link = gtk_label_get_focus_link (label, NULL);
return link;
}
/**
* gtk_label_get_current_uri:
* @label: a #GtkLabel
*
* 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 #GtkLabel::activate-link handler
* or for use in a #GtkWidget::query-tooltip handler.
*
* Returns: (nullable): the currently active URI or %NULL if there is none.
* The string is owned by GTK+ and must not be freed or modified.
*/
const gchar *
gtk_label_get_current_uri (GtkLabel *label)
{
GtkLabelLink *link;
g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
link = gtk_label_get_current_link (label);
if (link)
return link->uri;
return NULL;
}
/**
* gtk_label_set_track_visited_links:
* @label: a #GtkLabel
* @track_links: %TRUE to track visited links
*
* Sets whether the label should keep track of clicked
* links (and use a different color for them).
*/
void
gtk_label_set_track_visited_links (GtkLabel *label,
gboolean track_links)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_if_fail (GTK_IS_LABEL (label));
track_links = track_links != FALSE;
if (priv->track_links != track_links)
{
priv->track_links = track_links;
/* FIXME: shouldn't have to redo everything here */
gtk_label_recalculate (label);
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_TRACK_VISITED_LINKS]);
}
}
/**
* gtk_label_get_track_visited_links:
* @label: a #GtkLabel
*
* Returns whether the label is currently keeping track
* of clicked links.
*
* Returns: %TRUE if clicked links are remembered
*/
gboolean
gtk_label_get_track_visited_links (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
return priv->track_links;
}
static gboolean
gtk_label_query_tooltip (GtkWidget *widget,
gint x,
gint y,
gboolean keyboard_tip,
GtkTooltip *tooltip)
{
GtkLabel *label = GTK_LABEL (widget);
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GtkLabelSelectionInfo *info = priv->select_info;
gint index = -1;
if (info && info->links)
{
if (keyboard_tip)
{
if (info->selection_anchor == info->selection_end)
index = info->selection_anchor;
}
else
{
if (!get_layout_index (label, x, y, &index))
index = -1;
}
if (index != -1)
{
const int link_index = _gtk_label_get_link_at (label, index);
if (link_index != -1)
{
const GtkLabelLink *link = &info->links[link_index];
if (link->title)
{
gtk_tooltip_set_markup (tooltip, link->title);
}
}
}
}
return GTK_WIDGET_CLASS (gtk_label_parent_class)->query_tooltip (widget,
x, y,
keyboard_tip,
tooltip);
}
gint
_gtk_label_get_cursor_position (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
if (priv->select_info && priv->select_info->selectable)
return g_utf8_pointer_to_offset (priv->text,
priv->text + priv->select_info->selection_end);
return 0;
}
gint
_gtk_label_get_selection_bound (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
if (priv->select_info && priv->select_info->selectable)
return g_utf8_pointer_to_offset (priv->text,
priv->text + priv->select_info->selection_anchor);
return 0;
}
/**
* gtk_label_set_lines:
* @label: a #GtkLabel
* @lines: the desired number of lines, or -1
*
* 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.
*/
void
gtk_label_set_lines (GtkLabel *label,
gint lines)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_if_fail (GTK_IS_LABEL (label));
if (priv->lines != lines)
{
priv->lines = lines;
gtk_label_clear_layout (label);
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_LINES]);
gtk_widget_queue_resize (GTK_WIDGET (label));
}
}
/**
* gtk_label_get_lines:
* @label: a #GtkLabel
*
* Gets the number of lines to which an ellipsized, wrapping
* label should be limited. See gtk_label_set_lines().
*
* Returns: The number of lines
*/
gint
gtk_label_get_lines (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_val_if_fail (GTK_IS_LABEL (label), -1);
return priv->lines;
}
gint
_gtk_label_get_n_links (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
if (priv->select_info)
return priv->select_info->n_links;
return 0;
}
const gchar *
_gtk_label_get_link_uri (GtkLabel *label,
gint idx)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
if (priv->select_info)
return priv->select_info->links[idx].uri;
return NULL;
}
void
_gtk_label_get_link_extent (GtkLabel *label,
gint idx,
gint *start,
gint *end)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
if (priv->select_info)
{
const GtkLabelLink *link = &priv->select_info->links[idx];
*start = link->start;
*end = link->end;
}
else
{
*start = -1;
*end = -1;
}
}
int
_gtk_label_get_link_at (GtkLabel *label,
int pos)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
if (priv->select_info)
{
guint i;
for (i = 0; i < priv->select_info->n_links; i++)
{
const GtkLabelLink *link = &priv->select_info->links[i];
if (link->start <= pos && pos < link->end)
return i;
}
}
return -1;
}
void
_gtk_label_activate_link (GtkLabel *label,
gint idx)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
if (priv->select_info)
{
GtkLabelLink *link = &priv->select_info->links[idx];
emit_activate_link (label, link);
}
}
gboolean
_gtk_label_get_link_visited (GtkLabel *label,
gint idx)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
if (priv->select_info)
return priv->select_info->links[idx].visited;
return FALSE;
}
gboolean
_gtk_label_get_link_focused (GtkLabel *label,
gint idx)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
GtkLabelSelectionInfo *info = priv->select_info;
if (!info)
return FALSE;
if (info->selection_anchor != info->selection_end)
return FALSE;
if (idx >= 0 && idx < info->n_links)
{
const GtkLabelLink *link = &info->links[idx];
if (link->start <= info->selection_anchor &&
info->selection_anchor <= link->end)
return TRUE;
}
return FALSE;
}
/**
* gtk_label_set_xalign:
* @label: a #GtkLabel
* @xalign: the new xalign value, between 0 and 1
*
* Sets the #GtkLabel:xalign property for @label.
*/
void
gtk_label_set_xalign (GtkLabel *label,
gfloat xalign)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_if_fail (GTK_IS_LABEL (label));
xalign = CLAMP (xalign, 0.0, 1.0);
if (priv->xalign == xalign)
return;
priv->xalign = xalign;
gtk_widget_queue_draw (GTK_WIDGET (label));
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_XALIGN]);
}
/**
* gtk_label_get_xalign:
* @label: a #GtkLabel
*
* Gets the #GtkLabel:xalign property for @label.
*
* Returns: the xalign property
*/
gfloat
gtk_label_get_xalign (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_val_if_fail (GTK_IS_LABEL (label), 0.5);
return priv->xalign;
}
/**
* gtk_label_set_yalign:
* @label: a #GtkLabel
* @yalign: the new yalign value, between 0 and 1
*
* Sets the #GtkLabel:yalign property for @label.
*/
void
gtk_label_set_yalign (GtkLabel *label,
gfloat yalign)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_if_fail (GTK_IS_LABEL (label));
yalign = CLAMP (yalign, 0.0, 1.0);
if (priv->yalign == yalign)
return;
priv->yalign = yalign;
gtk_widget_queue_draw (GTK_WIDGET (label));
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_YALIGN]);
}
/**
* gtk_label_get_yalign:
* @label: a #GtkLabel
*
* Gets the #GtkLabel:yalign property for @label.
*
* Returns: the yalign property
*/
gfloat
gtk_label_get_yalign (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_val_if_fail (GTK_IS_LABEL (label), 0.5);
return priv->yalign;
}
/**
* gtk_label_set_extra_menu:
* @label: a #GtkLabel
* @model: (allow-none): a #GMenuModel
*
* Sets a menu model to add when constructing
* the context menu for @label.
*/
void
gtk_label_set_extra_menu (GtkLabel *label,
GMenuModel *model)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_if_fail (GTK_IS_LABEL (label));
if (g_set_object (&priv->extra_menu, model))
{
g_clear_pointer (&priv->popup_menu, gtk_widget_unparent);
g_object_notify_by_pspec (G_OBJECT (label), label_props[PROP_EXTRA_MENU]);
}
}
/**
* gtk_label_get_extra_menu:
* @label: a #GtkLabel
*
* Gets the menu model set with gtk_label_set_extra_menu().
*
* Returns: (transfer none): (nullable): the menu model
*/
GMenuModel *
gtk_label_get_extra_menu (GtkLabel *label)
{
GtkLabelPrivate *priv = gtk_label_get_instance_private (label);
g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
return priv->extra_menu;
}
Reference in New Issue View Git Blame Copy Permalink