diff libpurple/request.h @ 20598:285bb637a2b7

Updated hinting to be less invasive

--- a/libpurple/request.h	Sat Sep 22 09:48:07 2007 +0000
+++ b/libpurple/request.h	Sat Sep 22 16:19:34 2007 +0000
@@ -1192,6 +1192,18 @@
  *
  * @return A UI-specific handle.
  */
+void *purple_request_input_with_hint(void *handle, const char *title,
+						 const char *primary, const char *secondary,
+						 const char *default_value,
+						 gboolean multiline, gboolean masked, gchar *hint,
+						 const char *ok_text, GCallback ok_cb,
+						 const char *cancel_text, GCallback cancel_cb,
+						 PurpleAccount *account, const char *who, PurpleConversation *conv,
+						 const char *ui_hint, void *user_data);
+
+/**
+ * @deprecated Please use purple_request_input_with_hint() instead.
+ */
 void *purple_request_input(void *handle, const char *title,
 						 const char *primary, const char *secondary,
 						 const char *default_value,
@@ -1199,7 +1211,7 @@
 						 const char *ok_text, GCallback ok_cb,
 						 const char *cancel_text, GCallback cancel_cb,
 						 PurpleAccount *account, const char *who, PurpleConversation *conv,
-						 const char *ui_hint, void *user_data);
+						 void *user_data);
 
 /**
  * Prompts the user for multiple-choice input.
@@ -1225,13 +1237,24 @@
  *
  * @return A UI-specific handle.
  */
+void *purple_request_choice_with_hint(void *handle, const char *title,
+						  const char *primary, const char *secondary,
+						  int default_value,
+						  const char *ok_text, GCallback ok_cb,
+						  const char *cancel_text, GCallback cancel_cb,
+						  PurpleAccount *account, const char *who, PurpleConversation *conv,
+						  const char *ui_hint, void *user_data, ...) G_GNUC_NULL_TERMINATED;
+
+/**
+ * @deprecated Please use purple_request_choice_with_hint() instead.
+ */
 void *purple_request_choice(void *handle, const char *title,
 						  const char *primary, const char *secondary,
 						  int default_value,
 						  const char *ok_text, GCallback ok_cb,
 						  const char *cancel_text, GCallback cancel_cb,
 						  PurpleAccount *account, const char *who, PurpleConversation *conv,
-						  const char *ui_hint, void *user_data, ...) G_GNUC_NULL_TERMINATED;
+						  void *user_data, ...) G_GNUC_NULL_TERMINATED;
 
 /**
  * Prompts the user for multiple-choice input.
@@ -1257,13 +1280,24 @@
  *
  * @return A UI-specific handle.
  */
+void *purple_request_choice_varg_with_hint(void *handle, const char *title,
+							   const char *primary, const char *secondary,
+							   int default_value,
+							   const char *ok_text, GCallback ok_cb,
+							   const char *cancel_text, GCallback cancel_cb,
+							   PurpleAccount *account, const char *who, PurpleConversation *conv,
+							   const char *ui_hint, void *user_data, va_list choices);
+
+/**
+ * @deprecated Please use purple_request_choice_varg_with_hint() instead.
+ */
 void *purple_request_choice_varg(void *handle, const char *title,
 							   const char *primary, const char *secondary,
 							   int default_value,
 							   const char *ok_text, GCallback ok_cb,
 							   const char *cancel_text, GCallback cancel_cb,
 							   PurpleAccount *account, const char *who, PurpleConversation *conv,
-							   const char *ui_hint, void *user_data, va_list choices);
+							   void *user_data, va_list choices);
 
 /**
  * Prompts the user for an action.
@@ -1293,11 +1327,20 @@
  *
  * @return A UI-specific handle.
  */
+void *purple_request_action_with_hint(void *handle, const char *title,
+						  const char *primary, const char *secondary,
+						  int default_action,
+						  PurpleAccount *account, const char *who, PurpleConversation *conv,
+						  const char *ui_hint, void *user_data, size_t action_count, ...);
+
+/**
+ * @deprecated Please use purple_request_action_with_hint() instead.
+ */
 void *purple_request_action(void *handle, const char *title,
 						  const char *primary, const char *secondary,
 						  int default_action,
 						  PurpleAccount *account, const char *who, PurpleConversation *conv,
-						  const char *ui_hint, void *user_data, size_t action_count, ...);
+						  void *user_data, size_t action_count, ...);
 
 /**
  * Prompts the user for an action.
@@ -1321,11 +1364,21 @@
  *
  * @return A UI-specific handle.
  */
+void *purple_request_action_varg_with_hint(void *handle, const char *title,
+							   const char *primary, const char *secondary,
+							   int default_action,
+							   PurpleAccount *account, const char *who, PurpleConversation *conv,
+							   const char *ui_hint, void *user_data, size_t action_count,
+							   va_list actions);
+
+/**
+ * @deprecated Please use purple_request_action_varg_with_hint() instead.
+ */
 void *purple_request_action_varg(void *handle, const char *title,
 							   const char *primary, const char *secondary,
 							   int default_action,
 							   PurpleAccount *account, const char *who, PurpleConversation *conv,
-							   const char *ui_hint, void *user_data, size_t action_count,
+							   void *user_data, size_t action_count,
 							   va_list actions);
 
 /**
@@ -1350,13 +1403,24 @@
  *
  * @return A UI-specific handle.
  */
