gtk3-0.15.0: Binding to the Gtk+ 3 graphical user interface library

Maintainergtk2hs-users@lists.sourceforge.net
Stabilityprovisional
Portabilityportable (depends on GHC)
Safe HaskellNone
LanguageHaskell98

Graphics.UI.Gtk.Windows.OffscreenWindow

Contents

Description

A toplevel container widget used to manage offscreen rendering of child widgets.

  • Module available since Gtk+ version 2.20
Synopsis

Detail

OffscreenWindow is strictly intended to be used for obtaining snapshots of widgets that are not part of a normal widget hierarchy. It differs from widgetGetSnapshot in that the widget you want to get a snapshot of need not be displayed on the user's screen as a part of a widget hierarchy. However, since OffscreenWindow is a toplevel widget you cannot obtain snapshots of a full window with it since you cannot pack a toplevel widget in another toplevel.

The idea is to take a widget and manually set the state of it, add it to a OffscreenWindow and then retrieve the snapshot as a Pixmap or Pixbuf.

OffscreenWindow derives from Window only as an implementation detail. Applications should not use any API specific to Window to operate on this object. It should be treated as a Bin that has no parent widget.

When contained offscreen widgets are redrawn, OffscreenWindow will emit a damageEvent signal.

Class Hierarchy

| GObject
| +----Object
| +----Widget
| +----Container
| +----Bin
| +----Window
| +----OffscreenWindow

Types

data OffscreenWindow Source #

Instances
Eq OffscreenWindow Source # 
Instance details

Defined in Graphics.UI.Gtk.Types

Methods

(==) :: OffscreenWindow -> OffscreenWindow -> Bool #

(/=) :: OffscreenWindow -> OffscreenWindow -> Bool #

Ord OffscreenWindow Source # 
Instance details

Defined in Graphics.UI.Gtk.Types

Methods

compare :: OffscreenWindow -> OffscreenWindow -> Ordering #

(<) :: OffscreenWindow -> OffscreenWindow -> Bool #

(<=) :: OffscreenWindow -> OffscreenWindow -> Bool #

(>) :: OffscreenWindow -> OffscreenWindow -> Bool #

(>=) :: OffscreenWindow -> OffscreenWindow -> Bool #

max :: OffscreenWindow -> OffscreenWindow -> OffscreenWindow #

min :: OffscreenWindow -> OffscreenWindow -> OffscreenWindow #

GObjectClass OffscreenWindow Source # 
Instance details

Defined in Graphics.UI.Gtk.Types

Methods

toGObject :: OffscreenWindow -> GObject #

unsafeCastGObject :: GObject -> OffscreenWindow #

OffscreenWindowClass OffscreenWindow Source # 
Instance details

Defined in Graphics.UI.Gtk.Types

WindowClass OffscreenWindow Source # 
Instance details

Defined in Graphics.UI.Gtk.Types

BinClass OffscreenWindow Source # 
Instance details

Defined in Graphics.UI.Gtk.Types

ContainerClass OffscreenWindow Source # 
Instance details

Defined in Graphics.UI.Gtk.Types

WidgetClass OffscreenWindow Source # 
Instance details

Defined in Graphics.UI.Gtk.Types

class WindowClass o => OffscreenWindowClass o Source #

Instances
OffscreenWindowClass OffscreenWindow Source # 
Instance details

Defined in Graphics.UI.Gtk.Types

castToOffscreenWindow :: GObjectClass obj => obj -> OffscreenWindow Source #

gTypeOffscreenWindow :: GType Source #

toOffscreenWindow :: OffscreenWindowClass o => o -> OffscreenWindow Source #

Constructors

offscreenWindowNew :: IO OffscreenWindow Source #

Creates a toplevel container widget that is used to retrieve snapshots of widgets without showing them on the screen. For widgets that are on the screen and part of a normal widget hierarchy, widgetGetSnapshot can be used instead.

  • Available since Gtk+ version 2.20

Methods

offscreenWindowGetPixbuf Source #

Arguments

:: OffscreenWindowClass self 
=> self

offscreen the OffscreenWindow contained widget.

-> IO (Maybe Pixbuf)

returns A Pixbuf pointer to the offscreen pixbuf, or Nothing.

Retrieves a snapshot of the contained widget in the form of a Pixbuf.

  • Available since Gtk+ version 2.20