.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Plugin 3pm"
.TH Plugin 3pm 2025-09-28 "Lire 2.1.1" "LogReport's Lire Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Lire::Config::Plugin \- Value object for plugin configuration.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Lire::Config::Plugin;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This configuration object hold the name of a selected plugin as
well as its options.
.SS \fBget_plugin()\fP
.IX Subsection "get_plugin()"
Returns the currently selected plugin.
.ie n .SS "set_plugin( $plugin )"
.el .SS "set_plugin( \f(CW$plugin\fP )"
.IX Subsection "set_plugin( $plugin )"
Changes the selected plugin. If the selected plugin is changed, a
new property set will be created from the plugin\*(Aqs defined properties.
.SS \fBget_properties_spec()\fP
.IX Subsection "get_properties_spec()"
Returns the TypeSpec that is used to specify the plugin\*(Aqs properties.
This method will return an empty RecordSpec when the plugin didn\*(Aqt
define any properties. One can also use the \fBhas_properties()\fR method to
check if the Plugin defined configuration properties.
.SS \fBhas_properties()\fP
.IX Subsection "has_properties()"
Returns a boolean value indicating whether the current plugin is configurable.
.SS \fBget_properties()\fP
.IX Subsection "get_properties()"
Returns the Lire::Config::Dictionary object which hold the
plugin configuration.
.SS \fBas_value()\fP
.IX Subsection "as_value()"
Returns an hash reference with two keys : \*(Aqplugin\*(Aq which contains
the selected plugin and \*(Aqproperties\*(Aq which is an hash reference containing
the plugin\*(Aqs properties.
.ie n .SS "get( $name )"
.el .SS "get( \f(CW$name\fP )"
.IX Subsection "get( $name )"
Delegates to the Dictionary which contains the plugin\*(Aqs properties.
.ie n .SS "set( $name, $value )"
.el .SS "set( \f(CW$name\fP, \f(CW$value\fP )"
.IX Subsection "set( $name, $value )"
Delegates to the Dictionary which contains the plugin\*(Aqs properties.
.ie n .SS "is_set( $name )"
.el .SS "is_set( \f(CW$name\fP )"
.IX Subsection "is_set( $name )"
Delegates to the Dictionary which contains the plugin\*(Aqs properties.