WWWWWW

Current Directory: /usr/local/share/man/man3
Viewing File: /usr/local/share/man/man3/Curses::UI::Buttonbox.3pm
.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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::Buttonbox 3"
.TH Curses::UI::Buttonbox 3 "2011-09-01" "perl v5.26.3" "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::Buttonbox \- Create and manipulate button widgets
.SH "CLASS HIERARCHY"
.IX Header "CLASS HIERARCHY"
.Vb 3
\& Curses::UI::Widget
\&    |
\&    +\-\-\-\-Curses::UI::Buttonbox
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    use Curses::UI;
\&    my $cui = new Curses::UI;
\&    my $win = $cui\->add(\*(Aqwindow_id\*(Aq, \*(AqWindow\*(Aq);
\&
\&    my $buttons = $win\->add(
\&        \*(Aqmybuttons\*(Aq, \*(AqButtonbox\*(Aq,
\&        \-buttons   => [
\&            { 
\&              \-label => \*(Aq< Button 1 >\*(Aq,
\&              \-value => 1,
\&              \-shortcut => 1 
\&            },{ 
\&              \-label => \*(Aq< Button 2 >\*(Aq,
\&              \-value => 2,
\&              \-shortcut => 2 
\&            }
\&        ]
\&    );
\&
\&    $buttons\->focus();
\&    my $value = $buttons\->get();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Curses::UI::Buttonbox is a widget that can be used to create an
array of buttons (or, of course, only one button).
.SH "STANDARD OPTIONS"
.IX Header "STANDARD OPTIONS"
\&\fB\-parent\fR, \fB\-x\fR, \fB\-y\fR, \fB\-width\fR, \fB\-height\fR, 
\&\fB\-pad\fR, \fB\-padleft\fR, \fB\-padright\fR, \fB\-padtop\fR, \fB\-padbottom\fR,
\&\fB\-ipad\fR, \fB\-ipadleft\fR, \fB\-ipadright\fR, \fB\-ipadtop\fR, \fB\-ipadbottom\fR,
\&\fB\-title\fR, \fB\-titlefullwidth\fR, \fB\-titlereverse\fR, \fB\-onfocus\fR, 
\&\fB\-onblur\fR
.PP
For an explanation of these standard options, see 
Curses::UI::Widget.
.SH "WIDGET-SPECIFIC OPTIONS"
.IX Header "WIDGET-SPECIFIC OPTIONS"
.IP "\(bu" 4
\&\fB\-buttons\fR < \s-1ARRAYREF\s0 >
.Sp
This option takes a reference to a list of buttons.
The list may contain both predefined button types and  
complete button definitions of your own.
.Sp
* \fBYour own button definition\fR
.Sp
.Vb 2
\&  A button definition is a reference to a hash. This
\&  hash can have the following key\-value pairs:
\&
\&  obligatory:
\&  \-\-\-\-\-\-\-\-\-\-\-
\&
\&  \-label      This determines what text should be drawn
\&              on the button.
\&
\&  optional:
\&  \-\-\-\-\-\-\-\-\-
\&
\&  \-value      This determines the returnvalue for the
\&              get() method. If the value is not defined,
\&              the get() method will return the index
\&              of the button.
\&
\&  \-shortcut   The button will act as if it was pressed
\&              if the key defined by \-shortcut is pressed 
\&
\&  \-onpress    If the value for \-onpress is a CODE reference,
\&              this code will be executes if the button
\&              is pressed, before the buttons widget loses
\&              focus and returns.
.Ve
.Sp
* \fBPredefined button type\fR
.Sp
.Vb 3
\&  This module has a predefined list of frequently used button
\&  types. Using these in B<\-buttons> makes things a lot
\&  easier. The predefined button types are:
\&
\&  ok          \-label    => \*(Aq< OK >\*(Aq
\&              \-shortcut => \*(Aqo\*(Aq
\&              \-value    => 1
\&              \-onpress  => undef
\&
\&  cancel      \-label    => \*(Aq< Cancel >\*(Aq
\&              \-shortcut => \*(Aqc\*(Aq
\&              \-value    => 0
\&              \-onpress  => undef
\&
\&  yes         \-label    => \*(Aq< Yes >\*(Aq
\&              \-shortcut => \*(Aqy\*(Aq
\&              \-value    => 1
\&              \-onpress  => undef
\&
\&  no          \-label    => \*(Aq< No >\*(Aq
\&              \-shortcut => \*(Aqn\*(Aq
\&              \-value    => 0
\&              \-onpress  => undef
.Ve
.Sp
Example:
.Sp
.Vb 5
\&  ....
\&  \-buttons => [
\&      { \-label => \*(Aq< My own button >\*(Aq,
\&        \-value => \*(Aqmine!\*(Aq,
\&        \-shortcut => \*(Aqm\*(Aq },
\&
\&      \*(Aqok\*(Aq,
\&
\&      \*(Aqcancel\*(Aq,
\&
\&      { \-label => \*(Aq< My second button >\*(Aq,
\&        \-value => \*(Aqanother one\*(Aq,
\&        \-shortcut => \*(Aqs\*(Aq,
\&        \-onpress => sub { die "Do not press this button!\en" } }
\&  ]
\&  ....
.Ve
.IP "\(bu" 4
\&\fB\-selected\fR < \s-1INDEX\s0 >
.Sp
By default the first button (index = 0) is active. If you
want another button to be active at creation time, 
add this option. The \s-1INDEX\s0 is the index of the button you
want to make active.
.IP "\(bu" 4
\&\fB\-buttonalignment\fR < \s-1VALUE\s0 >
.Sp
You can specify how the buttons should be aligned in the 
widget. Available values for \s-1VALUE\s0 are 'left', 'middle' 
and 'right'.
.IP "\(bu" 4
\&\fB\-vertical\fR < \s-1BOOLEAN\s0 >
.Sp
When set to a true value, it will cause the buttons to be
rendered with vertical instead of horizontal alignment.
.SH "METHODS"
.IX Header "METHODS"
.IP "\(bu" 4
\&\fBnew\fR ( \s-1OPTIONS\s0 )
.IP "\(bu" 4
\&\fBlayout\fR ( )
.IP "\(bu" 4
\&\fBdraw\fR ( \s-1BOOLEAN\s0 )
.IP "\(bu" 4
\&\fBfocus\fR ( )
.IP "\(bu" 4
\&\fBonFocus\fR ( \s-1CODEREF\s0 )
.IP "\(bu" 4
\&\fBonBlur\fR ( \s-1CODEREF\s0 )
.IP "\(bu" 4
\&\fBdraw_if_visible\fR ( )
.Sp
These are standard methods. See Curses::UI::Widget 
for an explanation of these.
.IP "\(bu" 4
\&\fBget\fR ( )
.Sp
This method will return the index of the currently active
button. If a value is given for that index (using the
\&\fB\-value\fR option, see \fB\-buttons\fR above), that value will be 
returned.
.SH "DEFAULT BINDINGS"
.IX Header "DEFAULT BINDINGS"
.IP "\(bu" 4
<\fBenter\fR>, <\fBspace\fR>
.Sp
\&\s-1TODO:\s0 Fix dox
Call the 'loose\-focus' routine. By default this routine will have the
container in which the widget is loose its focus. If you do
not like this behaviour, then you can have it loose focus itself
by calling:
.Sp
.Vb 1
\&    $buttonswidget\->set_routine(\*(Aqloose\-focus\*(Aq, \*(AqRETURN\*(Aq);
.Ve
.Sp
For an explanation of \fBset_routine\fR, see 
Curses::UI::Widget.
.IP "\(bu" 4
<\fBcursor left\fR>, <\fBh\fR>
.Sp
Call the 'previous' routine. This will make the previous
button the active button. If the active button already is
the first button, nothing will be done.
.IP "\(bu" 4
<\fBcursor right\fR>, <\fBl\fR
.Sp
Call the 'next' routine. This will make the next button the
active button. If the next button already is the last button,
nothing will be done.
.IP "\(bu" 4
<\fBany other key\fR>
.Sp
This will call the 'shortcut' routine. This routine will 
handle the shortcuts that are set by the \fB\-shortcuts\fR option.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Curses::UI, 
Curses::UI::Widget, 
Curses::UI::Common
.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 \*(L"as is\*(R" without express
or implied warranty. It may be used, redistributed and/or modified
under the same terms as perl itself.
F1l3 Manager
