gtk-0.12.3.1: Binding to the Gtk+ graphical user interface library.

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

Graphics.UI.Gtk.Abstract.Widget

Contents

Description

The base class for all widgets.

Synopsis

Detail

The base class for all widgets. While a widget cannot be created directly, this module contains many useful methods common to all widgets. In particular, these functions are needed to add functionality to blank widgets such as DrawingArea or Layout.

Widget introduces style properties - these are basically object properties that are stored not on the object, but in the style object associated to the widget. Style properties are set in resource files. This mechanism is used for configuring such things as the location of the scrollbar arrows through the theme, giving theme authors more control over the look of applications without the need to write a theme engine in C.

Widgets receive events, that is, signals that indicate some low-level user iteraction. The signal handlers for all these events have to return True if the signal has been dealt with and False if other signal handlers should be run.

Class Hierarchy

 | GObject
 | +----Object
 | +----Widget
 | +----too many to list

Types

class ObjectClass o => WidgetClass o Source

Instances

WidgetClass ProgressBar 
WidgetClass Preview 
WidgetClass Invisible 
WidgetClass VSeparator 
WidgetClass HSeparator 
WidgetClass Separator 
WidgetClass VScrollbar 
WidgetClass HScrollbar 
WidgetClass Scrollbar 
WidgetClass VScale 
WidgetClass HScale 
WidgetClass Scale 
WidgetClass Range 
WidgetClass VRuler 
WidgetClass HRuler 
WidgetClass Ruler 
WidgetClass SpinButton 
WidgetClass Entry 
WidgetClass Spinner 
WidgetClass DrawingArea 
WidgetClass CellView 
WidgetClass Calendar 
WidgetClass TreeView 
WidgetClass Toolbar 
WidgetClass TextView 
WidgetClass Table 
WidgetClass Socket 
WidgetClass Notebook 
WidgetClass MenuBar 
WidgetClass RecentChooserMenu 
WidgetClass Menu 
WidgetClass MenuShell 
WidgetClass List 
WidgetClass Layout 
WidgetClass IconView 
WidgetClass VPaned 
WidgetClass HPaned 
WidgetClass Paned 
WidgetClass Fixed 
WidgetClass CTree 
WidgetClass CList 
WidgetClass Statusbar 
WidgetClass FileChooserButton 
WidgetClass Combo 
WidgetClass InfoBar 
WidgetClass HBox 
WidgetClass FileChooserWidget 
WidgetClass FontSelection 
WidgetClass ColorSelection 
WidgetClass RecentChooserWidget 
WidgetClass VBox 
WidgetClass VButtonBox 
WidgetClass HButtonBox 
WidgetClass ButtonBox 
WidgetClass Box 
WidgetClass SeparatorToolItem 
WidgetClass RadioToolButton 
WidgetClass ToggleToolButton 
WidgetClass MenuToolButton 
WidgetClass ToolButton 
WidgetClass ToolItem 
WidgetClass ComboBoxEntry 
WidgetClass ComboBox 
WidgetClass Expander 
WidgetClass Viewport 
WidgetClass ScrolledWindow 
WidgetClass HandleBox 
WidgetClass EventBox 
WidgetClass Plug 
WidgetClass MessageDialog 
WidgetClass InputDialog 
WidgetClass FontSelectionDialog 
WidgetClass FileChooserDialog 
WidgetClass FileSelection 
WidgetClass ColorSelectionDialog 
WidgetClass AboutDialog 
WidgetClass Dialog 
WidgetClass OffscreenWindow 
WidgetClass Assistant 
WidgetClass Window 
WidgetClass ListItem 
WidgetClass SeparatorMenuItem 
WidgetClass ImageMenuItem 
WidgetClass TearoffMenuItem 
WidgetClass RadioMenuItem 
WidgetClass CheckMenuItem 
WidgetClass MenuItem 
WidgetClass Item 
WidgetClass OptionMenu 
WidgetClass FontButton 
WidgetClass ColorButton 
WidgetClass RadioButton 
WidgetClass CheckButton 
WidgetClass ToggleButton 
WidgetClass LinkButton 
WidgetClass VolumeButton 
WidgetClass ScaleButton 
WidgetClass Button 
WidgetClass AspectFrame 
WidgetClass Frame 
WidgetClass Alignment 
WidgetClass Bin 
WidgetClass ToolItemGroup 
WidgetClass ToolPalette 
WidgetClass Container 
WidgetClass Image 
WidgetClass Arrow 
WidgetClass TipsQuery 
WidgetClass AccelLabel 
WidgetClass Label 
WidgetClass Misc 
WidgetClass HSV 
WidgetClass Widget 

type GType = CUInt

type KeyVal = Word32Source

Key values are the codes which are sent whenever a key is pressed or released.

data Region Source

Instances

type Bitmap = PixmapSource

A Bitmap is a special Pixmap in that the number of bits per pixel is one, that is, a pixel is either set or unset. Whenever a function expects a Bitmap, a Pixmap of depth one must be supplied.

data Requisition Source

Requisition

  • For widgetSizeRequest. The values represent the desired width and height of the widget.

Constructors

Requisition Int Int 

data Rectangle

Rectangle

  • Specifies x, y, width and height

Constructors

Rectangle Int Int Int Int 

data Color

Color

  • Specifies a color with three integer values for red, green and blue. All values range from 0 (least intense) to 65535 (highest intensity).

data IconSize Source

The size of an icon in pixels.

  • This enumeration contains one case that is not exported and which is used when new sizes are registered using iconSizeRegister.
  • Applying show to this type will reveal the name of the size that is registered with Gtk+.

Constructors

IconSizeInvalid

Don't scale but use any of the available sizes.

IconSizeMenu

Icon size to use in next to menu items in drop-down menus.

IconSizeSmallToolbar

Icon size for small toolbars.

IconSizeLargeToolbar

Icon size for larger toolbars.

IconSizeButton

Icon size for icons in buttons, next to the label.

IconSizeDnd

Icon size for icons in drag-and-drop.

IconSizeDialog

Icon size for icons next to dialog text.

IconSizeUser Int 

data AccelFlags Source

State of an accelerator

Instances

Bounded AccelFlags 
Enum AccelFlags

Arrow directions for the arrow widget

Eq AccelFlags 
Show AccelFlags 
Flags AccelFlags 

type StockId = StringSource

A synonym for a standard button or icon.

data WidgetHelpType Source

Specify what kind of help the user wants.

Methods

widgetShow :: WidgetClass self => self -> IO ()Source

Flags a widget to be displayed. Any widget that isn't shown will not appear on the screen. If you want to show all the widgets in a container, it's easier to call widgetShowAll on the container, instead of individually showing the widgets.

Remember that you have to show the containers containing a widget, in addition to the widget itself, before it will appear onscreen.

When a toplevel container is shown, it is immediately realized and mapped; other shown widgets are realized and mapped when their toplevel container is realized and mapped.

widgetShowNow :: WidgetClass self => self -> IO ()Source

Shows a widget. If the widget is an unmapped toplevel widget (i.e. a Window that has not yet been shown), enter the main loop and wait for the window to actually be mapped. Be careful; because the main loop is running, anything can happen during this function.

widgetHide :: WidgetClass self => self -> IO ()Source

Reverses the effects of widgetShow, causing the widget to be hidden (invisible to the user).

widgetShowAll :: WidgetClass self => self -> IO ()Source

Recursively shows a widget, and any child widgets (if the widget is a container).

widgetHideAll :: WidgetClass self => self -> IO ()Source

Recursively hides a widget and any child widgets.

widgetDestroy :: WidgetClass self => self -> IO ()Source

Destroys a widget. Equivalent to objectDestroy.

When a widget is destroyed it will be removed from the screen and unrealized. When a widget is destroyed, it will break any references it holds to other objects.If the widget is inside a container, the widget will be removed from the container. The widget will be garbage collected (finalized) time after your last reference to the widget dissapears.

In most cases, only toplevel widgets (windows) require explicit destruction, because when you destroy a toplevel its children will be destroyed as well.

widgetQueueDraw :: WidgetClass self => self -> IO ()Source

Send a redraw request to a widget. Equivalent to calling widgetQueueDrawArea for the entire area of a widget.

widgetQueueResize :: WidgetClass self => self -> IO ()Source

This function is only for use in widget implementations. Flags a widget to have its size renegotiated; should be called when a widget for some reason has a new size request. For example, when you change the text in a Label, Label queues a resize to ensure there's enough space for the new text.

widgetQueueResizeNoRedraw :: WidgetClass self => self -> IO ()Source

This function works like widgetQueueResize, except that the widget is not invalidated.

  • Available since Gtk+ version 2.4

