.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Padre::Current 3pm"
.TH Padre::Current 3pm "2012-06-27" "perl v5.14.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"
Padre::Current \- A context object, for centralising the concept of what is "current"
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \f(CW\*(C`Padre::Current\*(C'\fR detectes and returns whatever is current. Use it whenever you
need to do something with anything which might get a focus or be selectable otherwise
.PP
All methods could be called as functions, methods or class methods.
.SH "CLASS METHODS"
.IX Header "CLASS METHODS"
.ie n .SS """config"""
.el .SS "\f(CWconfig\fP"
.IX Subsection "config"
.Vb 1
\&    my $config = Padre::Current\->config;
.Ve
.PP
Returns a Padre::Config object for the current document.
.PP
Padre has three types of configuration: User-specific, host-specific and project-specific,
this method returnsa config object which includes the current values \- ne need to for you
to care about which config is active and which has priority.
.ie n .SS """document"""
.el .SS "\f(CWdocument\fP"
.IX Subsection "document"
.Vb 1
\&    my $document = Padre::Current\->document;
.Ve
.PP
Returns a Padre::Document object for the current document.
.ie n .SS """editor"""
.el .SS "\f(CWeditor\fP"
.IX Subsection "editor"
.Vb 1
\&    my $editor = Padre::Current\->editor;
.Ve
.PP
Returns a Padre::Editor object for the current editor (containing the current document).
.ie n .SS """filename"""
.el .SS "\f(CWfilename\fP"
.IX Subsection "filename"
.Vb 1
\&    my $filename = Padre::Current\->filename;
.Ve
.PP
Returns the filename of the current document.
.ie n .SS """ide"""
.el .SS "\f(CWide\fP"
.IX Subsection "ide"
.Vb 1
\&    my $ide = Padre::Current\->ide;
.Ve
.PP
Returns a Padre::Wx object of the current ide.
.ie n .SS """main"""
.el .SS "\f(CWmain\fP"
.IX Subsection "main"
.Vb 1
\&    my $main = Padre::Current\->main;
.Ve
.PP
Returns a Padre::Wx::Main object of the current ide.
.ie n .SS """notebook"""
.el .SS "\f(CWnotebook\fP"
.IX Subsection "notebook"
.Vb 1
\&    my $main = Padre::Current\->notebook;
.Ve
.PP
Returns a Padre::Wx::Notebook object of the current notebook.
.ie n .SS """project"""
.el .SS "\f(CWproject\fP"
.IX Subsection "project"
.Vb 1
\&    my $main = Padre::Current\->project;
.Ve
.PP
Returns a Padre::Project object of the current project.
.ie n .SS """text"""
.el .SS "\f(CWtext\fP"
.IX Subsection "text"
.Vb 1
\&    my $main = Padre::Current\->text;
.Ve
.PP
Returns the current selection (selected text in the current document).
.ie n .SS """title"""
.el .SS "\f(CWtitle\fP"
.IX Subsection "title"
.Vb 1
\&    my $main = Padre::Current\->title;
.Ve
.PP
Returns the title of the current editor window.
.SH "NAME"
Padre::Current \- convenient access to current objects within Padre
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    my $main = Padre::Current\->main;
\&    # ...
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Padre uses lots of objects from different classes. And one needs to
have access to the current object of this sort or this other to do
whatever is need at the time.
.PP
Instead of poking directly with the various classes to find the object
you need, \f(CW\*(C`Padre::Current\*(C'\fR provides a bunch of handy methods to
retrieve whatever current object you need.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
.Vb 2
\&    # Vanilla constructor
\&    Padre::Current\->new;
\&    
\&    # Seed the object with some context
\&    Padre::Current\->new( document => $document );
.Ve
.PP
The \f(CW\*(C`new\*(C'\fR constructor creates a new context object, it optionally takes
one or more named parameters which should be any context the caller is
aware of before he calls the constructor.
.PP
Providing this seed context allows the context object to derive parts of
the current context from other parts, without the need to fall back to
the last-resort \f(CW\*(C`Padre\->ide\*(C'\fR singleton-fetching method.
.PP
Many objects in Padre that are considered to be part of them context
will have a \f(CW\*(C`current\*(C'\fR method which automatically creates the context
object with it as a seed.
.PP
Returns a new \fBPadre::Current\fR object.
.ie n .SS """ide"""
.el .SS "\f(CWide\fP"
.IX Subsection "ide"
Return the Padre singleton for the \s-1IDE\s0 instance.
.ie n .SS """config"""
.el .SS "\f(CWconfig\fP"
.IX Subsection "config"
Returns the current Padre::Config configuration object for the \s-1IDE\s0.
.ie n .SS """main"""
.el .SS "\f(CWmain\fP"
.IX Subsection "main"
Returns the Padre::Wx::Main object for the main window.
.ie n .SS """notebook"""
.el .SS "\f(CWnotebook\fP"
.IX Subsection "notebook"
Returns the Padre::Wx::Notebook object for the main window.
.ie n .SS """document"""
.el .SS "\f(CWdocument\fP"
.IX Subsection "document"
Returns the active Padre::Document document object.
.ie n .SS """editor"""
.el .SS "\f(CWeditor\fP"
.IX Subsection "editor"
Returns the Padre::Editor editor object for the active document.
.ie n .SS """filename"""
.el .SS "\f(CWfilename\fP"
.IX Subsection "filename"
Returns the file name of the active document, if it has one.
.ie n .SS """title"""
.el .SS "\f(CWtitle\fP"
.IX Subsection "title"
Return the title of current editor window.
.ie n .SS """project"""
.el .SS "\f(CWproject\fP"
.IX Subsection "project"
Return the \f(CW\*(C`Padre::Project\*(C'\fR project object for the active document.
.ie n .SS """text"""
.el .SS "\f(CWtext\fP"
.IX Subsection "text"
Returns the selected text, or a null string if nothing is selected.
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2008\-2012 The Padre development team as listed in Padre.pm.
.PP
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
.PP
The full text of the license can be found in the
\&\s-1LICENSE\s0 file included with this module.