Applied Magnet's Patch
[sdlgit/SDL_perl.git] / lib / SDL / Cursor.pm
index f84c50d..7666a94 100644 (file)
@@ -1,10 +1,37 @@
+#!/usr/bin/env perl
+#
 # Cursor.pm
 #
-#      Copyright (C) 2000,2002 David J. Goehrig
+# Copyright (C) 2005 David J. Goehrig <dgoehrig@cpan.org>
+#
+# ------------------------------------------------------------------------------
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+# 
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+#
+# ------------------------------------------------------------------------------
+#
+# Please feel free to send questions, suggestions or improvements to:
+#
+#      David J. Goehrig
+#      dgoehrig@cpan.org
 #
 
 package SDL::Cursor;
 use strict;
+use warnings;
+use Carp;
 
 sub new {
        my $proto = shift;
@@ -13,8 +40,10 @@ sub new {
 
        verify (%options, qw/ -data -mask -x -y /) if $SDL::DEBUG;
 
+       
        my $self = \SDL::NewCursor($options{-data},$options{-mask},
                                $options{-x},$options{-y});
+       croak SDL::GetError() unless $$self;
        bless $self, $class;
        $self;
 }
@@ -40,66 +69,8 @@ sub get () {
 
 sub show ($;$) {
        my ($self,$toggle) = @_;
+       $toggle = 0 unless defined $toggle;
        SDL::ShowCursor($toggle);
 }
 
 1;
-
-__END__;
-
-=pod
-
-
-
-=head1 NAME
-
-SDL::Cursor - a SDL perl extension
-
-=head1 SYNOPSIS
-
-  $cursor = SDL::Cursor->new(
-       -data => new SDL::Surface "cursor.png",
-       -mask => new SDL::Surface "mask.png",
-       -x    => 0, -y => 0 );
-  $cusor->use;
-
-=head1 DESCRIPTION
-
-the SDL::Cursor module handles mouse cursors, and provide the developer to
-use custom made cursors. Note that the cursors can only be in black and
-white.
-
-=head1 METHODS
-
-=head2 new( -data => $surface_data, -mask => $surface_mask, x => $x, y => $y)
-
-Creates a new cursor. The <C>-data</C> and <C>-mask</C> parameters should be both black and white pictures. The height and width of these surfaces should be a multiple of 8. The <C>-x</C> and <C>-y</C> are the coordinates of the cursor 'hot spot'.
-
-=head2 warp($x, $y)
-
-Set the position of the cursor at the <C>$x</C>, <C>$y</C> coordinates in the application window.
-
-=head2 use()
-
-Set the cursor as the active cursor.
-
-=head2 get()
-
-When used statically <C>SDL::Cursor::get()</C>, it will return the instance of the current cursor in use. Called as a method, it will return itself.
-
-This method can be useful if you are dealing with several cursors.
-
-=head2 show($toggle)
-
-Set the visibility of the cursor. A false value will make the cursor
-invisible in the Application window. A true value will show it back.
-
-=head1 AUTHOR
-
-David J. Goehrig
-
-=head1 SEE ALSO
-
-L<perl> L<SDL::Surface>
-
-=cut