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

GI.GObject.Structs.TypeInterface

Contents

Exported types
Methods

Description

An opaque structure used as the base of all interface types.

Synopsis

Exported types

newtype TypeInterface #

Constructors

TypeInterface (ManagedPtr TypeInterface)

Instances

WrappedPtr TypeInterface #
Methods wrappedPtrCalloc :: IO (Ptr TypeInterface) # wrappedPtrCopy :: TypeInterface -> IO TypeInterface # wrappedPtrFree :: Maybe (FunPtr (Ptr TypeInterface -> IO ())) #
(~) AttrOpTag tag AttrSet => Constructible TypeInterface tag #
Methods new :: MonadIO m => (ManagedPtr TypeInterface -> TypeInterface) -> [AttrOp TypeInterface tag] -> m TypeInterface #
((~) * info (ResolveTypeInterfaceMethod t TypeInterface), MethodInfo * info TypeInterface p) => IsLabel t (TypeInterface -> p) #
Methods fromLabel :: Proxy# Symbol t -> TypeInterface -> p #
((~) * info (ResolveTypeInterfaceMethod t TypeInterface), MethodInfo * info TypeInterface p) => IsLabelProxy t (TypeInterface -> p) #
Methods fromLabelProxy :: Proxy Symbol t -> TypeInterface -> p #
HasAttributeList * TypeInterface #

((~) * signature (m TypeInterface), MonadIO m) => MethodInfo * TypeInterfacePeekParentMethodInfo TypeInterface signature #
Methods overloadedMethod :: MethodProxy TypeInterfacePeekParentMethodInfo TypeInterface -> signature -> s #
type AttributeList TypeInterface #
type AttributeList TypeInterface

newZeroTypeInterface :: MonadIO m => m TypeInterface #

Construct a TypeInterface struct initialized to zero.

noTypeInterface :: Maybe TypeInterface #

Methods

addPrerequisite

typeInterfaceAddPrerequisite #

Arguments

:: (HasCallStack, MonadIO m)
=> GType	`interfaceType`: `GType` value of an interface type
-> GType	`prerequisiteType`: `GType` value of an interface or instantiatable type
-> m ()

Adds prerequisiteType to the list of prerequisites of interfaceType. This means that any type implementing interfaceType must also implement prerequisiteType. Prerequisites can be thought of as an alternative to interface derivation (which GType doesn't support). An interface can have at most one instantiatable prerequisite type.

getPlugin

typeInterfaceGetPlugin #

Arguments

:: (HasCallStack, MonadIO m)
=> GType	`instanceType`: `GType` of an instantiatable type
-> GType	`interfaceType`: `GType` of an interface type
-> m TypePlugin	Returns: the `TypePlugin` for the dynamic interface `interfaceType` of `instanceType`

Returns the TypePlugin structure for the dynamic interface interfaceType which has been added to instanceType, or Nothing if interfaceType has not been added to instanceType or does not have a TypePlugin structure. See typeAddInterfaceDynamic.

peek

typeInterfacePeek #

Arguments

:: (HasCallStack, MonadIO m)
=> TypeClass	`instanceClass`: a `TypeClass` structure
-> GType	`ifaceType`: an interface ID which this class conforms to
-> m TypeInterface	Returns: the `TypeInterface` structure of `ifaceType` if implemented by `instanceClass`, `Nothing` otherwise

Returns the TypeInterface structure of an interface to which the passed in class conforms.

peekParent

data TypeInterfacePeekParentMethodInfo #

Instances

((~) * signature (m TypeInterface), MonadIO m) => MethodInfo * TypeInterfacePeekParentMethodInfo TypeInterface signature #
Methods overloadedMethod :: MethodProxy TypeInterfacePeekParentMethodInfo TypeInterface -> signature -> s #

typeInterfacePeekParent #

Arguments

:: (HasCallStack, MonadIO m)
=> TypeInterface	`gIface`: a `TypeInterface` structure
-> m TypeInterface	Returns: the corresponding `TypeInterface` structure of the parent type of the instance type to which `gIface` belongs, or `Nothing` if the parent type doesn't conform to the interface

Returns the corresponding TypeInterface structure of the parent type of the instance type to which gIface belongs. This is useful when deriving the implementation of an interface from the parent type and then possibly overriding some methods.

prerequisites

typeInterfacePrerequisites #

Arguments

:: (HasCallStack, MonadIO m)
=> GType	`interfaceType`: an interface type
-> m [GType]	Returns: a newly-allocated zero-terminated array of `GType` containing the prerequisites of `interfaceType`

Returns the prerequisites of an interfaces type.

Since: 2.2