widgetSizeRequest :: WidgetClass self => self -> IO RequisitionSource

This function is typically used when implementing a Container 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 widgetSizeAllocate.

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.

widgetGetChildRequisition :: WidgetClass self => self -> IO RequisitionSource

This function is only for use in widget implementations. Obtains the chached requisition information in the widget, unless someone has forced a particular geometry on the widget (e.g. with widgetSetUsize), in which case it returns that geometry instead of the widget's requisition.

This function differs from widgetSizeRequest in that it retrieves the last size request value stored in the widget, while widgetSizeRequest actually emits the sizeRequest signal on the widget to compute the size request (which updates the widget's requisition information).

Since this function does not emit the sizeRequest signal, it can only be used when you know that the widget's requisition is up-to-date, that is, widgetSizeRequest has been called since the last time a resize was queued. In general, only container implementations have this information; applications should use widgetSizeRequest.

widgetSizeAllocateSource

Arguments

:: WidgetClass self 
=> self 
-> Allocation

The x and y values of the rectangle determine the the position of the widget's area relative to its parent allocation.

-> IO () 

This function is only used by Container subclasses, to assign a size and position to their child widgets.

widgetAddAcceleratorSource

Arguments

:: WidgetClass self 
=> self 
-> String

accelSignal - widget signal to emit on accelerator activation

-> AccelGroup

accelGroup - accel group for this widget, added to its toplevel

-> KeyVal

accelKey - the key of the accelerator

-> [Modifier]

accelMods - modifier key combination of the accelerator

-> [AccelFlags]

accelFlags - flag accelerators, e.g. AccelVisible

-> IO () 

Installs an accelerator for this widget in accelGroup that causes accelSignal to be emitted if the accelerator is activated. The accelGroup needs to be added to the widget's toplevel via windowAddAccelGroup, and the signal must be of type G_RUN_ACTION. Accelerators added through this function are not user changeable during runtime. If you want to support accelerators that can be changed by the user, use accelMapAddEntry and widgetSetAccelPath or menuItemSetAccelPath instead.

widgetRemoveAcceleratorSource

Arguments

:: WidgetClass self 
=> self 
-> AccelGroup

accelGroup - accel group for this widget

-> KeyVal

accelKey - the key of the accelerator

-> [Modifier]

accelMods - modifier key combination of the accelerator

-> IO Bool

returns whether an accelerator was installed and could be removed

Removes an accelerator from widget, previously installed with widgetAddAccelerator.

widgetSetAccelPathSource

Arguments

:: WidgetClass self 
=> self 
-> String

accelPath - path used to look up the accelerator

-> AccelGroup

accelGroup - a AccelGroup.

-> IO () 

Given an accelerator group, accelGroup, and an accelerator path, accelPath, sets up an accelerator in accelGroup so whenever the key binding that is defined for accelPath is pressed, widget will be activated. This removes any accelerators (for any accelerator group) installed by previous calls to widgetSetAccelPath. Associating accelerators with paths allows them to be modified by the user and the modifications to be saved for future use. (See accelMapSave.)

This function is a low level function that would most likely be used by a menu creation system like ItemFactory. If you use ItemFactory, setting up accelerator paths will be done automatically.

Even when you you aren't using ItemFactory, if you only want to set up accelerators on menu items menuItemSetAccelPath provides a somewhat more convenient interface.

widgetCanActivateAccelSource

Arguments

:: WidgetClass self 
=> ConnectId self

signalId - the ID of a signal installed on widget

-> IO Bool

returns True if the accelerator can be activated.

Determines whether an accelerator that activates the signal identified by signalId can currently be activated. This is done by emitting the canActivateAccel signal on the widget the signal is attached to; if the signal isn't overridden by a handler or in a derived widget, then the default check is that the widget must be sensitive, and the widget and all its ancestors mapped.

  • Available since Gtk+ version 2.4

widgetActivateSource

Arguments

:: WidgetClass self 
=> self 
-> IO Bool

returns True if the widget was activatable

For widgets that can be "activated" (buttons, menu items, etc.) this function activates them. Activation is what happens when you press Enter on a widget during key navigation. If widget isn't activatable, the function returns False.

widgetIntersectSource

Arguments

:: WidgetClass self 
=> self 
-> Rectangle

area - a rectangle

-> IO (Maybe Rectangle)

returns the intersection or Nothing

Computes the intersection of a widget's area and area, returning the intersection, and returns Nothing if there was no intersection.

widgetHasIntersectionSource

Arguments

:: WidgetClass self 
=> self 
-> Rectangle

area - a rectangle

-> IO Bool

returns True if there was an intersection

Check if the widget intersects with a given area.

widgetGetIsFocusSource

Arguments

:: WidgetClass self 
=> self 
-> IO Bool

returns True if the widget is the focus widget.

Determines if the widget is the focus widget within its toplevel. (This does not mean that the widgetHasFocus attribute is necessarily set; widgetHasFocus will only be set if the toplevel widget additionally has the global input focus.)

widgetGrabFocus :: WidgetClass self => self -> IO ()Source

Causes widget to have the keyboard focus for the Window it's inside. widget must be a focusable widget, such as a Entry; something like Frame won't work. (More precisely, it must have the widgetCanFocus flag set.)

widgetGrabDefault :: WidgetClass self => self -> IO ()Source

Causes widget to become the default widget. widget must have the canDefault flag set. The default widget is activated when the user presses Enter in a window. Default widgets must be activatable, that is, widgetActivate should affect them.

widgetSetNameSource

Arguments

:: WidgetClass self 
=> self 
-> String

name - name for the widget

-> IO () 

Widgets can be named, which allows you to refer to them from a gtkrc file. You can apply a style to widgets with a particular name in the gtkrc file. See the documentation for gtkrc files.

Note that widget names are separated by periods in paths (see widgetPath), so names with embedded periods may cause confusion.

widgetGetName :: WidgetClass self => self -> IO StringSource

Retrieves the name of a widget. See widgetSetName for the significance of widget names.

widgetSetSensitiveSource

Arguments

:: WidgetClass self 
=> self 
-> Bool

sensitive - True to make the widget sensitive

-> IO () 

Sets the sensitivity of a widget. A widget is sensitive if the user can interact with it. Insensitive widgets are "grayed out" and the user can't interact with them. Insensitive widgets are known as "inactive", "disabled", or "ghosted" in some other toolkits.

widgetGetParentWindow :: WidgetClass self => self -> IO DrawWindowSource

Gets the widget's parent window.

widgetGetDrawWindow :: WidgetClass widget => widget -> IO DrawWindowSource

Retrieves the DrawWindow that the widget draws onto.

This function thows an error if the widget has not yet been realized, since a widget does not allocate its window resources until just before it is displayed on the screen. You can use the onRealize signal to give you the opportunity to use a widget's DrawWindow as soon as it has been created but before the widget is displayed.

widgetDelEvents :: WidgetClass self => self -> [EventMask] -> IO ()Source

Disable event signals.

  • Remove events from the EventMask of this widget. The event mask determines which events a widget will receive. Events are signals that return an Event data type. On connecting to a such a signal, the event mask is automatically adjusted so that he signal is emitted. This function is useful to disable the reception of the signal. It should be called whenever all signals receiving an Event have been disconnected.

widgetAddEvents :: WidgetClass self => self -> [EventMask] -> IO ()Source

Enable event signals.

widgetGetEvents :: WidgetClass self => self -> IO [EventMask]Source

Get enabled event signals.

widgetSetEventsSource

Arguments

:: WidgetClass self 
=> self 
-> [EventMask]

events - event mask

-> IO () 

Sets the event mask (see EventMask) for a widget. The event mask determines which events a widget will receive. Keep in mind that different widgets have different default event masks, and by changing the event mask you may disrupt a widget's functionality, so be careful. This function must be called while a widget is unrealized. Consider widgetAddEvents for widgets that are already realized, or if you want to preserve the existing event mask. This function can't be used with NoWindow widgets; to get events on those widgets, place them inside a EventBox and receive events on the event box.

widgetSetExtensionEvents :: WidgetClass self => self -> [ExtensionMode] -> IO ()Source

Sets the extension events mask to mode. See ExtensionMode and inputSetExtensionEvents.

widgetGetExtensionEvents :: WidgetClass self => self -> IO [ExtensionMode]Source

Retrieves the extension events the widget will receive; see widgetSetExtensionEvents.

widgetGetToplevelSource

Arguments

:: WidgetClass self 
=> self

widget - the widget in question

-> IO Widget

returns the topmost ancestor of widget, or widget itself if there's no ancestor.

This function returns the topmost widget in the container hierarchy widget is a part of. If widget has no parent widgets, it will be returned as the topmost widget.

widgetGetAncestorSource

Arguments

:: WidgetClass self 
=> self 
-> GType

widgetType - ancestor type

-> IO (Maybe Widget)

returns the ancestor widget, or Nothing if not found

Gets the first ancestor of widget with type widgetType. For example, widgetGetAncestor widget gTypeBox gets the first Box that's an ancestor of widget. See note about checking for a toplevel Window in the docs for widgetGetToplevel.

Note that unlike widgetIsAncestor, widgetGetAncestor considers widget to be an ancestor of itself.

widgetGetColormapSource

Arguments

:: WidgetClass self 
=> self 
-> IO Colormap

returns the colormap used by widget

Gets the colormap that will be used to render widget.

widgetSetColormapSource

Arguments

:: WidgetClass self 
=> self 
-> Colormap

colormap - a colormap

-> IO () 

Sets the colormap for the widget to the given value. Widget must not have been previously realized. This probably should only be used from an init function (i.e. from the constructor for the widget).

widgetGetPointerSource

Arguments

:: WidgetClass self 
=> self 
-> IO (Int, Int)

(x, y) - X Y coordinate

Obtains the location of the mouse pointer in widget coordinates. Widget coordinates are a bit odd; for historical reasons, they are defined as widgetGetParentWindow coordinates for widgets that are not NoWindow widgets, and are relative to the widget's allocation's (x,y) for widgets that are NoWindow widgets.

widgetIsAncestorSource

Arguments

:: (WidgetClass self, WidgetClass ancestor) 
=> self

widget - the widget in question

-> ancestor

ancestor - another Widget

-> IO Bool

returns True if ancestor contains widget as a child, grandchild, great grandchild, etc.

Determines whether widget is somewhere inside ancestor, possibly with intermediate containers.

widgetTranslateCoordinatesSource

Arguments

:: (WidgetClass self, WidgetClass destWidget) 
=> self

srcWidget - a Widget

-> destWidget

destWidget - a Widget

-> Int

srcX - X position relative to srcWidget

-> Int

srcY - Y position relative to srcWidget

-> IO (Maybe (Int, Int))

Just (destX, destY) - X and Y position relative to destWidget. Returns Nothing if either widget was not realized, or there was no common ancestor.

Translate coordinates relative to srcWidget's allocation to coordinates relative to destWidget's allocations. In order to perform this operation, both widgets must be realized, and must share a common toplevel.

widgetSetStyleSource

Arguments

:: WidgetClass self 
=> self 
-> Maybe Style

style - a Style, or Nothing to remove the effect of a previous widgetSetStyle and go back to the default style

-> IO () 

Sets the Style for a widget. You probably don't want to use this function; it interacts badly with themes, because themes work by replacing the Style. Instead, use widgetModifyStyle.

widgetGetStyle :: WidgetClass widget => widget -> IO StyleSource

Retrieve the Style associated with the widget.

widgetPushColormapSource

Arguments

:: Colormap

cmap - a Colormap

-> IO () 

Pushes cmap onto a global stack of colormaps; the topmost colormap on the stack will be used to create all widgets. Remove cmap with widgetPopColormap. There's little reason to use this function.

widgetPopColormap :: IO ()Source

Removes a colormap pushed with widgetPushColormap.

widgetSetDefaultColormapSource

Arguments

:: Colormap

colormap - a Colormap

-> IO () 

Sets the default colormap to use when creating widgets. widgetPushColormap is a better function to use if you only want to affect a few widgets, rather than all widgets.

widgetGetDefaultStyleSource

Arguments

:: IO Style

returns the default style. This Style object is owned by Gtk and should not be modified.

Returns the default style used by all widgets initially.

widgetGetDefaultColormapSource

Arguments

:: IO Colormap

returns default widget colormap

Obtains the default colormap used to create widgets.

widgetSetDirection :: WidgetClass self => self -> TextDirection -> IO ()Source

Sets the reading direction on a particular widget. This direction controls the primary direction for widgets containing text, and also the direction in which the children of a container are packed. The ability to set the direction is present in order so that correct localization into languages with right-to-left reading directions can be done. Generally, applications will let the default reading direction present, except for containers where the containers are arranged in an order that is explicitely visual rather than logical (such as buttons for text justification).

If the direction is set to TextDirNone, then the value set by widgetSetDefaultDirection will be used.

widgetGetDirection :: WidgetClass self => self -> IO TextDirectionSource

Gets the reading direction for a particular widget. See widgetSetDirection.

widgetSetDefaultDirectionSource

Arguments

:: TextDirection

dir - the new default direction. This cannot be TextDirNone.

-> IO () 

Sets the default reading direction for widgets where the direction has not been explicitly set by widgetSetDirection.

widgetGetDefaultDirection :: IO TextDirectionSource

Obtains the current default reading direction. See widgetSetDefaultDirection.

widgetShapeCombineMaskSource

Arguments

:: WidgetClass self 
=> self 
-> Maybe Bitmap

shapeMask - shape to be added, or Nothint to remove an existing shape.

-> Int

offsetX - X position of shape mask with respect to window.

-> Int

offsetY - Y position of shape mask with respect to window.

-> IO () 

Sets a shape for this widget's DrawWindow. This allows for transparent windows etc., see windowShapeCombineMask for more information.

widgetInputShapeCombineMaskSource

Arguments

:: WidgetClass self 
=> self 
-> Maybe Bitmap

shapeMask - shape to be added, or Nothint to remove an existing shape.

-> Int

offsetX - X position of shape mask with respect to window.

-> Int

offsetY - Y position of shape mask with respect to window.

-> IO () 

Sets an input shape for this widget's GDK window. This allows for windows which react to mouse click in a nonrectangular region, see windowInputShapeCombineMask for more information.

  • Available since Gtk+ version 2.10

widgetGetTooltipWindowSource

Arguments

:: WidgetClass self 
=> self 
-> IO Window

returns The Window of the current tooltip

Returns the Window of the current tooltip. This can be the Window created by default, or the custom tooltip window set using widgetSetTooltipWindow.

  • Available since Gtk+ version 2.12

widgetSetTooltipWindowSource

Arguments

:: (WidgetClass self, WindowClass customWindow) 
=> self 
-> Maybe customWindow

customWindow a Window, or Nothing. allow-none.

-> IO () 

Replaces the default, usually yellow, window used for displaying tooltips with customWindow. GTK+ will take care of showing and hiding customWindow at the right moment, to behave likewise as the default tooltip window. If customWindow is Nothing, the default tooltip window will be used.

If the custom window should have the default theming it needs to have the name 'gtk-tooltip', see widgetSetName.

  • Available since Gtk+ version 2.12

widgetTriggerTooltipQuery :: WidgetClass self => self -> IO ()Source

Triggers a tooltip query on the display where the toplevel of widget is located. See tooltipTriggerTooltipQuery for more information.

  • Available since Gtk+ version 2.12

widgetGetSnapshotSource

Arguments

:: WidgetClass self 
=> self 
-> Rectangle 
-> IO (Maybe Pixmap)

returns Pixmap snapshot of the widget

Create a Pixmap of the contents of the widget and its children.

Works even if the widget is obscured. The depth and visual of the resulting pixmap is dependent on the widget being snapshot and likely differs from those of a target widget displaying the pixmap. The function pixbufGetFromDrawable can be used to convert the pixmap to a visual independant representation.

The snapshot area used by this function is the widget's allocation plus any extra space occupied by additional windows belonging to this widget (such as the arrows of a spin button). Thus, the resulting snapshot pixmap is possibly larger than the allocation.

The resulting pixmap is shrunken to match the specified clipRect. The (x,y) coordinates of clipRect are interpreted widget relative. If width or height of clipRect are 0 or negative, the width or height of the resulting pixmap will be shrunken by the respective amount. For instance a clipRect { +5, +5, -10, -10 } will chop off 5 pixels at each side of the snapshot pixmap. clipRect will contain the exact widget-relative snapshot coordinates upon return. A clipRect of { -1, -1, 0, 0 } can be used to preserve the auto-grown snapshot area and use clipRect as a pure output parameter.

The returned pixmap can be Nothing, if the resulting clipArea was empty.

widgetPathSource

Arguments

:: WidgetClass self 
=> self 
-> IO (Int, String, String)

(pathLength, path, pathReversed) - length of the path, path string and reverse path string

Obtains the full path to widget. The path is simply the name of a widget and all its parents in the container hierarchy, separated by periods. The name of a widget comes from widgetGetName. Paths are used to apply styles to a widget in gtkrc configuration files. Widget names are the type of the widget by default (e.g. "GtkButton") or can be set to an application-specific value with widgetSetName. By setting the name of a widget, you allow users or theme authors to apply styles to that specific widget in their gtkrc file. Also returns the path in reverse order, i.e. starting with the widget's name instead of starting with the name of the widget's outermost ancestor.

widgetClassPathSource

Arguments

:: WidgetClass self 
=> self 
-> IO (Int, String, String)

(pathLength, path, pathReversed) - length of the path, path string and reverse path string

Same as widgetPath, but always uses the name of a widget's type, never uses a custom name set with widgetSetName.

widgetGetCompositeNameSource

Arguments

:: WidgetClass self 
=> self 
-> IO (Maybe String)

returns the composite name of widget, or Nothing if widget is not a composite child.

Obtains the composite name of a widget.

widgetModifyStyleSource

Arguments

:: (WidgetClass self, RcStyleClass style) 
=> self 
-> style

style - the RcStyle holding the style modifications

-> IO () 

Modifies style values on the widget. Modifications made using this technique take precedence over style values set via an RC file, however, they will be overriden if a style is explicitely set on the widget using widgetSetStyle. The RcStyle structure is designed so each field can either be set or unset, so it is possible, using this function, to modify some style values and leave the others unchanged.

Note that modifications made with this function are not cumulative with previous calls to widgetModifyStyle or with such functions as widgetModifyFg. If you wish to retain previous values, you must first call widgetGetModifierStyle, make your modifications to the returned style, then call widgetModifyStyle with that style. On the other hand, if you first call widgetModifyStyle, subsequent calls to such functions widgetModifyFg will have a cumulative effect with the initial modifications.

widgetGetModifierStyle :: WidgetClass self => self -> IO RcStyleSource

Returns the current modifier style for the widget. (As set by widgetModifyStyle.) If no style has previously set, a new RcStyle will be created with all values unset, and set as the modifier style for the widget. If you make changes to this rc style, you must call widgetModifyStyle, passing in the returned rc style, to make sure that your changes take effect.

Caution: passing the style back to widgetModifyStyle will normally end up destroying it, because widgetModifyStyle copies the passed-in style and sets the copy as the new modifier style, thus dropping any reference to the old modifier style. Add a reference to the modifier style if you want to keep it alive.

widgetModifyFgSource

Arguments

:: WidgetClass self 
=> self 
-> StateType

state - the state for which to set the foreground color.

-> Color

color - the color to assign (does not need to be allocated)

-> IO () 

Sets the foreground color for a widget in a particular state. All other style values are left untouched. See also widgetModifyStyle.

widgetModifyBgSource

Arguments

:: WidgetClass self 
=> self 
-> StateType

state - the state for which to set the background color.

-> Color

color - the color to assign (does not need to be allocated).

-> IO () 

Sets the background color for a widget in a particular state. All other style values are left untouched. See also widgetModifyStyle.

Note that "no window" widgets (which have the NoWindow flag set) draw on their parent container's window and thus may not draw any background themselves. This is the case for e.g. Label. To modify the background of such widgets, you have to set the background color on their parent; if you want to set the background of a rectangular area around a label, try placing the label in a EventBox widget and setting the background color on that.

widgetModifyTextSource

Arguments

:: WidgetClass self 
=> self 
-> StateType

state - the state for which to set the text color.

-> Color

color - the color to assign (does not need to be allocated).

-> IO () 

Sets the text color for a widget in a particular state. All other style values are left untouched. The text color is the foreground color used along with the base color (see widgetModifyBase) for widgets such as Entry and TextView. See also widgetModifyStyle.

widgetModifyBaseSource

Arguments

:: WidgetClass self 
=> self 
-> StateType

state - the state for which to set the base color.

-> Color

color - the color to assign (does not need to be allocated).

-> IO () 

Sets the base color for a widget in a particular state. All other style values are left untouched. The base color is the background color used along with the text color (see widgetModifyText) for widgets such as Entry and TextView. See also widgetModifyStyle.

Note that "no window" widgets (which have the NoWindow flag set) draw on their parent container's window and thus may not draw any background themselves. This is the case for e.g. Label. To modify the background of such widgets, you have to set the base color on their parent; if you want to set the background of a rectangular area around a label, try placing the label in a EventBox widget and setting the base color on that.

widgetModifyFontSource

Arguments

:: WidgetClass self 
=> self 
-> Maybe FontDescription

fontDesc - the font description to use, or Nothing to undo the effect of previous calls to widgetModifyFont.

-> IO () 

Sets the font to use for a widget. All other style values are left untouched. See also widgetModifyStyle.

widgetRestoreFgSource

Arguments

:: WidgetClass self 
=> self 
-> StateType

state - the state for which to restore the foreground color.

-> IO () 

Restores the foreground color for a widget in a particular state. This undoes the effects of previous calls to widgetModifyFg.

widgetRestoreBgSource

Arguments

:: WidgetClass self 
=> self 
-> StateType

state - the state for which to restore the background color.

-> IO () 

Restores the background color for a widget in a particular state. This undoes the effects of previous calls to widgetModifyBg.

widgetRestoreTextSource

Arguments

:: WidgetClass self 
=> self 
-> StateType

state - the state for which to restore the text color.

-> IO () 

Restores the text color for a widget in a particular state. This undoes the effects of previous calls to widgetModifyText.

widgetRestoreBaseSource

Arguments

:: WidgetClass self 
=> self 
-> StateType

state - the state for which to restore the base color.

-> IO () 

Restores the base color for a widget in a particular state. This undoes the effects of previous calls to widgetModifyBase.

widgetCreatePangoContextSource

Arguments

:: WidgetClass self 
=> self 
-> IO PangoContext

returns the new PangoContext

Creates a new PangoContext with the appropriate colormap, font description, and base direction for drawing text for this widget. See also widgetGetPangoContext.

widgetGetPangoContextSource

Arguments

:: WidgetClass self 
=> self 
-> IO PangoContext

returns the PangoContext for the widget.

Gets a PangoContext with the appropriate font description and base direction for this widget. Unlike the context returned by widgetCreatePangoContext, this context is owned by the widget (it can be used until the screen for the widget changes or the widget is removed from its toplevel), and will be updated to match any changes to the widget's attributes.

If you create and keep a PangoLayout using this context, you must deal with changes to the context by calling layoutContextChanged on the layout in response to the onStyleChanged and onDirectionChanged signals for the widget.

widgetCreateLayoutSource

Arguments

:: WidgetClass self 
=> self 
-> String

text - text to set on the layout

-> IO PangoLayout 

Prepare text for display.

The PangoLayout represents the rendered text. It can be shown on screen by calling drawLayout.

The returned PangoLayout shares the same font information (PangoContext) as this widget. If this information changes, the PangoLayout should change. The following code ensures that the displayed text always reflects the widget's settings:

 l <- widgetCreateLayout w "My Text."
 let update = do
 layoutContextChanged l
 -- update the Drawables which show this layout
 w `onDirectionChanged` update
 w `onStyleChanged` update

widgetRenderIconSource

Arguments

:: WidgetClass self 
=> self 
-> String

stockId - a stock ID

-> IconSize

size - a stock size

-> String

detail - render detail to pass to theme engine

-> IO (Maybe Pixbuf)

returns a new pixbuf, or Nothing if the stock ID wasn't known

A convenience function that uses the theme engine and RC file settings for widget to look up the stock icon and render it to a Pixbuf. The icon should be one of the stock id constants such as stockOpen. size should be a size such as IconSizeMenu. detail should be a string that identifies the widget or code doing the rendering, so that theme engines can special-case rendering for that widget or code.

The pixels in the returned Pixbuf are shared with the rest of the application and should not be modified.

widgetQueueDrawAreaSource

Arguments

:: WidgetClass self 
=> self 
-> Int

x - x coordinate of upper-left corner of rectangle to redraw

-> Int

y - y coordinate of upper-left corner of rectangle to redraw

-> Int

width - width of region to draw

-> Int

height - height of region to draw

-> IO () 

Invalidates the rectangular area of widget defined by x, y, width and height by calling drawWindowInvalidateRect on the widget's DrawWindow and all its child windows. Once the main loop becomes idle (after the current batch of events has been processed, roughly), the window will receive expose events for the union of all regions that have been invalidated.

Normally you would only use this function in widget implementations. In particular, you might use it, or drawWindowInvalidateRect directly, to schedule a redraw of a DrawingArea or some portion thereof.

Frequently you can just call windowInvalidateRect or windowInvalidateRegion instead of this function. Those functions will invalidate only a single window, instead of the widget and all its children.

The advantage of adding to the invalidated region compared to simply drawing immediately is efficiency; using an invalid region ensures that you only have to redraw one time.

widgetResetShapes :: WidgetClass self => self -> IO ()Source

Recursively resets the shape on this widget and its descendants.

widgetSetAppPaintableSource

Arguments

:: WidgetClass self 
=> self 
-> Bool

appPaintable - True if the application will paint on the widget

-> IO () 

Sets whether the application intends to draw on the widget in response to an onExpose signal.

  • This is a hint to the widget and does not affect the behavior of the GTK+ core; many widgets ignore this flag entirely. For widgets that do pay attention to the flag, such as EventBox and Window, the effect is to suppress default themed drawing of the widget's background. (Children of the widget will still be drawn.) The application is then entirely responsible for drawing the widget background.

widgetSetDoubleBufferedSource

Arguments

:: WidgetClass self 
=> self 
-> Bool

doubleBuffered - True to double-buffer a widget

-> IO () 

Widgets are double buffered by default; you can use this function to turn off the buffering. "Double buffered" simply means that drawWindowBeginPaintRegion and drawWindowEndPaint are called automatically around expose events sent to the widget. drawWindowBeginPaintRegion diverts all drawing to a widget's window to an offscreen buffer, and drawWindowEndPaint draws the buffer to the screen. The result is that users see the window update in one smooth step, and don't see individual graphics primitives being rendered.

In very simple terms, double buffered widgets don't flicker, so you would only use this function to turn off double buffering if you had special needs and really knew what you were doing.

Note: if you turn off double-buffering, you have to handle expose events, since even the clearing to the background color or pixmap will not happen automatically (as it is done in drawWindowBeginPaint).

widgetSetRedrawOnAllocateSource

Arguments

:: WidgetClass self 
=> self 
-> Bool

redrawOnAllocate - if True, the entire widget will be redrawn when it is allocated to a new size. Otherwise, only the new portion of the widget will be redrawn.

-> IO () 

Sets whether the entire widget is queued for drawing when its size allocation changes. By default, this setting is True and the entire widget is redrawn on every size change. If your widget leaves the upper left unchanged when made bigger, turning this setting on will improve performance.

Note that for "no window" widgets setting this flag to False turns off all allocation on resizing: the widget will not even redraw if its position changes; this is to allow containers that don't draw anything to avoid excess invalidations. If you set this flag on a "no window" widget that does draw its window, you are responsible for invalidating both the old and new allocation of the widget when the widget is moved and responsible for invalidating regions newly when the widget increases size.

widgetSetCompositeNameSource

Arguments

:: WidgetClass self 
=> self 
-> String

name - the name to set.

-> IO () 

Sets a widgets composite name. A child widget of a container is composite if it serves as an internal widget and, thus, is not added by the user.

widgetSetScrollAdjustmentsSource

Arguments

:: WidgetClass self 
=> self 
-> Maybe Adjustment

hadjustment - an adjustment for horizontal scrolling, or Nothing

-> Maybe Adjustment

vadjustment - an adjustment for vertical scrolling, or Nothing

-> IO Bool

returns True if the widget supports scrolling

For widgets that support scrolling, sets the scroll adjustments and returns True. For widgets that don't support scrolling, does nothing and returns False. Widgets that don't support scrolling can be scrolled by placing them in a Viewport, which does support scrolling.

widgetRegionIntersectSource

Arguments

:: WidgetClass self 
=> self 
-> Region

region - a Region in the same coordinate system as the widget's allocation. That is, relative to the widget's DrawWindow for NoWindow widgets; relative to the parent DrawWindow of the widget's DrawWindow for widgets with their own DrawWindow.

-> IO Region

returns A region holding the intersection of the widget and region. The coordinates of the return value are relative to the widget's DrawWindow, if it has one, otherwise it is relative to the parent's DrawWindow.

Computes the intersection of a widget's area and region, returning the intersection. The result may be empty, use regionEmpty to check.

widgetGetAccessibleSource

Arguments

:: WidgetClass self 
=> self 
-> IO Object

returns the Object associated with widget

Returns the accessible object that describes the widget to an assistive technology.

If no accessibility library is loaded (i.e. no ATK implementation library is loaded via GTK_MODULES or via another application library, such as libgnome), then this Object instance may be a no-op. Likewise, if no class-specific Object implementation is available for the widget instance in question, it will inherit an Object implementation from the first ancestor class for which such an implementation is defined.

The documentation of the ATK library contains more information about accessible objects and their uses.

widgetChildFocusSource

Arguments

:: WidgetClass self 
=> self 
-> DirectionType

direction - direction of focus movement

-> IO Bool

returns True if focus ended up inside widget

This function is used by custom widget implementations; if you're writing an app, you'd use widgetGrabFocus to move the focus to a particular widget, and containerSetFocusChain to change the focus tab order. So you may want to investigate those functions instead.

The "focus" default handler for a widget should return True if moving in direction left the focus on a focusable location inside that widget, and False if moving in direction moved the focus outside the widget. If returning True, widgets normally call widgetGrabFocus to place the focus accordingly; if returning False, they don't modify the current focus location.

widgetGetChildVisibleSource

Arguments

:: WidgetClass self 
=> self 
-> IO Bool

returns True if the widget is mapped with the parent.

Gets the value set with widgetSetChildVisible. If you feel a need to use this function, your code probably needs reorganization.

This function is only useful for container implementations and never should be called by an application.

widgetGetParent :: WidgetClass self => self -> IO (Maybe Widget)Source

Returns the parent container of widget.

  • Returns the parent container of widget if it has one.

widgetGetSettingsSource

Arguments

:: WidgetClass self 
=> self 
-> IO Settings

returns the relevant Settings object

Gets the settings object holding the settings (global property settings, RC file information, etc) used for this widget.

Note that this function can only be called when the Widget is attached to a toplevel, since the settings object is specific to a particular Screen.

widgetGetClipboardSource

Arguments

:: WidgetClass self 
=> self 
-> SelectionTag

selection a Atom which identifies the clipboard to use. selectionClipboard gives the default clipboard. Another common value is selectionPrimary, which gives the primary X selection.

-> IO Clipboard

returns the appropriate clipboard object. If no clipboard already exists, a new one will be created.

Returns the clipboard object for the given selection to be used with widget. widget must have a Display associated with it, so must be attached to a toplevel window.

widgetGetDisplaySource

Arguments

:: WidgetClass self 
=> self 
-> IO Display

returns the Display for the toplevel for this widget.

Get the Display for the toplevel window associated with this widget. This function can only be called after the widget has been added to a widget hierarchy with a Window at the top.

In general, you should only create display specific resources when a widget has been realized, and you should free those resources when the widget is unrealized.

  • Available since Gtk+ version 2.2

widgetGetRootWindowSource

Arguments

:: WidgetClass self 
=> self 
-> IO DrawWindow

returns the DrawWindow root window for the toplevel for this widget.

Get the root window where this widget is located. This function can only be called after the widget has been added to a widget heirarchy with Window at the top.

The root window is useful for such purposes as creating a popup DrawWindow associated with the window. In general, you should only create display specific resources when a widget has been realized, and you should free those resources when the widget is unrealized.

  • Available since Gtk+ version 2.2

widgetGetScreenSource

Arguments

:: WidgetClass self 
=> self 
-> IO Screen

returns the Screen for the toplevel for this widget.

Get the Screen from the toplevel window associated with this widget. This function can only be called after the widget has been added to a widget hierarchy with a Window at the top.

In general, you should only create screen specific resources when a widget has been realized, and you should free those resources when the widget is unrealized.

  • Available since Gtk+ version 2.2

widgetHasScreenSource

Arguments

:: WidgetClass self 
=> self 
-> IO Bool

returns True if there is a Screen associcated with the widget.

Checks whether there is a Screen is associated with this widget. All toplevel widgets have an associated screen, and all widgets added into a heirarchy with a toplevel window at the top.

  • Available since Gtk+ version 2.2

widgetGetSizeRequestSource

Arguments

:: WidgetClass self 
=> self 
-> IO (Int, Int)
(width, height)

Gets the size request that was explicitly set for the widget using widgetSetSizeRequest. A value of -1 for width or height indicates that that dimension has not been set explicitly and the natural requisition of the widget will be used intead. See widgetSetSizeRequest. To get the size a widget will actually use, call widgetSizeRequest instead of this function.

widgetSetChildVisibleSource

Arguments

:: WidgetClass self 
=> self 
-> Bool

isVisible - if True, widget should be mapped along with its parent.

-> IO () 

Sets whether widget should be mapped along with its when its parent is mapped and widget has been shown with widgetShow.

The child visibility can be set for widget before it is added to a container with widgetSetParent, to avoid mapping children unnecessary before immediately unmapping them. However it will be reset to its default state of True when the widget is removed from a container.

Note that changing the child visibility of a widget does not queue a resize on the widget. Most of the time, the size of a widget is computed from all visible children, whether or not they are mapped. If this is not the case, the container can queue a resize itself.

This function is only useful for container implementations and never should be called by an application.

widgetSetSizeRequestSource

Arguments

:: WidgetClass self 
=> self 
-> Int

width - width widget should request, or -1 to unset

-> Int

height - height widget should request, or -1 to unset

-> IO () 

Sets the minimum size of a widget; that is, the widget's size request will be width by height. You can use this function to force a widget to be either larger or smaller than it normally would be.

In most cases, windowSetDefaultSize is a better choice for toplevel windows than this function; setting the default size will still allow users to shrink the window. Setting the size request will force them to leave the window at least as large as the size request. When dealing with window sizes, windowSetGeometryHints can be a useful function as well.

Note the inherent danger of setting any fixed size - themes, translations into other languages, different fonts, and user action can all change the appropriate size for a given widget. So, it's basically impossible to hardcode a size that will always be correct.

The size request of a widget is the smallest size a widget can accept while still functioning well and drawing itself correctly. However in some strange cases a widget may be allocated less than its requested size, and in many cases a widget may be allocated more space than it requested.

If the size request in a given direction is -1 (unset), then the "natural" size request of the widget will be used instead.

Widgets can't actually be allocated a size less than 1 by 1, but you can pass 0,0 to this function to mean "as small as possible."

widgetSetNoShowAllSource

Arguments

:: WidgetClass self 
=> self 
-> Bool

noShowAll - the new value for the noShowAll property

-> IO () 

Sets the noShowAll property, which determines whether calls to widgetShowAll and widgetHideAll will affect this widget.

This is mostly for use in constructing widget hierarchies with externally controlled visibility, see UIManager.

  • Available since Gtk+ version 2.4

widgetGetNoShowAllSource

Arguments

:: WidgetClass self 
=> self 
-> IO Bool

returns the current value of the "no_show_all" property.

Returns the current value of the noShowAll property, which determines whether calls to widgetShowAll and widgetHideAll will affect this widget.

  • Available since Gtk+ version 2.4

widgetListMnemonicLabelsSource

Arguments

:: WidgetClass self 
=> self 
-> IO [Widget]

returns the list of mnemonic labels

Returns a list of the widgets, normally labels, for which this widget is a the target of a mnemonic (see for example, labelSetMnemonicWidget).

  • Available since Gtk+ version 2.4

widgetAddMnemonicLabelSource

Arguments

:: (WidgetClass self, WidgetClass label) 
=> self 
-> label

label - a Widget that acts as a mnemonic label for widget.

-> IO () 

Adds a widget to the list of mnemonic labels for this widget. (See widgetListMnemonicLabels). Note the list of mnemonic labels for the widget is cleared when the widget is destroyed, so the caller must make sure to update its internal state at this point as well, by using a connection to the destroy signal or a weak notifier.

  • Available since Gtk+ version 2.4

widgetRemoveMnemonicLabelSource

Arguments

:: (WidgetClass self, WidgetClass label) 
=> self 
-> label

label - a Widget that was previously set as a mnemnic label for widget with widgetAddMnemonicLabel.

-> IO () 

Removes a widget from the list of mnemonic labels for this widget. (See widgetListMnemonicLabels). The widget must have previously been added to the list with widgetAddMnemonicLabel.

  • Available since Gtk+ version 2.4

widgetGetActionSource

Arguments

:: WidgetClass self 
=> self 
-> IO (Maybe Action)

returns the action that a widget is a proxy for, or Nothing, if it is not attached to an action.

Returns the Action that widget is a proxy for. See also actionGetProxies.

  • Available since Gtk+ version 2.10

widgetIsCompositedSource

Arguments

:: WidgetClass self 
=> self 
-> IO Bool

returns True if the widget can rely on its alpha channel being drawn correctly.

Whether widget can rely on having its alpha channel drawn correctly. On X11 this function returns whether a compositing manager is running for widget's screen

  • Available since Gtk+ version 2.10

widgetReparentSource

Arguments

:: (WidgetClass self, WidgetClass newParent) 
=> self 
-> newParent

newParent - a Container to move the widget into

-> IO () 

Moves a widget from one Container to another.

widgetGetCanFocus :: WidgetClass self => self -> IO BoolSource

Check if this widget can receive keyboard input.

widgetSetCanFocus :: WidgetClass self => self -> Bool -> IO ()Source

Set if this widget can receive keyboard input.

  • To use the keyPress event, the widget must be allowed to get the input focus. Once it has the input focus all keyboard input is directed to this widget.

widgetGetAllocation :: WidgetClass self => self -> IO AllocationSource

Retrieves the widget's allocation.

  • Available since Gtk+ version 2.18

widgetGetState :: WidgetClass self => self -> IO StateTypeSource

Retrieve the current state of the widget.

  • The state refers to different modes of user interaction, see StateType for more information.

widgetSetState :: WidgetClass self => self -> StateType -> IO ()Source

This function is for use in widget implementations. Sets the state of a widget (insensitive, prelighted, etc.) Usually you should set the state using wrapper functions such as widgetSetSensitive.

widgetGetSavedState :: WidgetClass w => w -> IO StateTypeSource

Retrieve the current state of the widget.

  • If a widget is turned insensitive, the previous state is stored in a specific location. This function retrieves this previous state.

widgetGetSize :: WidgetClass widget => widget -> IO (Int, Int)Source

Returns the current size.

  • This information may be out of date if the user is resizing the window.

widgetEvent :: WidgetClass self => self -> EventM t BoolSource

Rarely-used function. This function is used to emit the event signals on a widget (those signals should never be emitted without using this function to do so). If you want to synthesize an event though, don't use this function; instead, use mainDoEvent so the event will behave as if it were in the event queue. Don't synthesize expose events; instead, use windowInvalidateRect to invalidate a region of the window.

Attributes

widgetName :: WidgetClass self => Attr self (Maybe String)Source

The name of the widget.

Default value: Nothing

widgetParent :: (WidgetClass self, ContainerClass container) => ReadWriteAttr self (Maybe Container) (Maybe container)Source

The parent widget of this widget. Must be a Container widget.

widgetWidthRequest :: WidgetClass self => Attr self IntSource

Override for width request of the widget, or -1 if natural request should be used.

Allowed values: >= -1

Default value: -1

widgetHeightRequest :: WidgetClass self => Attr self IntSource

Override for height request of the widget, or -1 if natural request should be used.

Allowed values: >= -1

Default value: -1

widgetVisible :: WidgetClass self => Attr self BoolSource

Whether the widget is visible.

Default value: False

widgetSensitive :: WidgetClass self => Attr self BoolSource

Whether the widget responds to input.

Default value: True

widgetAppPaintable :: WidgetClass self => Attr self BoolSource

Whether the application will paint directly on the widget.

Default value: False

widgetCanFocus :: WidgetClass self => Attr self BoolSource

Whether the widget can accept the input focus.

Default value: False

widgetHasFocus :: WidgetClass self => Attr self BoolSource

Whether the widget has the input focus.

Default value: False

widgetIsFocus :: WidgetClass self => Attr self BoolSource

Whether the widget is the focus widget within the toplevel.

Default value: False

widgetCanDefault :: WidgetClass self => Attr self BoolSource

Whether the widget can be the default widget.

Default value: False

widgetHasDefault :: WidgetClass self => Attr self BoolSource

Whether the widget is the default widget.

Default value: False

widgetReceivesDefault :: WidgetClass self => Attr self BoolSource

If True, the widget will receive the default action when it is focused.

Default value: False

widgetCompositeChild :: WidgetClass self => ReadAttr self BoolSource

Whether the widget is part of a composite widget.

Default value: False

widgetStyle :: WidgetClass self => Attr self StyleSource

The style of the widget, which contains information about how it will look (colors etc).

widgetState :: WidgetClass self => Attr self StateTypeSource

The current visual user interaction state of the widget (insensitive, prelighted, selected etc). See StateType for more information.

widgetEvents :: WidgetClass self => Attr self [EventMask]Source

The event mask that decides what kind of GdkEvents this widget gets.

Default value: StructureMask

widgetExtensionEvents :: WidgetClass self => Attr self [ExtensionMode]Source

The mask that decides what kind of extension events this widget gets.

Default value: ExtensionEventsNone

widgetNoShowAll :: WidgetClass self => Attr self BoolSource

Whether widgetShowAll should not affect this widget.

Default value: False

widgetColormap :: WidgetClass self => Attr self ColormapSource

'colormap' property. See widgetGetColormap and widgetSetColormap

widgetTooltipMarkup :: WidgetClass self => Attr self (Maybe Markup)Source

Sets the text of tooltip to be the given string, which is marked up with the Pango text markup language. Also see tooltipSetMarkup.

This is a convenience property which will take care of getting the tooltip shown if the given string is not "": hasTooltip will automatically be set to True and there will be taken care of queryTooltip in the default signal handler.

Default value: ""

  • Available since Gtk+ version 2.12

widgetTooltipText :: WidgetClass self => Attr self (Maybe String)Source

Sets the text of tooltip to be the given string.

Also see tooltipSetText.

This is a convenience property which will take care of getting the tooltip shown if the given string is not "": hasTooltip will automatically be set to True and there will be taken care of queryTooltip in the default signal handler.

Default value: ""

  • Available since Gtk+ version 2.12

widgetHasTooltip :: WidgetClass self => Attr self BoolSource

Enables or disables the emission of queryTooltip on widget. A value of True indicates that widget can have a tooltip, in this case the widget will be queried using queryTooltip to determine whether it will provide a tooltip or not.

Note that setting this property to True for the first time will change the event masks of the Windows of this widget to include leave-notify and motion-notify events. This cannot and will not be undone when the property is set to False again.

Default value: False

  • Available since Gtk+ version 2.12

widgetHasRcStyleSource

Arguments

:: WidgetClass self 
=> self 
-> IO Bool

returns True if the widget has been looked up through the rc mechanism, False otherwise.

Determines if the widget style has been looked up through the rc mechanism.

widgetGetRealizedSource

Arguments

:: WidgetClass self 
=> self 
-> IO Bool

returns True if widget is realized, False otherwise

Determines whether widget is realized.

widgetGetMappedSource

Arguments

:: WidgetClass self 
=> self 
-> IO Bool

returns True if the widget is mapped, False otherwise.

Whether the widget is mapped.

Signals

realize :: WidgetClass self => Signal self (IO ())Source

The widget should allocate any resources needed, in particular, the widget's DrawWindow is created. If you connect to this signal and you rely on some of these resources to be present, you have to use after.

unrealize :: WidgetClass self => Signal self (IO ())Source

The widget should deallocate any resources. This signal is emitted before the widget is destroyed.

mapSignal :: WidgetClass self => Signal self (IO ())Source

The widget appears on screen.

unmapSignal :: WidgetClass self => Signal self (IO ())Source

The widget disappears from the screen.

sizeRequest :: WidgetClass self => Signal self (IO Requisition)Source

Query the widget for the size it likes to have.

  • A parent container emits this signal to its child to query the needed height and width of the child. There is not guarantee that the widget will actually get this area.

sizeAllocate :: WidgetClass self => Signal self (Allocation -> IO ())Source

Inform widget about the size it has.

  • After querying a widget for the size it wants to have (through emitting the "sizeRequest" signal) a container will emit this signal to inform the widget about the real size it should occupy.

showSignal :: WidgetClass self => Signal self (IO ())Source

The widget is shown.

hideSignal :: WidgetClass self => Signal self (IO ())Source

The widget is hidden.

focus :: WidgetClass self => Signal self (DirectionType -> IO Bool)Source

The widget gains focus via the given user action.

stateChanged :: WidgetClass self => Signal self (StateType -> IO ())Source

The state of the widget (input focus, insensitive, etc.) has changed.

parentSet :: WidgetClass self => Signal self (Maybe Widget -> IO ())Source

The parentSet signal is emitted when a new parent has been set on a widget. The parameter is the new parent.

hierarchyChanged :: WidgetClass self => Signal self (Maybe Widget -> IO ())Source

Emitted when there is a change in the hierarchy to which a widget belong. More precisely, a widget is anchored when its toplevel ancestor is a Window. This signal is emitted when a widget changes from un-anchored to anchored or vice-versa.

styleSet :: WidgetClass self => Signal self (Style -> IO ())Source

The styleSet signal is emitted when a new style has been set on a widget. Note that style-modifying functions like widgetModifyBase also cause this signal to be emitted.

directionChanged :: WidgetClass self => Signal self (TextDirection -> IO ())Source

The default direction of text writing has changed.

grabNotify :: WidgetClass self => Signal self (Bool -> IO ())Source

The grabNotify signal is emitted when a widget becomes shadowed by a Gtk+ grab (not a pointer or keyboard grab) on another widget, or when it becomes unshadowed due to a grab being removed.

A widget is shadowed by a grabAdd when the topmost grab widget in the grab stack of its window group is not its ancestor.

popupMenuSignal :: WidgetClass self => Signal self (IO Bool)Source

This signal gets emitted whenever a widget should pop up a context-sensitive menu. This usually happens through the standard key binding mechanism; by pressing a certain key while a widget is focused, the user can cause the widget to pop up a menu. For example, the Entry widget creates a menu with clipboard commands.

showHelp :: WidgetClass self => Signal self (WidgetHelpType -> IO Bool)Source

Tell the widget to show an explanatory help text. Should return True if help has been shown.

accelClosuresChanged :: WidgetClass self => Signal self (IO ())Source

The set of keyboard accelerators has changed.

screenChanged :: WidgetClass self => Signal self (Screen -> IO ())Source

The widget moved to a new screen.

queryTooltip :: WidgetClass self => Signal self (Widget -> Maybe Point -> Tooltip -> IO Bool)Source

Emitted when hasTooltip is True and the gtkTooltipTimeout has expired with the cursor hovering above widget; or emitted when widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for widget. If this is the case True should be returned, False otherwise. Note if widget got focus in keyboard mode, Point is Nothing.

The signal handler is free to manipulate tooltip with the therefore destined function calls.

  • Available since Gtk+ version 2.12

Events

buttonPressEvent :: WidgetClass self => Signal self (EventM EButton Bool)Source

A mouse button has been depressed while the mouse pointer was within the widget area. Sets the widget's ButtonPressMask flag.

buttonReleaseEvent :: WidgetClass self => Signal self (EventM EButton Bool)Source

A mouse button has been released. Sets the widget's ButtonReleaseMask flag.

configureEvent :: WidgetClass self => Signal self (EventM EConfigure Bool)Source

The size of the window has changed.

deleteEvent :: WidgetClass self => Signal self (EventM EAny Bool)Source

The deleteEvent signal is emitted if a user requests that a toplevel window is closed. The default handler for this signal destroys the window. Calling widgetHide and returning True on reception of this signal will cause the window to be hidden instead, so that it can later be shown again without reconstructing it.

destroyEvent :: WidgetClass self => Signal self (EventM EAny Bool)Source

The destroyEvent signal is emitted when a DrawWindow is destroyed. You rarely get this signal, because most widgets disconnect themselves from their window before they destroy it, so no widget owns the window at destroy time. However, you might want to connect to the objectDestroy signal of Object.

enterNotifyEvent :: WidgetClass self => Signal self (EventM ECrossing Bool)Source

The mouse pointer has entered the widget. Sets the widget's EnterNotifyMask flag.

exposeEvent :: WidgetClass self => Signal self (EventM EExpose Bool)Source

Instructs the widget to redraw.

  • The DrawWindow that needs to be redrawn is available via eventWindow.
  • The part that needs to be redrawn is available via eventArea and eventRegion. The options are, in order of efficiency: (a) redraw the entire window, (b) ask for the eventArea and redraw that rectangle, (c) ask for the eventRegion and redraw each of those rectangles.

Only the exposed region will be updated; see also drawWindowBeginPaintRegion.

focusInEvent :: WidgetClass self => Signal self (EventM EFocus Bool)Source

The widget gets the input focus. Sets the widget's FocusChangeMask flag.

focusOutEvent :: WidgetClass self => Signal self (EventM EFocus Bool)Source

The widget lost the input focus. Sets the widget's FocusChangeMask flag.

grabBrokenEvent :: WidgetClass self => Signal self (EventM EGrabBroken Bool)Source

Emitted when a pointer or keyboard grab on a window belonging to widget gets broken.

On X11, this happens when the grab window becomes unviewable (i.e. it or one of its ancestors is unmapped), or if the same application grabs the pointer or keyboard again.

  • Available since Gtk+ version 2.8

keyPressEvent :: WidgetClass self => Signal self (EventM EKey Bool)Source

A key has been depressed. Sets the widget's KeyPressMask flag.

keyReleaseEvent :: WidgetClass self => Signal self (EventM EKey Bool)Source

A key has been released. Sets the widget's KeyReleaseMask flag.

leaveNotifyEvent :: WidgetClass self => Signal self (EventM ECrossing Bool)Source

The mouse pointer has left the widget. Sets the widget's LeaveNotifyMask flag.

mapEvent :: WidgetClass self => Signal self (EventM EAny Bool)Source

The window is put onto the screen.

motionNotifyEvent :: WidgetClass self => Signal self (EventM EMotion Bool)Source

The mouse pointer has moved. Since receiving all mouse movements is expensive, it is necessary to specify exactly what mouse motions are required by calling widgetAddEvents on this widget with one or more of the following flags:

  • PointerMotionMask: Track all movements.
  • ButtonMotionMask: Only track movements if a button is depressed.
  • Button1MotionMask: Only track movements if the left button is depressed.
  • Button2MotionMask: Only track movements if the middle button is depressed.
  • Button3MotionMask: Only track movements if the right button is depressed. PointerMotionHintMask is a special flag which can be used in combination with any of the above and is used to reduce the number of motionNotifyEvents received. Normally a motionNotifyEvent event is received each time the mouse moves. However, if the application spends a lot of time processing the event (updating the display, for example), it can lag behind the position of the mouse. When using PointerMotionHintMask, fewer motionNotifyEvents will be sent, some of which are marked as a hint. To receive more motion events after a motion hint event, the application needs to asks for more, by calling eventRequestMotions. This effectively limits the rate at which new motion events are received. (Note that you don't need to check if the hint is set as eventRequestMotions does so automatically.)

noExposeEvent :: WidgetClass self => Signal self (EventM EAny Bool)Source

Generated when the area of a Drawable being copied using, e.g. drawDrawable, is completely available.

proximityInEvent :: WidgetClass self => Signal self (EventM EProximity Bool)Source

The pen of a graphics tablet was put down. Sets the widget's ProximityInMask flag.

proximityOutEvent :: WidgetClass self => Signal self (EventM EProximity Bool)Source

The pen of a graphics tablet was lifted off the tablet. Sets the widget's ProximityOutMask flag.

scrollEvent :: WidgetClass self => Signal self (EventM EScroll Bool)Source

The scroll wheel of the mouse has been used. Sets the widget's ScrollMask flag.

unmapEvent :: WidgetClass self => Signal self (EventM EAny Bool)Source

The window is taken off the screen.

visibilityNotifyEvent :: WidgetClass self => Signal self (EventM EVisibility Bool)Source

Emitted when the window visibility status has changed. Sets the widget's VisibilityNotifyMask flag.

windowStateEvent :: WidgetClass self => Signal self (EventM EWindowState Bool)Source

Emitted when the state of the window changes, i.e. when it is minimized, moved to the top, etc.

Deprecated

onButtonPress, afterButtonPress :: WidgetClass w => w -> (Event -> IO Bool) -> IO (ConnectId w)Source

A Button was pressed.

  • This widget is part of a button which was just pressed. The event passed to the user function is a Button event.

onButtonRelease, afterButtonRelease :: WidgetClass w => w -> (Event -> IO Bool) -> IO (ConnectId w)Source

A Button was released.

onConfigure, afterConfigure :: WidgetClass w => w -> (Event -> IO Bool) -> IO (ConnectId w)Source

The widget's status has changed.

onDelete, afterDelete :: WidgetClass w => w -> (Event -> IO Bool) -> IO (ConnectId w)Source

This signal is emitted when the close icon on the surrounding window is pressed. The default action is to emit the "destroy" signal.

onDestroyEvent, afterDestroyEvent :: WidgetClass w => w -> (Event -> IO Bool) -> IO (ConnectId w)Source

The widget will be destroyed.

  • The widget received a destroy event from the window manager.

onDirectionChanged, afterDirectionChanged :: WidgetClass w => w -> (Event -> IO Bool) -> IO (ConnectId w)Source

The default text direction was changed.

onEnterNotify, afterEnterNotify :: WidgetClass w => w -> (Event -> IO Bool) -> IO (ConnectId w)Source

Mouse cursor entered widget.

onLeaveNotify, afterLeaveNotify :: WidgetClass w => w -> (Event -> IO Bool) -> IO (ConnectId w)Source

Mouse cursor leaves widget.

onExpose, afterExpose :: WidgetClass w => w -> (Event -> IO Bool) -> IO (ConnectId w)Source

Instructs the widget to redraw.

  • This event is useful for the DrawingArea. On receiving this signal the content of the passed Rectangle or Region needs to be redrawn. The return value should be True if the region was completely redrawn and False if other handlers in the chain should be invoked. If a client will redraw the whole area and is not interested in the extra information in Expose, it is more efficient to use onExposeRect.
  • Widgets that are very expensive to re-render, such as an image editor, may prefer to use the onExpose call back which delivers a Region in addition to a Rectangle. A Region consists of several rectangles that need redrawing. The simpler onExposeRect event encodes the area to be redrawn as a bounding rectangle which might be easier to deal with in a particular application.

onExposeRect, afterExposeRect :: WidgetClass w => w -> (Rectangle -> IO ()) -> IO (ConnectId w)Source

Expose event delivering a Rectangle.

onFocus, afterFocus :: WidgetClass w => w -> (DirectionType -> IO Bool) -> IO (ConnectId w)Source

This signal is called if the widget receives the input focus.

onFocusIn, afterFocusIn :: WidgetClass w => w -> (Event -> IO Bool) -> IO (ConnectId w)Source

Widget gains input focus.

onFocusOut, afterFocusOut :: WidgetClass w => w -> (Event -> IO Bool) -> IO (ConnectId w)Source

Widget looses input focus.

onGrabFocus, afterGrabFocus :: WidgetClass w => w -> IO () -> IO (ConnectId w)Source

The widget is about to receive all events.

  • It is possible to redirect all input events to one widget to force the user to use only this widget. Such a situation is initiated by addGrab.

onDestroy, afterDestroy :: WidgetClass w => w -> IO () -> IO (ConnectId w)Source

The widget will be destroyed.

  • This is the last signal this widget will receive.

onHide, afterHide :: WidgetClass w => w -> IO () -> IO (ConnectId w)Source

The widget was asked to hide itself.

  • This signal is emitted each time widgetHide is called. Use onUnmap when your application needs to be informed when the widget is actually removed from screen.

onHierarchyChanged, afterHierarchyChanged :: WidgetClass w => w -> IO () -> IO (ConnectId w)Source

The toplevel window changed.

  • When a subtree of widgets is removed or added from a tree with a toplevel window this signal is emitted. It is emitted on each widget in the detached or attached subtree.

onKeyPress, afterKeyPress :: WidgetClass w => w -> (Event -> IO Bool) -> IO (ConnectId w)Source

A key was pressed.

onKeyRelease, afterKeyRelease :: WidgetClass w => w -> (Event -> IO Bool) -> IO (ConnectId w)Source

A key was released.

onMotionNotify, afterMotionNotify :: WidgetClass w => w -> Bool -> (Event -> IO Bool) -> IO (ConnectId w)Source

Track mouse movements.

  • If hint is False, a callback for every movement of the mouse is generated. To avoid a backlog of mouse messages, it is usually sufficient to sent hint to True, generating only one event. The application now has to state that it is ready for the next message by calling drawWindowGetPointer.

onProximityIn, afterProximityIn :: WidgetClass w => w -> (Event -> IO Bool) -> IO (ConnectId w)Source

The input device became active.

  • This event indicates that a pen of a graphics tablet or similar device is now touching the tablet.

onProximityOut, afterProximityOut :: WidgetClass w => w -> (Event -> IO Bool) -> IO (ConnectId w)Source

The input device became inactive.

  • The pen was removed from the graphics tablet's surface.

onRealize, afterRealize :: WidgetClass w => w -> IO () -> IO (ConnectId w)Source

This widget's drawing area is about to be destroyed.

onScroll, afterScroll :: WidgetClass w => w -> (Event -> IO Bool) -> IO (ConnectId w)Source

The mouse wheel has turned.

onShow, afterShow :: WidgetClass w => w -> IO () -> IO (ConnectId w)Source

The widget was asked to show itself.

  • This signal is emitted each time widgetShow is called. Use onMap when your application needs to be informed when the widget is actually shown.

onSizeAllocate, afterSizeAllocate :: WidgetClass w => w -> (Allocation -> IO ()) -> IO (ConnectId w)Source

Inform widget about the size it has.

  • After querying a widget for the size it wants to have (through emitting the "sizeRequest" signal) a container will emit this signal to inform the widget about the real size it should occupy.

onSizeRequest, afterSizeRequest :: WidgetClass w => w -> IO Requisition -> IO (ConnectId w)Source

Query the widget for the size it likes to have.

  • A parent container emits this signal to its child to query the needed height and width of the child. There is not guarantee that the widget will actually get this area.

onUnmap, afterUnmap :: WidgetClass w => w -> IO () -> IO (ConnectId w)Source

The widget was removed from screen.

onUnrealize, afterUnrealize :: WidgetClass w => w -> IO () -> IO (ConnectId w)Source

This widget's drawing area is about to be destroyed.