.\" Automatically generated by Pod::Man 4.09 (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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "GTK 3pm"
.TH GTK 3pm "2017-09-07" "perl v5.26.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"
Data::TreeDumper::Renderer::GTK \- Gtk2::TreeView renderer for Data::TreeDumper
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\&  my $treedumper = Data::TreeDumper::Renderer::GTK\->new
\&                        (
\&                        data => \e%data,
\&                        title => \*(AqTest Data\*(Aq,
\&                        dumper_setup => {DISPLAY_PERL_SIZE => 1}
\&                        );
\&                        
\&  $treedumper\->modify_font(Gtk2::Pango::FontDescription\->from_string (\*(Aqmonospace\*(Aq));
\&  $treedumper\->expand_all;
\&  
\&  # some boilerplate to get the widget onto the screen...
\&  my $window = Gtk2::Window\->new;
\&  
\&  my $scroller = Gtk2::ScrolledWindow\->new;
\&  $scroller\->add ($treedumper);
\&  
\&  $window\->add ($scroller);
\&  $window\->show_all;
.Ve
.SH "HIERARCHY"
.IX Header "HIERARCHY"
.Vb 6
\&  Glib::Object
\&  +\-\-\-\-Gtk2::Object
\&        +\-\-\-\-Gtk2::Widget
\&              +\-\-\-\-Gtk2::Container
\&                    +\-\-\-\-Gtk2::TreeView
\&                          +\-\-\-\-Data::TreeDumper::Renderer::GTK
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
GTK-perl renderer for \fBData::TreeDumper\fR.
.PP
This widget is the gui equivalent of Data::TreeDumper; it will display a
perl data structure in a TreeView, allowing you to fold and unfold child
data structures and get a quick feel for what's where.  Right-clicking
anywhere in the view brings up a context menu, from which the user can
choose to expand or collapse all items.
.SH "EXAMPLE"
.IX Header "EXAMPLE"
\&\fBgtk_test.pl\fR
.SH "METHODS"
.IX Header "METHODS"
.IP "widget = Data::TreeDumper::Renderer::GTK::TreeDumper\->new (...)" 4
.IX Item "widget = Data::TreeDumper::Renderer::GTK::TreeDumper->new (...)"
Create a new TreeDumper.  The optional arguments are expect to be key/val
pairs.
.RS 4
.IP "\- dumper_setup => hash reference" 4
.IX Item "- dumper_setup => hash reference"
All data is passed to Data::TreeDumper
.IP "\- data => scalar" 4
.IX Item "- data => scalar"
Equivalent to calling \f(CW\*(C`$treedumper\->set_data ($scalar)\*(C'\fR.
.IP "\- title => string or undef" 4
.IX Item "- title => string or undef"
Equivalent to calling \f(CW\*(C`$treedumper\->set_title ($string)\*(C'\fR.
.RE
.RS 4
.RE
.ie n .IP "$treedumper\->set_data ($newdata)" 4
.el .IP "\f(CW$treedumper\fR\->set_data ($newdata)" 4
.IX Item "$treedumper->set_data ($newdata)"
.RS 4
.PD 0
.IP "\(bu" 4
.PD
\&\f(CW$newdata\fR (scalar)
.RE
.RS 4
.Sp
Fill the tree with \fI\f(CI$newdata\fI\fR, which may be any scalar.  The tree does
not reference \fI\f(CI$newdata\fI\fR \*(-- necessary data is copied.
.RE
.ie n .IP "$treedumper\->set_title ($title=undef)" 4
.el .IP "\f(CW$treedumper\fR\->set_title ($title=undef)" 4
.IX Item "$treedumper->set_title ($title=undef)"
.RS 4
.PD 0
.IP "\(bu" 4
.PD
\&\f(CW$title\fR (string or undef) a new title
.RE
.RS 4
.Sp
Set the string displayed as the column title.  The view is created with one
column, and the header is visible only if there is a title set.
.RE
.SH "EXPORT"
.IX Header "EXPORT"
None
.SH "AUTHORS"
.IX Header "AUTHORS"
Khemir Nadim ibn Hamouda. <nadim@khemir.net>
Muppet <scott at asofyet dot org>
.PP
.Vb 2
\&  Copyright (c) 2005 Nadim Ibn Hamouda el Khemir and 
\&  Muppet. All rights reserved.
\&  
\&  This program is free software; you can redistribute
\&  it and/or modify it under the same terms as Perlitself.
.Ve
.PP
If you find any value in this module, mail me!  All hints, tips, flames and wishes
are welcome at <nadim@khemir.net>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBData::TreeDumper\fR for advanced usage of the dumper engine.