Data.GI.Base

Convenience header for basic GObject-Introspection modules

See the documentation for each individual module for a description and usage help.

Documentation

get :: forall info (attr :: Symbol) obj result m. (AttrGetC info obj attr result, MonadIO m) => obj -> AttrLabelProxy attr -> m result

Get the value of an attribute for an object.

set :: forall o m. MonadIO m => o -> [AttrOp o 'AttrSet] -> m ()

Set a number of properties for some object.

data AttrOp obj (tag :: AttrOpTag) where

Constructors for the different operations allowed on an attribute.

Constructors

(:=) :: forall obj info (attr :: Symbol) (tag :: AttrOpTag) b. (HasAttributeList obj, info ~ ResolveAttribute attr obj, AttrInfo info, AttrBaseTypeConstraint info obj, AttrOpAllowed tag info obj, AttrSetTypeConstraint info b) => AttrLabelProxy attr -> b -> AttrOp obj tag infixr 0

Assign a value to an attribute

(:=>) :: forall obj info (attr :: Symbol) (tag :: AttrOpTag) b. (HasAttributeList obj, info ~ ResolveAttribute attr obj, AttrInfo info, AttrBaseTypeConstraint info obj, AttrOpAllowed tag info obj, AttrSetTypeConstraint info b) => AttrLabelProxy attr -> IO b -> AttrOp obj tag infixr 0

Assign the result of an IO action to an attribute

(:~) :: forall obj info (attr :: Symbol) (tag :: AttrOpTag) b a. (HasAttributeList obj, info ~ ResolveAttribute attr obj, AttrInfo info, AttrBaseTypeConstraint info obj, tag ~ 'AttrSet, AttrOpAllowed 'AttrSet info obj, AttrOpAllowed 'AttrGet info obj, AttrSetTypeConstraint info b, a ~ AttrGetType info) => AttrLabelProxy attr -> (a -> b) -> AttrOp obj tag infixr 0

Apply an update function to an attribute

(:~>) :: forall obj info (attr :: Symbol) (tag :: AttrOpTag) b a. (HasAttributeList obj, info ~ ResolveAttribute attr obj, AttrInfo info, AttrBaseTypeConstraint info obj, tag ~ 'AttrSet, AttrOpAllowed 'AttrSet info obj, AttrOpAllowed 'AttrGet info obj, AttrSetTypeConstraint info b, a ~ AttrGetType info) => AttrLabelProxy attr -> (a -> IO b) -> AttrOp obj tag infixr 0

Apply an IO update function to an attribute

(:&=) :: forall obj info (attr :: Symbol) (tag :: AttrOpTag) b. (HasAttributeList obj, info ~ ResolveAttribute attr obj, AttrInfo info, AttrBaseTypeConstraint info obj, AttrOpAllowed tag info obj, AttrTransferTypeConstraint info b, AttrSetTypeConstraint info (AttrTransferType info)) => AttrLabelProxy attr -> b -> AttrOp obj tag

Assign a value to an attribute, allocating any necessary memory for representing the Haskell value as a C value. Note that it is the responsibility of the caller to make sure that the memory is freed when no longer used, otherwise there will be a memory leak. In the majority of cases you probably want to use := instead, which has no potential memory leaks (at the cost of sometimes requiring some explicit Haskell -> C marshalling).

On :: forall obj info (tag :: AttrOpTag). (GObject obj, SignalInfo info) => SignalProxy obj info -> ((?self :: obj) => HaskellCallbackType info) -> AttrOp obj tag

Connect the given signal to a signal handler.

After :: forall obj info (tag :: AttrOpTag). (GObject obj, SignalInfo info) => SignalProxy obj info -> ((?self :: obj) => HaskellCallbackType info) -> AttrOp obj tag

Like On, but connect after the default signal.

module Data.GI.Base.BasicConversions

module Data.GI.Base.BasicTypes

data GClosure a

The basic type. This corresponds to a wrapped GClosure on the C side, which is a boxed object.

Instances

GBoxed (GClosure a)

GClosures are registered as boxed in the GLib type system.

Defined in Data.GI.Base.GClosure

TypedObject (GClosure a)

Find the associated GType for the given closure.

Defined in Data.GI.Base.GClosure

Methods

glibType :: IO GType

HasParentTypes (GClosure a)

Defined in Data.GI.Base.GClosure

type ParentTypes (GClosure a)

There are no types in the bindings that a closure can be safely cast to.

Defined in Data.GI.Base.GClosure

type ParentTypes (GClosure a) = '[] :: [Type]

new :: (Constructible a tag, MonadIO m) => (ManagedPtr a -> a) -> [AttrOp a tag] -> m a

Allocate a new instance of the given type, with the given attributes.

module Data.GI.Base.GError

module Data.GI.Base.GHashTable

newtype GValue

Haskell-side representation of a GValue.

Constructors

GValue (ManagedPtr GValue)

Instances

GBoxed GValue

GValues are registered as boxed in the GLib type system.

Defined in Data.GI.Base.GValue

TypedObject GValue

Find the associated GType for GValue.

Defined in Data.GI.Base.GValue

Methods

glibType :: IO GType

HasParentTypes GValue

Defined in Data.GI.Base.GValue

type ParentTypes GValue

There are no types in the bindings that a GValue can be safely cast to.

Defined in Data.GI.Base.GValue

type ParentTypes GValue = '[] :: [Type]

fromGValue :: (IsGValue a, MonadIO m) => GValue -> m a

Create a Haskell object out of the given GValue.

toGValue :: (IsGValue a, MonadIO m) => a -> m GValue

Create a GValue from the given Haskell value.

class IsGValue a where

Class for types that can be marshaled back and forth between Haskell values and GValues. These are low-level methods, you might want to use toGValue and fromGValue instead for a higher level interface.

Methods

gvalueGType_

Arguments

:: IO GType

GType for the GValue containing values of this type.

gvalueSet_

Arguments

:: Ptr GValue

-> a

-> IO ()

Set the GValue to the given Haskell value.

gvalueGet_

Arguments

:: Ptr GValue

-> IO a

Get the Haskel value inside the GValue.

Instances

IsGValue CInt

Defined in Data.GI.Base.GValue

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> CInt -> IO ()

gvalueGet_ :: Ptr GValue -> IO CInt

IsGValue CLong

Defined in Data.GI.Base.GValue

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> CLong -> IO ()

gvalueGet_ :: Ptr GValue -> IO CLong

IsGValue CUInt

Defined in Data.GI.Base.GValue

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> CUInt -> IO ()

gvalueGet_ :: Ptr GValue -> IO CUInt

IsGValue CULong

Defined in Data.GI.Base.GValue

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> CULong -> IO ()

gvalueGet_ :: Ptr GValue -> IO CULong

IsGValue Int32

Defined in Data.GI.Base.GValue

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Int32 -> IO ()

gvalueGet_ :: Ptr GValue -> IO Int32

IsGValue Int64

Defined in Data.GI.Base.GValue

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Int64 -> IO ()

gvalueGet_ :: Ptr GValue -> IO Int64

IsGValue Word32

Defined in Data.GI.Base.GValue

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Word32 -> IO ()

gvalueGet_ :: Ptr GValue -> IO Word32

IsGValue Word64

Defined in Data.GI.Base.GValue

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Word64 -> IO ()

gvalueGet_ :: Ptr GValue -> IO Word64

IsGValue GType

Defined in Data.GI.Base.GValue

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> GType -> IO ()

gvalueGet_ :: Ptr GValue -> IO GType

IsGValue Bool

Defined in Data.GI.Base.GValue

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Bool -> IO ()

gvalueGet_ :: Ptr GValue -> IO Bool

IsGValue Double

Defined in Data.GI.Base.GValue

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Double -> IO ()

gvalueGet_ :: Ptr GValue -> IO Double

IsGValue Float

Defined in Data.GI.Base.GValue

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Float -> IO ()

gvalueGet_ :: Ptr GValue -> IO Float

IsGValue (Ptr a)

Defined in Data.GI.Base.GValue

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Ptr a -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Ptr a)

IsGValue (StablePtr a)

Defined in Data.GI.Base.GValue

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> StablePtr a -> IO ()

gvalueGet_ :: Ptr GValue -> IO (StablePtr a)

IsGValue (Maybe GParamSpec)

Defined in Data.GI.Base.GValue

Methods

gvalueGType_ :: IO GType

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

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

IsGValue (Maybe Text)

Defined in Data.GI.Base.GValue

Methods

gvalueGType_ :: IO GType

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

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

IsGValue (Maybe String)

Defined in Data.GI.Base.GValue

Methods

gvalueGType_ :: IO GType

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

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

module Data.GI.Base.GVariant

module Data.GI.Base.ManagedPtr

on :: forall object info m. (GObject object, MonadIO m, SignalInfo info) => object -> SignalProxy object info -> ((?self :: object) => HaskellCallbackType info) -> m SignalHandlerId

Connect a signal to a signal handler.

after :: forall object info m. (GObject object, MonadIO m, SignalInfo info) => object -> SignalProxy object info -> ((?self :: object) => HaskellCallbackType info) -> m SignalHandlerId

Connect a signal to a handler, running the handler after the default one.

data SignalProxy object info where

Support for overloaded signal connectors.

Constructors

(:::) :: forall object info. SignalProxy object info -> Text -> SignalProxy object info

A signal connector annotated with a detail.

PropertyNotify :: forall info1 (propName :: Symbol) object (pl :: Symbol). (info1 ~ ResolveAttribute propName object, AttrInfo info1, pl ~ AttrLabel info1, KnownSymbol pl) => AttrLabelProxy propName -> SignalProxy object GObjectNotifySignalInfo

A signal connector for the notify signal on the given property.

Instances

info ~ ResolveSignal slot object => IsLabel slot (SignalProxy object info)

Support for overloaded labels.

Defined in Data.GI.Base.Signals

Methods

fromLabel :: SignalProxy object info

asA :: (ManagedPtrNewtype a, ManagedPtrNewtype b, HasParentTypes b, IsDescendantOf a b) => b -> (ManagedPtr a -> a) -> a

Safe coercions to a parent class. For instance:

#show $ label `asA` Gtk.Widget