.\" -*- 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 "Widget 3pm"
.TH Widget 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::UI::Widget \- Views for Lire::Config::Value object.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  use Curses::UI;
\&  use Lire::Config;
\&
\&  Lire::Config\->init();
\&  my $ui = new Curses::UI();
\&  my $window = $ui\->add( \*(Aqwindow\*(Aq, \*(AqWindow\*(Aq );
\&  my $widget = $window\->add( \*(Aqwidget\*(Aq, \*(AqLire::UI::Widget\*(Aq,
\&                             \*(Aqvalue\*(Aq => Lire::Config\->get_var( \*(Aqname\*(Aq ));
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Lire::UI::Widget defines Curses::UI::Widget subclasses that can be
used to edit Lire::Config::Value object.
.ie n .SS "new( %args, \*(Aqvalue\*(Aq => $value, [ onvaluechanged => $handler ] )"
.el .SS "new( \f(CW%args\fP, \*(Aqvalue\*(Aq => \f(CW$value\fP, [ onvaluechanged => \f(CW$handler\fP ] )"
.IX Subsection "new( %args, 'value' => $value, [ onvaluechanged => $handler ] )"
The \fBnew()\fR method is really a factory method which instantiate a proper
Lire::UI::Widget subclass based on the type of the Lire::Config::Value
\&\f(CW$value\fR. The onvaluechanged is an event that will be trigger whenever
the Lire::Config::Value is modified by the user.
.SS \fBvalue()\fP
.IX Subsection "value()"
Returns the Lire::Config::Value object which is edited by this view.
.ie n .SS "onValueChanded( $code )"
.el .SS "onValueChanded( \f(CW$code\fP )"
.IX Subsection "onValueChanded( $code )"
Changes the event handler connected to the \*(Aqonvaluechanged\*(Aq event.
This event is trigger whenever the Lire::Config::Value associated to
this widget is modified.
.SS \fBrefresh_view()\fP
.IX Subsection "refresh_view()"
This method can be called to update the view to reflect modifications
to the underlying Lire::COnfig::Value.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 1
\&  Lire::UI(3pm), Curses::UI(3pm)
.Ve
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR Widget.pm,v 1.27 2006/07/23 13:16:32 vanbaal Exp $
.SH AUTHORS
.IX Header "AUTHORS"
.Vb 2
\&  Francis J. Lacoste <flacoste@logreport.org>
\&  Wolfgang Sourdeau <wolfgang@logreport.org>
.Ve
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2004 Stichting LogReport Foundation LogReport@LogReport.org
.PP
This file is part of Lire.
.PP
Lire is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program (see COPYING); if not, check with
http://www.gnu.org/copyleft/gpl.html.