annotate gtk/plugins/perl/common/Gtk.pm @ 14416:eeca8be382a5

[gaim-migrate @ 17124] This is a Gaim::Gtk perl module for use by gaim plugins to get access to the gtkgaim interface functions. It isn't complete because anything dealing with Gtk widgets themselves doesn't work yet (I need to figure out the best way to do that). To use this a perl plugin just needs to include 'use Gaim::Gtk;' either on top of 'use Gaim;' or instead of it. I'm not done with this yet. At the moment you have to 'use Gaim;' or 'use Gaim::Gtk;' which loads all the parts, I'm planning to let you actually say 'use Gaim::Gtk::Debug;' to just get the gtkdebug.h functions. Though 'use Gaim' would work the same way as always. committer: Tailor Script <[e-mail]>

package Gaim::Gtk;

use 5.008;
use strict;
use warnings;
use Carp;

our $VERSION = '0.01';

use Gaim;

require XSLoader;
XSLoader::load('Gaim::Gtk', $VERSION);

1;
__END__

=head1 NAME

Gaim::Gtk - Perl extension for the Gaim instant messenger.

=head1 SYNOPSIS

    use Gaim::Gtk;

=head1 ABSTRACT

    This module provides the interface for using perl scripts as plugins in
    Gaim, with access to the Gaim Gtk interface functions.

=head1 DESCRIPTION

This module provides the interface for using perl scripts as plugins in Gaim,
with access to the Gaim Gtk interface functions. With this, developers can
write perl scripts that can be loaded in Gaim as plugins. The script can
interact with IMs, chats, accoutns, the buddy list, gaim signals, and more.

The API for the perl interface is very similar to that of the Gaim C API,
which can be viewed at http://gaim.sourceforge.net/api/ or in the header files
in the Gaim source tree.

=head1 FUNCTIONS

=over

=back

=head1 SEE ALSO
Gaim C API documentation - http://gaim.sourceforge.net/api/

The Gaim perl module.

Gaim website - http://gaim.sourceforge.net/

=head1 AUTHOR

Etan Reisner, E<lt>[e-mail]<gt>

=head1 COPYRIGHT AND LICENSE

Copyright 2006 by Etan Reisner