SACAVILIA / Desktop-Notify-0.03 / lib / Desktop / Notify.pm 

            

              
1
2
3
4
5
6
7
8
9
10
—
11
12
13
14
15
16
17
18
19
20
21
22
—
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
—
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
—
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
—
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217

              
package Desktop::Notify;
use warnings;
use strict;
use Net::DBus;
use File::Basename;
use Data::Dumper;
use Desktop::Notify::Notification;
=head1 NAME
Desktop::Notify - Communicate with the Desktop Notifications framework
=head1 VERSION
Version 0.03
=cut
our $VERSION = '0.03';
=head1 SYNOPSIS
    use Desktop::Notify;
     
    # Open a connection to the notification daemon
    my $notify = Desktop::Notify->new();
     
    # Create a notification to display
    my $notification = $notify->create(summary => 'Desktop::Notify',
                                       body => 'Hello, world!',
                                       timeout => 5000);
     
    # Display the notification
    $notification->show();
     
    # Close the notification later
    $notification->close();
=head1 DESCRIPTION
This module provides a Perl interface to the Desktop Notifications framework.
The framework allows applications to display pop-up notifications on an X
desktop.  This is implemented with two components: a daemon that displays the
notifications, and a client library used by applications to send notifications
to the daemon.  These components communicate through the DBus message bus
protocol.
More information is available from
L<http://trac.galago-project.org/wiki/DesktopNotifications>
This module serves the same purpose as C<libnotify>, in an object-oriented Perl
interface.  It is not, however, an interface to C<libnotify> itself, but a
separate implementation of the specification using L<Net::DBus>.
=head1 METHODS
=head2 new %opts
Connect to the notification daemon. %opts can include the following options:
=over
=item app_name
The application name to use for notifications. Default is C<basename($0)>
=item bus
The Net::DBus mesage bus to use. Default is to call Net::DBus->session, which
is usually where notification-daemon can be reached.
=item service
The DBus service name of the daemon. Default is
I<org.freedesktop.Notifications>.
=item objpath
The path to the notifications DBus object. Default is
I</org/freedesktop/Notifications>.
=item objiface
The DBus interface to access the notifications object as. Default is
I<org.freedesktop.Notifications>.
=back
=cut
sub new {
    my ($class, %opts) = @_;
    my $self = {};
    $self->{bus} = $opts{bus} || Net::DBus->session;
    $self->{service} = $self->{bus}
        ->get_service($opts{service} || 'org.freedesktop.Notifications');
    $self->{notify} = $self->{service}
        ->get_object($opts{objpath} || '/org/freedesktop/Notifications',
                     $opts{objiface} || 'org.freedesktop.Notifications');
    $self->{app_name} = $opts{app_name} || basename($0);
    $self->{notify}->connect_to_signal('NotificationClosed',
                                       sub {$self->_close_cb(@_)});
    bless $self, $class;
}
=head2 create %params
Creates a new notification object that can be displayed later. This will return
a L<Desktop::Notify::Notification> object; see that module for information
about using it.
=cut
sub create {
    my ($self, %params) = @_;
    return new Desktop::Notify::Notification($self, %params);
}
sub _register_notification {
    my ($self, $n) = @_;
    $self->{notes}->{$n->{id}} = $n;
}
sub _close_cb {
    my ($self, $nid) = @_;
    print __PACKAGE__, ": notification closed\n";
    if ($self->{close_callback})
    {
        print "invoking callback\n";
        $self->{close_callback}->($self->{notes}->{$nid});
    }
    delete $self->{notes}->{$nid};
}
=head2 close_callback $coderef
Sets a user-specified function to be called whenever a notification is closed.
It will be called with one argument, which is the Notification object that was
just closed.
=cut
sub close_callback {
    my ($self, $cb) = @_;
    print "callback is $cb\n";
    $self->{close_callback} = $cb;
}
=head1 AUTHOR
Stephen Cavilia, C<< <sac at atomicradi.us> >>
=head1 SEE ALSO
L<Net::DBus>
L<http://www.galago-project.org/specs/notification/index.php>
L<http://www.galago-project.org/downloads.php>
=head1 BUGS
Please report any bugs or feature requests to
C<bug-desktop-notify at rt.cpan.org>, or through the web interface at
L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Desktop-Notify>.
I will be notified, and then you'll automatically be notified of progress on
your bug as I make changes.
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
    perldoc Desktop::Notify
You can also look for information at:
=over 4
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/Desktop-Notify>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/Desktop-Notify>
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Desktop-Notify>
=item * Search CPAN
L<http://search.cpan.org/dist/Desktop-Notify>
=back
=head1 ACKNOWLEDGEMENTS
=head1 COPYRIGHT & LICENSE
Copyright 2007 Stephen Cavilia, all rights reserved.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
=cut
1; # End of Desktop::Notify