Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::EventFacet::Render.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Test2::EventFacet::Render 3pm"
61 .TH Test2::EventFacet::Render 3pm 2025-06-24 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Test2::EventFacet::Render \- Facet that dictates how to render an event.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 This facet is used to dictate how the event should be rendered by the standard
71 test2 rendering tools. If this facet is present then ONLY what is specified by
72 it will be rendered. It is assumed that anything important or note\-worthy will
73 be present here, no other facets will be considered for rendering/display.
74 .PP
75 This facet is a list type, you can add as many items as needed.
76 .SH FIELDS
77 .IX Header "FIELDS"
78 .ie n .IP "$string = $render\->[#]\->{details}" 4
79 .el .IP "\f(CW$string\fR = \f(CW$render\fR\->[#]\->{details}" 4
80 .IX Item "$string = $render->[#]->{details}"
81 .PD 0
82 .ie n .IP "$string = $render\->[#]\->\fBdetails()\fR" 4
83 .el .IP "\f(CW$string\fR = \f(CW$render\fR\->[#]\->\fBdetails()\fR" 4
84 .IX Item "$string = $render->[#]->details()"
85 .PD
86 Human readable text for display.
87 .ie n .IP "$string = $render\->[#]\->{tag}" 4
88 .el .IP "\f(CW$string\fR = \f(CW$render\fR\->[#]\->{tag}" 4
89 .IX Item "$string = $render->[#]->{tag}"
90 .PD 0
91 .ie n .IP "$string = $render\->[#]\->\fBtag()\fR" 4
92 .el .IP "\f(CW$string\fR = \f(CW$render\fR\->[#]\->\fBtag()\fR" 4
93 .IX Item "$string = $render->[#]->tag()"
94 .PD
95 Tag that should prefix/identify the main text.
96 .ie n .IP "$string = $render\->[#]\->{facet}" 4
97 .el .IP "\f(CW$string\fR = \f(CW$render\fR\->[#]\->{facet}" 4
98 .IX Item "$string = $render->[#]->{facet}"
99 .PD 0
100 .ie n .IP "$string = $render\->[#]\->\fBfacet()\fR" 4
101 .el .IP "\f(CW$string\fR = \f(CW$render\fR\->[#]\->\fBfacet()\fR" 4
102 .IX Item "$string = $render->[#]->facet()"
103 .PD
104 Optional, if the display text was generated from another facet this should
105 state what facet it was.
106 .ie n .IP "$mode = $render\->[#]\->{mode}" 4
107 .el .IP "\f(CW$mode\fR = \f(CW$render\fR\->[#]\->{mode}" 4
108 .IX Item "$mode = $render->[#]->{mode}"
109 .PD 0
110 .ie n .IP "$mode = $render\->[#]\->\fBmode()\fR" 4
111 .el .IP "\f(CW$mode\fR = \f(CW$render\fR\->[#]\->\fBmode()\fR" 4
112 .IX Item "$mode = $render->[#]->mode()"
113 .RS 4
114 .IP calculated 4
115 .IX Item "calculated"
116 .PD
117 Calculated means the facet was generated from another facet. Calculated facets
118 may be cleared and regenerated whenever the event state changes.
119 .IP replace 4
120 .IX Item "replace"
121 Replace means the facet is intended to replace the normal rendering of the
122 event.
123 .RE
124 .RS 4
125 .RE
126 .SH SOURCE
127 .IX Header "SOURCE"
128 The source code repository for Test2 can be found at
129 <https://github.com/Test\-More/test\-more/>.
130 .SH MAINTAINERS
131 .IX Header "MAINTAINERS"
132 .IP "Chad Granum <[email protected]>" 4
133 .IX Item "Chad Granum <[email protected]>"
134 .SH AUTHORS
135 .IX Header "AUTHORS"
136 .IP "Chad Granum <[email protected]>" 4
137 .IX Item "Chad Granum <[email protected]>"
138 .SH COPYRIGHT
139 .IX Header "COPYRIGHT"
140 Copyright Chad Granum <[email protected]>.
141 .PP
142 This program is free software; you can redistribute it and/or
143 modify it under the same terms as Perl itself.
144 .PP
145 See <https://dev.perl.org/licenses/>