.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Gtk2::Label 3pm" .TH Gtk2::Label 3pm "2019-09-16" "perl v5.28.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Gtk2::Label \- wrapper for GtkLabel .SH "HIERARCHY" .IX Header "HIERARCHY" .Vb 6 \& Glib::Object \& +\-\-\-\-Glib::InitiallyUnowned \& +\-\-\-\-Gtk2::Object \& +\-\-\-\-Gtk2::Widget \& +\-\-\-\-Gtk2::Misc \& +\-\-\-\-Gtk2::Label .Ve .SH "INTERFACES" .IX Header "INTERFACES" .Vb 2 \& Glib::Object::_Unregistered::AtkImplementorIface \& Gtk2::Buildable .Ve .SH "METHODS" .IX Header "METHODS" .SS "widget = Gtk2::Label\->\fBnew\fP ($str=undef)" .IX Subsection "widget = Gtk2::Label->new ($str=undef)" .IP "\(bu" 4 \&\f(CW$str\fR (string or undef) .SS "widget = Gtk2::Label\->\fBnew_with_mnemonic\fP ($str)" .IX Subsection "widget = Gtk2::Label->new_with_mnemonic ($str)" .IP "\(bu" 4 \&\f(CW$str\fR (string) .ie n .SS "double = $label\->\fBget_angle\fP" .el .SS "double = \f(CW$label\fP\->\fBget_angle\fP" .IX Subsection "double = $label->get_angle" Since: gtk+ 2.6 .ie n .SS "$label\->\fBset_angle\fP ($angle)" .el .SS "\f(CW$label\fP\->\fBset_angle\fP ($angle)" .IX Subsection "$label->set_angle ($angle)" .IP "\(bu" 4 \&\f(CW$angle\fR (double) .PP Since: gtk+ 2.6 .ie n .SS "attrlist = $label\->\fBget_attributes\fP" .el .SS "attrlist = \f(CW$label\fP\->\fBget_attributes\fP" .IX Subsection "attrlist = $label->get_attributes" .ie n .SS "$label\->\fBset_attributes\fP ($attrs)" .el .SS "\f(CW$label\fP\->\fBset_attributes\fP ($attrs)" .IX Subsection "$label->set_attributes ($attrs)" .IP "\(bu" 4 \&\f(CW$attrs\fR (Pango::AttrList) .ie n .SS "string = $label\->\fBget_current_uri\fP" .el .SS "string = \f(CW$label\fP\->\fBget_current_uri\fP" .IX Subsection "string = $label->get_current_uri" Since: gtk+ 2.18 .ie n .SS "ellipsizemode = $label\->\fBget_ellipsize\fP" .el .SS "ellipsizemode = \f(CW$label\fP\->\fBget_ellipsize\fP" .IX Subsection "ellipsizemode = $label->get_ellipsize" Since: gtk+ 2.6 .ie n .SS "$label\->\fBset_ellipsize\fP ($mode)" .el .SS "\f(CW$label\fP\->\fBset_ellipsize\fP ($mode)" .IX Subsection "$label->set_ellipsize ($mode)" .IP "\(bu" 4 \&\f(CW$mode\fR (Pango::EllipsizeMode) .PP Since: gtk+ 2.6 .ie n .SS "justification = $label\->\fBget_justify\fP" .el .SS "justification = \f(CW$label\fP\->\fBget_justify\fP" .IX Subsection "justification = $label->get_justify" .ie n .SS "$label\->\fBset_justify\fP ($jtype)" .el .SS "\f(CW$label\fP\->\fBset_justify\fP ($jtype)" .IX Subsection "$label->set_justify ($jtype)" .IP "\(bu" 4 \&\f(CW$jtype\fR (Gtk2::Justification) .ie n .SS "string = $label\->\fBget_label\fP" .el .SS "string = \f(CW$label\fP\->\fBget_label\fP" .IX Subsection "string = $label->get_label" .ie n .SS "$label\->\fBset_label\fP ($str)" .el .SS "\f(CW$label\fP\->\fBset_label\fP ($str)" .IX Subsection "$label->set_label ($str)" .IP "\(bu" 4 \&\f(CW$str\fR (string) .ie n .SS "layout = $label\->\fBget_layout\fP" .el .SS "layout = \f(CW$label\fP\->\fBget_layout\fP" .IX Subsection "layout = $label->get_layout" .ie n .SS "(x, y) = $label\->\fBget_layout_offsets\fP" .el .SS "(x, y) = \f(CW$label\fP\->\fBget_layout_offsets\fP" .IX Subsection "(x, y) = $label->get_layout_offsets" .ie n .SS "boolean = $label\->\fBget_line_wrap\fP" .el .SS "boolean = \f(CW$label\fP\->\fBget_line_wrap\fP" .IX Subsection "boolean = $label->get_line_wrap" .ie n .SS "wrapmode = $label\->\fBget_line_wrap_mode\fP" .el .SS "wrapmode = \f(CW$label\fP\->\fBget_line_wrap_mode\fP" .IX Subsection "wrapmode = $label->get_line_wrap_mode" Since: gtk+ 2.9 .ie n .SS "$label\->\fBset_line_wrap_mode\fP ($wrap_mode)" .el .SS "\f(CW$label\fP\->\fBset_line_wrap_mode\fP ($wrap_mode)" .IX Subsection "$label->set_line_wrap_mode ($wrap_mode)" .IP "\(bu" 4 \&\f(CW$wrap_mode\fR (Pango::WrapMode) .PP Since: gtk+ 2.9 .ie n .SS "$label\->\fBset_line_wrap\fP ($wrap)" .el .SS "\f(CW$label\fP\->\fBset_line_wrap\fP ($wrap)" .IX Subsection "$label->set_line_wrap ($wrap)" .IP "\(bu" 4 \&\f(CW$wrap\fR (boolean) .ie n .SS "$label\->\fBset_markup\fP ($str)" .el .SS "\f(CW$label\fP\->\fBset_markup\fP ($str)" .IX Subsection "$label->set_markup ($str)" .IP "\(bu" 4 \&\f(CW$str\fR (string) .ie n .SS "$label\->\fBset_markup_with_mnemonic\fP ($str)" .el .SS "\f(CW$label\fP\->\fBset_markup_with_mnemonic\fP ($str)" .IX Subsection "$label->set_markup_with_mnemonic ($str)" .IP "\(bu" 4 \&\f(CW$str\fR (string) .ie n .SS "integer = $label\->\fBget_max_width_chars\fP" .el .SS "integer = \f(CW$label\fP\->\fBget_max_width_chars\fP" .IX Subsection "integer = $label->get_max_width_chars" Since: gtk+ 2.6 .ie n .SS "$label\->\fBset_max_width_chars\fP ($n_chars)" .el .SS "\f(CW$label\fP\->\fBset_max_width_chars\fP ($n_chars)" .IX Subsection "$label->set_max_width_chars ($n_chars)" .IP "\(bu" 4 \&\f(CW$n_chars\fR (integer) .PP Since: gtk+ 2.6 .ie n .SS "integer = $label\->\fBget_mnemonic_keyval\fP" .el .SS "integer = \f(CW$label\fP\->\fBget_mnemonic_keyval\fP" .IX Subsection "integer = $label->get_mnemonic_keyval" .ie n .SS "widget or undef = $label\->\fBget_mnemonic_widget\fP" .el .SS "widget or undef = \f(CW$label\fP\->\fBget_mnemonic_widget\fP" .IX Subsection "widget or undef = $label->get_mnemonic_widget" .ie n .SS "$label\->\fBset_mnemonic_widget\fP ($widget)" .el .SS "\f(CW$label\fP\->\fBset_mnemonic_widget\fP ($widget)" .IX Subsection "$label->set_mnemonic_widget ($widget)" .IP "\(bu" 4 \&\f(CW$widget\fR (Gtk2::Widget or undef) .ie n .SS "$label\->\fBset_pattern\fP ($pattern)" .el .SS "\f(CW$label\fP\->\fBset_pattern\fP ($pattern)" .IX Subsection "$label->set_pattern ($pattern)" .IP "\(bu" 4 \&\f(CW$pattern\fR (string) .ie n .SS "$label\->\fBselect_region\fP ($start_offset=\-1, $end_offset=\-1)" .el .SS "\f(CW$label\fP\->\fBselect_region\fP ($start_offset=\-1, \f(CW$end_offset\fP=\-1)" .IX Subsection "$label->select_region ($start_offset=-1, $end_offset=-1)" .IP "\(bu" 4 \&\f(CW$start_offset\fR (integer) .IP "\(bu" 4 \&\f(CW$end_offset\fR (integer) .ie n .SS "boolean = $label\->\fBget_selectable\fP" .el .SS "boolean = \f(CW$label\fP\->\fBget_selectable\fP" .IX Subsection "boolean = $label->get_selectable" .ie n .SS "$label\->\fBset_selectable\fP ($setting)" .el .SS "\f(CW$label\fP\->\fBset_selectable\fP ($setting)" .IX Subsection "$label->set_selectable ($setting)" .IP "\(bu" 4 \&\f(CW$setting\fR (boolean) .ie n .SS "(start, end) = $label\->\fBget_selection_bounds\fP" .el .SS "(start, end) = \f(CW$label\fP\->\fBget_selection_bounds\fP" .IX Subsection "(start, end) = $label->get_selection_bounds" Returns integers, start and end. .ie n .SS "boolean = $label\->\fBget_single_line_mode\fP" .el .SS "boolean = \f(CW$label\fP\->\fBget_single_line_mode\fP" .IX Subsection "boolean = $label->get_single_line_mode" Since: gtk+ 2.6 .ie n .SS "$label\->\fBset_single_line_mode\fP ($single_line_mode)" .el .SS "\f(CW$label\fP\->\fBset_single_line_mode\fP ($single_line_mode)" .IX Subsection "$label->set_single_line_mode ($single_line_mode)" .IP "\(bu" 4 \&\f(CW$single_line_mode\fR (boolean) .PP Since: gtk+ 2.6 .ie n .SS "string or undef = $label\->\fBget_text\fP" .el .SS "string or undef = \f(CW$label\fP\->\fBget_text\fP" .IX Subsection "string or undef = $label->get_text" .ie n .SS "$label\->\fBset_text\fP ($str)" .el .SS "\f(CW$label\fP\->\fBset_text\fP ($str)" .IX Subsection "$label->set_text ($str)" .IP "\(bu" 4 \&\f(CW$str\fR (string or undef) .ie n .SS "$label\->\fBset_text_with_mnemonic\fP ($str)" .el .SS "\f(CW$label\fP\->\fBset_text_with_mnemonic\fP ($str)" .IX Subsection "$label->set_text_with_mnemonic ($str)" .IP "\(bu" 4 \&\f(CW$str\fR (string) .ie n .SS "boolean = $label\->\fBget_track_visited_links\fP" .el .SS "boolean = \f(CW$label\fP\->\fBget_track_visited_links\fP" .IX Subsection "boolean = $label->get_track_visited_links" Since: gtk+ 2.18 .ie n .SS "$label\->\fBset_track_visited_links\fP ($track_links)" .el .SS "\f(CW$label\fP\->\fBset_track_visited_links\fP ($track_links)" .IX Subsection "$label->set_track_visited_links ($track_links)" .IP "\(bu" 4 \&\f(CW$track_links\fR (boolean) .PP Since: gtk+ 2.18 .ie n .SS "boolean = $label\->\fBget_use_markup\fP" .el .SS "boolean = \f(CW$label\fP\->\fBget_use_markup\fP" .IX Subsection "boolean = $label->get_use_markup" .ie n .SS "$label\->\fBset_use_markup\fP ($setting)" .el .SS "\f(CW$label\fP\->\fBset_use_markup\fP ($setting)" .IX Subsection "$label->set_use_markup ($setting)" .IP "\(bu" 4 \&\f(CW$setting\fR (boolean) .ie n .SS "boolean = $label\->\fBget_use_underline\fP" .el .SS "boolean = \f(CW$label\fP\->\fBget_use_underline\fP" .IX Subsection "boolean = $label->get_use_underline" .ie n .SS "$label\->\fBset_use_underline\fP ($setting)" .el .SS "\f(CW$label\fP\->\fBset_use_underline\fP ($setting)" .IX Subsection "$label->set_use_underline ($setting)" .IP "\(bu" 4 \&\f(CW$setting\fR (boolean) .ie n .SS "integer = $label\->\fBget_width_chars\fP" .el .SS "integer = \f(CW$label\fP\->\fBget_width_chars\fP" .IX Subsection "integer = $label->get_width_chars" Since: gtk+ 2.6 .ie n .SS "$label\->\fBset_width_chars\fP ($n_chars)" .el .SS "\f(CW$label\fP\->\fBset_width_chars\fP ($n_chars)" .IX Subsection "$label->set_width_chars ($n_chars)" .IP "\(bu" 4 \&\f(CW$n_chars\fR (integer) .PP Since: gtk+ 2.6 .SH "PROPERTIES" .IX Header "PROPERTIES" .IP "'angle' (double : default 0 : readable / writable / private)" 4 .IX Item "'angle' (double : default 0 : readable / writable / private)" Angle at which the label is rotated .IP "'attributes' (Pango::AttrList : default undef : readable / writable / private)" 4 .IX Item "'attributes' (Pango::AttrList : default undef : readable / writable / private)" A list of style attributes to apply to the text of the label .IP "'cursor\-position' (integer : default 0 : readable / private)" 4 .IX Item "'cursor-position' (integer : default 0 : readable / private)" The current position of the insertion cursor in chars .ie n .IP "'ellipsize' (Pango::EllipsizeMode : default ""none"" : readable / writable / private)" 4 .el .IP "'ellipsize' (Pango::EllipsizeMode : default ``none'' : readable / writable / private)" 4 .IX Item "'ellipsize' (Pango::EllipsizeMode : default none : readable / writable / private)" The preferred place to ellipsize the string, if the label does not have enough room to display the entire string .ie n .IP "'justify' (Gtk2::Justification : default ""left"" : readable / writable / private)" 4 .el .IP "'justify' (Gtk2::Justification : default ``left'' : readable / writable / private)" 4 .IX Item "'justify' (Gtk2::Justification : default left : readable / writable / private)" The alignment of the lines in the text of the label relative to each other. This does \s-1NOT\s0 affect the alignment of the label within its allocation. See GtkMisc::xalign for that .ie n .IP "'label' (string : default """" : readable / writable / private)" 4 .el .IP "'label' (string : default ``'' : readable / writable / private)" 4 .IX Item "'label' (string : default """" : readable / writable / private)" The text of the label .IP "'max\-width\-chars' (integer : default \-1 : readable / writable / private)" 4 .IX Item "'max-width-chars' (integer : default -1 : readable / writable / private)" The desired maximum width of the label, in characters .IP "'mnemonic\-keyval' (Glib::UInt : default 0xFFFFFF VoidSymbol : readable / private)" 4 .IX Item "'mnemonic-keyval' (Glib::UInt : default 0xFFFFFF VoidSymbol : readable / private)" The mnemonic accelerator key for this label .IP "'mnemonic\-widget' (Gtk2::Widget : default undef : readable / writable / private)" 4 .IX Item "'mnemonic-widget' (Gtk2::Widget : default undef : readable / writable / private)" The widget to be activated when the label's mnemonic key is pressed .IP "'pattern' (string : default undef : writable / private)" 4 .IX Item "'pattern' (string : default undef : writable / private)" A string with _ characters in positions correspond to characters in the text to underline .IP "'selectable' (boolean : default false : readable / writable / private)" 4 .IX Item "'selectable' (boolean : default false : readable / writable / private)" Whether the label text can be selected with the mouse .IP "'selection\-bound' (integer : default 0 : readable / private)" 4 .IX Item "'selection-bound' (integer : default 0 : readable / private)" The position of the opposite end of the selection from the cursor in chars .IP "'single\-line\-mode' (boolean : default false : readable / writable / private)" 4 .IX Item "'single-line-mode' (boolean : default false : readable / writable / private)" Whether the label is in single line mode .IP "'track\-visited\-links' (boolean : default true : readable / writable / private)" 4 .IX Item "'track-visited-links' (boolean : default true : readable / writable / private)" Whether visited links should be tracked .IP "'use\-markup' (boolean : default false : readable / writable / private)" 4 .IX Item "'use-markup' (boolean : default false : readable / writable / private)" The text of the label includes \s-1XML\s0 markup. See \fBpango_parse_markup()\fR .IP "'use\-underline' (boolean : default false : readable / writable / private)" 4 .IX Item "'use-underline' (boolean : default false : readable / writable / private)" If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key .IP "'width\-chars' (integer : default \-1 : readable / writable / private)" 4 .IX Item "'width-chars' (integer : default -1 : readable / writable / private)" The desired width of the label, in characters .IP "'wrap' (boolean : default false : readable / writable / private)" 4 .IX Item "'wrap' (boolean : default false : readable / writable / private)" If set, wrap lines if the text becomes too wide .ie n .IP "'wrap\-mode' (Pango::WrapMode : default ""word"" : readable / writable / private)" 4 .el .IP "'wrap\-mode' (Pango::WrapMode : default ``word'' : readable / writable / private)" 4 .IX Item "'wrap-mode' (Pango::WrapMode : default word : readable / writable / private)" If wrap is set, controls how linewrapping is done .SH "SIGNALS" .IX Header "SIGNALS" .IP "\fBactivate-current-link\fR (Gtk2::Label)" 4 .IX Item "activate-current-link (Gtk2::Label)" .PD 0 .IP "boolean = \fBactivate-link\fR (Gtk2::Label, string)" 4 .IX Item "boolean = activate-link (Gtk2::Label, string)" .IP "\fBcopy-clipboard\fR (Gtk2::Label)" 4 .IX Item "copy-clipboard (Gtk2::Label)" .IP "\fBmove-cursor\fR (Gtk2::Label, Gtk2::MovementStep, integer, boolean)" 4 .IX Item "move-cursor (Gtk2::Label, Gtk2::MovementStep, integer, boolean)" .IP "\fBpopulate-popup\fR (Gtk2::Label, Gtk2::Menu)" 4 .IX Item "populate-popup (Gtk2::Label, Gtk2::Menu)" .PD .SH "ENUMS AND FLAGS" .IX Header "ENUMS AND FLAGS" .SS "enum Gtk2::Justification" .IX Subsection "enum Gtk2::Justification" .IP "\(bu" 4 \&'left' / '\s-1GTK_JUSTIFY_LEFT\s0' .IP "\(bu" 4 \&'right' / '\s-1GTK_JUSTIFY_RIGHT\s0' .IP "\(bu" 4 \&'center' / '\s-1GTK_JUSTIFY_CENTER\s0' .IP "\(bu" 4 \&'fill' / '\s-1GTK_JUSTIFY_FILL\s0' .SS "enum Gtk2::MovementStep" .IX Subsection "enum Gtk2::MovementStep" .IP "\(bu" 4 \&'logical\-positions' / '\s-1GTK_MOVEMENT_LOGICAL_POSITIONS\s0' .IP "\(bu" 4 \&'visual\-positions' / '\s-1GTK_MOVEMENT_VISUAL_POSITIONS\s0' .IP "\(bu" 4 \&'words' / '\s-1GTK_MOVEMENT_WORDS\s0' .IP "\(bu" 4 \&'display\-lines' / '\s-1GTK_MOVEMENT_DISPLAY_LINES\s0' .IP "\(bu" 4 \&'display\-line\-ends' / '\s-1GTK_MOVEMENT_DISPLAY_LINE_ENDS\s0' .IP "\(bu" 4 \&'paragraphs' / '\s-1GTK_MOVEMENT_PARAGRAPHS\s0' .IP "\(bu" 4 \&'paragraph\-ends' / '\s-1GTK_MOVEMENT_PARAGRAPH_ENDS\s0' .IP "\(bu" 4 \&'pages' / '\s-1GTK_MOVEMENT_PAGES\s0' .IP "\(bu" 4 \&'buffer\-ends' / '\s-1GTK_MOVEMENT_BUFFER_ENDS\s0' .IP "\(bu" 4 \&'horizontal\-pages' / '\s-1GTK_MOVEMENT_HORIZONTAL_PAGES\s0' .SS "enum Pango::EllipsizeMode" .IX Subsection "enum Pango::EllipsizeMode" .IP "\(bu" 4 \&'none' / '\s-1PANGO_ELLIPSIZE_NONE\s0' .IP "\(bu" 4 \&'start' / '\s-1PANGO_ELLIPSIZE_START\s0' .IP "\(bu" 4 \&'middle' / '\s-1PANGO_ELLIPSIZE_MIDDLE\s0' .IP "\(bu" 4 \&'end' / '\s-1PANGO_ELLIPSIZE_END\s0' .SS "enum Pango::WrapMode" .IX Subsection "enum Pango::WrapMode" .IP "\(bu" 4 \&'word' / '\s-1PANGO_WRAP_WORD\s0' .IP "\(bu" 4 \&'char' / '\s-1PANGO_WRAP_CHAR\s0' .IP "\(bu" 4 \&'word\-char' / '\s-1PANGO_WRAP_WORD_CHAR\s0' .SH "SEE ALSO" .IX Header "SEE ALSO" Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget, Gtk2::Misc .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2003\-2011 by the gtk2\-perl team. .PP This software is licensed under the \s-1LGPL.\s0 See Gtk2 for a full notice.