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
|
/** Interface for DKSignal class encapsulating D-Bus signal information.
Copyright (C) 2010 Free Software Foundation, Inc.
Written by: Niels Grewe <niels.grewe@halbordnung.de>
Created: July 2010
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 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
Library 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 02111 USA.
<title>DKSignal class reference</title>
*/
#import "DKIntrospectionNode.h"
#include <dbus/dbus.h>
@class NSString, NSMutableArray, DKArgument;
/**
* DKSignal encapsulates information about D-Bus signals, allowing their
* arguments to be deserialized into a dictionary that can be used as the
* userInfo dictionary of a NSNotification.
*/
@interface DKSignal: DKIntrospectionNode
{
NSMutableArray *args;
}
/**
* Add an argument to the signal specification. It is invalid to specify
* <code>kDKArgumentDirectionIn</code> as a value for <var>direction</var>.
*/
- (void)addArgument: (DKArgument*)arg
direction: (NSString*)direction;
/**
* Replace the arguments of the signal with the new array.
*/
- (void)setArguments: (NSMutableArray*)arguments;
/**
* Returns a custom notification name if one was set for the signal.
*/
- (NSString*)notificationName;
/**
* Registers the signal with the instance of DKNotificationCenter that is
* responsible for the proxy that the signal descends from.
*/
- (void)registerWithNotificationCenter;
/**
* Returns the values of the signals arguments in an dictionary. By default,
* those values will have an keys like arg0, arg1, ..., argN. If an
* org.gnustep.openstep.notification.key annotation is available for the
* arguments of this signal, the values will additionally be available for the
* key specified.
*/
- (NSDictionary*)userInfoFromIterator: (DBusMessageIter*)iter;
/**
* Returns YES if the signal is a stub signal created by the notification
* center.
*/
- (BOOL)isStub;
@end
|