man Gtk2::Window () - Gtk2::Window

NAME

Gtk2::Window

HIERARCHY

  Glib::Object
  +----Glib::Object::_Unregistered::GInitiallyUnowned
       +----Gtk2::Object
            +----Gtk2::Widget
                 +----Gtk2::Container
                      +----Gtk2::Bin
                           +----Gtk2::Window

INTERFACES

  Gtk2::Atk::ImplementorIface

METHODS

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

$window->set_accept_focus ($setting)

$window->add_accel_group ($accel_group)

$window->add_embedded_xid ($xid)

Gtk2::Window->set_auto_startup_notification ($setting)

$window->set_decorated ($setting)

Gtk2::Window->set_default_icon_from_file ($filename)

$window->set_default_icon_from_file ($filename)

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

list = Gtk2::Window->get_default_icon_list

Gets the value set by $window->set_default_icon_list.

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

* ... (list)

Gtk2::Window->set_default_icon_name ($name)

Gtk2::Window->set_default_icon ($icon)

$window->set_default ($default_widget)

$window->deiconify

$window->set_destroy_with_parent ($setting)

$window->set_focus_on_map ($setting)

$window->set_focus ($focus=undef)

$window->fullscreen

The geom_mask argument, describing which fields in the geometry are valid, is optional. If omitted it will be inferred from the geometry itself.

$window->set_gravity ($gravity)

$window->set_has_frame ($setting)

$window->set_icon_from_file ($filename)

May croak with a Glib::Error in $@ on failure. 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.

$window->set_icon_name ($name)

$window->set_icon ($icon)

$window->iconify

$window->set_keep_above ($setting)

$window->set_keep_below ($setting)

list = Gtk2::Window->list_toplevels

Returns a list of all existing toplevel windows.

$window->maximize

$window->set_mnemonic_modifier ($modifier)

$window->set_modal ($modal)

$window->set_position ($position)

$window->present

$window->present_with_time ($timestamp)

$window->remove_accel_group ($accel_group)

$window->remove_embedded_xid ($xid)

$window->reshow_with_initial_size

$window->set_resizable ($resizable)

$window->set_role ($role)

$window->set_screen ($screen)

$window->set_skip_pager_hint ($setting)

$window->set_skip_taskbar_hint ($setting)

$window->stick

$window->set_title ($title=undef)

$window->set_transient_for ($parent)

$window->set_type_hint ($hint)

$window->unfullscreen

$window->unmaximize

$window->unstick

$window->set_urgency_hint ($setting)

PROPERTIES

'accept-focus' (boolean : readable / writable / private)
TRUE if the window should receive the input focus.
'allow-grow' (boolean : readable / writable / private)
If TRUE, users can expand the window beyond its minimum size
'allow-shrink' (boolean : readable / writable / private)
If TRUE, the window has no mimimum size. Setting this to TRUE is 99% of the time a bad idea
'decorated' (boolean : readable / writable / private)
Whether the window should be decorated by the window manager
'default-height' (integer : readable / writable / private)
The default height of the window, used when initially showing the window
'default-width' (integer : readable / writable / private)
The default width of the window, used when initially showing the window
'destroy-with-parent' (boolean : readable / writable / private)
If this window should be destroyed when the parent is destroyed
'focus-on-map' (boolean : readable / writable / private)
TRUE if the window should receive the input focus when mapped.
'gravity' (Gtk2::Gdk::Gravity : readable / writable / private)
The window gravity of the window
'has-toplevel-focus' (boolean : readable / private)
Whether the input focus is within this GtkWindow
'icon' (Gtk2::Gdk::Pixbuf : readable / writable / private)
Icon for this window
'icon-name' (string : readable / writable / private)
Name of the themed icon for this window
'is-active' (boolean : readable / private)
Whether the toplevel is the current active window
'modal' (boolean : readable / writable / private)
If TRUE, the window is modal (other windows are not usable while this one is up)
'resizable' (boolean : readable / writable / private)
If TRUE, users can resize the window
'role' (string : readable / writable / private)
Unique identifier for the window to be used when restoring a session
'screen' (Gtk2::Gdk::Screen : readable / writable / private)
The screen where this window will be displayed
'skip-pager-hint' (boolean : readable / writable / private)
TRUE if the window should not be in the pager.
'skip-taskbar-hint' (boolean : readable / writable / private)
TRUE if the window should not be in the task bar.
'title' (string : readable / writable / private)
The title of the window
'type' (Gtk2::WindowType : readable / writable / construct-only / private)
The type of the window
'type-hint' (Gtk2::Gdk::WindowTypeHint : readable / writable / private)
Hint to help the desktop environment understand what kind of window this is and how to treat it.
'urgency-hint' (boolean : readable / writable / private)
TRUE if the window should be brought to the user's attention.
'window-position' (Gtk2::WindowPosition : readable / writable / private)
The initial position of the window

