X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/43866e378188c25dd1e2208016ab3cbeb086ae6c..440d4c6cfad24426bfddca7518f16c17f4e443f7:/osfmk/UserNotification/KUNCUserNotifications.h

diff --git a/osfmk/UserNotification/KUNCUserNotifications.h b/osfmk/UserNotification/KUNCUserNotifications.h
index c02b2fb11..8b3e3f0bb 100644
--- a/osfmk/UserNotification/KUNCUserNotifications.h
+++ b/osfmk/UserNotification/KUNCUserNotifications.h
@@ -1,16 +1,19 @@
 /*
- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2004 Apple Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
- * 
- * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in
- * compliance with the License. Please obtain a copy of the License at
- * http://www.opensource.apple.com/apsl/ and read it before using this
- * file.
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
+ * 
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
  * 
  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
@@ -20,7 +23,7 @@
  * Please see the License for the specific language governing rights and
  * limitations under the License.
  * 
- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 
 #ifndef __USERNOTIFICATION_KUNCUSERNOTIFICATIONS_H
@@ -40,14 +43,14 @@ __BEGIN_DECLS
  */
 kern_return_t
 KUNCUserNotificationDisplayNotice(
-	int		timeout,
+	int		noticeTimeout,
 	unsigned	flags,
 	char		*iconPath,
 	char		*soundPath,
 	char		*localizationPath,
 	char		*alertHeader,
 	char		*alertMessage,
-	char		*defaultButtonTitle);
+	char		*defaultButtonTitle) __attribute__((deprecated));
 
 /*
  * ***BLOCKING*** alert call, returned int value corresponds to the
@@ -55,7 +58,7 @@ KUNCUserNotificationDisplayNotice(
  */
 kern_return_t
 KUNCUserNotificationDisplayAlert(
-	int		timeout,
+	int		alertTimeout,
 	unsigned	flags,
 	char		*iconPath,
 	char		*soundPath,
@@ -65,7 +68,8 @@ KUNCUserNotificationDisplayAlert(
 	char 		*defaultButtonTitle,
 	char		*alternateButtonTitle,
 	char		*otherButtonTitle,
-	unsigned	*responseFlags);
+	unsigned	*responseFlags) __attribute__((deprecated));
+
 
 /*
  * Execute a userland executable with the given path, user and type
@@ -83,7 +87,7 @@ kern_return_t
 KUNCExecute(
 	char	*executionPath,
 	int	openAsUser,
-	int	pathExecutionType);
+	int	pathExecutionType) __attribute__((deprecated));
 
 
 /* KUNC User Notification XML Keys
@@ -97,32 +101,60 @@ KUNCExecute(
  *
  *  Key			Type
  * Header			string (header displayed on dialog)
+ * 				corresponds to kCFUserNotificationAlertHeaderKey
+ *
  * Icon URL			string (url of the icon to display)
+ * 				corresponds to kCFUserNotificationIconURLKey
+ *
  * Sound URL			string (url of the sound to play on display)
+ * 				corresponds to kCFUserNotificationSoundURLKey
+ *
  * Localization URL		string (url of bundle to retrieve localization
  *				info from, using Localizable.strings files)
+ * 				corresponds to kCFUserNotificationLocalizationURLKey
+ *
  * Message			string (text of the message, can contain %@'s
  *				which are filled from tokenString passed in) 
+ * 				corresponds to kCFUserNotificationAlertMessageKey
+ *
  * OK Button Title 		string (title of the "main" button)
- * Alternate Button Title 	string (title of the "alternate" button -
- *				usually cancel)
+ * 				corresponds to kCFUserNotificationDefaultButtonTitleKey
+ *
+ * Alternate Button Title 	string (title of the "alternate" button,  usually cancel)
+ * 				corresponds to kCFUserNotificationAlternateButtonTitleKey
+ *
  * Other Button Title	 	string (title of the "other" button)
+ * 				corresponds to kCFUserNotificationOtherButtonTitleKey
+ *
  * Timeout			string (numeric, int - seconds until the dialog
  *				goes away on it's own)
- * Alert Level			string (Stop, Notice, Alert, 
+ *
+ * Alert Level			string (Stop, Notice, Alert)
+ *
  * Blocking Message		string (numeric, 1 or 0 - if 1, the dialog will
  *				have no buttons)
+ *
  * Text Field Strings		array of strings (each becomes a text field)
+ * 				corresponds to kCFUserNotificationTextFieldTitlesKey
+ *
  * Password Fields		array of strings (numeric - each indicates a
  *				pwd field)
+ *
  * Popup Button Strings		array of strings (each entry becomes a popup
  *				button string)
+ *
  * Radio Button Strings		array of strings (each becomes a radio button)
+ *
  * Check Box Strings		array of strings (each becomes a check box)
+ * 				corresponds to kCFUserNotificationCheckBoxTitlesKey
+ *
  * Selected Radio		string (numeric - which radio is selected)
+ *
  * Checked Boxes		array of strings (numeric - each indicates a
  *				checked field)
+ *
  * Selected Popup		string (numeric - which popup entry is selected)
+ *
  */
 
 /*
@@ -153,7 +185,7 @@ KUNCExecute(
  *		back to the client in the callback pararmeter contextKey
  */
 
-typedef int KUNCUserNotificationID;
+typedef uintptr_t KUNCUserNotificationID;
 
 /*
  * Reponse value checking & default setting
@@ -178,15 +210,14 @@ enum {
  */
 typedef void
 (*KUNCUserNotificationCallBack)(
-	int	contextKey,
-	int	responseFlags,
-	void	*xmlData);
+	int		contextKey,
+	int		responseFlags,
+	const void	*xmlData);
 
 /*
  * Get a notification ID
  */
-KUNCUserNotificationID KUNCGetNotificationID();
-
+KUNCUserNotificationID KUNCGetNotificationID(void) __attribute__((deprecated));
 
 /* This function currently requires a bundle path, which kexts cannot currently get.  In the future, the CFBundleIdentiofier of the kext will be pass in in place of the bundlePath. */
 
@@ -199,12 +230,12 @@ KUNCUserNotificationDisplayFromBundle(
 	char				*messageKey,
 	char				*tokenString,
 	KUNCUserNotificationCallBack	callback,
-	int				contextKey);
+	int				contextKey) __attribute__((deprecated));
 
 
 kern_return_t
 KUNCUserNotificationCancel(
-	KUNCUserNotificationID	notification);
+	KUNCUserNotificationID	notification) __attribute__((deprecated));
 
 
 __END_DECLS