gi-gtk-3.0.43: Gtk bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | None
Language | Haskell2010

GI.Gtk.Objects.HandleBox

Contents

- Exported types
- Methods
  - getChildDetached
  - getHandlePosition
  - getShadowType
  - getSnapEdge
  - new
  - setHandlePosition
  - setShadowType
  - setSnapEdge
- Properties
  - childDetached
  - handlePosition
  - shadowType
  - snapEdge
  - snapEdgeSet
- Signals
  - childAttached
  - childDetached

Description

The `HandleBox` widget allows a portion of a window to be "torn off". It is a bin widget which displays its child and a handle that the user can drag to tear off a separate window (the “float window”) containing the child widget. A thin “ghost” is drawn in the original location of the handlebox. By dragging the separate window back to its original location, it can be reattached.

When reattaching, the ghost and float window, must be aligned along one of the edges, the “snap edge”. This either can be specified by the application programmer explicitly, or GTK+ will pick a reasonable default based on the handle position.

To make detaching and reattaching the handlebox as minimally confusing as possible to the user, it is important to set the snap edge so that the snap edge does not move when the handlebox is deattached. For instance, if the handlebox is packed at the bottom of a VBox, then when the handlebox is detached, the bottom edge of the handlebox's allocation will remain fixed as the height of the handlebox shrinks, so the snap edge should be set to `PositionTypeBottom`.

    t'GI.Gtk.Objects.HandleBox.HandleBox' has been deprecated. It is very specialized, lacks features
    to make it useful and most importantly does not fit well into modern
    application design. Do not use it. There is no replacement.

Synopsis

- newtype HandleBox = HandleBox (ManagedPtr HandleBox)
- class (GObject o, IsDescendantOf HandleBox o) => IsHandleBox o
- toHandleBox :: (MonadIO m, IsHandleBox o) => o -> m HandleBox
- handleBoxGetChildDetached :: (HasCallStack, MonadIO m, IsHandleBox a) => a -> m Bool
- handleBoxGetHandlePosition :: (HasCallStack, MonadIO m, IsHandleBox a) => a -> m PositionType
- handleBoxGetShadowType :: (HasCallStack, MonadIO m, IsHandleBox a) => a -> m ShadowType
- handleBoxGetSnapEdge :: (HasCallStack, MonadIO m, IsHandleBox a) => a -> m PositionType
- handleBoxNew :: (HasCallStack, MonadIO m) => m HandleBox
- handleBoxSetHandlePosition :: (HasCallStack, MonadIO m, IsHandleBox a) => a -> PositionType -> m ()
- handleBoxSetShadowType :: (HasCallStack, MonadIO m, IsHandleBox a) => a -> ShadowType -> m ()
- handleBoxSetSnapEdge :: (HasCallStack, MonadIO m, IsHandleBox a) => a -> PositionType -> m ()
- getHandleBoxChildDetached :: (MonadIO m, IsHandleBox o) => o -> m Bool
- constructHandleBoxHandlePosition :: (IsHandleBox o, MonadIO m) => PositionType -> m (GValueConstruct o)
- getHandleBoxHandlePosition :: (MonadIO m, IsHandleBox o) => o -> m PositionType
- setHandleBoxHandlePosition :: (MonadIO m, IsHandleBox o) => o -> PositionType -> m ()
- constructHandleBoxShadowType :: (IsHandleBox o, MonadIO m) => ShadowType -> m (GValueConstruct o)
- getHandleBoxShadowType :: (MonadIO m, IsHandleBox o) => o -> m ShadowType
- setHandleBoxShadowType :: (MonadIO m, IsHandleBox o) => o -> ShadowType -> m ()
- constructHandleBoxSnapEdge :: (IsHandleBox o, MonadIO m) => PositionType -> m (GValueConstruct o)
- getHandleBoxSnapEdge :: (MonadIO m, IsHandleBox o) => o -> m PositionType
- setHandleBoxSnapEdge :: (MonadIO m, IsHandleBox o) => o -> PositionType -> m ()
- constructHandleBoxSnapEdgeSet :: (IsHandleBox o, MonadIO m) => Bool -> m (GValueConstruct o)
- getHandleBoxSnapEdgeSet :: (MonadIO m, IsHandleBox o) => o -> m Bool
- setHandleBoxSnapEdgeSet :: (MonadIO m, IsHandleBox o) => o -> Bool -> m ()
- type HandleBoxChildAttachedCallback = Widget -> IO ()
- afterHandleBoxChildAttached :: (IsHandleBox a, MonadIO m) => a -> ((?self :: a) => HandleBoxChildAttachedCallback) -> m SignalHandlerId
- onHandleBoxChildAttached :: (IsHandleBox a, MonadIO m) => a -> ((?self :: a) => HandleBoxChildAttachedCallback) -> m SignalHandlerId
- type HandleBoxChildDetachedCallback = Widget -> IO ()
- afterHandleBoxChildDetached :: (IsHandleBox a, MonadIO m) => a -> ((?self :: a) => HandleBoxChildDetachedCallback) -> m SignalHandlerId
- onHandleBoxChildDetached :: (IsHandleBox a, MonadIO m) => a -> ((?self :: a) => HandleBoxChildDetachedCallback) -> m SignalHandlerId