+void *purple_request_fields_with_hint(void *handle, const char *title,
+						  const char *primary, const char *secondary,
+						  PurpleRequestFields *fields,
+						  const char *ok_text, GCallback ok_cb,
+						  const char *cancel_text, GCallback cancel_cb,
+						  PurpleAccount *account, const char *who, PurpleConversation *conv,
+						  const char *ui_hint, void *user_data);
+
+/**
+ * @deprecated Please use purple_request_fields_with_hint() instead.
+ */
 void *purple_request_fields(void *handle, const char *title,
 						  const char *primary, const char *secondary,
 						  PurpleRequestFields *fields,
 						  const char *ok_text, GCallback ok_cb,
 						  const char *cancel_text, GCallback cancel_cb,
 						  PurpleAccount *account, const char *who, PurpleConversation *conv,
-						  const char *ui_hint, void *user_data);
+						  void *user_data);
 
 /**
  * Closes a request.
@@ -1376,31 +1440,61 @@
 /**
  * A wrapper for purple_request_action() that uses @c Yes and @c No buttons.
  */
-#define purple_request_yes_no(handle, title, primary, secondary, \
+#define purple_request_yes_no_with_hint(handle, title, primary, secondary, \
 							default_action, account, who, conv, \
 							ui_hint, user_data, yes_cb, no_cb) \
+	purple_request_action_with_hint((handle), (title), (primary), (secondary), \
+						(default_action), account, who, conv, (ui_hint), (user_data), 2, \
+						_("_Yes"), (yes_cb), _("_No"), (no_cb))
+
+/**
+ * @deprecated Please use purple_request_yes_no_with_hint instead.
+ */
+#define purple_request_yes_no(handle, title, primary, secondary, \
+							default_action, account, who, conv, \
+							user_data, yes_cb, no_cb) \
 	purple_request_action((handle), (title), (primary), (secondary), \
-						(default_action), account, who, conv, (ui_hint), (user_data), 2, \
+						(default_action), account, who, conv, (user_data), 2, \
 						_("_Yes"), (yes_cb), _("_No"), (no_cb))
 
 /**
  * A wrapper for purple_request_action() that uses @c OK and @c Cancel buttons.
  */
-#define purple_request_ok_cancel(handle, title, primary, secondary, \
+#define purple_request_ok_cancel_with_hint(handle, title, primary, secondary, \
 							default_action, account, who, conv, \
 						    ui_hint, user_data, ok_cb, cancel_cb) \
+	purple_request_action_with_hint((handle), (title), (primary), (secondary), \
+						(default_action), account, who, conv, (ui_hint), (user_data), 2, \
+						_("_OK"), (ok_cb), _("_Cancel"), (cancel_cb))
+
+/**
+ * @deprecated Please use purple_request_ok_cancel_with_hint instead.
+ */
+#define purple_request_ok_cancel(handle, title, primary, secondary, \
+							default_action, account, who, conv, \
+						    user_data, ok_cb, cancel_cb) \
 	purple_request_action((handle), (title), (primary), (secondary), \
-						(default_action), account, who, conv, (ui_hint), (user_data), 2, \
+						(default_action), account, who, conv, (user_data), 2, \
 						_("_OK"), (ok_cb), _("_Cancel"), (cancel_cb))
 
 /**
  * A wrapper for purple_request_action() that uses Accept and Cancel buttons.
  */
-#define purple_request_accept_cancel(handle, title, primary, secondary, \
+#define purple_request_accept_cancel_with_hint(handle, title, primary, secondary, \
 								   default_action, account, who, conv, \
 								   ui_hint, user_data, accept_cb, cancel_cb) \
+	purple_request_action_with_hint((handle), (title), (primary), (secondary), \
+						(default_action), account, who, conv, (ui_hint), (user_data), 2, \
+						_("_Accept"), (accept_cb), _("_Cancel"), (cancel_cb))
+
+/**
+ * @deprecated Please use purple_request_accept_cancel_with_hint instead.
+ */
+#define purple_request_accept_cancel(handle, title, primary, secondary, \
+								   default_action, account, who, conv, \
+								   user_data, accept_cb, cancel_cb) \
 	purple_request_action((handle), (title), (primary), (secondary), \
-						(default_action), account, who, conv, (ui_hint), (user_data), 2, \
+						(default_action), account, who, conv, (user_data), 2, \
 						_("_Accept"), (accept_cb), _("_Cancel"), (cancel_cb))
 
 /**
@@ -1424,11 +1518,20 @@
  *
  * @return A UI-specific handle.
  */
+void *purple_request_file_with_hint(void *handle, const char *title, const char *filename,
+						gboolean savedialog,
+						GCallback ok_cb, GCallback cancel_cb,
+						PurpleAccount *account, const char *who, PurpleConversation *conv,
+						const char *ui_hint, void *user_data);
+
+/**
+ * @deprecated Please use purple_request_file_with_hint() instead.
+ */
 void *purple_request_file(void *handle, const char *title, const char *filename,
 						gboolean savedialog,
 						GCallback ok_cb, GCallback cancel_cb,
 						PurpleAccount *account, const char *who, PurpleConversation *conv,
-						const char *ui_hint, void *user_data);
+						void *user_data);
 
 /**
  * Displays a folder select dialog. Returns the selected filename to
@@ -1449,6 +1552,14 @@
  *
  * @return A UI-specific handle.
  */
+void *purple_request_folder_with_hint(void *handle, const char *title, const char *dirname,
+						GCallback ok_cb, GCallback cancel_cb,
+						PurpleAccount *account, const char *who, PurpleConversation *conv,
+						const char *ui_hint, void *user_data);
+
+/**
+ * @deprecated Please use purple_request_folder_with_hint() instead.
+ */
 void *purple_request_folder(void *handle, const char *title, const char *dirname,
 						GCallback ok_cb, GCallback cancel_cb,
 						PurpleAccount *account, const char *who, PurpleConversation *conv,