Gtk2::Label(3)

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 / static-nick / static-blurb)
    Angle at which the label is rotated

'attributes' (Pango::AttrList : default undef : readable / writable / private / static-nick / static-blurb)
    A list of style attributes to apply to the text of the label

'cursor-position' (integer : default 0 : readable / private / static-nick / static-blurb)
    The current position of the insertion cursor in chars

'ellipsize' (Pango::EllipsizeMode : default "none" : readable / writable / private / static-nick / static-blurb)
    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 / static-nick / static-blurb)
    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 / static-nick / static-blurb)
    The text of the label

'max-width-chars' (integer : default -1 : readable / writable / private / static-nick / static-blurb)
    The desired maximum width of the label, in characters

'mnemonic-keyval' (Glib::UInt : default 0xFFFFFF VoidSymbol : readable / private / static-nick / static-blurb)
    The mnemonic accelerator key for this label

'mnemonic-widget' (Gtk2::Widget : default undef : readable / writable / private / static-nick / static-blurb)
    The widget to be activated when the label's mnemonic key is pressed

'pattern' (string : default undef : writable / private / static-nick / static-blurb)
    A string with _ characters in positions correspond to characters in the text to underline

'selectable' (boolean : default false : readable / writable / private / static-nick / static-blurb)
    Whether the label text can be selected with the mouse

'selection-bound' (integer : default 0 : readable / private / static-nick / static-blurb)
    The position of the opposite end of the selection from the cursor in chars

'single-line-mode' (boolean : default false : readable / writable / private / static-nick / static-blurb)
    Whether the label is in single line mode

'track-visited-links' (boolean : default true : readable / writable / private / static-nick / static-blurb)
    Whether visited links should be tracked

'use-markup' (boolean : default false : readable / writable / private / static-nick / static-blurb)
    The text of the label includes XML markup. See pango_parse_markup()

'use-underline' (boolean : default false : readable / writable / private / static-nick / static-blurb)
    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 / static-nick / static-blurb)
    The desired width of the label, in characters

'wrap' (boolean : default false : readable / writable / private / static-nick / static-blurb)
    If set, wrap lines if the text becomes too wide

'wrap-mode' (Pango::WrapMode : default "word" : readable / writable / private / static-nick / static-blurb)
    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.