.\" 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 "CLI::Framework::Command::Meta 3pm" .TH CLI::Framework::Command::Meta 3pm "2021-01-09" "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" CLI::Framework::Command::Meta \- Represent "metacommands" (app\-aware commands) .SH "DESCRIPTION" .IX Header "DESCRIPTION" This class is a subclass of CLI::Framework::Command. It defines \&\*(L"metacommands\*(R", commands that are application-aware (and thus, implicitly aware of all other commands registered within the application). Metacommands have methods that set and retrieve a reference to the application within which they are running. .PP This class exists as a separate class because, with few exceptions, commands should be independent of the application they are associated with and should not affect that application. Metacommands represent the exception to that rule. In the exceptional cases, your command will inherit from this one instead of \&\f(CW\*(C`CLI::Framework::Command\*(C'\fR. .SH "WHEN TO BUILD METACOMMANDS VS REGULAR COMMANDS" .IX Header "WHEN TO BUILD METACOMMANDS VS REGULAR COMMANDS" See tutorial advice on this topic. .SH "METHODS" .IX Header "METHODS" .ie n .SS "\fBget_app()\fP / set_app( $app )" .el .SS "\fBget_app()\fP / set_app( \f(CW$app\fP )" .IX Subsection "get_app() / set_app( $app )" Retrieve or set the application object associated with a metacommand object. .PP .Vb 1 \& $app = $command\->get_app(); \& \& $command\->set_app( $app ); .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" CLI::Framework::Command .PP CLI::Framework::Application