home *** CD-ROM | disk | FTP | other *** search
/ PC Welt 2006 November (DVD) / PCWELT_11_2006.ISO / casper / filesystem.squashfs / usr / lib / perl5 / Gtk2.pm < prev   
Encoding:
Perl POD Document  |  2005-11-28  |  7.1 KB  |  235 lines
  1. #
  2. # Copyright (C) 2003-2005 by the gtk2-perl team (see the file AUTHORS for
  3. # the full list)
  4. # 
  5. # This library is free software; you can redistribute it and/or modify it under
  6. # the terms of the GNU Library General Public License as published by the Free
  7. # Software Foundation; either version 2.1 of the License, or (at your option)
  8. # any later version.
  9. # 
  10. # This library is distributed in the hope that it will be useful, but WITHOUT
  11. # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12. # FOR A PARTICULAR PURPOSE.  See the GNU Library General Public License for
  13. # more details.
  14. # 
  15. # You should have received a copy of the GNU Library General Public License
  16. # along with this library; if not, write to the Free Software Foundation, Inc.,
  17. # 59 Temple Place - Suite 330, Boston, MA  02111-1307  USA.
  18. #
  19. # $Header: /cvsroot/gtk2-perl/gtk2-perl-xs/Gtk2/Gtk2.pm,v 1.84.2.2 2005/11/28 20:25:53 kaffeetisch Exp $
  20. #
  21.  
  22. package Gtk2;
  23.  
  24. # Gtk uses unicode strings; thus we require perl>=5.8.x,
  25. # which is unicode internally.
  26. use 5.008;
  27. use strict;
  28. use warnings;
  29.  
  30. use Glib;
  31.  
  32. require DynaLoader;
  33.  
  34. our $VERSION = '1.102';
  35.  
  36. our @ISA = qw(DynaLoader);
  37.  
  38. sub import {
  39.     my $class = shift;
  40.  
  41.     # threads' init needs to be called before the main init and we don't
  42.     # want to force the order those options are passed to us so we need to
  43.     # cache the choices in booleans and (optionally) do them in the corect
  44.     # order afterwards
  45.     my $init = 0;
  46.     my $threads_init = 0;
  47.  
  48.     foreach (@_) {
  49.         if (/^-?init$/) {
  50.             $init = 1;
  51.         } elsif (/-?threads-init$/) {
  52.             $threads_init = 1;
  53.         } else {
  54.             $class->VERSION ($_);
  55.         }
  56.     }
  57.  
  58.     Gtk2::Gdk::Threads->init if ($threads_init);
  59.     Gtk2->init if ($init);
  60. }
  61.  
  62. # this is critical -- tell dynaloader to load the module so that its 
  63. # symbols are available to all other modules.  without this, nobody
  64. # else can use important functions like gtk2perl_new_object!
  65. #
  66. # hrm.  win32 doesn't really use this, because we have to link the whole
  67. # thing at compile time to ensure all the symbols are defined.
  68. #
  69. # on darwin, at least with the particular 5.8.0 binary i'm using, perl
  70. # complains "Can't make loaded symbols global on this platform" when this
  71. # is set to 0x01, but goes on to work fine.  returning 0 here avoids the
  72. # warning and doesn't appear to break anything.
  73. sub dl_load_flags { $^O eq 'darwin' ? 0x00 : 0x01 }
  74.  
  75. # now load the XS code.
  76. Gtk2->bootstrap ($VERSION);
  77.  
  78. # Preloaded methods go here.
  79.  
  80. package Gtk2::Gdk;
  81.  
  82. sub CHARS { 8 };
  83. sub SHORTS { 16 };
  84. sub LONGS { 32 };
  85.  
  86. sub USHORTS { 16 };
  87. sub ULONGS { 32 };
  88.  
  89. package Gtk2::Gdk::Atom;
  90.  
  91. use overload
  92.     '==' => \&Gtk2::Gdk::Atom::eq,
  93.     fallback => 1;
  94.  
  95. package Gtk2::TreeSortable::IterCompareFunc;
  96.  
  97. use overload
  98.     '&{}' => sub { \&Gtk2::TreeSortable::IterCompareFunc::invoke },
  99.     fallback => 1;
  100.  
  101. package Gtk2;
  102.  
  103.  
  104. 1;
  105. __END__
  106. # documentation is a good thing.
  107.  
  108. =head1 NAME
  109.  
  110. Gtk2 - Perl interface to the 2.x series of the Gimp Toolkit library
  111.  
  112. =head1 SYNOPSIS
  113.  
  114.   use Gtk2 -init;
  115.   # Gtk2->init; works if you didn't use -init on use
  116.   my $window = Gtk2::Window->new ('toplevel');
  117.   my $button = Gtk2::Button->new ('Quit');
  118.   $button->signal_connect (clicked => sub { Gtk2->main_quit });
  119.   $window->add ($button);
  120.   $window->show_all;
  121.   Gtk2->main;
  122.  
  123. =head1 ABSTRACT
  124.  
  125. Perl bindings to the 2.x series of the Gtk+ widget set.  This module
  126. allows you to write graphical user interfaces in a perlish and
  127. object-oriented way, freeing you from the casting and memory management
  128. in C, yet remaining very close in spirit to original API.
  129.  
  130. =head1 DESCRIPTION
  131.  
  132. The Gtk2 module allows a perl developer to use the Gtk+ graphical user
  133. interface library.  Find out more about Gtk+ at http://www.gtk.org.
  134.  
  135. The GTK+ Reference Manual is also a handy companion when writing Gtk
  136. programs in any language.  http://developer.gnome.org/doc/API/2.0/gtk/
  137. The perl bindings follow the C API very closely, and the C reference
  138. documentation should be considered the canonical source.
  139.  
  140. To discuss gtk2-perl, ask questions and flame/praise the authors,
  141. join gtk-perl-list@gnome.org at lists.gnome.org.
  142.  
  143. Also have a look at the gtk2-perl website and sourceforge project page,
  144. http://gtk2-perl.sourceforge.net
  145.  
  146. =head1 INITIALIZATION
  147.  
  148.   use Gtk2 qw/-init/;
  149.   use Gtk2 qw/-init -threads-init/;
  150.  
  151. =over
  152.  
  153. =item -init
  154.  
  155. Equivalent to Gtk2->init, called to initialize GLIB and GTK+. Just about every
  156. Gtk2-Perl script should do "use Gtk2 -init"; This initialization should take
  157. place before using any other Gtk2 functions in your GUI applications. It will
  158. initialize everything needed to operate the toolkit and parses some standard
  159. command line options. @ARGV is adjusted accordingly so your own code will never
  160. see those standard arguments.
  161.  
  162. =item -threads-init
  163.  
  164. Equivalent to Gtk2::Gdk::Threads->init, called to initialze/enable gdk's thread
  165. safety mechanisms so that gdk can be accessed from multiple threads when used
  166. in conjunction with Gtk2::Gdk::Threads->enter and Gtk2::Gdk::Threads->leave. If
  167. invoked as Gtk2::Gdk::Threads->init it should be done before Gtk2->init is
  168. called, if done by "use Gtk2 -init -threads-init" order does not matter.
  169.  
  170. =back
  171.  
  172. =head1 SEE ALSO
  173.  
  174. L<perl>(1), L<Glib>(3pm).
  175.  
  176. L<Gtk2::Gdk::Keysyms>(3pm) contains a hash of key codes, culled from
  177. gdk/gdkkeysyms.h
  178.  
  179. L<Gtk2::api>(3pm) describes how to map the C API into perl, and some of the
  180. important differences in the perl bindings.
  181.  
  182. L<Gtk2::Helper>(3pm) contains stuff that makes writing Gtk2 programs
  183. a little easier.
  184.  
  185. L<Gtk2::SimpleList>(3pm) makes the GtkListStore and GtkTreeModel a I<lot>
  186. easier to use.
  187.  
  188. L<Gtk2::Pango>(3pm) exports various little-used but important constants you
  189. may need to work with pango directly.
  190.  
  191. L<Gtk2::index>(3pm) lists the autogenerated api documentation pod files
  192. for Gtk2.
  193.  
  194. Gtk2 also provides code to make it relatively painless to create perl
  195. wrappers for other GLib/Gtk-based libraries.  See L<Gtk2::CodeGen>,
  196. L<ExtUtils::PkgConfig>, and L<ExtUtils::Depends>.  If you're writing bindings,
  197. you'll probably also be interested in L<Gtk2::devel>, which is a supplement
  198. to L<Glib::devel> and L<Glib::xsapi>.  The Binding Howto, at
  199. http://gtk2-perl.sourceforge.net/doc/binding_howto.pod.html, ties it all
  200. together.
  201.  
  202. =head1 AUTHORS
  203.  
  204. The gtk2-perl team:
  205.  
  206.  muppet <scott at asofyet dot org>
  207.  Ross McFarland <rwmcfa1 at neces dot com>
  208.  Torsten Schoenfeld <kaffeetisch at web dot de>
  209.  Marc Lehmann <pcg at goof dot com>
  210.  G├╢ran Thyni <gthyni at kirra dot net>
  211.  J├╢rn Reder <joern at zyn dot de>
  212.  Chas Owens <alas at wilma dot widomaker dot com>
  213.  Guillaume Cottenceau <gc at mandrakesoft dot com>
  214.  
  215. =head1 COPYRIGHT AND LICENSE
  216.  
  217. Copyright 2003-2005 by the gtk2-perl team.
  218.  
  219. This library is free software; you can redistribute it and/or
  220. modify it under the terms of the GNU Library General Public
  221. License as published by the Free Software Foundation; either
  222. version 2 of the License, or (at your option) any later version.
  223.  
  224. This library is distributed in the hope that it will be useful,
  225. but WITHOUT ANY WARRANTY; without even the implied warranty of
  226. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  227. Library General Public License for more details.
  228.  
  229. You should have received a copy of the GNU Library General Public
  230. License along with this library; if not, write to the 
  231. Free Software Foundation, Inc., 59 Temple Place - Suite 330, 
  232. Boston, MA  02111-1307  USA.
  233.  
  234. =cut
  235.