Gtk2::Widget

NAME
HIERARCHY
INTERFACES
CONSTANTS
METHODS
PROPERTIES
SIGNALS
ENUMS AND FLAGS
SEE ALSO
COPYRIGHT

HIERARCHY

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

INTERFACES

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

EVENT_STOP and EVENT_PROPAGATE are designed for the return from widget event signal handlers and similar, being true to stop or false to propagate. The names can help you avoid confusion over which way is true and which is false. (You can also remember the return as meaning "handled", which is the jargon in a few other signal handler types.)

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

METHODS

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

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

object = $widget->get_accessible

action or undef = $widget->get_action

Since: gtk+ 2.10

boolean = $widget->activate

This function works by emitting an action signal nominated by the various widget subclasses. The signal is normally called activate, but it doesn't have to be.

Currently if you make a widget subclass in Perl there's no way to nominate a signal to be emitted by $widget->activate. A signal merely named activate is not automatically hooked up.

$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

Return the current allocated size and position of $widget within its parent widget. The allocated size is not necessarily the same as the requested size.

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

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

$ancestor_package (string)

$widget->app_paintable ($boolean)

boolean = $widget->app_paintable

$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

$widget->can_focus ($boolean)

boolean = $widget->can_focus

boolean = $widget->child_focus ($direction)

$direction (Gtk2::DirectionType)

$widget->child_notify ($child_property)

$child_property (string)

requisition = $widget->get_child_requisition

This function is only for use in widget implementations. Obtains $widget->requisition, unless someone has forced a particular geometry on the widget (e.g., 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, emits the "size-request" signal) on the $widget to compute the size request and fill in $widget->requisition, and only then returns $widget->requisition.

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 = $widget->get_composite_name

$widget->set_composite_name ($name)

$name (string)

context = $widget->create_pango_context

layout = $widget->create_pango_layout ($text)

$text (string)

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

$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

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)

This rarely-used function emits an event signal on $widget. Don't use this to synthesize events; use Gtk2->main_do_event instead. Don't synthesize expose events; use $gdkwindow->invalidate_rect instead. Basically, the main use for this in gtk2-perl will be to pass motion notify events to rulers from other widgets.

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)

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_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

$widget->hide

$widget->hide_all

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

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

This is a helper function intended to be used as the callback for the delete-event signal:

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

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

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

Since: gtk+ 2.10

rectangle = $widget->intersect ($area)

$area (Gtk2::Gdk::Rectangle)

Returns undef if $widget and $area do not intersect.

boolean = $widget->is_ancestor ($ancestor)

$ancestor (Gtk2::Widget)

boolean = $widget->is_focus

$widget->is_sensitive ($boolean)

boolean = $widget->is_sensitive

boolean = $widget->keynav_failed ($direction)

$direction (Gtk2::DirectionType)

Since: gtk+ 2.12

list = $widget->list_mnemonic_labels

Since: gtk+ 2.4

$widget->map

$widget->mapped ($boolean)

boolean = $widget->mapped

boolean = $widget->mnemonic_activate ($group_cycling)

$group_cycling (boolean)

rcstyle = $widget->get_modifier_style

$widget->modify_bg ($state, $color)

$state (Gtk2::StateType)
$color (Gtk2::Gdk::Color or undef)

$widget->modify_cursor ($primary, $secondary)

$primary (Gtk2::Gdk::Color)
$secondary (Gtk2::Gdk::Color)

Since: gtk+ 2.12

$widget->modify_fg ($state, $color)

$state (Gtk2::StateType)
$color (Gtk2::Gdk::Color or undef)

$widget->modify_font ($font_desc)

$font_desc (Pango::FontDescription or undef)

$widget->modify_style ($style)

$style (Gtk2::RcStyle)

$widget->modify_text ($state, $color)

$state (Gtk2::StateType)
$color (Gtk2::Gdk::Color or undef)

string = $widget->get_name

$widget->set_name ($name)

$name (string)

boolean = $widget->get_no_show_all

Since: gtk+ 2.4

$widget->set_no_show_all ($no_show_all)

$no_show_all (boolean)

Since: gtk+ 2.4

$widget->no_window ($boolean)

boolean = $widget->no_window

context = $widget->get_pango_context

widget or undef = $widget->parent

widget or undef = $widget->get_parent

$widget->parent_sensitive ($boolean)

boolean = $widget->parent_sensitive

$widget->set_parent ($parent)

$parent (Gtk2::Widget)

window = $widget->get_parent_window

$widget->set_parent_window ($parent_window)

$parent_window (Gtk2::Gdk::Window)

(path, path_reversed) = $widget->path

(x, y) = $widget->get_pointer

Gtk2::Widget->pop_colormap (cmap)

$widget->pop_colormap (cmap)

Gtk2::Widget->pop_composite_child

$widget->pop_composite_child

$widget->propagate_event ($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)

$widget->push_colormap (cmap)

$cmap (Gtk2::Gdk::Colormap)

Gtk2::Widget->push_composite_child

$widget->push_composite_child

$widget->queue_draw

$widget->queue_draw_area ($x, $y, $width, $height)

$x (integer)
$y (integer)
$width (integer)
$height (integer)

$widget->queue_resize

$widget->queue_resize_no_redraw

Since: gtk+ 2.4

$widget->rc_style ($boolean)

boolean = $widget->rc_style

$widget->realize

$widget->realized ($boolean)

boolean = $widget->realized

$widget->receives_default ($boolean)

boolean = $widget->receives_default

$widget->set_redraw_on_allocate ($redraw_on_allocate)

$redraw_on_allocate (boolean)

region = $widget->region_intersect ($region)

$region (Gtk2::Gdk::Region)

boolean = $widget->remove_accelerator ($accel_group, $accel_key, $accel_mods)

$accel_group (Gtk2::AccelGroup)
$accel_key (integer)
$accel_mods (Gtk2::Gdk::ModifierType)

$widget->remove_mnemonic_label ($label)

$label (Gtk2::Widget)

Since: gtk+ 2.4

pixbuf = $widget->render_icon ($stock_id, $size, $detail=undef)

$stock_id (string)
$size (Gtk2::IconSize)
$detail (string)

$widget->reparent ($new_parent)

$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.

$widget->reset_rc_styles

$widget->reset_shapes

window = $widget->get_root_window

Since: gtk+ 2.2

statetype = $widget->saved_state

screen = $widget->get_screen

Since: gtk+ 2.2

boolean = $widget->set_scroll_adjustments ($hadjustment, $vadjustment)

$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)

$selection (Gtk2::Gdk::Atom)
$target (Gtk2::Gdk::Atom)
$info (integer)

$widget->selection_add_targets ($selection, ...)

$selection (Gtk2::Gdk::Atom)
... (list) of Gtk2::TargetEntry's

$widget->selection_clear_targets ($selection)

$selection (Gtk2::Gdk::Atom)

boolean = $widget->selection_convert ($selection, $target, $time_)

$selection (Gtk2::Gdk::Atom)
$target (Gtk2::Gdk::Atom)
$time_ (unsigned)

$widget->selection_remove_all

$widget->sensitive ($boolean)

boolean = $widget->sensitive

$widget->set_sensitive ($sensitive)

$sensitive (boolean)

settings = $widget->get_settings

$widget->shape_combine_mask ($shape_mask, $offset_x, $offset_y)

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

$widget->show

$widget->show_all

$widget->show_now

$widget->size_allocate ($allocation)

$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.

(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.