Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (inaki@blueleaf.cc)
Safe Haskell	None
Language	Haskell2010

GI.Gtk.Objects.HandleBox

Contents

Exported types
Methods
Properties
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.

'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
noHandleBox :: Maybe 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 => PositionType -> IO (GValueConstruct o)
getHandleBoxHandlePosition :: (MonadIO m, IsHandleBox o) => o -> m PositionType
setHandleBoxHandlePosition :: (MonadIO m, IsHandleBox o) => o -> PositionType -> m ()
constructHandleBoxShadowType :: IsHandleBox o => ShadowType -> IO (GValueConstruct o)
getHandleBoxShadowType :: (MonadIO m, IsHandleBox o) => o -> m ShadowType
setHandleBoxShadowType :: (MonadIO m, IsHandleBox o) => o -> ShadowType -> m ()
constructHandleBoxSnapEdge :: IsHandleBox o => PositionType -> IO (GValueConstruct o)
getHandleBoxSnapEdge :: (MonadIO m, IsHandleBox o) => o -> m PositionType
setHandleBoxSnapEdge :: (MonadIO m, IsHandleBox o) => o -> PositionType -> m ()
constructHandleBoxSnapEdgeSet :: IsHandleBox o => Bool -> IO (GValueConstruct o)
getHandleBoxSnapEdgeSet :: (MonadIO m, IsHandleBox o) => o -> m Bool
setHandleBoxSnapEdgeSet :: (MonadIO m, IsHandleBox o) => o -> Bool -> m ()
type C_HandleBoxChildAttachedCallback = Ptr () -> Ptr Widget -> Ptr () -> IO ()
type HandleBoxChildAttachedCallback = Widget -> IO ()
afterHandleBoxChildAttached :: (IsHandleBox a, MonadIO m) => a -> HandleBoxChildAttachedCallback -> m SignalHandlerId
genClosure_HandleBoxChildAttached :: MonadIO m => HandleBoxChildAttachedCallback -> m (GClosure C_HandleBoxChildAttachedCallback)
mk_HandleBoxChildAttachedCallback :: C_HandleBoxChildAttachedCallback -> IO (FunPtr C_HandleBoxChildAttachedCallback)
noHandleBoxChildAttachedCallback :: Maybe HandleBoxChildAttachedCallback
onHandleBoxChildAttached :: (IsHandleBox a, MonadIO m) => a -> HandleBoxChildAttachedCallback -> m SignalHandlerId
wrap_HandleBoxChildAttachedCallback :: HandleBoxChildAttachedCallback -> C_HandleBoxChildAttachedCallback
type C_HandleBoxChildDetachedCallback = Ptr () -> Ptr Widget -> Ptr () -> IO ()
type HandleBoxChildDetachedCallback = Widget -> IO ()
afterHandleBoxChildDetached :: (IsHandleBox a, MonadIO m) => a -> HandleBoxChildDetachedCallback -> m SignalHandlerId
genClosure_HandleBoxChildDetached :: MonadIO m => HandleBoxChildDetachedCallback -> m (GClosure C_HandleBoxChildDetachedCallback)
mk_HandleBoxChildDetachedCallback :: C_HandleBoxChildDetachedCallback -> IO (FunPtr C_HandleBoxChildDetachedCallback)
noHandleBoxChildDetachedCallback :: Maybe HandleBoxChildDetachedCallback
onHandleBoxChildDetached :: (IsHandleBox a, MonadIO m) => a -> HandleBoxChildDetachedCallback -> m SignalHandlerId
wrap_HandleBoxChildDetachedCallback :: HandleBoxChildDetachedCallback -> C_HandleBoxChildDetachedCallback

Exported types

newtype HandleBox Source #

Memory-managed wrapper type.

Constructors

HandleBox (ManagedPtr HandleBox)

Instances

GObject HandleBox Source #
Instance details Defined in GI.Gtk.Objects.HandleBox Methods gobjectType :: IO GType #
HasParentTypes HandleBox Source #
Instance details Defined in GI.Gtk.Objects.HandleBox
type ParentTypes HandleBox Source #
Instance details Defined in GI.Gtk.Objects.HandleBox type ParentTypes HandleBox = Bin ': (Container ': (Widget ': (Object ': (ImplementorIface ': (Buildable ': ([] :: [Type]))))))

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

(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.

noHandleBox :: Maybe HandleBox Source #

A convenience alias for Nothing :: Maybe HandleBox.

Methods

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 => PositionType -> IO (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 => ShadowType -> IO (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 => PositionType -> IO (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 => Bool -> IO (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 C_HandleBoxChildAttachedCallback = Ptr () -> Ptr Widget -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

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 -> HandleBoxChildAttachedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “child-attached” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after handleBox #childAttached callback

genClosure_HandleBoxChildAttached :: MonadIO m => HandleBoxChildAttachedCallback -> m (GClosure C_HandleBoxChildAttachedCallback) Source #

Wrap the callback into a GClosure.

mk_HandleBoxChildAttachedCallback :: C_HandleBoxChildAttachedCallback -> IO (FunPtr C_HandleBoxChildAttachedCallback) Source #

Generate a function pointer callable from C code, from a C_HandleBoxChildAttachedCallback.

noHandleBoxChildAttachedCallback :: Maybe HandleBoxChildAttachedCallback Source #

A convenience synonym for Nothing :: Maybe HandleBoxChildAttachedCallback.

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

Connect a signal handler for the “child-attached” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on handleBox #childAttached callback

wrap_HandleBoxChildAttachedCallback :: HandleBoxChildAttachedCallback -> C_HandleBoxChildAttachedCallback Source #

Wrap a HandleBoxChildAttachedCallback into a C_HandleBoxChildAttachedCallback.

childDetached

type C_HandleBoxChildDetachedCallback = Ptr () -> Ptr Widget -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

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 -> HandleBoxChildDetachedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “child-detached” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after handleBox #childDetached callback

genClosure_HandleBoxChildDetached :: MonadIO m => HandleBoxChildDetachedCallback -> m (GClosure C_HandleBoxChildDetachedCallback) Source #

Wrap the callback into a GClosure.

mk_HandleBoxChildDetachedCallback :: C_HandleBoxChildDetachedCallback -> IO (FunPtr C_HandleBoxChildDetachedCallback) Source #

Generate a function pointer callable from C code, from a C_HandleBoxChildDetachedCallback.

noHandleBoxChildDetachedCallback :: Maybe HandleBoxChildDetachedCallback Source #

A convenience synonym for Nothing :: Maybe HandleBoxChildDetachedCallback.

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

Connect a signal handler for the “child-detached” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on handleBox #childDetached callback

wrap_HandleBoxChildDetachedCallback :: HandleBoxChildDetachedCallback -> C_HandleBoxChildDetachedCallback Source #

Wrap a HandleBoxChildDetachedCallback into a C_HandleBoxChildDetachedCallback.