Gtk2::Widget(3)

📦

version 1.24993 · 2 versions

1.24993 · fedora 43 (latest)
1.24993 · fedora 44

💖 NAME 💖

ok so bestie, Gtk2::Widget is literally just the Perl wrapper for GtkWidget. that's the whole vibe. the humble little building block everything in GTK+ is made of. iconic behavior honestly. 🎀

🌈 HIERARCHY 🌈

the family tree, so you know where she comes from:

Glib::Object
+----Glib::InitiallyUnowned
     +----Gtk2::Object
          +----Gtk2::Widget

🦋 INTERFACES 🦋

she also does these, like a queen with multiple side quests:

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

✨ CONSTANTS ✨

ok so EVENT_STOP and EVENT_PROPAGATE?? these are for when you're returning from widget event signal handlers and stuff like that. EVENT_STOP is true = stop, EVENT_PROPAGATE is false = propagate. the whole point of these names is so you don't have to play the "wait which one is true again 😭" game. and if you wanna remember it another way: think of the return value as meaning "handled" — that's the jargon some other signal handler types use. iykyk 💅

Gtk2::EVENT_STOP         # true
Gtk2::EVENT_PROPAGATE    # false

🌸 METHODS 🌸

`$widget->set_accel_path ($accel_path, $accel_group)`

$accel_path (string or undef)
$accel_group (Gtk2::AccelGroup or undef)

`object = $widget->get_accessible`

`action or undef = $widget->get_action`

Since: gtk+ 2.10

`boolean = $widget->activate`

so this one works by emitting an action signal that the various widget subclasses nominate. normally that signal is called activate, but like... it doesn't have to be. no cap.

heads up: right now if you make a widget subclass in Perl, there's genuinely no way to nominate a signal for $widget->activate to emit. a signal that's just named activate does not get automatically hooked up. sorry bestie 😭

`$widget->add_accelerator ($accel_signal, $accel_group, $accel_key, $accel_mods, $flags)`

$accel_signal (string)
$accel_group (Gtk2::AccelGroup)
$accel_key (integer)
$accel_mods (Gtk2::Gdk::ModifierType)
$flags (Gtk2::AccelFlags)

`$widget->add_events ($events)`

$events (Gtk2::Gdk::EventMask)

`$widget->add_mnemonic_label ($label)`

$label (Gtk2::Widget)

Since: gtk+ 2.4

`rectangle = $widget->allocation`

gives you back the current allocated size and position of $widget inside its parent widget. and like, the allocated size is not necessarily the same as the requested size, ok, they're different things.

⚠️ the returned rect object points into $widget, so it's only usable for as long as $widget exists. she's a loan, not a gift 💀

`rectangle = $widget->get_allocation`

Since: gtk+ 2.18

`$widget->set_allocation ($allocation)`

$allocation (Gtk2::Gdk::Rectangle)

Since: gtk+ 2.18

`widget or undef = $widget->get_ancestor ($ancestor_package)`

$ancestor_package (string)

`$widget->app_paintable ($boolean)`

`boolean = $widget->app_paintable`

`boolean = $widget->get_app_paintable`

Since: gtk+ 2.18

`$widget->set_app_paintable ($app_paintable)`

$app_paintable (boolean)

`boolean = $widget->can_activate_accel ($signal_id)`

$signal_id (integer)

Since: gtk+ 2.4

`$widget->can_default ($boolean)`

`boolean = $widget->can_default`

`boolean = $widget->get_can_default`

Since: gtk+ 2.18

`$widget->set_can_default ($can_default)`

$can_default (boolean)

Since: gtk+ 2.18

`$widget->can_focus ($boolean)`

`boolean = $widget->can_focus`

`boolean = $widget->get_can_focus`

Since: gtk+ 2.18

`$widget->set_can_focus ($can_focus)`

$can_focus (boolean)

Since: gtk+ 2.18

`boolean = $widget->child_focus ($direction)`

$direction (Gtk2::DirectionType)

`$widget->child_notify ($child_property)`

$child_property (string)

`requisition = $widget->get_child_requisition`