# Exported types

newtype HandleBox Source #

Memory-managed wrapper type.

Constructors

HandleBox (ManagedPtr HandleBox) |

#### Instances

Instances details

Eq HandleBox Source # |
Instance details Defined in GI.Gtk.Objects.HandleBox Methods (==) :: HandleBox -> HandleBox -> Bool Source # (/=) :: HandleBox -> HandleBox -> Bool Source #
GObject HandleBox Source # |
Instance details Defined in GI.Gtk.Objects.HandleBox
ManagedPtrNewtype HandleBox Source # |
Instance details Defined in GI.Gtk.Objects.HandleBox Methods toManagedPtr :: HandleBox -> ManagedPtr HandleBox Source #
TypedObject HandleBox Source # |
Instance details Defined in GI.Gtk.Objects.HandleBox Methods glibType :: IO GType Source #
HasParentTypes HandleBox Source # |
Instance details Defined in GI.Gtk.Objects.HandleBox
IsGValue (Maybe HandleBox) Source # | Convert `HandleBox` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.HandleBox Methods gvalueGType_ :: IO GType Source # gvalueSet_ :: Ptr GValue -> Maybe HandleBox -> IO () Source # gvalueGet_ :: Ptr GValue -> IO (Maybe HandleBox) Source #
type ParentTypes HandleBox Source # |
Instance details Defined in GI.Gtk.Objects.HandleBox type ParentTypes HandleBox = '[Bin, Container, Widget, Object, ImplementorIface, Buildable]

class (GObject o, IsDescendantOf HandleBox o) => IsHandleBox o Source #

Type class for types which can be safely cast to `HandleBox`, for instance with `toHandleBox`.

#### Instances

Instances details

(GObject o, IsDescendantOf HandleBox o) => IsHandleBox o Source # |
Instance details Defined in GI.Gtk.Objects.HandleBox

toHandleBox :: (MonadIO m, IsHandleBox o) => o -> m HandleBox Source #

Cast to `HandleBox`, for types for which this is known to be safe. For general casts, use `castTo`.

# Methods

### Click to display all available methods, including inherited ones

Expand

#### Methods

activate, add, addAccelerator, addChild, addDeviceEvents, addEvents, addMnemonicLabel, addTickCallback, bindProperty, bindPropertyFull, canActivateAccel, checkResize, childFocus, childGetProperty, childNotify, childNotifyByPspec, childSetProperty, childType, classPath, computeExpand, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, destroy, destroyed, deviceIsShadowed, dragBegin, dragBeginWithCoordinates, dragCheckThreshold, dragDestAddImageTargets, dragDestAddTextTargets, dragDestAddUriTargets, dragDestFindTarget, dragDestGetTargetList, dragDestGetTrackMotion, dragDestSet, dragDestSetProxy, dragDestSetTargetList, dragDestSetTrackMotion, dragDestUnset, dragGetData, dragHighlight, dragSourceAddImageTargets, dragSourceAddTextTargets, dragSourceAddUriTargets, dragSourceGetTargetList, dragSourceSet, dragSourceSetIconGicon, dragSourceSetIconName, dragSourceSetIconPixbuf, dragSourceSetIconStock, dragSourceSetTargetList, dragSourceUnset, dragUnhighlight, draw, ensureStyle, errorBell, event, forall, forceFloating, foreach, freezeChildNotify, freezeNotify, getv, grabAdd, grabDefault, grabFocus, grabRemove, hasDefault, hasFocus, hasGrab, hasRcStyle, hasScreen, hasVisibleFocus, hide, hideOnDelete, inDestruction, initTemplate, inputShapeCombineRegion, insertActionGroup, intersect, isAncestor, isComposited, isDrawable, isFloating, isFocus, isSensitive, isToplevel, isVisible, keynavFailed, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parserFinished, path, propagateDraw, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetRcStyles, resetStyle, resizeChildren, runDispose, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, styleAttach, styleGetProperty, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unsetFocusChain, unsetStateFlags, watchClosure.

