.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" 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 .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . 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 "Event::ExecFlow::Frontend 3" .TH Event::ExecFlow::Frontend 3 2023-07-25 "perl v5.38.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 Event::ExecFlow::Frontend \- Abstract base class for custom frontends .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 4 \& #\-\- Derived from Event::ExecFlow::Frontend \& my $frontend = MyApp::GUI::Frontent\->new(); \& my $job = Event::ExecFlow::Job::Command\->new ( ... ); \& $frontend\->start_job($job); \& \& #\-\- Later the following methods are called and need to \& #\-\- by implemented by you \& $frontend\->report_job_start($job); \& $frontend\->report_job_progress($job); \& $frontend\->report_job_error($job); \& $frontend\->report_job_warning($job); \& $frontend\->report_job_finished($job); \& $frontend\->log($message); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" This is an abstract base class and usually not used directly from the application. For daily programming the attributes defined in this class are most important, since they are common to all Jobs of the Event::ExecFlow framework. .SH "OBJECT HIERARCHY" .IX Header "OBJECT HIERARCHY" .Vb 1 \& Event::ExecFlow \& \& Event::ExecFlow::Job \& +\-\-\- Event::ExecFlow::Job::Group \& +\-\-\- Event::ExecFlow::Job::Command \& +\-\-\- Event::ExecFlow::Job::Code \& \& Event::ExecFlow::Frontend \& Event::ExecFlow::Callbacks \& Event::ExecFlow::Scheduler \& +\-\-\- Event::ExecFlow::Scheduler::SimpleMax .Ve .SH METHODS .IX Header "METHODS" [ FIXME: describe all methods in detail ] .SH AUTHORS .IX Header "AUTHORS" .Vb 1 \& Jörn Reder .Ve .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 2005\-2006 by Jörn Reder. .PP This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. .PP 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 Library General Public License for more details. .PP You should have received a copy of the GNU Library 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. .SH "POD ERRORS" .IX Header "POD ERRORS" Hey! \fBThe above document had some coding errors, which are explained below:\fR .IP "Around line 123:" 4 .IX Item "Around line 123:" Non-ASCII character seen before =encoding in 'Jörn'. Assuming CP1252