.\" 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 "Gtk2::GladeXML::Simple 3pm" .TH Gtk2::GladeXML::Simple 3pm "2018-06-30" "perl v5.26.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" Gtk2::GladeXML::Simple \- A clean object\-oriented interface to Gtk2::GladeXML .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& package MyApp; \& use base qw( Gtk2::GladeXML::Simple ); \& \& sub new { \& my $class = shift; \& my $self = $class\->SUPER::new( $gladefile ); \& return $self; \& } \& \& ... \& \& # Signal handlers are methods of your class \& sub on_button_clicked { \& my $self = shift; \& # You have access to your widgets directly \& # or using $self\->get_widget( widget_name ) \& my $button = $self\->{button1}; \& } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Gtk2::GladeXML::Simple is a module that provides a clean and easy interface for Gnome/Gtk2 and Glade applications using an object-oriented syntax. You just make Gtk2::GladeXML::Simple your application's base class, have your \f(CW\*(C`new\*(C'\fR call \&\f(CW\*(C`SUPER::new\*(C'\fR, and the module will do the tedious and dirty work for you. .PP Gtk2::GladeXML::Simple offers: .IP "\(bu" 4 Signal handler callbacks as methods of your class. .Sp .Vb 5 \& sub on_button1_clicked { \& my $self = shift; # $self always received as first parameter \& ... \& # do anything you want in a OO fashioned way \& } .Ve .IP "\(bu" 4 Autoconnection of signal handlers. .IP "\(bu" 4 Autocalling of creation functions for custom widgets. .IP "\(bu" 4 Access to the widgets as instance attributes. .Sp .Vb 3 \& my $btn = $self\->{button1}; # fetch widgets as instance attributes by their names \& my $window = $self\->{main_window}; \& my $custom = $self\->{custom_widget}; .Ve .SH "METHODS" .IX Header "METHODS" This class provides the following public methods: .ie n .IP "new( $gladefile \fI[, \f(CI$root\fI, \f(CI$domain\fI ]\fR );" 4 .el .IP "new( \f(CW$gladefile\fR \fI[, \f(CI$root\fI, \f(CI$domain\fI ]\fR );" 4 .IX Item "new( $gladefile [, $root, $domain ] );" This method creates a new object of your subclass of Gtk2::GladeXML::Simple. The \f(CW$gladefile\fR parameter is the name of the file created by the Glade Visual Editor. The \f(CW$root\fR is an optional parameter that tells \f(CW\*(C`libglade\*(C'\fR the name of the widget to start building from. The optional \f(CW$domain\fR parameter that specifies the translation domain for the glade xml file ( undef by default ). .IP "glade_object" 4 .IX Item "glade_object" This method returns the Gtk2::GladeXML object in play. .ie n .IP "get_widget( $widget_name )" 4 .el .IP "get_widget( \f(CW$widget_name\fR )" 4 .IX Item "get_widget( $widget_name )" Returns the widget with given name. Same as calling \f(CW$self\fR\->{$widget_name}. .IP "get_widgets" 4 .IX Item "get_widgets" Returns a list with all the widgets in the glade file. .IP "run" 4 .IX Item "run" Call this method in order to run your application. If you need another event loop rather than the Gtk one, override \fIrun\fR in your class with your event loop (for example the GStreamer event loop). .SH "EXTENDED EXAMPLE" .IX Header "EXTENDED EXAMPLE" This example shows the usage of the module by creating a small Yahoo search engine using WWW::Search::Yahoo. .PP .Vb 1 \& package YahooApp; \& \& use strict; \& use warnings; \& use Gtk2 \*(Aq\-init\*(Aq; \& use Gtk2::Html2; #not part of the Gtk2 core widgets \& use Gtk2::GladeXML::Simple; \& use WWW::Search; \& \& use base qw( Gtk2::GladeXML::Simple ); \& \& my $header =< \& \&
Yahoo Gtk2 App \& \& \& \&

\& Found: \&

\& HEADER \& \& my $footer =< \& \& FOOTER \& \& sub new { \& my $class = shift; \& #Calling our super class constructor \& my $self = $class\->SUPER::new( \*(Aqyahoo.glade\*(Aq ); \& #Initialize the search engine \& $self\->{_yahoo} = WWW::Search\->new( \*(AqYahoo\*(Aq ); \& return $self; \& } \& \& sub do_search { \& my $self = shift; \& $self\->{_yahoo}\->native_query( shift ); \& my $buf = $header; \& for( 1..10 ) { \& my $rv = $self\->{_yahoo}\->next_result || last; \& $buf .= qq{

} . $rv\->title; \& $buf .= qq{

} . $rv\->description; \& $buf .= qq{

} . $rv\->url . q{


}; \& } \& $buf .= $footer; \& $self\->{buf} = $buf; \& } \& \& ### Signal handlers, now they\*(Aqre methods of the class ### \& sub on_Clear_clicked { \& my $self = shift; \& my $html = $self\->{custom1}; #fetch widgets by their names \& $html\->{document}\->clear; \& my $statusbar = $self\->{statusbar1}; #another widget \& $statusbar\->pop( $statusbar\->get_context_id( "Yahoo" ) ); \& } \& \& sub on_Search_clicked { \& my $self = shift; \& my $text = $self\->{text_entry}\->get_text; \& return unless $text ne \*(Aq\*(Aq; \& my $statusbar = $self\->{statusbar1}; \& $statusbar\->push( $statusbar\->get_context_id( "Yahoo" ), "Searching for: $text" ); \& $self\->do_search( $text ); \& my $html = $self\->{custom1}; \& $html\->{document}\->clear; \& $html\->{document}\->open_stream( "text/html" ); \& $html\->{document}\->write_stream( $self\->{buf} ); \& $html\->{document}\->close_stream; \& } \& \& ### Creation function for the custom widget, method of the class as well ### \& sub create_htmlview { \& my $self = shift; \& my $view = Gtk2::Html2::View\->new; \& my $document = Gtk2::Html2::Document\->new; \& $view\->set_document( $document ); \& $view\->{document} = $document; \& $view\->show_all; \& return $view; \& } \& \& sub gtk_main_quit { Gtk2\->main_quit } \& \& 1; \& \& package main; \& \& YahooApp\->new\->run; #Go! \& \& 1; .Ve .PP The \fIyahoo.glade\fR file needed for this example is in the \fIexamples\fR directory, along with other example programs. .SH "UTILITIES" .IX Header "UTILITIES" .SS "Rapid Application Development with \fIgpsketcher\fP" .IX Subsection "Rapid Application Development with gpsketcher" The Gtk2::GladeXML::Simple distribution includes \fIgpsketcher\fR, a program that generates Perl code stubs from glade \s-1XML\s0 files. The code stubs include the basic framework for Gtk2::GladeXML::Simple interaction, method signatures, and everything that describes the application itself. Developers must fill in the code stubs to add the correct functionality to the application. .SH "SEE ALSO" .IX Header "SEE ALSO" Gtk2::GladeXML, Gtk2, gpsketcher .PP The Libglade Reference Manual at .PP The gtk2 \s-1API\s0 Reference at .SH "TODO" .IX Header "TODO" Tests. .PP More examples? .PP Add \fIGtk2::GladeXML::Simple::new_from_buffer()\fR? .PP Support to I18N ( bindtextdomain ) .SH "AUTHOR" .IX Header "AUTHOR" Marco Antonio Manzo .PP Special thanks in no order to Scott Arrington \*(L"muppet\*(R" who provided lots of great ideas to improve this module. Sandino \*(L"tigrux\*(R" Flores who is the author of SimpleGladeApp and the main source of this module's core idea. Sean M. Burke and Rocco Caputo for constantly helping me with ideas and cleaning my \s-1POD.\s0 .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright (C) 2005 by Marco Antonio Manzo .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.6 or, at your option, any later version of Perl 5 you may have available.