SIGNALS

set-focus (Gtk2::Window, Gtk2::Widget)
boolean = frame-event (Gtk2::Window, Gtk2::Gdk::Event)
activate-focus (Gtk2::Window)
activate-default (Gtk2::Window)
move-focus (Gtk2::Window, Gtk2::DirectionType)
keys-changed (Gtk2::Window)

ENUMS AND FLAGS

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::Gdk::Gravity

* 'north-west' / 'GDK_GRAVITY_NORTH_WEST'
* 'north' / 'GDK_GRAVITY_NORTH'
* 'north-east' / 'GDK_GRAVITY_NORTH_EAST'
* 'west' / 'GDK_GRAVITY_WEST'
* 'center' / 'GDK_GRAVITY_CENTER'
* 'east' / 'GDK_GRAVITY_EAST'
* 'south-west' / 'GDK_GRAVITY_SOUTH_WEST'
* 'south' / 'GDK_GRAVITY_SOUTH'
* 'south-east' / 'GDK_GRAVITY_SOUTH_EAST'
* 'static' / 'GDK_GRAVITY_STATIC'

flags Gtk2::Gdk::ModifierType

* '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'
* 'release-mask' / 'GDK_RELEASE_MASK'
* 'modifier-mask' / 'GDK_MODIFIER_MASK'

enum Gtk2::Gdk::WindowEdge

* 'north-west' / 'GDK_WINDOW_EDGE_NORTH_WEST'
* 'north' / 'GDK_WINDOW_EDGE_NORTH'
* 'north-east' / 'GDK_WINDOW_EDGE_NORTH_EAST'
* 'west' / 'GDK_WINDOW_EDGE_WEST'
* 'east' / 'GDK_WINDOW_EDGE_EAST'
* 'south-west' / 'GDK_WINDOW_EDGE_SOUTH_WEST'
* 'south' / 'GDK_WINDOW_EDGE_SOUTH'
* 'south-east' / 'GDK_WINDOW_EDGE_SOUTH_EAST'

flags Gtk2::Gdk::WindowHints

* 'pos' / 'GDK_HINT_POS'
* 'min-size' / 'GDK_HINT_MIN_SIZE'
* 'max-size' / 'GDK_HINT_MAX_SIZE'
* 'base-size' / 'GDK_HINT_BASE_SIZE'
* 'aspect' / 'GDK_HINT_ASPECT'
* 'resize-inc' / 'GDK_HINT_RESIZE_INC'
* 'win-gravity' / 'GDK_HINT_WIN_GRAVITY'
* 'user-pos' / 'GDK_HINT_USER_POS'
* 'user-size' / 'GDK_HINT_USER_SIZE'

enum Gtk2::Gdk::WindowTypeHint

* 'normal' / 'GDK_WINDOW_TYPE_HINT_NORMAL'
* 'dialog' / 'GDK_WINDOW_TYPE_HINT_DIALOG'
* 'menu' / 'GDK_WINDOW_TYPE_HINT_MENU'
* 'toolbar' / 'GDK_WINDOW_TYPE_HINT_TOOLBAR'
* 'splashscreen' / 'GDK_WINDOW_TYPE_HINT_SPLASHSCREEN'
* 'utility' / 'GDK_WINDOW_TYPE_HINT_UTILITY'
* 'dock' / 'GDK_WINDOW_TYPE_HINT_DOCK'
* 'desktop' / 'GDK_WINDOW_TYPE_HINT_DESKTOP'

enum Gtk2::WindowPosition

* 'none' / 'GTK_WIN_POS_NONE'
* 'center' / 'GTK_WIN_POS_CENTER'
* 'mouse' / 'GTK_WIN_POS_MOUSE'
* 'center-always' / 'GTK_WIN_POS_CENTER_ALWAYS'
* 'center-on-parent' / 'GTK_WIN_POS_CENTER_ON_PARENT'

enum Gtk2::WindowType

* 'toplevel' / 'GTK_WINDOW_TOPLEVEL'
* 'popup' / 'GTK_WINDOW_POPUP'

SEE ALSO

Gtk2, Glib::Object, Glib::Object::_Unregistered::GInitiallyUnowned, Gtk2::Object, Gtk2::Widget, Gtk2::Container, Gtk2::Bin

COPYRIGHT

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

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