| 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.Gst.Structs.PluginDesc
Contents
Description
A plugin should export a variable of this type called plugin_desc. The plugin loader will use the data provided there to initialize the plugin.
The @licence parameter must be one of: LGPL, GPL, QPL, GPL/QPL, MPL, BSD, MIT/X11, Proprietary, unknown.
- newtype PluginDesc = PluginDesc (ForeignPtr PluginDesc)
- newZeroPluginDesc :: MonadIO m => m PluginDesc
- noPluginDesc :: Maybe PluginDesc
- pluginDescClearDescription :: MonadIO m => PluginDesc -> m ()
- pluginDescDescription :: AttrLabelProxy "description"
- pluginDescReadDescription :: MonadIO m => PluginDesc -> m (Maybe Text)
- pluginDescWriteDescription :: MonadIO m => PluginDesc -> CString -> m ()
- pluginDescClearLicense :: MonadIO m => PluginDesc -> m ()
- pluginDescLicense :: AttrLabelProxy "license"
- pluginDescReadLicense :: MonadIO m => PluginDesc -> m (Maybe Text)
- pluginDescWriteLicense :: MonadIO m => PluginDesc -> CString -> m ()
- pluginDescMajorVersion :: AttrLabelProxy "majorVersion"
- pluginDescReadMajorVersion :: MonadIO m => PluginDesc -> m Int32
- pluginDescWriteMajorVersion :: MonadIO m => PluginDesc -> Int32 -> m ()
- pluginDescMinorVersion :: AttrLabelProxy "minorVersion"
- pluginDescReadMinorVersion :: MonadIO m => PluginDesc -> m Int32
- pluginDescWriteMinorVersion :: MonadIO m => PluginDesc -> Int32 -> m ()
- pluginDescClearName :: MonadIO m => PluginDesc -> m ()
- pluginDescName :: AttrLabelProxy "name"
- pluginDescReadName :: MonadIO m => PluginDesc -> m (Maybe Text)
- pluginDescWriteName :: MonadIO m => PluginDesc -> CString -> m ()
- pluginDescClearOrigin :: MonadIO m => PluginDesc -> m ()
- pluginDescOrigin :: AttrLabelProxy "origin"
- pluginDescReadOrigin :: MonadIO m => PluginDesc -> m (Maybe Text)
- pluginDescWriteOrigin :: MonadIO m => PluginDesc -> CString -> m ()
- pluginDescClearPackage :: MonadIO m => PluginDesc -> m ()
- pluginDescPackage :: AttrLabelProxy "package"
- pluginDescReadPackage :: MonadIO m => PluginDesc -> m (Maybe Text)
- pluginDescWritePackage :: MonadIO m => PluginDesc -> CString -> m ()
- pluginDescClearReleaseDatetime :: MonadIO m => PluginDesc -> m ()
- pluginDescReadReleaseDatetime :: MonadIO m => PluginDesc -> m (Maybe Text)
- pluginDescReleaseDatetime :: AttrLabelProxy "releaseDatetime"
- pluginDescWriteReleaseDatetime :: MonadIO m => PluginDesc -> CString -> m ()
- pluginDescClearSource :: MonadIO m => PluginDesc -> m ()
- pluginDescReadSource :: MonadIO m => PluginDesc -> m (Maybe Text)
- pluginDescSource :: AttrLabelProxy "source"
- pluginDescWriteSource :: MonadIO m => PluginDesc -> CString -> m ()
- pluginDescClearVersion :: MonadIO m => PluginDesc -> m ()
- pluginDescReadVersion :: MonadIO m => PluginDesc -> m (Maybe Text)
- pluginDescVersion :: AttrLabelProxy "version"
- pluginDescWriteVersion :: MonadIO m => PluginDesc -> CString -> m ()
Exported types
newtype PluginDesc Source
Constructors
| PluginDesc (ForeignPtr PluginDesc) |
Instances
| WrappedPtr PluginDesc Source | |
| (~) AttrOpTag tag AttrSet => Constructible PluginDesc tag Source | |
| ((~) * info (ResolvePluginDescMethod t PluginDesc), MethodInfo * info PluginDesc p) => IsLabelProxy t (PluginDesc -> p) Source | |
| type AttributeList PluginDesc Source |
newZeroPluginDesc :: MonadIO m => m PluginDesc Source
Construct a PluginDesc struct initialized to zero.
Properties
Description
pluginDescClearDescription :: MonadIO m => PluginDesc -> m () Source
pluginDescDescription :: AttrLabelProxy "description" Source
pluginDescReadDescription :: MonadIO m => PluginDesc -> m (Maybe Text) Source
pluginDescWriteDescription :: MonadIO m => PluginDesc -> CString -> m () Source
License
pluginDescClearLicense :: MonadIO m => PluginDesc -> m () Source
pluginDescLicense :: AttrLabelProxy "license" Source
pluginDescReadLicense :: MonadIO m => PluginDesc -> m (Maybe Text) Source
pluginDescWriteLicense :: MonadIO m => PluginDesc -> CString -> m () Source
MajorVersion
pluginDescMajorVersion :: AttrLabelProxy "majorVersion" Source
pluginDescReadMajorVersion :: MonadIO m => PluginDesc -> m Int32 Source
pluginDescWriteMajorVersion :: MonadIO m => PluginDesc -> Int32 -> m () Source
MinorVersion
pluginDescMinorVersion :: AttrLabelProxy "minorVersion" Source
pluginDescReadMinorVersion :: MonadIO m => PluginDesc -> m Int32 Source
pluginDescWriteMinorVersion :: MonadIO m => PluginDesc -> Int32 -> m () Source
Name
pluginDescClearName :: MonadIO m => PluginDesc -> m () Source
pluginDescName :: AttrLabelProxy "name" Source
pluginDescReadName :: MonadIO m => PluginDesc -> m (Maybe Text) Source
pluginDescWriteName :: MonadIO m => PluginDesc -> CString -> m () Source
Origin
pluginDescClearOrigin :: MonadIO m => PluginDesc -> m () Source
pluginDescOrigin :: AttrLabelProxy "origin" Source
pluginDescReadOrigin :: MonadIO m => PluginDesc -> m (Maybe Text) Source
pluginDescWriteOrigin :: MonadIO m => PluginDesc -> CString -> m () Source
Package
pluginDescClearPackage :: MonadIO m => PluginDesc -> m () Source
pluginDescPackage :: AttrLabelProxy "package" Source
pluginDescReadPackage :: MonadIO m => PluginDesc -> m (Maybe Text) Source
pluginDescWritePackage :: MonadIO m => PluginDesc -> CString -> m () Source
ReleaseDatetime
pluginDescClearReleaseDatetime :: MonadIO m => PluginDesc -> m () Source
pluginDescReadReleaseDatetime :: MonadIO m => PluginDesc -> m (Maybe Text) Source
pluginDescReleaseDatetime :: AttrLabelProxy "releaseDatetime" Source
pluginDescWriteReleaseDatetime :: MonadIO m => PluginDesc -> CString -> m () Source
Source
pluginDescClearSource :: MonadIO m => PluginDesc -> m () Source
pluginDescReadSource :: MonadIO m => PluginDesc -> m (Maybe Text) Source
pluginDescSource :: AttrLabelProxy "source" Source
pluginDescWriteSource :: MonadIO m => PluginDesc -> CString -> m () Source
Version
pluginDescClearVersion :: MonadIO m => PluginDesc -> m () Source
pluginDescReadVersion :: MonadIO m => PluginDesc -> m (Maybe Text) Source
pluginDescVersion :: AttrLabelProxy "version" Source
pluginDescWriteVersion :: MonadIO m => PluginDesc -> CString -> m () Source