.\" 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::Wx::Editor 3pm"
.TH Padre::Wx::Editor 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::Wx::Editor \- Padre document editor object
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBPadre::Wx::Editor\fR implements the Scintilla-based document editor for
Padre. It implements the majority of functionality relating to visualisation
and navigation of documents.
.SH "METHODS"
.IX Header "METHODS"
.SS "get_brace_info"
.IX Subsection "get_brace_info"
Look at a given position in the editor if there is a brace (according to the
setting editor_braces) before or after, and return the information about the context
It always look first at the character after the position.
.PP
.Vb 2
\&        Params:
\&                pos \- the cursor position in the editor [defaults to cursor position) : int
\&
\&        Return:
\&                undef if no brace, otherwise [brace, actual_pos, is_after, is_opening]
\&                where:
\&                        brace \- the brace char at actual_pos
\&                        actual_pos \- the actual position where the brace has been found
\&                        is_after \- true iff the brace is after the cursor : boolean
\&                        is_opening \- true iff only the brace is an opening one
\&
\&        Examples:
\&
\&                |{} => should find the { : [0,{,1,1]
\&                {|} => should find the } : [1,},1,0]
\&                {| } => should find the { : [0,{,0,1]
.Ve
.SS "get_brace_type"
.IX Subsection "get_brace_type"
Tell if a character is a brace, and if it is an opening or a closing one
.PP
.Vb 2
\&        Params:
\&                char \- a character : string
\&
\&        Return:
\&                int : 0 if this is not a brace, an odd value if it is an opening brace and an even
\&                one for a closing brace
.Ve
.SS "find_matching_brace"
.IX Subsection "find_matching_brace"
Find the position of to the matching brace if any. If the cursor is inside the braces the destination
will be inside too, same it is outside.
.PP
.Vb 2
\&        Params:
\&                pos \- the cursor position in the editor [defaults to cursor position) : int
\&
\&        Return:
\&                matching_pos \- the matching position, or undef if none
.Ve
.SS "goto_matching_brace"
.IX Subsection "goto_matching_brace"
Move the cursor to the matching brace if any. If the cursor is inside the braces the destination
will be inside too, same it is outside.
.PP
.Vb 2
\&        Params:
\&                pos \- the cursor position in the editor [defaults to cursor position) : int
.Ve
.SS "select_to_matching_brace"
.IX Subsection "select_to_matching_brace"
Select to the matching opening or closing brace. If the cursor is inside the braces the destination
will be inside too, same it is outside.
.PP
.Vb 2
\&        Params:
\&                pos \- the cursor position in the editor [defaults to cursor position) : int
.Ve
.SS "find_line"
.IX Subsection "find_line"
.Vb 1
\&  my $line_number = $editor\->find_line( 123, "sub foo {" );
.Ve
.PP
The \f(CW\*(C`find_line\*(C'\fR method locates a line in a document using a line number
and the content of the line.
.PP
It is intended for use in situations where a search function has determined
that a particular line is of interest, but the document may have changed in
the time since the original search was made.
.PP
Starting at the suggested line, it will locate the line containing the text
which is the closest to line provided. If no text is provided the method
acts as a simple pass-through.
.PP
Returns an integer line number guaranteed to exist in the document, or
\&\f(CW\*(C`undef\*(C'\fR if the hint text could not be found anywhere in the document.
.SS "position"
.IX Subsection "position"
.Vb 1
\&  my $position = $editor\->position($untrusted);
.Ve
.PP
The \f(CW\*(C`position\*(C'\fR method is used to clean parameters that are supposed to
refer to a position within the editor. It takes what should be an numeric
document position, constrains the value to the actual position range of
the document, and removes any fractional characters.
.PP
This method should generally be used when doing something to a document
somewhere in it preferable aborting that functionality completely.
.PP
Returns an integer character position guaranteed to exist in the document.
.SS "line"
.IX Subsection "line"
.Vb 1
\&  my $line = $editor\->line($untrusted);
.Ve
.PP
The \f(CW\*(C`line\*(C'\fR method is used to clean parameters that are supposed to
refer to a line within the editor. It takes what should be an numeric
document line, constrains the value to the actual line range of
the document, and removes any fractional characters.
.PP
This method should generally be used when doing something to a document
somewhere in it preferable aborting that functionality completely.
.PP
Returns an integer line number guaranteed to exist in the document.
.SS "clipboard_length"
.IX Subsection "clipboard_length"
.Vb 1
\&  my $chars = Padre::Wx::Editor\->clipboard_length;
.Ve
.PP
The \f(CW\*(C`clipboard_length\*(C'\fR method returns the number of characters of text
currently in the clipboard, if any.
.PP
Returns an integer number of characters, or zero if the clipboard is empty
or contains non-text data.
.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.