.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
.\" ========================================================================
.\"
.IX Title "Curses::UI::Searchable 3"
.TH Curses::UI::Searchable 3 2023-07-25 "perl v5.38.0" "User Contributed Perl 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
Curses::UI::Searchable \- Add 'less'\-like search abilities to a widget
.SH "CLASS HIERARCHY"
.IX Header "CLASS HIERARCHY"
.Vb 1
\& Curses::UI::Searchable \- base class
.Ve
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    package MyWidget;
\&
\&    use Curses::UI::Searchable;
\&    use vars qw(@ISA);
\&    @ISA = qw(Curses::UI::Searchable);
\&
\&    ....
\&
\&    sub new () {
\&        # Create class instance $this.
\&        ....
\&
\&        $this\->set_routine(\*(Aqsearch\-forward\*(Aq, \e&search_forward);
\&        $this\->set_binding(\*(Aqsearch\-forward\*(Aq, \*(Aq/\*(Aq);
\&        $this\->set_routine(\*(Aqsearch\-backward\*(Aq, \e&search_backward);
\&        $this\->set_binding(\*(Aqsearch\-backward\*(Aq, \*(Aq?\*(Aq);
\&    }
\&
\&    sub layout_content() {
\&        my $this = shift;
\&
\&        # Layout your widget\*(Aqs content.
\&        ....
\&
\&        return $this;
\&    }
\&
\&    sub number_of_lines() {
\&        my $this = shift;
\&
\&        # Return the number of lines in
\&        # the widget\*(Aqs content.
\&        return ....
\&    }
\&
\&    sub getline_at_ypos($;) {
\&        my $this = shift;
\&        my $ypos = shift; 
\&
\&        # Return the content on the line 
\&        # where ypos = $ypos
\&        return ....
\&    }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Using Curses::UI::Searchable, you can add 'less'\-like
search capabilities to your widget.
.PP
To make your widget searchable using this class,
your widget should meet the following requirements:
.IP \(bu 4
\&\fBmake it a descendant of Curses::UI::Searchable\fR
.Sp
All methods for searching are in Curses::UI::Searchable.
By making your class a descendant of this class, these
methods are automatically inherited.
.IP \(bu 4
\&\fB\-ypos data member\fR
.Sp
The current vertical position in the widget should be
identified by \f(CW$this\fR\->{\-ypos}. This y\-position is the
index of the line of content. Here's an example for 
a Listbox widget.
.Sp
.Vb 8
\& \-ypos
\&   |
\&   v
\&       +\-\-\-\-\-\-+
\&   0   |One   |
\&   1   |Two   |
\&   2   |Three |
\&       +\-\-\-\-\-\-+
.Ve
.IP \(bu 4
\&\fBmethod: number_of_lines ( )\fR
.Sp
Your widget class should have a method \fBnumber_of_lines\fR,
which returns the total number of lines in the widget's 
content. So in the example above, this method would
return the value 3.
.IP \(bu 4
\&\fBmethod: getline_at_ypos ( YPOS )\fR
.Sp
Your widget class should have a method \fBgetline_at_ypos\fR,
which returns the line of content at \-ypos YPOS.
So in the example above, this method would return
the value "Two" for YPOS = 1.
.IP \(bu 4
\&\fBmethod: layout_content ( )\fR
.Sp
The search routines will set the \-ypos of your widget if a
match is found for the given search string. Your \fBlayout_content\fR
routine should make sure that the line of content at \-ypos
will be made visible if the \fBdraw\fR method is called.
.IP \(bu 4
\&\fBmethod: draw ( )\fR
.Sp
If the search routines find a match, \f(CW$this\fR\->{\-search_highlight}
will be set to the \-ypos for the line on which the match
was found. If no match was found \f(CW$this\fR\->{\-search_highlight}
will be undefined. If you want a matching line to be highlighted, 
in your widget, you can use this data member to do so
(an example of a widget that uses this option is the 
Curses::UI::TextViewer widget).
.IP \(bu 4
\&\fBbindings for searchroutines\fR
.Sp
There are two search routines. These are \fBsearch_forward\fR and
\&\fBsearch_backward\fR. These have to be called in order to 
display the search prompt. The best way to do this is by
creating bindings for them. Here's an example which will
make '/' a forward search and '?' a backward search:
.Sp
.Vb 4
\&    $this\->set_routine(\*(Aqsearch\-forward\*(Aq  , \e&search_forward);
\&    $this\->set_binding(\*(Aqsearch\-forward\*(Aq  , \*(Aq/\*(Aq);
\&    $this\->set_routine(\*(Aqsearch\-backward\*(Aq , \e&search_backward);
\&    $this\->set_binding(\*(Aqsearch\-backward\*(Aq , \*(Aq?\*(Aq);
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Curses::UI,
.SH AUTHOR
.IX Header "AUTHOR"
Copyright (c) 2001\-2002 Maurice Makaay. All rights reserved.
.PP
Maintained by Marcus Thiesen (marcus@cpan.thiesenweb.de)
.PP
This package is free software and is provided "as is" without express
or implied warranty. It may be used, redistributed and/or modified
under the same terms as perl itself.