.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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 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.
.\"
.\" 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
.\"
.\" 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::Role::Main 3pm"
.TH Padre::Wx::Role::Main 3pm "2014-09-11" "perl v5.20.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"
Padre::Wx::Role::Main \- Convenience methods for children of the main window
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This role implements the fairly common method pattern for Wx elements that
are children of Padre::Wx::Main.
.PP
It provides accessors for easy access to the most commonly needed elements,
and shortcut integration with the Padre::Current context system.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """ide"""
.el .SS "\f(CWide\fP"
.IX Subsection "ide"
.Vb 1
\&    my $ide = $object\->ide;
.Ve
.PP
Get the Padre \s-1IDE\s0 instance that this object is a child of.
.ie n .SS """config"""
.el .SS "\f(CWconfig\fP"
.IX Subsection "config"
.Vb 1
\&    my $config = $object\->config;
.Ve
.PP
Get the Padre::Config for the current user. Provided mainly as a
convenience because it is needed so often.
.PP
Please note that this method does \s-1NOT\s0 integrate with the Padre::Current
context system. Any project-specific configuration of overrides of default
behaviour will not be present in this configuration object.
.PP
For a project-aware configuration, use the following instead.
.PP
.Vb 1
\&  $self\->current\->config;
.Ve
.ie n .SS """main"""
.el .SS "\f(CWmain\fP"
.IX Subsection "main"
.Vb 1
\&    my $main = $object\->main;
.Ve
.PP
Get the Padre::Wx::Main main window that this object is a child of.
.ie n .SS """aui"""
.el .SS "\f(CWaui\fP"
.IX Subsection "aui"
.Vb 1
\&    my $aui = $object\->aui;
.Ve
.PP
Convenient access to the Wx Advanced User Interface (\s-1AUI\s0) Manager object.
.SS "current"
.IX Subsection "current"
.Vb 1
\&    my $current = $object\->current;
.Ve
.PP
Get a new \f(CW\*(C`Padre::Current\*(C'\fR context object, for access to other parts of
the current context.
.SS "lock_update"
.IX Subsection "lock_update"
.Vb 1
\&    my $lock = $object\->lock_update;
.Ve
.PP
The Padre::Locker \s-1API\s0 in Padre provides a solid and extensible system for
locking of \s-1IDE\s0 resources when large-scale change of state is to occur.
.PP
Unfortunately, there are some cases in which this mechanism can cause problems.
.PP
Window update locking using this \s-1API\s0 is done on the entire main window. The
resulting \f(CW\*(C`Freeze\*(C'\fR/\f(CW\*(C`Thaw\*(C'\fR calls are recursive on Windows, and as \f(CW\*(C`Thaw\*(C'\fR calls
invalidate the painted state of widgets, this results in a global redraw and
on the non-double-bufferred Windows platform this causes flickering.
.PP
When a piece of code is making very targeted changes to just the graphical
state of the application and will only need an \s-1UPDATE\s0 lock (i.e. does not need
refresh or database locks) the alternative \f(CW\*(C`lock_update\*(C'\fR method provides a
convenience for creating a Wx::WindowUpdateLocker independent of the main
locking \s-1API.\s0
.PP
By using a localised lock and avoiding a global update lock, this should
remove global flickering on these changes, and limit flickering to just
the element being update, which should be much less noticeable.
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2008\-2013 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 5 itself.
.PP
The full text of the license can be found in the
\&\s-1LICENSE\s0 file included with this module.