Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
UI::Dialog::Backend::KUseroContributed Perl DocUI::Dialog::Backend::KDialog(3)

NAME
       UI::Dialog::Backend::KDialog - backend for the KDE dialog variant.

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

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

ABSTRACT
       UI::Dialog::Backend::KDialog is the UI::Dialog backend for the KDE
       dialog variant. While this module is used through UI::Dialog or any
       other loader module only	the compatible methods are ever	accessible.
       However,	when using this	module directly	in your	application (as	in the
       SYNOPSIS	example) you are given access to all the options and features
       of the real kdialog(1) application.

DESCRIPTION
       Although	this dialog variant doesn't have any progress meters, it does
       have the	benefits of many different file/uri/directory widgets. It's a
       shame that this is the only dialog variant for KDE.

EXPORT
	 None

INHERITS
	 UI::Dialog::Backend

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.

       RETURNS
		 A blessed object reference of the
		 UI::Dialog::Backend::KDialog class.

       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" ('')	*
	   nocancel = 0,1 (0) *
	   defaultno = 0,1 (0) *
	   beepbefore =	0,1 (0)	*
	   beepafter = 0,1 (0) *
	   extrabutton = 0,1 (0) *
	   extralabel =	"extra label" (0) *
	   helpbutton =	0,1 (0)	*
	   helplabel = "help label" (0)	*
	   maxinput = \d+ (0) *

WIDGET METHODS
   yesno( ) yesnocancel( ) warningyesno( ) warningyesnocancel( )
       EXAMPLE
	    # if ($d->warningyesnocancel( text => 'A question?') ) {
	    # if ($d->warningyesno( text => 'A question?') ) {
	    # if ($d->yesnocancel( text	=> 'A question?') ) {
	    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,
		 yes and no.

       RETURNS
		 TRUE \fIs0(1) for a response of YES or	FALSE \fIs0(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.

       RETURNS
		 TRUE \fIs0(1) for a response of OK or FALSE \fIs0(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.

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

   inputbox( )
       EXAMPLE
	    my $string = $d->inputbox( text => '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 \fIs0(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 \fIs0(1) if the response is OK and FALSE \fIs0(0)	for
		 anything else.

   menu( )
       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
		 \fIs0(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.

       RETURNS
		 an ARRAY of the chosen	tags if	the response is	OK and FALSE
		 \fIs0(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
		 \fIs0(0) for anything else.

   fselect( ) getopenfilename( ) getsavefilename( ) getopenurl(	) getsaveurl(
       )
       EXAMPLE
	    # my $text = $d->getsaveurl( path => '/path/' );
	    # my $text = $d->getopenurl( path => '/path/' );
	    # my $text = $d->getsavefilename( path => '/path/' );
	    # my $text = $d->getopenfilename( path => '/path/' );
	    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 \fIs0(0) for
		 anything else.

   dselect( ) getexistingdirectory( )
       EXAMPLE
	    # my $text = $d->getexistingdirectory( path	=> '/path/to/a/dir' );
	    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.

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

SEE ALSO
       PERLDOC
	  UI::Dialog
	  UI::Dialog::KDE
	  UI::Dialog::Backend
	  UI::Dialog::Backend::XOSD

       MAN FILES
	 None. Use `kdialog --help` from a command line.

BUGS
       Please email the	author with any	bug reports. Include the name of the
       module in the subject line.

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

COPYRIGHT AND LICENSE
	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

perl v5.24.1			  2016-02-03   UI::Dialog::Backend::KDialog(3)

NAME | SYNOPSIS | ABSTRACT | DESCRIPTION | EXPORT | INHERITS | CONSTRUCTOR | WIDGET METHODS | SEE ALSO | BUGS | AUTHOR | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=UI::Dialog::Backend::KDialog&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help