GI.Gdk.Interfaces.Popup

A GdkPopup is a surface that is attached to another surface.

The GdkPopup is positioned relative to its parent surface.

GdkPopups are typically used to implement menus and similar popups. They can be modal, which is indicated by the [propertygdkPopup:autohide] property.

Exported types

newtype Popup

Memory-managed wrapper type.

Constructors

Popup (ManagedPtr Popup)

Instances

Eq Popup

Defined in GI.Gdk.Interfaces.Popup

Methods

(==) :: Popup -> Popup -> Bool

(/=) :: Popup -> Popup -> Bool

GObject Popup

Defined in GI.Gdk.Interfaces.Popup

ManagedPtrNewtype Popup

Defined in GI.Gdk.Interfaces.Popup

Methods

toManagedPtr :: Popup -> ManagedPtr Popup

TypedObject Popup

Defined in GI.Gdk.Interfaces.Popup

Methods

glibType :: IO GType

HasParentTypes Popup

Defined in GI.Gdk.Interfaces.Popup

IsGValue (Maybe Popup)

Convert Popup to and from GValue. See toGValue and fromGValue.

Defined in GI.Gdk.Interfaces.Popup

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Popup -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Popup)

type ParentTypes Popup

Defined in GI.Gdk.Interfaces.Popup

type ParentTypes Popup = '[Object, Surface]

class (GObject o, IsDescendantOf Popup o) => IsPopup o

Type class for types which can be safely cast to Popup, for instance with toPopup.

Instances

(GObject o, IsDescendantOf Popup o) => IsPopup o

Defined in GI.Gdk.Interfaces.Popup

toPopup :: (MonadIO m, IsPopup o) => o -> m Popup

Cast to Popup, 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

Methods

beep, bindProperty, bindPropertyFull, createCairoContext, createGlContext, createSimilarSurface, createVulkanContext, destroy, forceFloating, freezeNotify, getv, hide, isDestroyed, isFloating, notify, notifyByPspec, present, queueRender, ref, refSink, requestLayout, runDispose, stealData, stealQdata, thawNotify, translateCoordinates, unref, watchClosure.

Getters

getAutohide, getCursor, getData, getDeviceCursor, getDevicePosition, getDisplay, getFrameClock, getHeight, getMapped, getParent, getPositionX, getPositionY, getProperty, getQdata, getRectAnchor, getScaleFactor, getSurfaceAnchor, getWidth.

Setters

setCursor, setData, setDataFull, setDeviceCursor, setInputRegion, setOpaqueRegion, setProperty.

getAutohide

popupGetAutohide

Arguments

:: (HasCallStack, MonadIO m, IsPopup a)

=> a

popup: a GdkPopup

-> m Bool

Returns: True if popup will autohide

Returns whether this popup is set to hide on outside clicks.

getParent

popupGetParent

Arguments

:: (HasCallStack, MonadIO m, IsPopup a)

=> a

popup: a GdkPopup

-> m (Maybe Surface)

Returns: the parent surface

Returns the parent surface of a popup.

getPositionX

popupGetPositionX

Arguments

:: (HasCallStack, MonadIO m, IsPopup a)

=> a

popup: a GdkPopup

-> m Int32

Returns: the X coordinate of popup position

Obtains the position of the popup relative to its parent.

getPositionY

popupGetPositionY

Arguments

:: (HasCallStack, MonadIO m, IsPopup a)

=> a

popup: a GdkPopup

-> m Int32

Returns: the Y coordinate of popup position

Obtains the position of the popup relative to its parent.

getRectAnchor

popupGetRectAnchor

Arguments

:: (HasCallStack, MonadIO m, IsPopup a)

=> a

popup: a GdkPopup

-> m Gravity

Returns: the current rectangle anchor value of popup

Gets the current popup rectangle anchor.

The value returned may change after calling popupPresent, or after the Surface::layout signal is emitted.

getSurfaceAnchor

popupGetSurfaceAnchor

Arguments

:: (HasCallStack, MonadIO m, IsPopup a)

=> a

popup: a GdkPopup

-> m Gravity

Returns: the current surface anchor value of popup

Gets the current popup surface anchor.

The value returned may change after calling popupPresent, or after the Surface::layout signal is emitted.

present

popupPresent

Arguments

:: (HasCallStack, MonadIO m, IsPopup a)

=> a

popup: the GdkPopup to show

-> Int32

width: the unconstrained popup width to layout

-> Int32

height: the unconstrained popup height to layout

-> PopupLayout

layout: the GdkPopupLayout object used to layout

-> m Bool

Returns: False if it failed to be presented, otherwise True.

Present popup after having processed the GdkPopupLayout rules.

If the popup was previously now showing, it will be showed, otherwise it will change position according to layout.

After calling this function, the result should be handled in response to the signalgdkSurface[layout] signal being emitted. The resulting popup position can be queried using popupGetPositionX, popupGetPositionY, and the resulting size will be sent as parameters in the layout signal. Use popupGetRectAnchor and popupGetSurfaceAnchor to get the resulting anchors.

Presenting may fail, for example if the popup is set to autohide and is immediately hidden upon being presented. If presenting failed, the Surface::layout signal will not me emitted.

Properties

autohide

Whether to hide on outside clicks.

constructPopupAutohide :: (IsPopup o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getPopupAutohide :: (MonadIO m, IsPopup o) => o -> m Bool

Get the value of the “autohide” property. When overloading is enabled, this is equivalent to

get popup #autohide

parent

The parent surface.

constructPopupParent :: (IsPopup o, MonadIO m, IsSurface a) => a -> m (GValueConstruct o)

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

getPopupParent :: (MonadIO m, IsPopup o) => o -> m (Maybe Surface)

Get the value of the “parent” property. When overloading is enabled, this is equivalent to

get popup #parent