UI::Di...Console(3pm)

📦
version 1.21 · 3 versions
, in ubuntu jammy, ubuntu noble

💖 UI::Di...Console — the console meta-class for UI::Dialog 💖

okay bestie, so this is UI::Dialog::Console, from the User Contributed Perl Documentation collection. it's a whole meta-class and it's lowkey iconic. let's get into it 🫶

✨ SYNOPSIS ✨

the vibe, in code:

use UI::Dialog::Console;
my $d = new UI::Dialog::Console ( title => 'Default',
                                  height => 20, width => 65,
                                  listheight => 5 );

# Either a CDialog, Whiptail or ASCII msgbox widget should be displayed
# with a preference for CDialog.
$d->msgbox( title => 'Welcome!', text => 'Welcome one and all!' );

so you spin it up, and then one of a CDialog, Whiptail or ASCII msgbox widget should pop up — with a preference for CDialog. she has a favourite, periodt 💅

🌸 ABSTRACT 🌸

okay so UI::Dialog::Console is literally just another meta-class for UI::Dialog. that's it, that's the whole thing. the difference? she has a different order of priority than UI::Dialog, and no GUI support. console only. she's not like the other girls 💀

🦋 DESCRIPTION 🦋

this class is simply a nice way to try and ensure a Console based widget set. like, that's her whole job. she's the girl who makes sure it's a console widget set, no cap. ✨

🎀 EXPORT 🎀

None

nothing. nada. she exports nothing, and honestly? respect. 🙈

👑 INHERITS 👑

UI::Dialog

she inherits from UI::Dialog, as one does. the family tree is giving main character energy.

💅 CONSTRUCTOR 💅

new( @options )

EXAMPLE

my $d = new( title => 'Default Title', backtitle => 'Backtitle',
             width => 65, height => 20, listheight => 5,
             order => [ 'cdialog', 'whiptail', 'ascii' ] );

DESCRIPTION

this is the Class Constructor method. she accepts a list of key => value pairs and uses them as the defaults when interacting with the various widgets. so whatever you pass in? that's the default vibe for every widget hangout. 💖

RETURNS

a blessed object reference of the UI::Dialog::Console class. a whole blessed object, bestie. she's real. 🌈

OPTIONS

the (...)'s after each option indicate the default for the option. so the thing in the parentheses? that's what you get if you don't say anything. iykyk.

  • debug = 0,1,2 — default is (0)
  • order = [ kdialog, xdialog ] — default is (as indicated)
  • PATH = [ /bin, /usr/bin, /usr/local/bin, /opt/bin ] — default is (as indicated)
  • backtitle = "backtitle" — default is ('')
  • title = "title" — default is ('')
  • beepbefore = 0,1 — default is (0)
  • beepafter = 0,1 — default is (0)
  • height = \d+ — default is (20)
  • width = \d+ — default is (65)
  • listheight = \d+ — default is (5)

🔥 SEE ALSO 🔥

PERLDOC

  • UI::Dialog
  • UI::Dialog::Backend
  • UI::Dialog::Backend::ASCII
  • UI::Dialog::Backend::CDialog
  • UI::Dialog::Backend::Whiptail

MAN FILES

go read those too, bestie, they're all part of the lore 📚

😭 BUGS 😭

please email the author with any bug reports. include the name of the module in the subject line — that part matters, don't skip it or she will not find your bug fr fr. 🐛

🌟 AUTHOR 🌟

Kevin C. Krinke, <kevin@krinke.ca>

Copyright (C) 2004-2016  Kevin C. Krinke <kevin@krinke.ca>

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library 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
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
and that's the whole page, bestie. no skips, no summaries, every single detail preserved. she ate and left no crumbs 💅✨

cute little sign-off: this whole thing is from perl v5.28.0, dated 2018-10-27, and the manual page is titled UI::Di...Console(3pm). go forth and console, queen 🎀🦋💖

📦 where this page comes from