Gtk2::Button(3)

📦
version 1.24993 · 2 versions
, in fedora 43

💖 Gtk2::Button — the wrapper for GtkButton 💖

okay bestie, sit down, hydrate, because today we're talking about Gtk2::Button — the Perl wrapper for GtkButton. It's the thing you click. It's the moment. It's the button. Periodt. 🎀

This page lives in the User Contributed Perl Documentation section, and I'm about to give you the whole tour, no skips, no cuts, full album. 🦋

🌸 HIERARCHY 🌸

so like, the ancestry?? immaculate. generational talent. look at this lineage:

  Glib::Object
  +----Glib::InitiallyUnowned
       +----Gtk2::Object
            +----Gtk2::Widget
                 +----Gtk2::Container
                      +----Gtk2::Bin
                           +----Gtk2::Button

six levels of main character energy and the button is the final form 💅

✨ INTERFACES ✨

these are the interfaces it implements, and yes it's giving versatile:

  Glib::Object::_Unregistered::AtkImplementorIface
  Gtk2::Buildable
  Gtk2::Activatable

🎀 MNEMONICS 🎀

okay so "mnemonics" is just fancy speak for memory aids. in GTK+, a mnemonic is an underlined character that maps to a keyboard accelerator. for a button, that means: hold Alt + press that key → button gets activated. keyboard girlies stay winning. ⌨️

for convenience, Gtk2-Perl uses mnemonics by default on widgets that support them. if characters in the label string are preceded by an underscore, they get underlined. and listen — if you need a literal underscore character in a label, use '__' (two underscores, bestie, two). if you don't want mnemonics at all, just use the non-mnemonic version explicitly (e.g. Gtk2::Button::new_with_label). pick your fighter. 🫶

🔥 METHODS 🔥

widget = Gtk2::Button->new

widget = Gtk2::Button->new ($mnemonic)

  • $mnemonic (string) — used to label the widget, see "MNEMONICS" above 👆

widget = Gtk2::Button->new_from_stock ($stock_id)

  • $stock_id (string) — creates a new button using the icon and text from the specified stock item, see Gtk2::Stock

widget = Gtk2::Button->new_with_label ($label)

  • $label (string) — used to label the widget

widget = Gtk2::Button->new_with_mnemonic ($mnemonic)

  • $mnemonic (string) — used to label the widget, see "MNEMONICS"

(xalign, yalign) = $button->get_alignment

Since: gtk+ 2.4

$button->set_alignment ($xalign, $yalign)

  • $xalign (double)
  • $yalign (double)
Since: gtk+ 2.4

$button->clicked

$button->enter

window or undef = $button->get_event_window

Since: gtk+ 2.22

boolean = $button->get_focus_on_click

Since: gtk+ 2.4

$button->set_focus_on_click ($focus_on_click)

  • $focus_on_click (boolean)
Since: gtk+ 2.4

widget or undef = $button->get_image

Since: gtk+ 2.6

positiontype = $button->get_image_position

Since: gtk+ 2.10

$button->set_image_position ($position)

  • $position (Gtk2::PositionType)
Since: gtk+ 2.10

$button->set_image ($image)

  • $image (Gtk2::Widget or undef)
Since: gtk+ 2.6

string = $button->get_label

$button->set_label ($label)

  • $label (string)

$button->leave

$button->pressed

$button->released

reliefstyle = $button->get_relief

$button->set_relief ($newstyle)

  • $newstyle (Gtk2::ReliefStyle)

boolean = $button->get_use_stock

$button->set_use_stock ($use_stock)

  • $use_stock (boolean)

boolean = $button->get_use_underline

$button->set_use_underline ($use_underline)

  • $use_underline (boolean)

💜 PROPERTIES 💜

  • 'focus-on-click' (boolean : default true : readable / writable / private / static-nick / static-blurb) — Whether the button grabs focus when it is clicked with the mouse
  • 'image' (Gtk2::Widget : default undef : readable / writable / private / static-nick / static-blurb) — Child widget to appear next to the button text
  • 'image-position' (Gtk2::PositionType : default "left" : readable / writable / private / static-nick / static-blurb) — The position of the image relative to the text
  • 'label' (string : default undef : readable / writable / construct / private / static-nick / static-blurb) — Text of the label widget inside the button, if the button contains a label widget
  • 'relief' (Gtk2::ReliefStyle : default "normal" : readable / writable / private / static-nick / static-blurb) — The border relief style
  • 'use-stock' (boolean : default false : readable / writable / construct / private / static-nick / static-blurb) — If set, the label is used to pick a stock item instead of being displayed
  • 'use-underline' (boolean : default false : readable / writable / construct / private / static-nick / static-blurb) — If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key
  • 'xalign' (float : default 0.5 : readable / writable / private / static-nick / static-blurb) — Horizontal position of child in available space. 0.0 is left aligned, 1.0 is right aligned
  • 'yalign' (float : default 0.5 : readable / writable / private / static-nick / static-blurb) — Vertical position of child in available space. 0.0 is top aligned, 1.0 is bottom aligned

🌈 STYLE PROPERTIES 🌈

  • 'child-displacement-x' (integer : default 0 : readable / private / static-nick / static-blurb) — How far in the x direction to move the child when the button is depressed
  • 'child-displacement-y' (integer : default 0 : readable / private / static-nick / static-blurb) — How far in the y direction to move the child when the button is depressed
  • 'default-border' (Gtk2::Border : default undef : readable / private / static-nick / static-blurb) — Extra space to add for GTK_CAN_DEFAULT buttons
  • 'default-outside-border' (Gtk2::Border : default undef : readable / private / static-nick / static-blurb) — Extra space to add for GTK_CAN_DEFAULT buttons that is always drawn outside the border
  • 'displace-focus' (boolean : default false : readable / private / static-nick / static-blurb) — Whether the child_displacement_x/_y properties should also affect the focus rectangle
  • 'image-spacing' (integer : default 2 : readable / private / static-nick / static-blurb) — Spacing in pixels between the image and label
  • 'inner-border' (Gtk2::Border : default undef : readable / private / static-nick / static-blurb) — Border between button edges and child.

👑 SIGNALS 👑

  • activate (Gtk2::Button)
  • clicked (Gtk2::Button)
  • enter (Gtk2::Button)
  • leave (Gtk2::Button)
  • pressed (Gtk2::Button)
  • released (Gtk2::Button)

🧚 ENUMS AND FLAGS 🧚

enum Gtk2::PositionType

  • 'left' / GTK_POS_LEFT
  • 'right' / GTK_POS_RIGHT
  • 'top' / GTK_POS_TOP
  • 'bottom' / GTK_POS_BOTTOM

enum Gtk2::ReliefStyle

  • 'normal' / GTK_RELIEF_NORMAL
  • 'half' / GTK_RELIEF_HALF
  • 'none' / GTK_RELIEF_NONE

💫 SEE ALSO 💫

Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget, Gtk2::Container, Gtk2::Bin

Copyright (C) 2003-2011 by the gtk2-perl team.

This software is licensed under the LGPL. See Gtk2 for a full notice.

and that's the whole page, bestie 💖 this was perl v5.42.0, dated 2025-07-25, and yes — Gtk2::Button(3) ate and left no crumbs. go click something iconic. 👑✨

📦 where this page comes from