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

πŸ“¦
version 1.21 Β· 3 versions
, in ubuntu jammy, ubuntu noble

πŸ’– UI::Dialog::Backend::Zenity πŸ’–

okay bestie, so this is the perl doc page for UI::Dialog::Backend::Zenity β€” it lives in section 3pm of the User Contributed Perl Documentation, and it's literally the whole vibe of wrapping the Zenity app in Perl. let's get into it 🫢


✨ NAME ✨

UI::Dialog::Backend::Zenity β€” a wrapper of the Zenity application. that's it, that's the name, slay.


🌸 SYNOPSIS 🌸

use UI::Dialog::Backend::Zenity;
my $d = new UI::Dialog::Backend::Zenity ( backtitle => 'Demo',
                                          title => 'Default' );

$d->msgbox( title => 'Welcome!', text => 'Welcome one and all!' );

see how easy that is?? no cap, that's the whole thing πŸ’…


πŸ¦‹ ABSTRACT πŸ¦‹

okay so Zenity is the speedy, slick, and ultimately cool GTK2 dialog variant β€” it's the one that is destined to obselete the current GNOME dialog variant, GDialog. (yes, the original page says "obselete", we're keeping it, it's iconic πŸ’€). and this module? it's an OOPerl wrapper of the Zenity application. main character energy fr fr.


🌈 DESCRIPTION 🌈

UI::Dialog::Backend::Zenity is the UI::Dialog backend for the new GNOME dialog variant. while this module is used through UI::Dialog or any other loader module, only the compatible methods are ever accessible. but here's the tea: when you use this module directly in your own application (like in the SYNOPSIS example up there πŸ‘†) you get access to all the options and features of the real zenity(1) application. all of them. the full menu. periodt.


πŸŽ€ EXPORT πŸŽ€

None

nope. nothing exported. it's giving minimalist.


πŸ‘‘ INHERITS πŸ‘‘

UI::Dialog::Backend

that's the parent, the blueprint, the ancestry πŸ’œ


πŸ’… CONSTRUCTOR πŸ’…

new( @options )

EXAMPLE

my $d = new( title => 'Default Title', backtitle => 'Backtitle',
             width => 65, height => 20, listheight => 5 );

DESCRIPTION

This is the Class Constructor method. it accepts a list of key => value pairs and uses them as the defaults when interacting with the various widgets. basically you're setting the vibe once and everything after that just follows 🫢

RETURNS

A blessed object reference of the UI::Dialog::Backend::Zenity class. blessed, as in officially anointed ✨

OPTIONS

The (...)'s after each option indicate the default for the option. An * denotes support by all the widget methods on a per-use policy defaulting to the values decided during object creation.

  • debug = 0,1,2 (0)
  • literal = 0,1 (0)
  • backtitle = "backtitle" ('') *
  • title = "title" ('') *
  • height = \d+ (0) *
  • width = \d+ (0) *
  • display = ":0" ('') *
  • name = "wmname" ('') *
  • class = "wmclass" ('') *
  • beepbin = "/usr/bin/beep" ('')
  • beepbefore = 0,1 (0) *
  • beepafter = 0,1 (0) *

πŸ”₯ WIDGET METHODS πŸ”₯

yesno( ) and question( )

EXAMPLE

if ($d->yesno( text => 'A binary type question?') ) {
    # user pressed yes
} else {
    # user pressed no or cancel
}

DESCRIPTION

Present the end user with a message box that has two buttons, OK and CANCEL (aka: Yes and No). yesno() is a wrapper for question(). same energy, two names πŸ’«

RETURNS

TRUE (1) for a response of YES or FALSE (0) for anything else.


msgbox( )

EXAMPLE

$d->msgbox( text => 'A simple message' );

DESCRIPTION

Pesent the end user with a message box that has an OK button. (yep, "Pesent" β€” we're keeping the typo, it's part of the lore 😭)

RETURNS

TRUE (1) for a response of OK or FALSE (0) for anything else.


password( )

EXAMPLE

my $string = $d->password( text => 'Enter some (hidden) text.' );

DESCRIPTION

Present the end user with a text input field that doesn't reveal the input (except to the script) and a message. sneaky. secretive. exactly what you want πŸ•΅οΈ

RETURNS

a SCALAR if the response is OK and FALSE (0) for anything else.


inputbox( )

EXAMPLE

my $string = $d->inputbox( text => 'Please enter some text...',
                           entry => 'this is the input field' );

DESCRIPTION

Present the end user with a text input field and a message.

RETURNS

a SCALAR if the response is OK and FALSE (0) for anything else.


textbox( )

EXAMPLE

$d->textbox( path => '/path/to/a/text/file' );

DESCRIPTION

Present the end user with a simple scrolling box containing the contents of the given text file.

RETURNS

TRUE (1) if the response is OK and FALSE (0) for anything else.


editbox( )

EXAMPLE

$d->editbox( path => '/path/to/a/text/file' );

