| 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.Atk.Objects.ObjectFactory
Description
This class is the base object class for a factory used to create an
accessible object for a specific GType. The function
registrySetFactoryType is normally called to store in the
registry the factory type to be used to create an accessible of a
particular GType.
Synopsis
- newtype ObjectFactory = ObjectFactory (ManagedPtr ObjectFactory)
- class GObject o => IsObjectFactory o
- toObjectFactory :: (MonadIO m, IsObjectFactory o) => o -> m ObjectFactory
- noObjectFactory :: Maybe ObjectFactory
- objectFactoryCreateAccessible :: (HasCallStack, MonadIO m, IsObjectFactory a, IsObject b) => a -> b -> m Object
- objectFactoryGetAccessibleType :: (HasCallStack, MonadIO m, IsObjectFactory a) => a -> m GType
- objectFactoryInvalidate :: (HasCallStack, MonadIO m, IsObjectFactory a) => a -> m ()
Exported types
newtype ObjectFactory Source #
Memory-managed wrapper type.
Constructors
| ObjectFactory (ManagedPtr ObjectFactory) |
Instances
| GObject ObjectFactory Source # | |
Defined in GI.Atk.Objects.ObjectFactory Methods gobjectType :: ObjectFactory -> IO GType # | |
| IsObject ObjectFactory Source # | |
Defined in GI.Atk.Objects.ObjectFactory | |
| IsObjectFactory ObjectFactory Source # | |
Defined in GI.Atk.Objects.ObjectFactory | |
class GObject o => IsObjectFactory o Source #
Type class for types which can be safely cast to ObjectFactory, for instance with toObjectFactory.
Instances
| (GObject a, (UnknownAncestorError ObjectFactory a :: Constraint)) => IsObjectFactory a Source # | |
Defined in GI.Atk.Objects.ObjectFactory | |
| IsObjectFactory ObjectFactory Source # | |
Defined in GI.Atk.Objects.ObjectFactory | |
| IsObjectFactory NoOpObjectFactory Source # | |
Defined in GI.Atk.Objects.NoOpObjectFactory | |
toObjectFactory :: (MonadIO m, IsObjectFactory o) => o -> m ObjectFactory Source #
Cast to ObjectFactory, for types for which this is known to be safe. For general casts, use castTo.
noObjectFactory :: Maybe ObjectFactory Source #
A convenience alias for Nothing :: Maybe ObjectFactory.
Methods
createAccessible
objectFactoryCreateAccessible Source #
Arguments
| :: (HasCallStack, MonadIO m, IsObjectFactory a, IsObject b) | |
| => a |
|
| -> b |
|
| -> m Object | Returns: an |
Provides an Object that implements an accessibility interface
on behalf of obj
getAccessibleType
objectFactoryGetAccessibleType Source #
Arguments
| :: (HasCallStack, MonadIO m, IsObjectFactory a) | |
| => a |
|
| -> m GType | Returns: the type of the accessible which is created by the |
Gets the GType of the accessible which is created by the factory.
invalidate
objectFactoryInvalidate Source #
Arguments
| :: (HasCallStack, MonadIO m, IsObjectFactory a) | |
| => a |
|
| -> m () |
Inform factory that it is no longer being used to create
accessibles. When called, factory may need to inform
AtkObjects which it has created that they need to be re-instantiated.
Note: primarily used for runtime replacement of AtkObjectFactorys
in object registries.