#### Getters

getAccessible, getActionGroup, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getBorderWidth, getCanDefault, getCanFocus, getChild, getChildDetached, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getHalign, getHandlePosition, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getInternalChild, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getResizeMode, getRootWindow, getScaleFactor, getScreen, getSensitive, getSettings, getShadowType, getSizeRequest, getSnapEdge, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.

#### Setters

setAccelPath, setAllocation, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHalign, setHandlePosition, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizeMode, setSensitive, setShadowType, setSizeRequest, setSnapEdge, setState, setStateFlags, setStyle, setSupportMultidevice, setTooltipMarkup, setTooltipText, setTooltipWindow, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.

## getChildDetached

handleBoxGetChildDetached Source #

Arguments

:: (HasCallStack, MonadIO m, IsHandleBox a) |
=> a | `handleBox`: a `HandleBox`
-> m Bool | Returns: `True` if the child is currently detached, otherwise `False`

Deprecated: (Since version 3.4)`HandleBox` has been deprecated.

Whether the handlebox’s child is currently detached.

Since: 2.14

## getHandlePosition

handleBoxGetHandlePosition Source #

Arguments

:: (HasCallStack, MonadIO m, IsHandleBox a) |
=> a | `handleBox`: a `HandleBox`
-> m PositionType | Returns: the current handle position.

Deprecated: (Since version 3.4)`HandleBox` has been deprecated.

Gets the handle position of the handle box. See `handleBoxSetHandlePosition`.

## getShadowType

handleBoxGetShadowType Source #

Arguments

:: (HasCallStack, MonadIO m, IsHandleBox a) |
=> a | `handleBox`: a `HandleBox`
-> m ShadowType | Returns: the type of shadow currently drawn around the handle box.

Deprecated: (Since version 3.4)`HandleBox` has been deprecated.

Gets the type of shadow drawn around the handle box. See `handleBoxSetShadowType`.

## getSnapEdge

handleBoxGetSnapEdge Source #

Arguments

:: (HasCallStack, MonadIO m, IsHandleBox a) |
=> a | `handleBox`: a `HandleBox`
-> m PositionType | Returns: the edge used for determining reattachment, or (GtkPositionType)-1 if this is determined (as per default) from the handle position.

Deprecated: (Since version 3.4)`HandleBox` has been deprecated.

Gets the edge used for determining reattachment of the handle box. See `handleBoxSetSnapEdge`.

## new

handleBoxNew Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> m HandleBox | Returns: a new `HandleBox`.

Deprecated: (Since version 3.4)`HandleBox` has been deprecated.

Create a new handle box.

## setHandlePosition

handleBoxSetHandlePosition Source #

Arguments

:: (HasCallStack, MonadIO m, IsHandleBox a) |
=> a | `handleBox`: a `HandleBox`
-> PositionType | `position`: the side of the handlebox where the handle should be drawn.
-> m () |

Deprecated: (Since version 3.4)`HandleBox` has been deprecated.

Sets the side of the handlebox where the handle is drawn.

## setShadowType

handleBoxSetShadowType Source #

Arguments

:: (HasCallStack, MonadIO m, IsHandleBox a) |
=> a | `handleBox`: a `HandleBox`
-> ShadowType | `type`: the shadow type.
-> m () |

Deprecated: (Since version 3.4)`HandleBox` has been deprecated.

Sets the type of shadow to be drawn around the border of the handle box.

## setSnapEdge

handleBoxSetSnapEdge Source #

Arguments

:: (HasCallStack, MonadIO m, IsHandleBox a) |
=> a | `handleBox`: a `HandleBox`
-> PositionType | `edge`: the snap edge, or -1 to unset the value; in which case GTK+ will try to guess an appropriate value in the future.
-> m () |

Deprecated: (Since version 3.4)`HandleBox` has been deprecated.

Sets the snap edge of a handlebox. The snap edge is the edge of the detached child that must be aligned with the corresponding edge of the “ghost” left behind when the child was detached to reattach the torn-off window. Usually, the snap edge should be chosen so that it stays in the same place on the screen when the handlebox is torn off.

If the snap edge is not set, then an appropriate value will be guessed from the handle position. If the handle position is `PositionTypeRight` or `PositionTypeLeft`, then the snap edge will be `PositionTypeTop`, otherwise it will be `PositionTypeLeft`.

# Properties

## childDetached

No description available in the introspection data.

