Test2::EventFacet::Render(3p) Perl Programmers Reference Guide

Test2::EventFacet::Render(3p) Perl Programmers Reference Guide #

Test2::EventFacet::Render(3p) Perl Programmers Reference Guide

NNAAMMEE #

 Test2::EventFacet::Render - Facet that dictates how to render an event.

DDEESSCCRRIIPPTTIIOONN #

 This facet is used to dictate how the event should be rendered by the
 standard test2 rendering tools. If this facet is present then ONLY what
 is specified by it will be rendered. It is assumed that anything
 important or note-worthy will be present here, no other facets will be
 considered for rendering/display.

 This facet is a list type, you can add as many items as needed.

FFIIEELLDDSS #

 $string = $render->[#]->{details}
 $string = $render->[#]->ddeettaaiillss(())
     Human readable text for display.

 $string = $render->[#]->{tag}
 $string = $render->[#]->ttaagg(())
     Tag that should prefix/identify the main text.

 $string = $render->[#]->{facet}
 $string = $render->[#]->ffaacceett(())
     Optional, if the display text was generated from another facet this
     should state what facet it was.

 $mode = $render->[#]->{mode}
 $mode = $render->[#]->mmooddee(())
     calculated
         Calculated means the facet was generated from another facet.
         Calculated facets may be cleared and regenerated whenever the
         event state changes.

     replace
         Replace means the facet is intended to replace the normal
         rendering of the event.

SSOOUURRCCEE #

 The source code repository for Test2 can be found at
 _h_t_t_p_:_/_/_g_i_t_h_u_b_._c_o_m_/_T_e_s_t_-_M_o_r_e_/_t_e_s_t_-_m_o_r_e_/.

MMAAIINNTTAAIINNEERRSS #

 Chad Granum <exodist@cpan.org>

AAUUTTHHOORRSS #

 Chad Granum <exodist@cpan.org>

CCOOPPYYRRIIGGHHTT #

 Copyright 2020 Chad Granum <exodist@cpan.org>.

 This program is free software; you can redistribute it and/or modify it
 under the same terms as Perl itself.

 See _h_t_t_p_:_/_/_d_e_v_._p_e_r_l_._o_r_g_/_l_i_c_e_n_s_e_s_/

perl v5.36.3 2023-02-15 Test2::EventFacet::Render(3p)