.\" 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 "Net::Hotline::FileInfoItem 3pm" .TH Net::Hotline::FileInfoItem 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" Net::Hotline::FileInfoItem \- File object used internally by Net::Hotline::Client .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Net::Hotline::FileInfoItem; \& \& $file = new Net::Hotline::FileInfoItem; \& \& $file\->name("smile"); \& $file\->comments("A happy file."); \& ... .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Net::Hotline::FileInfoItem is a simple class for storing and retrieving file information, You should never have to create your own Net::Hotline::FileInfoItem objects when using Net::Hotline::Client. Getting and (to a lesser extent) setting attributes is all that should be necessary. .SH "CONSTRUCTION" .IX Header "CONSTRUCTION" .IP "new" 4 .IX Item "new" Creates a new Net::Hotline::FileInfoItem object with all attributes set to undef. .SH "METHODS" .IX Header "METHODS" All the Net::Hotline::FileInfoItem methods are simple attribute get/set routines. If given an argument, they set an attribute. In all cases, they return the current value of the attribute. .IP "comment \s-1TEXT\s0" 4 .IX Item "comment TEXT" The file comments (as seen in the Mac \s-1OS\s0 Finder). .IP "ctime \s-1NUM\s0" 4 .IX Item "ctime NUM" The creation time of the file, given as a Mac \s-1OS\s0 native time value. Add the constant Net::Hotline::Constants::HTLC_MACOS_TO_UNIX_TIME to it to change it to seconds since the Unix epoch. .IP "creator \s-1TEXT\s0" 4 .IX Item "creator TEXT" The file creator, given as a four-letter Mac \s-1OS\s0 creator code (\*(L"\s-1TTXT\*(R", \*(L"SIT\s0!\*(R", etc.) .IP "name \s-1TEXT\s0" 4 .IX Item "name TEXT" The file name. .IP "icon" 4 .IX Item "icon" The file icon given as a four-letter code. .IP "mtime \s-1NUM\s0" 4 .IX Item "mtime NUM" The modification time of the file, given as a Mac \s-1OS\s0 native time value. Add the constant Net::Hotline::Constants::HTLC_MACOS_TO_UNIX_TIME to it to change it to seconds since the Unix epoch. .IP "ctime \s-1NUM\s0" 4 .IX Item "ctime NUM" The creation time of the file, given as a Mac \s-1OS\s0 native time value. Add the constant Net::Hotline::Constants::HTLC_MACOS_TO_UNIX_TIME to it to change it to seconds since the Unix epoch. .IP "size \s-1NUM\s0" 4 .IX Item "size NUM" The size of the file in bytes. .IP "type \s-1TEXT\s0" 4 .IX Item "type TEXT" The file type, given as a four-letter Mac \s-1OS\s0 type code (\*(L"\s-1TEXT\*(R", \*(L"PICT\*(R",\s0 etc.), Net::Hotline::Constants::HTLC_INFO_FOLDER_TYPE for folders, and Net::Hotline::Constants::HTLC_INFO_FALIAS_TYPE for folder aliases. .SH "AUTHOR" .IX Header "AUTHOR" John C. Siracusa (siracusa@mindspring.com) .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright(c) 1999 by John Siracusa. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.