getHandleBoxChildDetached :: (MonadIO m, IsHandleBox o) => o -> m Bool Source #

Get the value of the “`child-detached`” property. When overloading is enabled, this is equivalent to

    get handleBox #childDetached

## handlePosition

No description available in the introspection data.

constructHandleBoxHandlePosition :: (IsHandleBox o, MonadIO m) => PositionType -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`handle-position`” property. This is rarely needed directly, but it is used by `new`.

getHandleBoxHandlePosition :: (MonadIO m, IsHandleBox o) => o -> m PositionType Source #

Get the value of the “`handle-position`” property. When overloading is enabled, this is equivalent to

    get handleBox #handlePosition

setHandleBoxHandlePosition :: (MonadIO m, IsHandleBox o) => o -> PositionType -> m () Source #

Set the value of the “`handle-position`” property. When overloading is enabled, this is equivalent to

    set handleBox [ #handlePosition := value ]

## shadowType

No description available in the introspection data.

constructHandleBoxShadowType :: (IsHandleBox o, MonadIO m) => ShadowType -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`shadow-type`” property. This is rarely needed directly, but it is used by `new`.

getHandleBoxShadowType :: (MonadIO m, IsHandleBox o) => o -> m ShadowType Source #

Get the value of the “`shadow-type`” property. When overloading is enabled, this is equivalent to

    get handleBox #shadowType

setHandleBoxShadowType :: (MonadIO m, IsHandleBox o) => o -> ShadowType -> m () Source #

Set the value of the “`shadow-type`” property. When overloading is enabled, this is equivalent to

    set handleBox [ #shadowType := value ]

## snapEdge

No description available in the introspection data.

constructHandleBoxSnapEdge :: (IsHandleBox o, MonadIO m) => PositionType -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`snap-edge`” property. This is rarely needed directly, but it is used by `new`.

getHandleBoxSnapEdge :: (MonadIO m, IsHandleBox o) => o -> m PositionType Source #

Get the value of the “`snap-edge`” property. When overloading is enabled, this is equivalent to

    get handleBox #snapEdge

setHandleBoxSnapEdge :: (MonadIO m, IsHandleBox o) => o -> PositionType -> m () Source #

Set the value of the “`snap-edge`” property. When overloading is enabled, this is equivalent to

    set handleBox [ #snapEdge := value ]

## snapEdgeSet

No description available in the introspection data.

constructHandleBoxSnapEdgeSet :: (IsHandleBox o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`snap-edge-set`” property. This is rarely needed directly, but it is used by `new`.

getHandleBoxSnapEdgeSet :: (MonadIO m, IsHandleBox o) => o -> m Bool Source #

Get the value of the “`snap-edge-set`” property. When overloading is enabled, this is equivalent to

    get handleBox #snapEdgeSet

setHandleBoxSnapEdgeSet :: (MonadIO m, IsHandleBox o) => o -> Bool -> m () Source #

Set the value of the “`snap-edge-set`” property. When overloading is enabled, this is equivalent to

    set handleBox [ #snapEdgeSet := value ]

# Signals

## childAttached

type HandleBoxChildAttachedCallback Source #

Arguments

= Widget | `widget`: the child widget of the handlebox. (this argument provides no extra information and is here only for backwards-compatibility)
-> IO () |

Deprecated: (Since version 3.4)`HandleBox` has been deprecated.

This signal is emitted when the contents of the handlebox are reattached to the main window.

afterHandleBoxChildAttached :: (IsHandleBox a, MonadIO m) => a -> ((?self :: a) => HandleBoxChildAttachedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the childAttached signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after handleBox #childAttached callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onHandleBoxChildAttached :: (IsHandleBox a, MonadIO m) => a -> ((?self :: a) => HandleBoxChildAttachedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the childAttached signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on handleBox #childAttached callback

## childDetached

type HandleBoxChildDetachedCallback Source #

Arguments

= Widget | `widget`: the child widget of the handlebox. (this argument provides no extra information and is here only for backwards-compatibility)
-> IO () |

Deprecated: (Since version 3.4)`HandleBox` has been deprecated.

This signal is emitted when the contents of the handlebox are detached from the main window.

afterHandleBoxChildDetached :: (IsHandleBox a, MonadIO m) => a -> ((?self :: a) => HandleBoxChildDetachedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the childDetached signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after handleBox #childDetached callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onHandleBoxChildDetached :: (IsHandleBox a, MonadIO m) => a -> ((?self :: a) => HandleBoxChildDetachedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the childDetached signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on handleBox #childDetached callback