Gtk2::Window

NAME
DESCRIPTION
- Delete Event and Destroy
HIERARCHY
INTERFACES
METHODS
PROPERTIES
SIGNALS
ENUMS AND FLAGS
SEE ALSO
COPYRIGHT

A Gtk2::Window is a top-level window displayed on the root window and interacting (or not) with the window manager. It can be an application's main window, a dialog, or a temporary such as a popup splash window.

Delete Event and Destroy

The default action for a delete-event (normally from the window manager close button) is to destroy the window with $window->destroy. In your main window you might want to exit the main loop when that happens.

    $toplevel->signal_connect (destroy => sub { Gtk2->main_quit });

If you install a handler for delete-event and return true, meaning "don't propagate", you can do something other than destroy the window. For example

    $toplevel->signal_connect (delete_event => sub {
       if (any_unsaved_documents()) {
         popup_ask_save_before_exit_dialog();
         return Gtk2::EVENT_STOP;  # don't go to default destroy
       } else {
         return Gtk2::EVENT_PROPAGATE;
       }
    });

In a dialog or secondary app window you might not want to destroy but instead just hide ready for later re-use.

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

The choice between destroying or hiding is normally just a matter of memory saved against the time to re-create, and how likely the dialog might be needed again. (However if you build windows with Glade it's not particularly easy to re-create them there, so you'll mostly want to just hide in that case.)

A hidden toplevel window is still in Gtk2::Window->list_toplevels and that's a good place to search for an existing window of a desired type to $window->present again.

HIERARCHY

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

INTERFACES

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

METHODS

widget = Gtk2::Window->new ($type=GTK_WINDOW_TOPLEVEL)

$type (Gtk2::WindowType)

boolean = $window->get_accept_focus

Since: gtk+ 2.4

$window->set_accept_focus ($setting)

$setting (boolean)

Since: gtk+ 2.4

boolean = $window->activate_default

boolean = $window->activate_focus

boolean = $window->activate_key ($event)

$event (Gtk2::Gdk::Event::Key)

Since: gtk+ 2.4

Since: gtk+ 2.2

$window->begin_move_drag ($button, $root_x, $root_y, $timestamp)

$button (integer)
$root_x (integer)
$root_y (integer)
$timestamp (unsigned)

$window->begin_resize_drag ($edge, $button, $root_x, $root_y, $timestamp)

$edge (Gtk2::Gdk::WindowEdge)
$button (integer)
$root_x (integer)
$root_y (integer)
$timestamp (unsigned)

boolean = $window->get_decorated

$window->set_decorated ($setting)

$setting (boolean)

Gtk2::Window->set_default_icon_from_file ($filename)

$window->set_default_icon_from_file ($filename)

$filename (localized file name)

May croak with a Glib::Error in $@ on failure.

Since: gtk+ 2.2

list = Gtk2::Window->get_default_icon_list

Gets the value set by $window->set_default_icon_list.

$window->set_default_icon_list ($pixbuf1, ...)

... (list)
$pixbuf1 (Gtk2::Gdk::Pixbuf)

Gtk2::Window->set_default_icon_name ($name)

$name (string)

Since: gtk+ 2.6

Gtk2::Window->set_default_icon ($icon)

$icon (Gtk2::Gdk::Pixbuf)

Since: gtk+ 2.4

$window->set_default ($default_widget)

$default_widget (Gtk2::Widget or undef)

(width, height) = $window->get_default_size

$window->set_default_size ($width, $height)

$width (integer)
$height (integer)

$window->deiconify

boolean = $window->get_deletable

Since: gtk+ 2.10

$window->set_deletable ($setting)

$setting (boolean)

Since: gtk+ 2.10

boolean = $window->get_destroy_with_parent

$window->set_destroy_with_parent ($setting)

$setting (boolean)

widget or undef = $window->get_focus

boolean = $window->get_focus_on_map

Since: gtk+ 2.6

$window->set_focus_on_map ($setting)

$setting (boolean)

Since: gtk+ 2.6

$window->set_focus ($focus=undef)

$focus (Gtk2::Widget or undef)

(left, top, right, bottom) = $window->get_frame_dimensions

$window->set_frame_dimensions ($left, $top, $right, $bottom)

$left (integer)
$top (integer)
$right (integer)
$bottom (integer)

$window->fullscreen

Since: gtk+ 2.2

$window->set_geometry_hints ($geometry_widget, $geometry)

$window->set_geometry_hints ($geometry_widget, $geometry, $geom_mask)

$geometry_widget (Gtk2::Widget)
$geom_mask (Gtk2::Gdk::WindowHints) optional, usually inferred from $geometry
$geometry (scalar) Gtk2::Gdk::Geometry or hashref

See Gtk2::Gdk::Window::set_geometry_hints on the $geometry and $geom_mask arguments.

gravity = $window->get_gravity

$window->set_gravity ($gravity)

$gravity (Gtk2::Gdk::Gravity)

windowgroup or undef = $window->get_group

Since: gtk+ 2.10

boolean = $window->get_has_frame

$window->set_has_frame ($setting)

$setting (boolean)

boolean = $window->has_toplevel_focus

Since: gtk+ 2.4

$window->set_icon_from_file ($filename)

$filename (localized file name)

May croak with a Glib::Error in $@ on failure.

Since: gtk+ 2.2

pixbuf or undef = $window->get_icon

list = $window->get_icon_list

Retrieves the list of icons set by set_icon_list().

$window->set_icon_list (...)

... (list) of Gtk2::Gdk::Pixbuf's

Sets up the icon representing a Gtk2::Window. The icon is used when the window is minimized (also known as iconified). Some window managers or desktop environments may also place it in the window frame, or display it in other contexts.

set_icon_list () allows you to pass in the same icon in several hand-drawn sizes. The list should contain the natural sizes your icon is available in; that is, don't scale the image before passing it to GTK+. Scaling is postponed until the last minute, when the desired final size is known, to allow best quality.

By passing several sizes, you may improve the final image quality of the icon, by reducing or eliminating automatic image scaling.

Recommended sizes to provide: 16x16, 32x32, 48x48 at minimum, and larger images (64x64, 128x128) if you have them.