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

Contents

- Exported types
- Methods
  - addId
  - getId
  - getPlugWindow
  - new
- Signals
  - plugAdded
  - plugRemoved

Description

Together with `Plug`, `Socket` provides the ability to embed widgets from one process into another process in a fashion that is transparent to the user. One process creates a `Socket` widget and passes that widget’s window ID to the other process, which then creates a `Plug` with that window ID. Any widgets contained in the `Plug` then will appear inside the first application’s window.

The socket’s window ID is obtained by using `socketGetId`. Before using this function, the socket must have been realized, and for hence, have been added to its parent.

## Obtaining the window ID of a socket.

### C code

    GtkWidget *socket = gtk_socket_new ();
    gtk_widget_show (socket);
    gtk_container_add (GTK_CONTAINER (parent), socket);

    // The following call is only necessary if one of
    // the ancestors of the socket is not yet visible.
    gtk_widget_realize (socket);
    g_print ("The ID of the sockets window is %#x\n",
             gtk_socket_get_id (socket));

Note that if you pass the window ID of the socket to another process that will create a plug in the socket, you must make sure that the socket widget is not destroyed until that plug is created. Violating this rule will cause unpredictable consequences, the most likely consequence being that the plug will appear as a separate toplevel window. You can check if the plug has been created by using `socketGetPlugWindow`. If it returns a non-`Nothing` value, then the plug has been successfully created inside of the socket.

When GTK+ is notified that the embedded window has been destroyed, then it will destroy the socket as well. You should always, therefore, be prepared for your sockets to be destroyed at any time when the main event loop is running. To prevent this from happening, you can connect to the Socket::plugRemoved signal.

The communication between a `Socket` and a `Plug` follows the XEmbed Protocol. This protocol has also been implemented in other toolkits, e.g. Qt, allowing the same level of integration when embedding a Qt widget in GTK or vice versa.

The `Plug` and `Socket` widgets are only available when GTK+ is compiled for the X11 platform and `GDK_WINDOWING_X11` is defined. They can only be used on a `GdkX11Display`. To use `Plug` and `Socket`, you need to include the `gtk/gtkx.h` header.

Synopsis

- newtype Socket = Socket (ManagedPtr Socket)
- class (GObject o, IsDescendantOf Socket o) => IsSocket o
- toSocket :: (MonadIO m, IsSocket o) => o -> m Socket
- socketAddId :: (HasCallStack, MonadIO m, IsSocket a) => a -> CULong -> m ()
- socketGetId :: (HasCallStack, MonadIO m, IsSocket a) => a -> m CULong
- socketGetPlugWindow :: (HasCallStack, MonadIO m, IsSocket a) => a -> m (Maybe Window)
- socketNew :: (HasCallStack, MonadIO m) => m Socket
- type SocketPlugAddedCallback = IO ()
- afterSocketPlugAdded :: (IsSocket a, MonadIO m) => a -> ((?self :: a) => SocketPlugAddedCallback) -> m SignalHandlerId
- onSocketPlugAdded :: (IsSocket a, MonadIO m) => a -> ((?self :: a) => SocketPlugAddedCallback) -> m SignalHandlerId
- type SocketPlugRemovedCallback = IO Bool
- afterSocketPlugRemoved :: (IsSocket a, MonadIO m) => a -> ((?self :: a) => SocketPlugRemovedCallback) -> m SignalHandlerId
- onSocketPlugRemoved :: (IsSocket a, MonadIO m) => a -> ((?self :: a) => SocketPlugRemovedCallback) -> m SignalHandlerId

# Exported types

newtype Socket Source #

Memory-managed wrapper type.

Constructors

Socket (ManagedPtr Socket) |

#### Instances

Instances details

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

class (GObject o, IsDescendantOf Socket o) => IsSocket o Source #

Type class for types which can be safely cast to `Socket`, for instance with `toSocket`.

#### Instances

Instances details

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

toSocket :: (MonadIO m, IsSocket o) => o -> m Socket Source #

Cast to `Socket`, 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, addId, 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, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getId, getInternalChild, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPlugWindow, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getResizeMode, getRootWindow, getScaleFactor, getScreen, getSensitive, getSettings, getSizeRequest, 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, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizeMode, setSensitive, setSizeRequest, setState, setStateFlags, setStyle, setSupportMultidevice, setTooltipMarkup, setTooltipText, setTooltipWindow, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.

## addId

socketAddId Source #

Arguments

:: (HasCallStack, MonadIO m, IsSocket a) |
=> a | `socket_`: a `Socket`
-> CULong | `window`: the Window of a client participating in the XEMBED protocol.
-> m () |

Adds an XEMBED client, such as a `Plug`, to the `Socket`. The client may be in the same process or in a different process.

To embed a `Plug` in a `Socket`, you can either create the `Plug` with `gtk_plug_new (0)`, call `plugGetId` to get the window ID of the plug, and then pass that to the `socketAddId`, or you can call `socketGetId` to get the window ID for the socket, and call `plugNew` passing in that ID.

The `Socket` must have already be added into a toplevel window before you can make this call.

## getId

socketGetId Source #

Arguments

:: (HasCallStack, MonadIO m, IsSocket a) |
=> a | `socket_`: a `Socket`.
-> m CULong | Returns: the window ID for the socket

Gets the window ID of a `Socket` widget, which can then be used to create a client embedded inside the socket, for instance with `plugNew`.

The `Socket` must have already be added into a toplevel window before you can make this call.

## getPlugWindow

socketGetPlugWindow Source #

Arguments

:: (HasCallStack, MonadIO m, IsSocket a) |
=> a | `socket_`: a `Socket`.
-> m (Maybe Window) | Returns: the window of the plug if available, or `Nothing`

Retrieves the window of the plug. Use this to check if the plug has been created inside of the socket.

Since: 2.14

## new

socketNew Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> m Socket | Returns: the new `Socket`.

Create a new empty `Socket`.

# Signals

## plugAdded

type SocketPlugAddedCallback = IO () Source #

This signal is emitted when a client is successfully added to the socket.

afterSocketPlugAdded :: (IsSocket a, MonadIO m) => a -> ((?self :: a) => SocketPlugAddedCallback) -> m SignalHandlerId Source #

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

    after socket #plugAdded 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.

onSocketPlugAdded :: (IsSocket a, MonadIO m) => a -> ((?self :: a) => SocketPlugAddedCallback) -> m SignalHandlerId Source #

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

    on socket #plugAdded callback

## plugRemoved

type SocketPlugRemovedCallback Source #

Arguments

= IO Bool | Returns: `True` to stop other handlers from being invoked.

This signal is emitted when a client is removed from the socket. The default action is to destroy the `Socket` widget, so if you want to reuse it you must add a signal handler that returns `True`.

afterSocketPlugRemoved :: (IsSocket a, MonadIO m) => a -> ((?self :: a) => SocketPlugRemovedCallback) -> m SignalHandlerId Source #

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

    after socket #plugRemoved 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.

onSocketPlugRemoved :: (IsSocket a, MonadIO m) => a -> ((?self :: a) => SocketPlugRemovedCallback) -> m SignalHandlerId Source #

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

    on socket #plugRemoved callback