ok this one is strictly for widget implementations, like behind-the-scenes only, not for the general public bestie. it obtains $widget->requisition... unless somebody has forced a particular geometry onto the widget (for example with set_usize(), in which case it returns that geometry instead of the widget's requisition.

this function differs from size_request() in that it retrieves the last size request value from $widget->requisition, while size_request() actually calls the size_request virtual method (that is, it emits the size-request signal) on the $widget to compute the size request and fill in $widget->requisition, and only then returns $widget->requisition.

and because this function does not call the size_request method, it can only be used when you know that $widget->requisition is up-to-date. in general, only container implementations have this information; applications should use size_request ().

`boolean = $widget->get_child_visible`

`$widget->set_child_visible ($is_visible)`

$is_visible (boolean)

`(path, path_reversed) = $widget->class_path`

`clipboard = $widget->get_clipboard ($selection=GDK_SELECTION_CLIPBOARD)`

$selection (Gtk2::Gdk::Atom)

Since: gtk+ 2.2

`colormap = $widget->get_colormap`

`$widget->set_colormap ($colormap)`

$colormap (Gtk2::Gdk::Colormap)

`$widget->composite_child ($boolean)`

`boolean = $widget->composite_child`

`string or undef = $widget->get_composite_name`

`$widget->set_composite_name ($name)`

$name (string)

`context = $widget->create_pango_context`

`layout = $widget->create_pango_layout ($text=undef)`

$text (string or undef)

`colormap = Gtk2::Widget->get_default_colormap`

`colormap = $widget->get_default_colormap`

`Gtk2::Widget->set_default_colormap ($colormap)`

`$widget->set_default_colormap ($colormap)`

$colormap (Gtk2::Gdk::Colormap)

`textdirection = Gtk2::Widget->get_default_direction`

`Gtk2::Widget->set_default_direction ($dir)`

$dir (Gtk2::TextDirection)

`style = Gtk2::Widget->get_default_style`

`style = $widget->get_default_style`

`visual = Gtk2::Widget->get_default_visual`

`visual = $widget->get_default_visual`

`$widget->destroy`

`textdirection = $widget->get_direction`

`$widget->set_direction ($dir)`

$dir (Gtk2::TextDirection)

`display = $widget->get_display`

Since: gtk+ 2.2

`$widget->double_buffered ($boolean)`

`boolean = $widget->double_buffered`

`boolean = $widget->get_double_buffered`

Since: gtk+ 2.18

`$widget->set_double_buffered ($double_buffered)`

$double_buffered (boolean)

`dragcontext = $widget->drag_begin ($targets, $actions, $button, $event)`

$targets (Gtk2::TargetList)
$actions (Gtk2::Gdk::DragAction)
$button (integer)
$event (Gtk2::Gdk::Event)

`boolean = $widget->drag_check_threshold ($start_x, $start_y, $current_x, $current_y)`

$start_x (integer)
$start_y (integer)
$current_x (integer)
$current_y (integer)

`$widget->drag_dest_add_image_targets`

Since: gtk+ 2.6

`$widget->drag_dest_add_text_targets`

Since: gtk+ 2.6

`$widget->drag_dest_add_uri_targets`

Since: gtk+ 2.6

`atom = $widget->drag_dest_find_target ($context, $target_list)`

$context (Gtk2::Gdk::DragContext)
$target_list (Gtk2::TargetList or undef)

`targetlist or undef = $widget->drag_dest_get_target_list`

`boolean = $widget->drag_dest_get_track_motion`

Since: gtk+ 2.10

`$widget->drag_dest_set ($flags, $actions, ...)`

$flags (Gtk2::DestDefaults)
$actions (Gtk2::Gdk::DragAction)
... (list) of Gtk2::TargetEntry's

`$widget->drag_dest_set_proxy ($proxy_window, $protocol, $use_coordinates)`

$proxy_window (Gtk2::Gdk::Window)
$protocol (Gtk2::Gdk::DragProtocol)
$use_coordinates (boolean)

`$widget->drag_dest_set_target_list ($target_list)`

$target_list (Gtk2::TargetList or undef)

`$widget->drag_dest_set_track_motion ($track_motion)`

$track_motion (boolean)

Since: gtk+ 2.10

`$widget->drag_dest_unset`

`$widget->drag_get_data ($context, $target, $time_)`

$context (Gtk2::Gdk::DragContext)
$target (Gtk2::Gdk::Atom)
$time_ (unsigned)

`$widget->drag_highlight`

`$widget->drag_source_add_image_targets`

Since: gtk+ 2.6

`$widget->drag_source_add_text_targets`

Since: gtk+ 2.6

`$widget->drag_source_add_uri_targets`

Since: gtk+ 2.6

`targetlist or undef = $widget->drag_source_get_target_list`

Since: gtk+ 2.4

`$widget->drag_source_set ($start_button_mask, $actions, ...)`

$start_button_mask (Gtk2::Gdk::ModifierType)
$actions (Gtk2::Gdk::DragAction)
... (list) of Gtk2::TargetEntry's

`$widget->drag_source_set_icon ($colormap, $pixmap, $mask)`

$colormap (Gtk2::Gdk::Colormap or undef)
$pixmap (Gtk2::Gdk::Pixmap or undef)
$mask (Gtk2::Gdk::Bitmap or undef)

`$widget->drag_source_set_icon_name ($icon_name)`

$icon_name (string)

Since: gtk+ 2.8

`$widget->drag_source_set_icon_pixbuf ($pixbuf)`

$pixbuf (Gtk2::Gdk::Pixbuf or undef)

`$widget->drag_source_set_icon_stock ($stock_id)`

$stock_id (string)

`$widget->drag_source_set_target_list ($target_list)`

$target_list (Gtk2::TargetList or undef)

Since: gtk+ 2.4

`$widget->drag_source_unset`

`$widget->drag_unhighlight`

`$widget->drawable ($boolean)`

`boolean = $widget->drawable`

`$widget->ensure_style`

`$widget->error_bell`

Since: gtk+ 2.12

`boolean = $widget->event ($event)`

$event (Gtk2::Gdk::Event)

ok so this one is rarely-used, she emits an event signal on $widget. do NOT use this to synthesize events — use Gtk2->main_do_event instead. do NOT synthesize expose events — use $gdkwindow->invalidate_rect instead. basically, the main use for this in gtk2-perl is passing motion notify events to rulers from other widgets. that's it, that's the whole job 💅

`eventmask = $widget->get_events`

`$widget->set_events ($events)`

$events (Gtk2::Gdk::EventMask)

`extensionmode = $widget->get_extension_events`

`$widget->set_extension_events ($mode)`

$mode (Gtk2::Gdk::ExtensionMode)

`pspec or undef = $widget_or_class_name->find_style_property ($name)`

$name (string)

returns a Glib::ParamSpec for the style property $name on widget $widget_or_class_name. and if there's no property $name?? it returns undef. see Glib::Object list_properties for the fields in a ParamSpec. 🫶

Since: gtk+ 2.2

`widgetflags = $widget->flags`

`widgetflags = $widget->get_flags`

`$widget->set_flags ($flags)`

$flags (Gtk2::WidgetFlags)

`$widget->freeze_child_notify`

`$widget->grab_default`

`$widget->grab_focus`

`$widget->has_default ($boolean)`

`boolean = $widget->has_default`

`$widget->has_focus ($boolean)`

`boolean = $widget->has_focus`

`$widget->has_grab ($boolean)`

`boolean = $widget->has_grab`

`boolean = $widget->has_rc_style`

Since: gtk+ 2.20

`boolean = $widget->has_screen`

Since: gtk+ 2.2

`boolean = $widget->get_has_tooltip`

Since: gtk+ 2.12

`$widget->set_has_tooltip ($has_tooltip)`

$has_tooltip (boolean)

Since: gtk+ 2.12

`boolean = $widget->get_has_window`

Since: gtk+ 2.18

`$widget->set_has_window ($has_window)`

$has_window (boolean)

Since: gtk+ 2.18

`$widget->hide`

`$widget->hide_all`

`boolean = Gtk2::Widget::hide_on_delete ($widget, ...)`

$widget (Gtk2::Widget)
... (list) other arguments ignored (event etc)

this is a lil helper function meant to be used as the callback for the delete-event signal:

$wiget->signal_connect (
  delete_event => \&Gtk2::Widget::hide_on_delete);

(yes, $wiget is spelled like that in the source. we don't fix it, we preserve it, that's the rule bestie 🍓)

`$widget->input_shape_combine_mask ($shape_mask, $offset_x, $offset_y)`

$shape_mask (Gtk2::Gdk::Bitmap or undef)
$offset_x (integer)
$offset_y (integer)

✨ to be continued, bestie — this was just part 1 of 4, more chaos incoming ✨

Since: gtk+ 2.10

rectangle = $widget->intersect ($area) — bestie, this checks if your widget and $area intersect. ✨
- $area (Gtk2::Gdk::Rectangle)
- Returns undef if $widget and $area do not intersect. 💀
boolean = $widget->is_ancestor ($ancestor) — is $ancestor an ancestor of $widget? 👀
- $ancestor (Gtk2::Widget)
boolean = $widget->is_composited — returns whether the widget is composited. 🦋 Since: gtk+ 2.10
boolean = $widget->is_drawable — can it be drawn on? 🎨 Since: gtk+ 2.18
boolean = $widget->is_focus — does it have focus? 👑
$widget->is_sensitive ($boolean) and boolean = $widget->is_sensitive — set or get sensitivity. 💅
boolean = $widget->is_toplevel — is it a toplevel? 🌟 Since: gtk+ 2.18
boolean = $widget->keynav_failed ($direction) — keynav failed? 😭
- $direction (Gtk2::DirectionType) Since: gtk+ 2.12
list = $widget->list_mnemonic_labels — list of mnemonic labels. 🏷️ Since: gtk+ 2.4
list = $widget_or_class_name->list_style_properties — returns a list of Glib::ParamSpec objects which are the style properties available on $widget_or_class_name. See Glib::Object list_properties for the fields in a ParamSpec. 📋 Since: gtk+ 2.2
$widget->map, $widget->mapped ($boolean), boolean = $widget->mapped, boolean = $widget->get_mapped — map or check mapped status. 🗺️ Since: gtk+ 2.20
$widget->set_mapped ($mapped) — set mapped. 🔧
- $mapped (boolean) Since: gtk+ 2.20
boolean = $widget->mnemonic_activate ($group_cycling) — activate mnemonic. ⌨️
- $group_cycling (boolean)
rcstyle = $widget->get_modifier_style — get modifier style. 🎀
$widget->modify_base ($state, $color) — modify base color. 🎨
- $state (Gtk2::StateType)
- $color (Gtk2::Gdk::Color or undef)
$widget->modify_bg ($state, $color) — modify background. 🌈
- $state (Gtk2::StateType)
- $color (Gtk2::Gdk::Color or undef)
$widget->modify_cursor ($primary, $secondary) — modify cursor colors. 🖱️
- $primary (Gtk2::Gdk::Color or undef)
- $secondary (Gtk2::Gdk::Color or undef) Since: gtk+ 2.12
$widget->modify_fg ($state, $color) — modify foreground. ✨
- $state (Gtk2::StateType)
- $color (Gtk2::Gdk::Color or undef)
$widget->modify_font ($font_desc) — modify font. 🔤
- $font_desc (Pango::FontDescription or undef)
$widget->modify_style ($style) — modify style. 💅
- $style (Gtk2::RcStyle)
$widget->modify_text ($state, $color) — modify text color. 📝
- $state (Gtk2::StateType)
- $color (Gtk2::Gdk::Color or undef)
string = $widget->get_name and $widget->set_name ($name) — get or set the widget name. 🏷️
- $name (string)
boolean = $widget->get_no_show_all — get no-show-all flag. 🙈 Since: gtk+ 2.4
$widget->set_no_show_all ($no_show_all) — set no-show-all. 🚫
- $no_show_all (boolean) Since: gtk+ 2.4
$widget->no_window ($boolean) and boolean = $widget->no_window — no window? 🪟
context = $widget->get_pango_context — get Pango context. 🖋️
widget or undef = $widget->parent and widget or undef = $widget->get_parent — get parent widget. 👪
$widget->parent_sensitive ($boolean) and boolean = $widget->parent_sensitive — parent sensitive? 💖
$widget->set_parent ($parent) — set parent. 👨‍👧
- $parent (Gtk2::Widget)
window = $widget->get_parent_window and $widget->set_parent_window ($parent_window) — get or set parent window. 🪟
- $parent_window (Gtk2::Gdk::Window)
(path, path_reversed) = $widget->path — get path. 🛤️
(x, y) = $widget->get_pointer — get pointer coords. 🖱️
Gtk2::Widget->pop_colormap (cmap) and $widget->pop_colormap (cmap) — pop colormap. 🎨
Gtk2::Widget->pop_composite_child and $widget->pop_composite_child — pop composite child. 👶
$widget->propagate_event ($event) — propagate an event. ⚡
- $event (Gtk2::Gdk::Event)

From gtk+'s API documentation: You most likely don't want to use any of these functions; synthesizing events is rarely needed. Consider asking on the mailing list for better ways to achieve your goals. For example, use Gtk2::Gdk::invalidate_rect or Gtk2::Widget::queue_draw instead of making up expose events. 😬

Gtk2::Widget->push_colormap (cmap) and $widget->push_colormap (cmap) — push colormap. 🌈
- $cmap (Gtk2::Gdk::Colormap)
Gtk2::Widget->push_composite_child and $widget->push_composite_child — push composite child. 👶
$widget->queue_draw — queue a draw. 🎨
$widget->queue_draw_area ($x, $y, $width, $height) — queue draw for area. 🖌️
- $x (integer)
- $y (integer)
- $width (integer)
- $height (integer)
$widget->queue_resize — queue resize. 📐
$widget->queue_resize_no_redraw — queue resize without redraw. 🚫🎨 Since: gtk+ 2.4
$widget->rc_style ($boolean) and boolean = $widget->rc_style — rc style? 🎀
$widget->realize — realize the widget. ✨
$widget->realized ($boolean), boolean = $widget->realized, boolean = $widget->get_realized — realized status. ✅ Since: gtk+ 2.20
$widget->set_realized ($realized) — set realized. 🔧
- $realized (boolean) Since: gtk+ 2.20
$widget->receives_default ($boolean), boolean = $widget->receives_default, boolean = $widget->get_receives_default — receives default? 🎯 Since: gtk+ 2.18
$widget->set_receives_default ($receives_default) — set receives default. 🎯
- $receives_default (boolean) Since: gtk+ 2.18
$widget->set_redraw_on_allocate ($redraw_on_allocate) — set redraw on allocate. 🔄
- $redraw_on_allocate (boolean)
region = $widget->region_intersect ($region) — intersect region. 🗺️
- $region (Gtk2::Gdk::Region)
boolean = $widget->remove_accelerator ($accel_group, $accel_key, $accel_mods) — remove accelerator. ⌨️
- $accel_group (Gtk2::AccelGroup)
- $accel_key (integer)
- $accel_mods (Gtk2::Gdk::ModifierType)
$widget->remove_mnemonic_label ($label) — remove mnemonic label. 🏷️
- $label (Gtk2::Widget) Since: gtk+ 2.4
pixbuf = $widget->render_icon ($stock_id, $size, $detail=undef) — render icon. 🖼️
- $stock_id (string)
- $size (Gtk2::IconSize)
- $detail (string)
$widget->reparent ($new_parent) — reparent. 👪
- $new_parent (Gtk2::Widget)
requisition = $widget->requisition — return the currently desired width and height of $widget. Basically this is the result from the last size_request call on $widget, and therefore may not be up-to-date if $widget has asked for a resize but its container parent has not yet called size_request. 📏

The returned requisition object points into $widget and can only be used as long as $widget exists. ⚠️

requisition = $widget->get_requisition — get requisition. 📐 Since: gtk+ 2.20
$widget->reset_rc_styles — reset rc styles. 🎀
$widget->reset_shapes — reset shapes. 🔷
window = $widget->get_root_window — get root window. 🪟 Since: gtk+ 2.2
statetype = $widget->saved_state — saved state. 💾
screen = $widget->get_screen — get screen. 🖥️ Since: gtk+ 2.2
boolean = $widget->set_scroll_adjustments ($hadjustment, $vadjustment) — set scroll adjustments. 📜
- $hadjustment (Gtk2::Adjustment or undef)
- $vadjustment (Gtk2::Adjustment or undef) This function works by emitting a setter signal nominated by the various widget types which have "native" scrolling. The signal is normally called "set-scroll-adjustments", but it doesn't have to be. If you make a widget subclass in Perl and create a signal in it called "set-scroll-adjustments" taking two Gtk2::Adjustment parameters then the subclassing automatically hooks that up to be emitted by $widget->set_scroll_adjustments. (Your "class closure" default handler code should then store the adjustment objects somewhere.) 🧠
$widget->selection_add_target ($selection, $target, $info) — add selection target. 🎯
- $selection (Gtk2::Gdk::Atom)
- $target (Gtk2::Gdk::Atom)
- $info (integer)
$widget->selection_add_targets ($selection, ...) — add multiple selection targets. 🎯
- $selection (Gtk2::Gdk::Atom)
- ... (list) of Gtk2::TargetEntry's
$widget->selection_clear_targets ($selection) — clear selection targets. 🧹
- $selection (Gtk2::Gdk::Atom)
boolean = $widget->selection_convert ($selection, $target, $time_) — convert selection. 🔄
- $selection (Gtk2::Gdk::Atom)
- $target (Gtk2::Gdk::Atom)
- $time_ (unsigned)
$widget->selection_remove_all — remove all selections. 🗑️
boolean = $widget->send_focus_change ($event) — send focus change. 🎯
- $event (Gtk2::Gdk::Event) Since: gtk+ 2.22
$widget->sensitive ($boolean), boolean = $widget->sensitive, boolean = $widget->get_sensitive — sensitivity. 💖 Since: gtk+ 2.18
$widget->set_sensitive ($sensitive) — set sensitive. 💖
- $sensitive (boolean)
settings = $widget->get_settings — get settings. ⚙️
$widget->shape_combine_mask ($shape_mask, $offset_x, $offset_y) — combine shape mask. 🔷
- $shape_mask (Gtk2::Gdk::Bitmap or undef)
- $offset_x (integer)
- $offset_y (integer)
$widget->show, $widget->show_all, $widget->show_now — show the widget. 👀
$widget->size_allocate ($allocation) — allocate size. 📐
- $allocation (Gtk2::Gdk::Rectangle)
requisition = $widget->size_request — this function is typically used when implementing a GtkContainer subclass. Obtains the preferred size of a widget. The container uses this information to arrange its child widgets and decide what size allocations to give them with size_allocate (). 📏 You can also call this function from an application, with some caveats. Most notably, getting a size request requires the widget to be associated with a screen, because font information may be needed. Multihead-aware applications should keep this in mind. 🖥️ Also remember that the size request is not necessarily the size a widget will actually be allocated. ⚠️ See also get_child_requisition ()
(width, height) = $widget->get_size_request — gets the size request that was explicitly set for the widget using set_size_request(). A value of -1 for width or height indicates that the dimension has not been explicitly set and the natural requisition of the widget will be used instead. See set_size_request(). To get the size a widget will actually use, call size_request() instead of this function. 📐
$widget->set_size_request ($width=-1, $height=-1) — set size request. 📏
- $width (integer)
- $height (integer)
pixmap or undef = $widget->get_snapshot ($clip_rect=undef) — get snapshot. 📸
- $clip_rect (Gtk2::Gdk::Rectangle or undef) Since: gtk+ 2.14
statetype = $widget->state, statetype = $widget->get_state — state. 💾 Since: gtk+ 2.18
$widget->set_state ($state) — set state. 💾
- $state (Gtk2::StateType)
style = $widget->style, $style->style_attach — style and attach. 🎨 Since: gtk+ 2.20
style = $widget->get_style — get style. 🎨
list = $widget->style_get ($first_property_name, ...) — get style properties. 📋
- $first_property_name (string)
- ... (list) 0 or more additional property names Returns the values of the requested style properties. Since: gtk+ 2.2
list = $widget->style_get_property ($first_property_name, ...) — an alias for style_get. 📋
- $first_property_name (string)
- ... (list) 0 or more additional property names Since: gtk+ 2.2
$widget->set_style ($style) — set style. 🎨
- $style (Gtk2::Style or undef)
$widget->thaw_child_notify — thaw child notify. 🔥
string = $widget->get_tooltip_markup — get tooltip markup. 💬 Since: gtk+ 2.12
$widget->set_tooltip_markup ($markup) — set tooltip markup. 💬
- $markup (string or undef) Since: gtk+ 2.12
string = $widget->get_tooltip_text — get tooltip text. 💬 Since: gtk+ 2.12
$widget->set_tooltip_text ($text) — set tooltip text. 💬
- $text (string or undef) Since: gtk+ 2.12
window or undef = $widget->get_tooltip_window — get tooltip window. 🪟 Since: gtk+ 2.12
$widget->set_tooltip_window ($custom_window) — set tooltip window. 🪟
- $custom_window (Gtk2::Window or undef) Since: gtk+ 2.12
$widget->toplevel ($value), boolean = $widget->toplevel, widget = $widget->get_toplevel — toplevel stuff. 🌟
(dst_x, dst_y) = $src_widget->translate_coordinates ($dest_widget, $src_x, $src_y) — translate coordinates. 🗺️
- $dest_widget (Gtk2::Widget)
- $src_x (integer)
- $src_y (integer) Returns an empty list if either widget is not realized or if they do not share a common ancestor. 🚫
$widget->trigger_tooltip_query — trigger tooltip query. 💬 Since: gtk+ 2.12
$widget->unmap, $widget->unparent, $widget->unrealize — unmap, unparent, unrealize. 🚪
$widget->unset_flags ($flags) — unset flags. 🚩
- $flags (Gtk2::WidgetFlags)
$widget->visible ($boolean), boolean = $widget->visible, boolean = $widget->get_visible — visibility. 👀 Since: gtk+ 2.18
$widget->set_visible ($visible) — set visible. 👀
- $visible (boolean) Since: gtk+ 2.18
visual = $widget->get_visual — get visual. 🎨
window or undef = $widget->window ($new=undef) — window. 🪟
- $new (Gtk2::Gdk::Window or undef)

window or undef = $widget->get_window

Since: gtk+ 2.14 ✨ — bestie, you get back the widget's window, or undef if it hasn't got one yet. No window, no undef-crisis, just vibes.

$widget->set_window ($window)

$window (Gtk2::Gdk::Window) — the window you're handing over 🫶

Since: gtk+ 2.18

🌸 PROPERTIES 🌸

Every single one of these is a real, certified property, okay? Type, default and flags included, no gatekeeping 💅

'app-paintable' — type boolean, default false, flags readable / writable / private / static-nick / static-blurb. Whether the application will paint directly on the widget 🎨
'can-default' — type boolean, default false, flags readable / writable / private / static-nick / static-blurb. Whether the widget can be the default widget 👑
'can-focus' — type boolean, default false, flags readable / writable / private / static-nick / static-blurb. Whether the widget can accept the input focus ✨
'composite-child' — type boolean, default false, flags readable / private / static-nick / static-blurb. Whether the widget is part of a composite widget 🧩
'double-buffered' — type boolean, default true, flags readable / writable / private / static-nick / static-blurb. Whether or not the widget is double buffered 🪞
'events' — type Gtk2::Gdk::EventMask, default structure-mask, flags readable / writable / private / static-nick / static-blurb. The event mask that decides what kind of GdkEvents this widget gets 🎟️
'extension-events' — type Gtk2::Gdk::ExtensionMode, default "none", flags readable / writable / private / static-nick / static-blurb. The mask that decides what kind of extension events this widget gets 🌈
'has-default' — type boolean, default false, flags readable / writable / private / static-nick / static-blurb. Whether the widget is the default widget 👑
'has-focus' — type boolean, default false, flags readable / writable / private / static-nick / static-blurb. Whether the widget has the input focus ✨
'has-tooltip' — type boolean, default false, flags readable / writable / private / static-nick / static-blurb. Whether this widget has a tooltip 💬
'height-request' — type integer, default -1, flags readable / writable / private / static-nick / static-blurb. Override for height request of the widget, or -1 if the natural request should be used 📏
'is-focus' — type boolean, default false, flags readable / writable / private / static-nick / static-blurb. Whether the widget is the focus widget within the toplevel 🎯
'name' — type string, default undef, flags readable / writable / private / static-nick / static-blurb. The name of the widget 🏷️
'no-show-all' — type boolean, default false, flags readable / writable / private / static-nick / static-blurb. Whether gtk_widget_show_all() should not affect this widget 🙈
'parent' — type Gtk2::Container, default undef, flags readable / writable / private / static-nick / static-blurb. The parent widget of this widget. Must be a Container widget 👨‍👩‍👧
'receives-default' — type boolean, default false, flags readable / writable / private / static-nick / static-blurb. If TRUE, the widget will receive the default action when it is focused 👑
'sensitive' — type boolean, default true, flags readable / writable / private / static-nick / static-blurb. Whether the widget responds to input 🫶
'style' — type Gtk2::Style, default undef, flags readable / writable / private / static-nick / static-blurb. The style of the widget, which contains information about how it will look (colors etc) 💅
'tooltip-markup' — type string, default undef, flags readable / writable / private / static-nick / static-blurb. The contents of the tooltip for this widget 💬
'tooltip-text' — type string, default undef, flags readable / writable / private / static-nick / static-blurb. The contents of the tooltip for this widget 💬
'visible' — type boolean, default false, flags readable / writable / private / static-nick / static-blurb. Whether the widget is visible 👀
'width-request' — type integer, default -1, flags readable / writable / private / static-nick / static-blurb. Override for width request of the widget, or -1 if the natural request should be used 📏
'window' — type Gtk2::Gdk::Window, default undef, flags readable / private / static-nick / static-blurb. The widget's window if it is realized 🪟

🎀 STYLE PROPERTIES 🎀

These ones are style, not vibes-only — they're the actual style properties, and yes every single flag is coming with us 💖

'cursor-aspect-ratio' — type float, default 0.04, flags readable / private / static-nick / static-blurb. Aspect ratio with which to draw insertion cursor ✏️
'cursor-color' — type Gtk2::Gdk::Color, default undef, flags readable / private / static-nick / static-blurb. Color with which to draw insertion cursor ✏️
'draw-border' — type Gtk2::Border, default undef, flags readable / private / static-nick / static-blurb. Size of areas outside the widget's allocation to draw 🖼️
'focus-line-pattern' — type string, default "\1\1", flags readable / private / static-nick / static-blurb. Dash pattern used to draw the focus indicator 🎯
'focus-line-width' — type integer, default 1, flags readable / private / static-nick / static-blurb. Width, in pixels, of the focus indicator line 🎯
'focus-padding' — type integer, default 1, flags readable / private / static-nick / static-blurb. Width, in pixels, between focus indicator and the widget 'box' 🎯
'interior-focus' — type boolean, default true, flags readable / private / static-nick / static-blurb. Whether to draw the focus indicator inside widgets 🎯
'link-color' — type Gtk2::Gdk::Color, default undef, flags readable / private / static-nick / static-blurb. Color of unvisited links 🔗
'scroll-arrow-hlength' — type integer, default 16, flags readable / private / static-nick / static-blurb. The length of horizontal scroll arrows ↔️
'scroll-arrow-vlength' — type integer, default 16, flags readable / private / static-nick / static-blurb. The length of vertical scroll arrows ↕️
'secondary-cursor-color' — type Gtk2::Gdk::Color, default undef, flags readable / private / static-nick / static-blurb. Color with which to draw the secondary insertion cursor when editing mixed right-to-left and left-to-right text ✏️
'separator-height' — type integer, default 0, flags readable / private / static-nick / static-blurb. The height of separators if "wide-separators" is TRUE ➖
'separator-width' — type integer, default 0, flags readable / private / static-nick / static-blurb. The width of separators if wide-separators is TRUE ➖
'tooltip-alpha' — type Glib::UChar, default 255, flags readable / private / static-nick / static-blurb. The opacity to be used when drawing tooltips 💬
'tooltip-radius' — type Glib::UInt, default 0, flags readable / private / static-nick / static-blurb. The radius to be used when drawing tooltips 💬
'visited-link-color' — type Gtk2::Gdk::Color, default undef, flags readable / private / static-nick / static-blurb. Color of visited links 🔗
'wide-separators' — type boolean, default false, flags readable / private / static-nick / static-blurb. Whether separators have configurable width and should be drawn using a box instead of a line ➖
'window-dragging' — type boolean, default false, flags readable / writable / private / static-nick / static-blurb. Window dragging 🪟

🔥 SIGNALS 🔥

Okay so here's the whole signal list, every last one, signatures verbatim because I do not play about accuracy 🫶 Where you see boolean = at the front, that's the listing telling you the return value is a boolean, iykyk.

accel-closures-changed — (Gtk2::Widget)
boolean = button-press-event — (Gtk2::Widget, Gtk2::Gdk::Event)
boolean = button-release-event — (Gtk2::Widget, Gtk2::Gdk::Event)
boolean = can-activate-accel — (Gtk2::Widget, Glib::UInt)
child-notify — (Gtk2::Widget, Glib::ParamSpec)
boolean = client-event — (Gtk2::Widget, Gtk2::Gdk::Event)
composited-changed — (Gtk2::Widget)
boolean = configure-event — (Gtk2::Widget, Gtk2::Gdk::Event)
boolean = damage-event — (Gtk2::Widget, Gtk2::Gdk::Event)
boolean = delete-event — (Gtk2::Widget, Gtk2::Gdk::Event)
boolean = destroy-event — (Gtk2::Widget, Gtk2::Gdk::Event)
direction-changed — (Gtk2::Widget, Gtk2::TextDirection)
drag-begin — (Gtk2::Widget, Gtk2::Gdk::DragContext)
drag-data-delete — (Gtk2::Widget, Gtk2::Gdk::DragContext)
drag-data-get — (Gtk2::Widget, Gtk2::Gdk::DragContext, Gtk2::SelectionData, Glib::UInt, Glib::UInt)
drag-data-received — (Gtk2::Widget, Gtk2::Gdk::DragContext, integer, integer, Gtk2::SelectionData, Glib::UInt, Glib::UInt)
boolean = drag-drop — (Gtk2::Widget, Gtk2::Gdk::DragContext, integer, integer, Glib::UInt)
drag-end — (Gtk2::Widget, Gtk2::Gdk::DragContext)
boolean = drag-failed — (Gtk2::Widget, Gtk2::Gdk::DragContext, Gtk2::DragResult)
drag-leave — (Gtk2::Widget, Gtk2::Gdk::DragContext, Glib::UInt)
boolean = drag-motion — (Gtk2::Widget, Gtk2::Gdk::DragContext, integer, integer, Glib::UInt)
boolean = enter-notify-event — (Gtk2::Widget, Gtk2::Gdk::Event)
boolean = event — (Gtk2::Widget, Gtk2::Gdk::Event)
event-after — (Gtk2::Widget, Gtk2::Gdk::Event)
boolean = expose-event — (Gtk2::Widget, Gtk2::Gdk::Event)
boolean = focus — (Gtk2::Widget, Gtk2::DirectionType)
boolean = focus-in-event — (Gtk2::Widget, Gtk2::Gdk::Event)
boolean = focus-out-event — (Gtk2::Widget, Gtk2::Gdk::Event)
boolean = grab-broken-event — (Gtk2::Widget, Gtk2::Gdk::Event)
grab-focus — (Gtk2::Widget)
grab-notify — (Gtk2::Widget, boolean)
hide — (Gtk2::Widget)
hierarchy-changed — (Gtk2::Widget, Gtk2::Widget)
boolean = key-press-event — (Gtk2::Widget, Gtk2::Gdk::Event)
boolean = key-release-event — (Gtk2::Widget, Gtk2::Gdk::Event)
boolean = keynav-failed — (Gtk2::Widget, Gtk2::DirectionType)
boolean = leave-notify-event — (Gtk2::Widget, Gtk2::Gdk::Event)
map — (Gtk2::Widget)
boolean = map-event — (Gtk2::Widget, Gtk2::Gdk::Event)
boolean = mnemonic-activate — (Gtk2::Widget, boolean)
boolean = motion-notify-event — (Gtk2::Widget, Gtk2::Gdk::Event)
move-focus — (Gtk2::Widget, Gtk2::DirectionType)
boolean = no-expose-event — (Gtk2::Widget, Gtk2::Gdk::Event)
parent-set — (Gtk2::Widget, Gtk2::Widget)
boolean = popup-menu — (Gtk2::Widget)
boolean = property-notify-event — (Gtk2::Widget, Gtk2::Gdk::Event)
boolean = proximity-in-event — (Gtk2::Widget, Gtk2::Gdk::Event)
boolean = proximity-out-event — (Gtk2::Widget, Gtk2::Gdk::Event)
boolean = query-tooltip — (Gtk2::Widget, integer, integer, boolean, Gtk2::Tooltip)
realize — (Gtk2::Widget)
screen-changed — (Gtk2::Widget, Gtk2::Gdk::Screen)
boolean = scroll-event — (Gtk2::Widget, Gtk2::Gdk::Event)
boolean = selection-clear-event — (Gtk2::Widget, Gtk2::Gdk::Event)
selection-get — (Gtk2::Widget, Gtk2::SelectionData, Glib::UInt, Glib::UInt)
boolean = selection-notify-event — (Gtk2::Widget, Gtk2::Gdk::Event)
selection-received — (Gtk2::Widget, Gtk2::SelectionData, Glib::UInt)
boolean = selection-request-event — (Gtk2::Widget, Gtk2::Gdk::Event)
show — (Gtk2::Widget)
boolean = show-help — (Gtk2::Widget, Gtk2::WidgetHelpType)
size-allocate — (Gtk2::Widget, Gtk2::Gdk::Rectangle)
size-request — (Gtk2::Widget, Gtk2::Requisition)
state-changed — (Gtk2::Widget, Gtk2::StateType)
style-set — (Gtk2::Widget, Gtk2::Style)
unmap — (Gtk2::Widget)
boolean = unmap-event — (Gtk2::Widget, Gtk2::Gdk::Event)
unrealize — (Gtk2::Widget)
boolean = visibility-notify-event — (Gtk2::Widget, Gtk2::Gdk::Event)
boolean = window-state-event — (Gtk2::Widget, Gtk2::Gdk::Event)

💀 that's 68 signals, bestie. All of them. Not one skipped, not one merged, periodt.

🌈 ENUMS AND FLAGS 🌈

okay bestie, this is the big ol' bucket of all the enums and flags you might bump into while messing with widgets 💖 each one shows you the cute Perl name and the C name it's chillin' with, so you can pass whichever and nobody's gonna be mad at you.

flags Gtk2::AccelFlags

'visible' / 'GTK_ACCEL_VISIBLE'
'locked' / 'GTK_ACCEL_LOCKED'
'mask' / 'GTK_ACCEL_MASK'

flags Gtk2::DestDefaults

'motion' / 'GTK_DEST_DEFAULT_MOTION'
'highlight' / 'GTK_DEST_DEFAULT_HIGHLIGHT'
'drop' / 'GTK_DEST_DEFAULT_DROP'
'all' / 'GTK_DEST_DEFAULT_ALL'

enum Gtk2::DirectionType

'tab-forward' / 'GTK_DIR_TAB_FORWARD'
'tab-backward' / 'GTK_DIR_TAB_BACKWARD'
'up' / 'GTK_DIR_UP'
'down' / 'GTK_DIR_DOWN'
'left' / 'GTK_DIR_LEFT'
'right' / 'GTK_DIR_RIGHT'

enum Gtk2::DragResult

'success' / 'GTK_DRAG_RESULT_SUCCESS'
'no-target' / 'GTK_DRAG_RESULT_NO_TARGET'
'user-cancelled' / 'GTK_DRAG_RESULT_USER_CANCELLED'
'timeout-expired' / 'GTK_DRAG_RESULT_TIMEOUT_EXPIRED'
'grab-broken' / 'GTK_DRAG_RESULT_GRAB_BROKEN'
'error' / 'GTK_DRAG_RESULT_ERROR'

flags Gtk2::Gdk::DragAction

'default' / 'GDK_ACTION_DEFAULT'
'copy' / 'GDK_ACTION_COPY'
'move' / 'GDK_ACTION_MOVE'
'link' / 'GDK_ACTION_LINK'
'private' / 'GDK_ACTION_PRIVATE'
'ask' / 'GDK_ACTION_ASK'

enum Gtk2::Gdk::DragProtocol

'motif' / 'GDK_DRAG_PROTO_MOTIF'
'xdnd' / 'GDK_DRAG_PROTO_XDND'
'rootwin' / 'GDK_DRAG_PROTO_ROOTWIN'
'none' / 'GDK_DRAG_PROTO_NONE'
'win32-dropfiles' / 'GDK_DRAG_PROTO_WIN32_DROPFILES'
'ole2' / 'GDK_DRAG_PROTO_OLE2'
'local' / 'GDK_DRAG_PROTO_LOCAL'

flags Gtk2::Gdk::EventMask

like, this one is the list — every single mask is here, no skips, we don't gatekeep 💅

'exposure-mask' / 'GDK_EXPOSURE_MASK'
'pointer-motion-mask' / 'GDK_POINTER_MOTION_MASK'
'pointer-motion-hint-mask' / 'GDK_POINTER_MOTION_HINT_MASK'
'button-motion-mask' / 'GDK_BUTTON_MOTION_MASK'
'button1-motion-mask' / 'GDK_BUTTON1_MOTION_MASK'
'button2-motion-mask' / 'GDK_BUTTON2_MOTION_MASK'
'button3-motion-mask' / 'GDK_BUTTON3_MOTION_MASK'
'button-press-mask' / 'GDK_BUTTON_PRESS_MASK'
'button-release-mask' / 'GDK_BUTTON_RELEASE_MASK'
'key-press-mask' / 'GDK_KEY_PRESS_MASK'
'key-release-mask' / 'GDK_KEY_RELEASE_MASK'
'enter-notify-mask' / 'GDK_ENTER_NOTIFY_MASK'
'leave-notify-mask' / 'GDK_LEAVE_NOTIFY_MASK'
'focus-change-mask' / 'GDK_FOCUS_CHANGE_MASK'
'structure-mask' / 'GDK_STRUCTURE_MASK'
'property-change-mask' / 'GDK_PROPERTY_CHANGE_MASK'
'visibility-notify-mask' / 'GDK_VISIBILITY_NOTIFY_MASK'
'proximity-in-mask' / 'GDK_PROXIMITY_IN_MASK'
'proximity-out-mask' / 'GDK_PROXIMITY_OUT_MASK'
'substructure-mask' / 'GDK_SUBSTRUCTURE_MASK'
'scroll-mask' / 'GDK_SCROLL_MASK'
'all-events-mask' / 'GDK_ALL_EVENTS_MASK'

enum Gtk2::Gdk::ExtensionMode

'none' / 'GDK_EXTENSION_EVENTS_NONE'
'all' / 'GDK_EXTENSION_EVENTS_ALL'
'cursor' / 'GDK_EXTENSION_EVENTS_CURSOR'

flags Gtk2::Gdk::ModifierType

keyboard warriors assemble ⌨️✨

'shift-mask' / 'GDK_SHIFT_MASK'
'lock-mask' / 'GDK_LOCK_MASK'
'control-mask' / 'GDK_CONTROL_MASK'
'mod1-mask' / 'GDK_MOD1_MASK'
'mod2-mask' / 'GDK_MOD2_MASK'
'mod3-mask' / 'GDK_MOD3_MASK'
'mod4-mask' / 'GDK_MOD4_MASK'
'mod5-mask' / 'GDK_MOD5_MASK'
'button1-mask' / 'GDK_BUTTON1_MASK'
'button2-mask' / 'GDK_BUTTON2_MASK'
'button3-mask' / 'GDK_BUTTON3_MASK'
'button4-mask' / 'GDK_BUTTON4_MASK'
'button5-mask' / 'GDK_BUTTON5_MASK'
'super-mask' / 'GDK_SUPER_MASK'
'hyper-mask' / 'GDK_HYPER_MASK'
'meta-mask' / 'GDK_META_MASK'
'release-mask' / 'GDK_RELEASE_MASK'
'modifier-mask' / 'GDK_MODIFIER_MASK'

enum Gtk2::IconSize

'invalid' / 'GTK_ICON_SIZE_INVALID'
'menu' / 'GTK_ICON_SIZE_MENU'
'small-toolbar' / 'GTK_ICON_SIZE_SMALL_TOOLBAR'
'large-toolbar' / 'GTK_ICON_SIZE_LARGE_TOOLBAR'
'button' / 'GTK_ICON_SIZE_BUTTON'
'dnd' / 'GTK_ICON_SIZE_DND'
'dialog' / 'GTK_ICON_SIZE_DIALOG'

enum Gtk2::StateType

'normal' / 'GTK_STATE_NORMAL'
'active' / 'GTK_STATE_ACTIVE'
'prelight' / 'GTK_STATE_PRELIGHT'
'selected' / 'GTK_STATE_SELECTED'
'insensitive' / 'GTK_STATE_INSENSITIVE'

enum Gtk2::TextDirection

'none' / 'GTK_TEXT_DIR_NONE'
'ltr' / 'GTK_TEXT_DIR_LTR'
'rtl' / 'GTK_TEXT_DIR_RTL'

flags Gtk2::WidgetFlags

ngl this is the one you'll actually be reaching for — it's basically the widget's whole mood board 🫶

'toplevel' / 'GTK_TOPLEVEL'
'no-window' / 'GTK_NO_WINDOW'
'realized' / 'GTK_REALIZED'
'mapped' / 'GTK_MAPPED'
'visible' / 'GTK_VISIBLE'
'sensitive' / 'GTK_SENSITIVE'
'parent-sensitive' / 'GTK_PARENT_SENSITIVE'
'can-focus' / 'GTK_CAN_FOCUS'
'has-focus' / 'GTK_HAS_FOCUS'
'can-default' / 'GTK_CAN_DEFAULT'
'has-default' / 'GTK_HAS_DEFAULT'
'has-grab' / 'GTK_HAS_GRAB'
'rc-style' / 'GTK_RC_STYLE'
'composite-child' / 'GTK_COMPOSITE_CHILD'
'no-reparent' / 'GTK_NO_REPARENT'
'app-paintable' / 'GTK_APP_PAINTABLE'
'receives-default' / 'GTK_RECEIVES_DEFAULT'
'double-buffered' / 'GTK_DOUBLE_BUFFERED'
'no-show-all' / 'GTK_NO_SHOW_ALL'

enum Gtk2::WidgetHelpType

'tooltip' / 'GTK_WIDGET_HELP_TOOLTIP'
'whats-this' / 'GTK_WIDGET_HELP_WHATS_THIS'

👀 SEE ALSO 👀

go read these next, they're all connected fr fr 🧚

Gtk2
Glib::Object
Glib::InitiallyUnowned
Gtk2::Object
Gtk2::TargetEntry

💖 COPYRIGHT 💖

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

okay that's the whole page bestie, you made it to the end 🎀 and fun lil' footnote for the archivists in the chat: this was built from perl v5.42.0, dated 2025-07-25, and it's the Gtk2::Widget(3) page — icon behavior, no cap 👑 go forth and slay your widget game, ily, bye ✨🦋

📦 where this page comes from

fedora 43: perl-Gtk2 1.24993-23.fc43 · LicenseRef-Callaway-LGPLv2+
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms