.\" -*- 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 "Firefox::Marionette::Display 3pm" .TH Firefox::Marionette::Display 3pm 2024-05-15 "perl v5.38.2" "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 Firefox::Marionette::Display \- Represents a display from the displays method .SH VERSION .IX Header "VERSION" Version 1.57 .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 3 \& use Firefox::Marionette(); \& use Encode(); \& use v5.10; \& \& my $firefox = Firefox::Marionette\->new( visible => 1, kiosk => 1 )\->go(\*(Aqhttp://metacpan.org\*(Aq);; \& my $element = $firefox\->find_id(\*(Aqmetacpan_search\-input\*(Aq); \& foreach my $display ($firefox\->displays()) { \& say \*(AqCan Firefox resize for "\*(Aq . Encode::encode(\*(AqUTF\-8\*(Aq, $display\->usage(), 1) . \*(Aq"?\*(Aq; \& if ($firefox\->resize($display\->width(), $display\->height())) { \& say \*(AqNow displaying with a Pixel aspect ratio of \*(Aq . $display\->par(); \& say \*(AqNow displaying with a Storage aspect ratio of \*(Aq . $display\->sar(); \& say \*(AqNow displaying with a Display aspect ratio of \*(Aq . $display\->dar(); \& } else { \& say \*(AqApparently NOT!\*(Aq; \& } \& } .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" This module handles the implementation of a display . .SH SUBROUTINES/METHODS .IX Header "SUBROUTINES/METHODS" .SS dar .IX Subsection "dar" returns the Display aspect ratio for the display. .SS designation .IX Subsection "designation" returns the designation value, such as "VGA" or "16K". .SS height .IX Subsection "height" returns the resolution height .SS new .IX Subsection "new" accepts a hash for the display with the following allowed keys; .IP \(bu 4 designation \- See the designation column. .IP \(bu 4 usage \- See the usage column. .IP \(bu 4 width \- The width of the entire firefox window. .IP \(bu 4 height \- The height of the entire firefox window. .IP \(bu 4 sar \- The Storage aspect ratio , which is related to the below ratios with the equation SAR = PAR/DAR. .IP \(bu 4 dar \- The Display aspect ratio . .IP \(bu 4 par \- The Pixel aspect ratio . .SS par .IX Subsection "par" returns the Pixel aspect ratio for the display. .SS sar .IX Subsection "sar" returns the Storage aspect ratio , which is related to the below ratios with the equation SAR = PAR/DAR. .SS total .IX Subsection "total" returns the product of height and width. .SS usage .IX Subsection "usage" returns the usage value such as "Apple PowerBook G4". .SS width .IX Subsection "width" returns the resolution width .SH DIAGNOSTICS .IX Header "DIAGNOSTICS" None. .SH "CONFIGURATION AND ENVIRONMENT" .IX Header "CONFIGURATION AND ENVIRONMENT" Firefox::Marionette::Display requires no configuration files or environment variables. .SH DEPENDENCIES .IX Header "DEPENDENCIES" Firefox::Marionette::Display does not requires any non-core Perl modules .SH INCOMPATIBILITIES .IX Header "INCOMPATIBILITIES" None reported. .SH "BUGS AND LIMITATIONS" .IX Header "BUGS AND LIMITATIONS" To report a bug, or view the current list of bugs, please visit .SH AUTHOR .IX Header "AUTHOR" David Dick \f(CW\*(C`\*(C'\fR .SH "LICENSE AND COPYRIGHT" .IX Header "LICENSE AND COPYRIGHT" Copyright (c) 2024, David Dick \f(CW\*(C`\*(C'\fR. All rights reserved. .PP This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See "perlartistic" in perlartistic. .SH "DISCLAIMER OF WARRANTY" .IX Header "DISCLAIMER OF WARRANTY" BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION. .PP IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.