DESCRIPTION

Present the end user with an editable textbox containing the contents of the given text file. go ahead, change it, it's editable bestie ✏️

RETURNS

A SCALAR containing the edited text if the response is OK and FALSE (0) for anything else.


EXAMPLE

my $selection1 = $d->menu( text => 'Select one:',
                           list => [ 'tag1', 'item1',
                                     'tag2', 'item2',
                                     'tag3', 'item3' ] );

DESCRIPTION

Present the user with a selectable list.

RETURNS

a SCALAR of the chosen tag if the response is OK and FALSE (0) for anything else.


checklist( )

EXAMPLE

my @selection = $d->checklist( text => 'Select one:',
                               list => [ 'tag1', [ 'item1', 0 ],
                                         'tag2', [ 'item2', 1 ],
                                         'tag3', [ 'item3', 1 ] ]
                             );

DESCRIPTION

Present the user with a selectable checklist. multiple picks, no problem πŸ’–

RETURNS

an ARRAY of the chosen tags if the response is OK and FALSE (0) for anything else.


radiolist( )

EXAMPLE

my $selection = $d->radiolist( text => 'Select one:',
                               list => [ 'tag1', [ 'item1', 0 ],
                                         'tag2', [ 'item2', 1 ],
                                         'tag3', [ 'item3', 0 ] ]
                             );

DESCRIPTION

Present the user with a selectable radiolist.

RETURNS

a SCALAR of the chosen tag if the response is OK and FALSE (0) for anything else.


fselect( )

EXAMPLE

my $text = $d->fselect( path => '/path/to/a/file/or/directory' );

DESCRIPTION

Present the user with a file selection widget preset with the given path.

RETURNS

a SCALAR if the response is OK and FALSE (0) for anything else.


dselect( )

EXAMPLE

my $text = $d->dselect( path => '/path/to/a/directory' );

DESCRIPTION

Present the user with a file selection widget preset with the given path. Unlike fselect() this widget will only return a directory selection. directories only, no files allowed, strict queen behavior πŸŽ€

RETURNS

a SCALAR if the response is OK and FALSE (0) for anything else.


calendar( )

EXAMPLE

my $date = $d->calendar( day => 10, month => 10, year => 1977,
                         'date-format' => '%d/%m/%y' );

DESCRIPTION

Present the user with a calendar so that they may select a date. The 'date-format' option follows the same format definition as the date(1) command line program. If the day, month and year options are not provided, the widget defaults to the current date. The default format for the date string is '%d/%m/%y' which breaks down to: "dd/mm/yy".

RETURNS

a SCALAR if the response is OK and FALSE (0) for anything else.


gauge_start( )

EXAMPLE

$d->gauge_start( text => 'gauge...', percentage => 1 );

DESCRIPTION

Display a meter bar to the user. This get's the widget realized but requires the use of the other gauge_*() methods for functionality. (yes, "get's". we don't fix it. it's canon πŸ’€)

RETURNS

TRUE (1) if the widget loaded fine and FALSE (0) for anything else.


gauge_inc( )

EXAMPLE

$d->gauge_inc( 1 );

DESCRIPTION

Increment the meter by the given amount. up up up ⬆️

RETURNS

TRUE (1) if the widget incremented fine and FALSE (0) for anything else.


gauge_dec( )

EXAMPLE

$d->gauge_dec( 1 );

DESCRIPTION

Decrement the meter by the given amount. down down down ⬇️

RETURNS

TRUE (1) if the widget incremented fine and FALSE (0) for anything else.


gauge_set( )

EXAMPLE

$d->gauge_set( 99 );

DESCRIPTION

Set the meter bar to the given amount. just. put it there. exactly there πŸ“

RETURNS

TRUE (1) if the widget set fine and FALSE (0) for anything else.


gauge_stop( )

EXAMPLE

$d->gauge_stop();

DESCRIPTION

End the meter bar widget process. bye bye gauge πŸ‘‹

RETURNS

TRUE (1) if the widget closed fine and FALSE (0) for anything else.


🧚 SEE ALSO 🧚

PERLDOC

  • UI::Dialog
  • UI::Dialog::GNOME
  • UI::Dialog::Backend
  • UI::Dialog::Backend::Nautilus
  • UI::Dialog::Backend::XOSD

MAN FILES


😭 BUGS 😭

Please email the author with any bug reports. Include the name of the module in the subject line. (subject line matters bestie, don't skip it πŸ™ˆ)


πŸ’œ 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 a wrap on the whole entire page, no skips, no cuts πŸ’…

okay so the footer energy: this page came from perl v5.28.0, dated 2018-10-27, and the manual name/section at the top is UI::Di...:Zenity(3pm) (they truncated it, not me, it's literally UI::Dialog::Backend::Zenity in 3pm β€” iykyk 🌸). mwah, go write some dialogs 🫢✨

πŸ“¦ where this page comes from