--- name: "Gtk2::Label" section: "3pm" platform: "linux" package: "libgtk2-perl-doc" version: "2:1.24992-1" release: "Debian 10 (Buster)" platforms: ["linux"] url: "https://new.carta.tech/Gtk2::Label" --- # Gtk2::Label(3pm) wrapper for GtkLabel ## NAME Gtk2::Label - wrapper for GtkLabel ## HIERARCHY ``` Glib::Object +----Glib::InitiallyUnowned +----Gtk2::Object +----Gtk2::Widget +----Gtk2::Misc +----Gtk2::Label ``` ## INTERFACES ``` Glib::Object::_Unregistered::AtkImplementorIface Gtk2::Buildable ``` ## METHODS ### widget = Gtk2::Label-\>new ($str=undef) - • `$str` (string or undef) ### widget = Gtk2::Label-\>new\_with\_mnemonic ($str) - • `$str` (string) ### double = $label-\>get\_angle Since: gtk+ 2.6 ### $label-\>set\_angle ($angle) - • `$angle` (double) Since: gtk+ 2.6 ### attrlist = $label-\>get\_attributes ### $label-\>set\_attributes ($attrs) - • `$attrs` (Pango::AttrList) ### string = $label-\>get\_current\_uri Since: gtk+ 2.18 ### ellipsizemode = $label-\>get\_ellipsize Since: gtk+ 2.6 ### $label-\>set\_ellipsize ($mode) - • `$mode` (Pango::EllipsizeMode) Since: gtk+ 2.6 ### justification = $label-\>get\_justify ### $label-\>set\_justify ($jtype) - • `$jtype` (Gtk2::Justification) ### string = $label-\>get\_label ### $label-\>set\_label ($str) - • `$str` (string) ### layout = $label-\>get\_layout ### (x, y) = $label-\>get\_layout\_offsets ### boolean = $label-\>get\_line\_wrap ### wrapmode = $label-\>get\_line\_wrap\_mode Since: gtk+ 2.9 ### $label-\>set\_line\_wrap\_mode ($wrap\_mode) - • `$wrap_mode` (Pango::WrapMode) Since: gtk+ 2.9 ### $label-\>set\_line\_wrap ($wrap) - • `$wrap` (boolean) ### $label-\>set\_markup ($str) - • `$str` (string) ### $label-\>set\_markup\_with\_mnemonic ($str) - • `$str` (string) ### integer = $label-\>get\_max\_width\_chars Since: gtk+ 2.6 ### $label-\>set\_max\_width\_chars ($n\_chars) - • `$n_chars` (integer) Since: gtk+ 2.6 ### integer = $label-\>get\_mnemonic\_keyval ### widget or undef = $label-\>get\_mnemonic\_widget ### $label-\>set\_mnemonic\_widget ($widget) - • `$widget` (Gtk2::Widget or undef) ### $label-\>set\_pattern ($pattern) - • `$pattern` (string) ### $label-\>select\_region ($start\_offset=-1, $end\_offset=-1) - • `$start_offset` (integer) - • `$end_offset` (integer) ### boolean = $label-\>get\_selectable ### $label-\>set\_selectable ($setting) - • `$setting` (boolean) ### (start, end) = $label-\>get\_selection\_bounds Returns integers, start and end. ### boolean = $label-\>get\_single\_line\_mode Since: gtk+ 2.6 ### $label-\>set\_single\_line\_mode ($single\_line\_mode) - • `$single_line_mode` (boolean) Since: gtk+ 2.6 ### string or undef = $label-\>get\_text ### $label-\>set\_text ($str) - • `$str` (string or undef) ### $label-\>set\_text\_with\_mnemonic ($str) - • `$str` (string) ### boolean = $label-\>get\_track\_visited\_links Since: gtk+ 2.18 ### $label-\>set\_track\_visited\_links ($track\_links) - • `$track_links` (boolean) Since: gtk+ 2.18 ### boolean = $label-\>get\_use\_markup ### $label-\>set\_use\_markup ($setting) - • `$setting` (boolean) ### boolean = $label-\>get\_use\_underline ### $label-\>set\_use\_underline ($setting) - • `$setting` (boolean) ### integer = $label-\>get\_width\_chars Since: gtk+ 2.6 ### $label-\>set\_width\_chars ($n\_chars) - • `$n_chars` (integer) Since: gtk+ 2.6 ## PROPERTIES - 'angle' (double : default 0 : readable / writable / private) Angle at which the label is rotated - 'attributes' (Pango::AttrList : default undef : readable / writable / private) A list of style attributes to apply to the text of the label - 'cursor-position' (integer : default 0 : readable / private) The current position of the insertion cursor in chars - '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 - '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 NOT affect the alignment of the label within its allocation. See GtkMisc::xalign for that - 'label' (string : default "" : readable / writable / private) The text of the label - 'max-width-chars' (integer : default -1 : readable / writable / private) The desired maximum width of the label, in characters - 'mnemonic-keyval' (Glib::UInt : default 0xFFFFFF VoidSymbol : readable / private) The mnemonic accelerator key for this label - 'mnemonic-widget' (Gtk2::Widget : default undef : readable / writable / private) The widget to be activated when the label's mnemonic key is pressed - 'pattern' (string : default undef : writable / private) A string with \_ characters in positions correspond to characters in the text to underline - 'selectable' (boolean : default false : readable / writable / private) Whether the label text can be selected with the mouse - 'selection-bound' (integer : default 0 : readable / private) The position of the opposite end of the selection from the cursor in chars - 'single-line-mode' (boolean : default false : readable / writable / private) Whether the label is in single line mode - 'track-visited-links' (boolean : default true : readable / writable / private) Whether visited links should be tracked - 'use-markup' (boolean : default false : readable / writable / private) The text of the label includes XML markup. See *pango\_parse\_markup()* - '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 - 'width-chars' (integer : default -1 : readable / writable / private) The desired width of the label, in characters - 'wrap' (boolean : default false : readable / writable / private) If set, wrap lines if the text becomes too wide - 'wrap-mode' (Pango::WrapMode : default "word" : readable / writable / private) If wrap is set, controls how linewrapping is done ## SIGNALS - **activate-current-link** (Gtk2::Label) - boolean = **activate-link** (Gtk2::Label, string) - **copy-clipboard** (Gtk2::Label) - **move-cursor** (Gtk2::Label, Gtk2::MovementStep, integer, boolean) - **populate-popup** (Gtk2::Label, Gtk2::Menu) ## ENUMS AND FLAGS ### enum Gtk2::Justification - • 'left' / 'GTK\_JUSTIFY\_LEFT' - • 'right' / 'GTK\_JUSTIFY\_RIGHT' - • 'center' / 'GTK\_JUSTIFY\_CENTER' - • 'fill' / 'GTK\_JUSTIFY\_FILL' ### enum Gtk2::MovementStep - • 'logical-positions' / 'GTK\_MOVEMENT\_LOGICAL\_POSITIONS' - • 'visual-positions' / 'GTK\_MOVEMENT\_VISUAL\_POSITIONS' - • 'words' / 'GTK\_MOVEMENT\_WORDS' - • 'display-lines' / 'GTK\_MOVEMENT\_DISPLAY\_LINES' - • 'display-line-ends' / 'GTK\_MOVEMENT\_DISPLAY\_LINE\_ENDS' - • 'paragraphs' / 'GTK\_MOVEMENT\_PARAGRAPHS' - • 'paragraph-ends' / 'GTK\_MOVEMENT\_PARAGRAPH\_ENDS' - • 'pages' / 'GTK\_MOVEMENT\_PAGES' - • 'buffer-ends' / 'GTK\_MOVEMENT\_BUFFER\_ENDS' - • 'horizontal-pages' / 'GTK\_MOVEMENT\_HORIZONTAL\_PAGES' ### enum Pango::EllipsizeMode - • 'none' / 'PANGO\_ELLIPSIZE\_NONE' - • 'start' / 'PANGO\_ELLIPSIZE\_START' - • 'middle' / 'PANGO\_ELLIPSIZE\_MIDDLE' - • 'end' / 'PANGO\_ELLIPSIZE\_END' ### enum Pango::WrapMode - • 'word' / 'PANGO\_WRAP\_WORD' - • 'char' / 'PANGO\_WRAP\_CHAR' - • 'word-char' / 'PANGO\_WRAP\_WORD\_CHAR' ## SEE ALSO Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget, Gtk2::Misc ## COPYRIGHT Copyright (C) 2003-2011 by the gtk2-perl team. This software is licensed under the LGPL. See Gtk2 for a full notice.