.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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::Dialog::Status 3pm" .TH Curses::UI::Dialog::Status 3pm "2021-01-01" "perl v5.32.0" "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::Dialog::Status \- Create and manipulate status dialogs .SH "CLASS HIERARCHY" .IX Header "CLASS HIERARCHY" .Vb 7 \& Curses::UI::Widget \& | \& +\-\-\-\-Curses::UI::Container \& | \& +\-\-\-\-Curses::UI::Window \& | \& +\-\-\-\-Curses::UI::Dialog::Status .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); \& \& # The hard way. \& # \-\-\-\-\-\-\-\-\-\-\-\-\- \& my $dialog = $win\->add( \& \*(Aqmydialog\*(Aq, \*(AqDialog::Status\*(Aq, \& \-message => \*(AqHello, world!\*(Aq, \& ); \& \& $dialog\->draw(); \& \& $win\->delete(\*(Aqmydialog\*(Aq); \& \& # The easy way (see Curses::UI documentation). \& # \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \& $cui\->status( \-message => \*(AqSome message\*(Aq ); \& \& # or even: \& $cui\->status( \*(AqSome message\*(Aq ); \& \& $cui\->nostatus; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Curses::UI::Dialog::Status is not really a dialog, since the user has no way of interacting with it. It is merely a way of presenting status information to the user of your program. .PP See exampes/demo\-Curses::UI::Dialog::Status in the distribution for a short demo. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\(bu" 4 \&\fB\-title\fR < \s-1TEXT\s0 > .Sp Set the title of the dialog window to \s-1TEXT.\s0 .IP "\(bu" 4 \&\fB\-message\fR < \s-1TEXT\s0 > .Sp This option sets the initial message to show to \s-1TEXT.\s0 .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 ) .Sp These are standard methods. See Curses::UI::Container for an explanation of these. .IP "\(bu" 4 \&\fBmessage\fR ( \s-1TEXT\s0 ) .Sp This method will update the message of the status dialog to \s-1TEXT.\s0 For this update to show, you will have to call the \&\fBdraw\fR method of the progress dialog. .SH "SEE ALSO" .IX Header "SEE ALSO" Curses::UI, Curses::UI::Container .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.