Your IP : 216.73.216.182
| Current Path : /usr/local/man/man3/ |
|
|
| Current File : //usr/local/man/man3/UI::Dialog::Backend::Nautilus.3pm |
.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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 "UI::Dialog::Backend::Nautilus 3pm"
.TH UI::Dialog::Backend::Nautilus 3pm "2016-02-03" "perl v5.30.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"
UI::Dialog::Backend::Nautilus \- wrapper around the data provided by the nautilus(1).
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& use UI::Dialog::Backend::Nautilus;
\& my $nautilus = new UI::Dialog::Backend::Nautilus ();
\& my @paths = $nautilus\->paths();
.Ve
.SH "ABSTRACT"
.IX Header "ABSTRACT"
UI::Dialog::Backend::Nautilus is simply an OOPerl wrapper around the
data provided by the \fBnautilus\fR\|(1) file manager's scripts feature.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBnautilus\fR\|(1) is a \s-1GNOME\s0 file manager that has a \*(L"right-click\*(R" menu for
user made scripts (found in the user's ~/.gnome2/nautilus\-scripts/
directory). This is an OOPerl interface to the environment variables
provided to the scripts during runtime by nautilus. When you use any of
the UI::Dialog meta classes (UI::Dialog, UI::Dialog::GNOME, etc.) access
to this backend is provided via the \f(CW$d\fR\->nautilus method. ie: replace
\&\f(CW$nautilus\fR with \f(CW$d\fR\->nautilus in the synopsis example (provided you made
\&\f(CW$d\fR with something like my \f(CW$d\fR = new UI::Dialog...). Also, UI::Dialog and
friends only load this module when you first use the \f(CW$d\fR\->nautilus method
(this may silently fail, but you can test by \fBref()\fR for success).
.SH "EXPORT"
.IX Header "EXPORT"
.Vb 1
\& None
.Ve
.SH "INHERITS"
.IX Header "INHERITS"
.Vb 1
\& None
.Ve
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.ie n .SS "new( @options )"
.el .SS "new( \f(CW@options\fP )"
.IX Subsection "new( @options )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 1
\& my $nautilus = new UI::Dialog::Backend::Nautilus ();
.Ve
.RE
.RS 4
.RE
.IP "\s-1DESCRIPTION\s0" 4
.IX Item "DESCRIPTION"
.RS 4
.RS 6
This is the Class Constructor method. It accepts a list of key => value pairs
and uses them as the defaults when interacting with the various widgets.
.RE
.RE
.RS 4
.RE
.IP "\s-1RETURNS\s0" 4
.IX Item "RETURNS"
.RS 4
.RS 6
A blessed object reference of the UI::Dialog::Backend::Nautilus class.
.RE
.RE
.RS 4
.RE
.SH "METHODS"
.IX Header "METHODS"
.SS "path( )"
.IX Subsection "path( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 1
\& my $path = $nautilus\->path();
.Ve
.RE
.RS 4
.RE
.IP "\s-1DESCRIPTION\s0" 4
.IX Item "DESCRIPTION"
.RS 4
.RS 6
This method examines the \s-1NAUTILUS_SCRIPT_CURRENT_URI\s0 string uri
unescapes and strips it of any prefixing protocol indicators (file://)
then returns the modified string.
.RE
.RE
.RS 4
.RE
.IP "\s-1RETURNS\s0" 4
.IX Item "RETURNS"
.RS 4
.Vb 1
\& a SCALAR.
.Ve
.RE
.RS 4
.RE
.SS "paths( )"
.IX Subsection "paths( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 1
\& my @paths = $nautilus\->paths();
.Ve
.RE
.RS 4
.RE
.IP "\s-1DESCRIPTION\s0" 4
.IX Item "DESCRIPTION"
.RS 4
.RS 6
This method splits the \s-1NAUTILUS_SCRIPT_SELECTED_FILE_PATHS\s0 multiline
string and returns the \s-1ARRAY\s0 of selections in the order provided by
nautilus.
.RE
.RE
.RS 4
.RE
.IP "\s-1RETURNS\s0" 4
.IX Item "RETURNS"
.RS 4
.Vb 1
\& an ARRAY.
.Ve
.RE
.RS 4
.RE
.SS "uri( )"
.IX Subsection "uri( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 1
\& my $uri = $nautilus\->uri();
.Ve
.RE
.RS 4
.RE
.IP "\s-1DESCRIPTION\s0" 4
.IX Item "DESCRIPTION"
.RS 4
.RS 6
This simply returns the \s-1NAUTILUS_SCRIPT_CURRENT_URI\s0 string.
.RE
.RE
.RS 4
.RE
.IP "\s-1RETURNS\s0" 4
.IX Item "RETURNS"
.RS 4
.Vb 1
\& a SCALAR.
.Ve
.RE
.RS 4
.RE
.SS "uris( )"
.IX Subsection "uris( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 1
\& my @uris = $nautilus\->uris();
.Ve
.RE
.RS 4
.RE
.IP "\s-1DESCRIPTION\s0" 4
.IX Item "DESCRIPTION"
.RS 4
.RS 6
This method splits the \s-1NAUTILUS_SCRIPT_SELECTED_URIS\s0 multiline
string and returns the \s-1ARRAY\s0 of selections in the order provided by
nautilus. This does not uri escape or unescape the string.
.RE
.RE
.RS 4
.RE
.IP "\s-1RETURNS\s0" 4
.IX Item "RETURNS"
.RS 4
.Vb 1
\& an ARRAY.
.Ve
.RE
.RS 4
.RE
.SS "geometry( )"
.IX Subsection "geometry( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 1
\& my ($h,$w,$x,$y) = $nautilus\->geometry();
.Ve
.RE
.RS 4
.RE
.IP "\s-1DESCRIPTION\s0" 4
.IX Item "DESCRIPTION"
.RS 4
.RS 6
This method splits the \s-1NAUTILUS_SCRIPT_WINDOW_GEOMETRY\s0 string and returns
and \s-1ARRAY\s0 of the geometry details provided by nautilus. The array returned
contains the following (in order):
.Sp
.Vb 4
\& height
\& width
\& X\-coordinate
\& Y\-coordinate
.Ve
.RE
.RE
.RS 4
.RE
.IP "\s-1RETURNS\s0" 4
.IX Item "RETURNS"
.RS 4
.Vb 1
\& an ARRAY.
.Ve
.RE
.RS 4
.RE
.SS "uri_unescape( )"
.IX Subsection "uri_unescape( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 3
\& my $path = $nautilus\->uri_unescape( "file:///path/to/somewhere" );
\& my @paths = $nautilus\->uri_unescape( "file:///path/to/somewhere",
\& "file:///yet/another/path" );
.Ve
.RE
.RS 4
.RE
.IP "\s-1DESCRIPTION\s0" 4
.IX Item "DESCRIPTION"
.RS 4
.RS 6
This is the method used to unescape the \s-1NAUTILUS_SCRIPT_CURRENT_URI\s0 in
the \fBpath()\fR method. This method is derived from the URI::Escape module which
is not included in the Perl core modules yet is vitally necessary for the
\&\fBpath()\fR method to function in a useful manor.
.RE
.RE
.RS 4
.RE
.IP "\s-1RETURNS\s0" 4
.IX Item "RETURNS"
.RS 4
.RS 6
an \s-1ARRAY\s0 or a \s-1SCALAR\s0 depending on the calling arguments.
.RE
.RE
.RS 4
.RE
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\s-1PERLDOC\s0" 2
.IX Item "PERLDOC"
.Vb 2
\& UI::Dialog
\& UI::Dialog::Backend
.Ve
.IP "\s-1MAN FILES\s0" 2
.IX Item "MAN FILES"
.Vb 1
\& nautilus(1)
.Ve
.SH "BUGS"
.IX Header "BUGS"
.Vb 2
\& Please email the author with any bug reports. Include the name of the
\& module in the subject line.
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 1
\& Kevin C. Krinke, E<lt>kevin@krinke.caE<gt>
.Ve
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
.Vb 1
\& Copyright (C) 2004\-2016 Kevin C. Krinke <kevin@krinke.ca>
\&
\& This library is free software; you can redistribute it and/or
\& modify it under the terms of the GNU Lesser General Public
\& License as published by the Free Software Foundation; either
\& version 2.1 of the License, or (at your option) any later version.
\&
\& This library is distributed in the hope that it will be useful,
\& but WITHOUT ANY WARRANTY; without even the implied warranty of
\& MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
\& Lesser General Public License for more details.
\&
\& You should have received a copy of the GNU Lesser General Public
\& License along with this library; if not, write to the Free Software
\& Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111\-1307 USA
.Ve