Maintainer | gtk2hs-devel@lists.sourceforge.net |
---|---|
Stability | alpha |
Portability | portable (depends on GHC) |
Safe Haskell | None |
Language | Haskell98 |
A factory for creating Element
s.
- data ElementFactory
- class PluginFeatureClass o => ElementFactoryClass o
- castToElementFactory :: GObjectClass obj => obj -> ElementFactory
- gTypeElementFactory :: GType
- elementFactoryFind :: String -> IO (Maybe ElementFactory)
- elementFactoryGetElementType :: ElementFactoryClass elementFactory => elementFactory -> IO (Maybe GType)
- elementFactoryGetLongname :: ElementFactoryClass elementFactory => elementFactory -> IO String
- elementFactoryGetKlass :: ElementFactoryClass elementFactory => elementFactory -> IO String
- elementFactoryGetDescription :: ElementFactoryClass elementFactory => elementFactory -> IO String
- elementFactoryGetAuthor :: ElementFactoryClass elementFactory => elementFactory -> IO String
- elementFactoryGetNumPadTemplates :: ElementFactoryClass elementFactory => elementFactory -> IO Word
- elementFactoryGetURIType :: ElementFactoryClass elementFactory => elementFactory -> IO Int
- elementFactoryGetURIProtocols :: ElementFactoryClass elementFactory => elementFactory -> IO [String]
- elementFactoryHasInterface :: ElementFactoryClass elementFactory => elementFactory -> String -> IO Bool
- elementFactoryCreate :: ElementFactoryClass elementFactory => elementFactory -> String -> IO (Maybe Element)
- elementFactoryMake :: String -> Maybe String -> IO (Maybe Element)
- elementFactoryCanSinkCaps :: ElementFactoryClass elementFactory => elementFactory -> Caps -> IO Bool
- elementFactoryCanSrcCaps :: ElementFactoryClass elementFactory => elementFactory -> Caps -> IO Bool
- elementFactoryGetPadTemplates :: ElementFactoryClass elementFactory => elementFactory -> IO [PadTemplate]
Detail
ElementFactory
is used to create instances of Element
s.
Use elementFactoryFind
and elementFactoryCreate
to create
element instances, or use elementFactoryMake
as a convenient
shortcut.
Types
data ElementFactory Source #
class PluginFeatureClass o => ElementFactoryClass o Source #
castToElementFactory :: GObjectClass obj => obj -> ElementFactory Source #
ElementFactory Operations
:: String |
|
-> IO (Maybe ElementFactory) | the factory if found, otherwise |
Search for an element factory with the given name.
elementFactoryGetElementType Source #
:: ElementFactoryClass elementFactory | |
=> elementFactory |
|
-> IO (Maybe GType) | the type of elements managed
by the factory, or |
Get the GType
for elements managed by the given factory. The type
can only be retrieved if the element factory is loaded, which can
be assured with
pluginFeatureLoad
.
elementFactoryGetLongname Source #
:: ElementFactoryClass elementFactory | |
=> elementFactory |
|
-> IO String | the factory's long name |
Get the long name for the given factory.
elementFactoryGetKlass Source #
:: ElementFactoryClass elementFactory | |
=> elementFactory |
|
-> IO String | the factory's class |
Get the class for the given factory.
elementFactoryGetDescription Source #
:: ElementFactoryClass elementFactory | |
=> elementFactory |
|
-> IO String | the factory's description |
Get the description for the given factory.
elementFactoryGetAuthor Source #
:: ElementFactoryClass elementFactory | |
=> elementFactory |
|
-> IO String | the factory's author |
Get the author of the given factory.
elementFactoryGetNumPadTemplates Source #
:: ElementFactoryClass elementFactory | |
=> elementFactory |
|
-> IO Word | the number of |
Get the number of PadTemplate
s provided by the given factory.
elementFactoryGetURIType Source #
:: ElementFactoryClass elementFactory | |
=> elementFactory |
|
-> IO Int | the type of URIs supported by the factory |
Get the type of URIs supported by the given factory.
elementFactoryGetURIProtocols Source #
:: ElementFactoryClass elementFactory | |
=> elementFactory |
|
-> IO [String] | the supported protocols |
Get the list of protocols supported by the given factory.
elementFactoryHasInterface Source #
:: ElementFactoryClass elementFactory | |
=> elementFactory |
|
-> String |
|
-> IO Bool | true if the interface is implemented |
Check if the given factory implements the interface with the given name.
Since 0.10.14.
:: ElementFactoryClass elementFactory | |
=> elementFactory |
|
-> String |
|
-> IO (Maybe Element) | the new element if it could be created,
otherwise |
Create a new element of the type supplied by the given factory. It will be given the name supplied.
:: String |
|
-> Maybe String |
|
-> IO (Maybe Element) | the new element if it could be created,
otherwise |
Create a new element of the type supplied by the named factory.
elementFactoryCanSinkCaps Source #
:: ElementFactoryClass elementFactory | |
=> elementFactory |
|
-> Caps |
|
-> IO Bool |
|
Check if the given factory can sink the given capabilities.
elementFactoryCanSrcCaps Source #
:: ElementFactoryClass elementFactory | |
=> elementFactory |
|
-> Caps |
|
-> IO Bool |
|
Check if the given factory can source the given capabilities.
elementFactoryGetPadTemplates Source #
:: ElementFactoryClass elementFactory | |
=> elementFactory |
|
-> IO [PadTemplate] | the provided pad templates |
Get the pad templates provided by the given factory.