GI.Gdk.Interfaces.Popup

A Popup is a surface that is attached to another surface, and is positioned relative to it.

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

IsGValue Popup

Convert Popup to and from GValue with toGValue and fromGValue.

Defined in GI.Gdk.Interfaces.Popup

Methods

toGValue :: Popup -> IO GValue

fromGValue :: GValue -> IO 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

GObject Popup

Defined in GI.Gdk.Interfaces.Popup

HasParentTypes Popup

Defined in GI.Gdk.Interfaces.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

Overloaded methods

getAutohide

popupGetAutohide

Arguments

:: (HasCallStack, MonadIO m, IsPopup a)

=> a

popup: a Popup

-> 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 Popup

-> m Surface

Returns: the parent surface

Returns the parent surface of a popup.

getPositionX

popupGetPositionX

Arguments

:: (HasCallStack, MonadIO m, IsPopup a)

=> a

popup: a Popup

-> 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 Popup

-> 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 Popup

-> 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 "popup-layout-changed" is emitted.

getSurfaceAnchor

popupGetSurfaceAnchor

Arguments

:: (HasCallStack, MonadIO m, IsPopup a)

=> a

popup: a Popup

-> 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 "popup-layout-changed" is emitted.

present

popupPresent

Arguments

:: (HasCallStack, MonadIO m, IsPopup a)

=> a

popup: the Popup to show

-> Int32

width: the unconstrained popup width to layout

-> Int32

height: the unconstrained popup height to layout

-> PopupLayout

layout: the PopupLayout object used to layout

-> m Bool

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

Present popup after having processed the PopupLayout 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 of the layout can be queried using popupGetPositionX, popupGetPositionY, surfaceGetWidth, surfaceGetHeight, popupGetRectAnchor and popupGetSurfaceAnchor.

Presenting may have fail, for example if it was immediately hidden if the popup was set to autohide.

Properties

autohide

No description available in the introspection data.

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

No description available in the introspection data.

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 Surface

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

get popup #parent