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 |
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 (ManagedPtr PluginDesc)
- newZeroPluginDesc :: MonadIO m => m PluginDesc
- noPluginDesc :: Maybe PluginDesc
- clearPluginDescDescription :: MonadIO m => PluginDesc -> m ()
- getPluginDescDescription :: MonadIO m => PluginDesc -> m (Maybe Text)
- pluginDesc_description :: AttrLabelProxy "description"
- setPluginDescDescription :: MonadIO m => PluginDesc -> CString -> m ()
- clearPluginDescLicense :: MonadIO m => PluginDesc -> m ()
- getPluginDescLicense :: MonadIO m => PluginDesc -> m (Maybe Text)
- pluginDesc_license :: AttrLabelProxy "license"
- setPluginDescLicense :: MonadIO m => PluginDesc -> CString -> m ()
- getPluginDescMajorVersion :: MonadIO m => PluginDesc -> m Int32
- pluginDesc_majorVersion :: AttrLabelProxy "majorVersion"
- setPluginDescMajorVersion :: MonadIO m => PluginDesc -> Int32 -> m ()
- getPluginDescMinorVersion :: MonadIO m => PluginDesc -> m Int32
- pluginDesc_minorVersion :: AttrLabelProxy "minorVersion"
- setPluginDescMinorVersion :: MonadIO m => PluginDesc -> Int32 -> m ()
- clearPluginDescName :: MonadIO m => PluginDesc -> m ()
- getPluginDescName :: MonadIO m => PluginDesc -> m (Maybe Text)
- pluginDesc_name :: AttrLabelProxy "name"
- setPluginDescName :: MonadIO m => PluginDesc -> CString -> m ()
- clearPluginDescOrigin :: MonadIO m => PluginDesc -> m ()
- getPluginDescOrigin :: MonadIO m => PluginDesc -> m (Maybe Text)
- pluginDesc_origin :: AttrLabelProxy "origin"
- setPluginDescOrigin :: MonadIO m => PluginDesc -> CString -> m ()
- clearPluginDescPackage :: MonadIO m => PluginDesc -> m ()
- getPluginDescPackage :: MonadIO m => PluginDesc -> m (Maybe Text)
- pluginDesc_package :: AttrLabelProxy "package"
- setPluginDescPackage :: MonadIO m => PluginDesc -> CString -> m ()
- clearPluginDescPluginInit :: MonadIO m => PluginDesc -> m ()
- getPluginDescPluginInit :: MonadIO m => PluginDesc -> m (Maybe PluginInitFunc)
- pluginDesc_pluginInit :: AttrLabelProxy "pluginInit"
- setPluginDescPluginInit :: MonadIO m => PluginDesc -> FunPtr C_PluginInitFunc -> m ()
- clearPluginDescReleaseDatetime :: MonadIO m => PluginDesc -> m ()
- getPluginDescReleaseDatetime :: MonadIO m => PluginDesc -> m (Maybe Text)
- pluginDesc_releaseDatetime :: AttrLabelProxy "releaseDatetime"
- setPluginDescReleaseDatetime :: MonadIO m => PluginDesc -> CString -> m ()
- clearPluginDescSource :: MonadIO m => PluginDesc -> m ()
- getPluginDescSource :: MonadIO m => PluginDesc -> m (Maybe Text)
- pluginDesc_source :: AttrLabelProxy "source"
- setPluginDescSource :: MonadIO m => PluginDesc -> CString -> m ()
- clearPluginDescVersion :: MonadIO m => PluginDesc -> m ()
- getPluginDescVersion :: MonadIO m => PluginDesc -> m (Maybe Text)
- pluginDesc_version :: AttrLabelProxy "version"
- setPluginDescVersion :: MonadIO m => PluginDesc -> CString -> m ()
Exported types
newtype PluginDesc Source #
WrappedPtr PluginDesc Source # | |
(~) AttrOpTag tag AttrSet => Constructible PluginDesc tag Source # | |
((~) * info (ResolvePluginDescMethod t PluginDesc), MethodInfo * info PluginDesc p) => IsLabel t (PluginDesc -> p) Source # | |
((~) * info (ResolvePluginDescMethod t PluginDesc), MethodInfo * info PluginDesc p) => IsLabelProxy t (PluginDesc -> p) Source # | |
HasAttributeList * PluginDesc Source # | |
type AttributeList PluginDesc Source # | |
newZeroPluginDesc :: MonadIO m => m PluginDesc Source #
Construct a PluginDesc
struct initialized to zero.
Properties
description
clearPluginDescDescription :: MonadIO m => PluginDesc -> m () Source #
getPluginDescDescription :: MonadIO m => PluginDesc -> m (Maybe Text) Source #
pluginDesc_description :: AttrLabelProxy "description" Source #
setPluginDescDescription :: MonadIO m => PluginDesc -> CString -> m () Source #
license
clearPluginDescLicense :: MonadIO m => PluginDesc -> m () Source #
getPluginDescLicense :: MonadIO m => PluginDesc -> m (Maybe Text) Source #
pluginDesc_license :: AttrLabelProxy "license" Source #
setPluginDescLicense :: MonadIO m => PluginDesc -> CString -> m () Source #
majorVersion
getPluginDescMajorVersion :: MonadIO m => PluginDesc -> m Int32 Source #
pluginDesc_majorVersion :: AttrLabelProxy "majorVersion" Source #
setPluginDescMajorVersion :: MonadIO m => PluginDesc -> Int32 -> m () Source #
minorVersion
getPluginDescMinorVersion :: MonadIO m => PluginDesc -> m Int32 Source #
pluginDesc_minorVersion :: AttrLabelProxy "minorVersion" Source #
setPluginDescMinorVersion :: MonadIO m => PluginDesc -> Int32 -> m () Source #
name
clearPluginDescName :: MonadIO m => PluginDesc -> m () Source #
getPluginDescName :: MonadIO m => PluginDesc -> m (Maybe Text) Source #
pluginDesc_name :: AttrLabelProxy "name" Source #
setPluginDescName :: MonadIO m => PluginDesc -> CString -> m () Source #
origin
clearPluginDescOrigin :: MonadIO m => PluginDesc -> m () Source #
getPluginDescOrigin :: MonadIO m => PluginDesc -> m (Maybe Text) Source #
pluginDesc_origin :: AttrLabelProxy "origin" Source #
setPluginDescOrigin :: MonadIO m => PluginDesc -> CString -> m () Source #
package
clearPluginDescPackage :: MonadIO m => PluginDesc -> m () Source #
getPluginDescPackage :: MonadIO m => PluginDesc -> m (Maybe Text) Source #
pluginDesc_package :: AttrLabelProxy "package" Source #
setPluginDescPackage :: MonadIO m => PluginDesc -> CString -> m () Source #
pluginInit
clearPluginDescPluginInit :: MonadIO m => PluginDesc -> m () Source #
getPluginDescPluginInit :: MonadIO m => PluginDesc -> m (Maybe PluginInitFunc) Source #
pluginDesc_pluginInit :: AttrLabelProxy "pluginInit" Source #
setPluginDescPluginInit :: MonadIO m => PluginDesc -> FunPtr C_PluginInitFunc -> m () Source #
releaseDatetime
clearPluginDescReleaseDatetime :: MonadIO m => PluginDesc -> m () Source #
getPluginDescReleaseDatetime :: MonadIO m => PluginDesc -> m (Maybe Text) Source #
pluginDesc_releaseDatetime :: AttrLabelProxy "releaseDatetime" Source #
setPluginDescReleaseDatetime :: MonadIO m => PluginDesc -> CString -> m () Source #
source
clearPluginDescSource :: MonadIO m => PluginDesc -> m () Source #
getPluginDescSource :: MonadIO m => PluginDesc -> m (Maybe Text) Source #
pluginDesc_source :: AttrLabelProxy "source" Source #
setPluginDescSource :: MonadIO m => PluginDesc -> CString -> m () Source #
version
clearPluginDescVersion :: MonadIO m => PluginDesc -> m () Source #
getPluginDescVersion :: MonadIO m => PluginDesc -> m (Maybe Text) Source #
pluginDesc_version :: AttrLabelProxy "version" Source #
setPluginDescVersion :: MonadIO m => PluginDesc -> CString -> m () Source #