Curses:...opupmenu(3)

Curses:...opupmenu(3) — straight outta the User Contributed Perl Documentation, and your bestie is here to walk you through it 💖

🌸 NAME 🌸

Curses::UI::Popupmenu — create and manipulate popupbox widgets. That's the whole name-and-game, bestie ✨

🦋 CLASS HIERARCHY 🦋

        Curses::UI::Widget
           |
           +----Curses::UI::Popupmenu

✨ SYNOPSIS ✨

           use Curses::UI;
           my $cui = new Curses::UI;
           my $win = $cui->add('window_id', 'Window');

           my $popupbox = $win->add(
               'mypopupbox', 'Popupmenu',
               -values    => [1, 2, 3],
               -labels    => { 1 => 'One',
                               2 => 'Two',
                               3 => 'Three' },
           );

           $popupbox->focus();
           my $value = $popupbox->get();

🌸 DESCRIPTION 🌸

Curses::UI::Popupmenu is a widget that can be used to create something very similar to a basic Curses::UI::Listbox. The difference is that the widget will show only the currently selected value (or "-------" if no value is yet selected). The list of possible values will be shown as a separate popup window if requested.

Normally the widget will look something like this:

 [Current value ]

If the popup window is opened, it looks something like this:

 [Current value ]
 +--------------+
 |Other value   |
 |Current value |
 |Third value   |
 +--------------+

🎀 STANDARD OPTIONS 🎀

Every one of these is a standard option, and the explanation lives in Curses::UI::Widget:

• -parent — standard option; see Curses::UI::Widget.
• -x — standard option; see Curses::UI::Widget.
• -y — standard option; see Curses::UI::Widget.
• -width — standard option; see Curses::UI::Widget.
• -height — standard option; see Curses::UI::Widget.
• -pad — standard option; see Curses::UI::Widget.
• -padleft — standard option; see Curses::UI::Widget.
• -padright — standard option; see Curses::UI::Widget.
• -padtop — standard option; see Curses::UI::Widget.
• -padbottom — standard option; see Curses::UI::Widget.
• -ipad — standard option; see Curses::UI::Widget.
• -ipadleft — standard option; see Curses::UI::Widget.
• -ipadright — standard option; see Curses::UI::Widget.
• -ipadtop — standard option; see Curses::UI::Widget.
• -ipadbottom — standard option; see Curses::UI::Widget.
• -title — standard option; see Curses::UI::Widget.
• -titlefullwidth — standard option; see Curses::UI::Widget.
• -titlereverse — standard option; see Curses::UI::Widget.
• -onfocus — standard option; see Curses::UI::Widget.
• -onblur — standard option; see Curses::UI::Widget.

For an explanation of these standard options, see Curses::UI::Widget.

👑 WIDGET-SPECIFIC OPTIONS 👑

The first four are exactly the same as the options for the Listbox widget. So for an explanation of these, take a look at Curses::UI::Listbox.

• -values < LIST > — same as the Listbox option, bestie; check Curses::UI::Listbox for the deets.
• -labels < HASHREF > — also exactly like the Listbox option, so Curses::UI::Listbox is your guide.
• -selected < INDEX > — same Listbox energy; see Curses::UI::Listbox.
• -wraparound < BOOLEAN > — yep, same as Listbox; explanation is in Curses::UI::Listbox.
• -onchange < CODEREF > — sets the onChange event handler for the popupmenu widget. If a new item is selected, the code in CODEREF will be executed. It will get the widget reference as its argument. Slay 💅

💅 METHODS 💅

These are standard methods. See Curses::UI::Widget for an explanation of these:

• new ( OPTIONS ) — standard method; see Curses::UI::Widget.
• layout ( ) — standard method; see Curses::UI::Widget.
• draw ( BOOLEAN ) — standard method; see Curses::UI::Widget.
• intellidraw ( ) — standard method; see Curses::UI::Widget.
• focus ( ) — standard method; see Curses::UI::Widget.
• onFocus ( CODEREF ) — standard method; see Curses::UI::Widget.
• onBlur ( CODEREF ) — standard method; see Curses::UI::Widget.

And the ones with their own little spotlight:

• get ( ) — this method will return the currently selected value. Iconic.
• onChange ( CODEREF ) — this method can be used to set the -onchange event handler (see above) after initialization of the popupmenu.

🌈 DEFAULT BINDINGS 🌈

There are bindings for the widget itself and bindings for the popup listbox that can be opened by this widget.

🧚 The widget itself 🧚

• <tab> — calls the 'loose-focus' routine. This will have the widget loose its focus.
• <enter>, <cursor-right, <l>, <space> — calls the 'open-popup' routine. This will show the popup listbox and bring the focus to this listbox. See The popup listbox below for a description of the bindings for this listbox.
• <cursor-down>, <j> — calls the 'select-next' routine. This will select the item in the list that is after the currently selected item (unless the last item is already selected). If no item is selected, the first item in the list will get selected.
• <cursor-up>, <k> — calls the 'select-prev' routine. This will select the item in the list that is before the currently selected item (unless the first item is already selected). If no item is selected, the first item in the list will get selected.

🍓 The popup listbox 🍓

The bindings for the popup listbox are the same as the bindings for the Listbox widget. So take a look at Curses::UI::Listbox for a description of these. The difference is that the 'loose-focus' and 'option-select' routine will have the popup listbox to close. If the routine 'option-select' is called, the active item will get selected.

🔥 SEE ALSO 🔥

Go peek at: Curses::UI, Curses::UI::Listbox, Curses::UI::Widget, Curses::UI::Common.

💜 AUTHOR 💜

Copyright (c) 2001-2002 Maurice Makaay. All rights reserved.

Maintained by Marcus Thiesen (marcus@cpan.thiesenweb.de)

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.

---

💖 And that's the page! Source/version: perl v5.42.2; date: 2023-07-03; and it's the Curses:...opupmenu(3) page. Bye bestie, go slay those popup menus! 🎀