libpurple/request.h

changeset 43285
acde304cf24c
parent 42730
86afaa3533bc
child 43294
1056ce0140f2
--- a/libpurple/request.h	Fri Jul 11 02:46:28 2025 -0500
+++ b/libpurple/request.h	Sun Jul 13 00:01:48 2025 -0500
@@ -68,6 +68,8 @@
  * @PURPLE_REQUEST_FOLDER: Folder selection request.
  *
  * Request types.
+ *
+ * Since: 2.0
  */
 typedef enum
 {
@@ -86,6 +88,8 @@
  * @PURPLE_REQUEST_FEATURE_HTML: Specifies that HTML should be supported.
  *
  * Feature flags for the request api.
+ *
+ * Since: 3.0
  */
 typedef enum
 {
@@ -103,6 +107,8 @@
  * @PURPLE_REQUEST_ICON_ERROR: Use an error icon.
  *
  * Constants to define which kind of icon should be displayed.
+ *
+ * Since: 3.0
  */
 typedef enum
 {
@@ -120,6 +126,8 @@
  * @data: user-data.
  *
  * A callback that's used to handle cancel actions.
+ *
+ * Since: 3.0
  */
 typedef void (*PurpleRequestCancelCb)(gpointer data);
 
@@ -198,6 +206,8 @@
  * @value: The value that was input.
  *
  * The type of callback passed to purple_request_input().
+ *
+ * Since: 2.0
  */
 typedef void (*PurpleRequestInputCb)(void *data, const char *value);
 
@@ -209,6 +219,8 @@
  * The type of callbacks passed to purple_request_action().  The first
  * argument is the <literal>user_data</literal> parameter; the second is the
  * index in the list of actions of the one chosen.
+ *
+ * Since: 2.0
  */
 typedef void (*PurpleRequestActionCb)(void *data, int action);
 
@@ -220,6 +232,8 @@
  * The type of callbacks passed to purple_request_choice().  The first
  * argument is the <literal>user_data</literal> parameter; the second is the
  * values of those choice.
+ *
+ * Since: 2.0
  */
 typedef void (*PurpleRequestChoiceCb)(void *data, gpointer value);
 
@@ -229,6 +243,8 @@
  * @page: The page.
  *
  * The type of callbacks passed to purple_request_fields().
+ *
+ * Since: 2.0
  */
 typedef void (*PurpleRequestFieldsCb)(void *data, PurpleRequestPage *page);
 
@@ -238,6 +254,8 @@
  * @filename: The filename.
  *
  * The type of callbacks passed to purple_request_file().
+ *
+ * Since: 2.0
  */
 typedef void (*PurpleRequestFileCb)(void *data, const char *filename);
 
@@ -246,6 +264,8 @@
  * @data: User data.
  *
  * The type of callback passed to purple_request_cpar_set_help_cb().
+ *
+ * Since: 3.0
  */
 typedef void (*PurpleRequestHelpCb)(gpointer data);
 
@@ -654,6 +674,8 @@
  * Prompts the user for text input.
  *
  * Returns: A UI-specific handle.
+ *
+ * Since: 2.0
  */
 PURPLE_AVAILABLE_IN_ALL
 void *purple_request_input(void *handle, const char *title, const char *primary,
@@ -694,6 +716,8 @@
  * Prompts the user for multiple-choice input.
  *
  * Returns: A UI-specific handle.
+ *
+ * Since: 2.0
  */
 PURPLE_AVAILABLE_IN_ALL
 void *purple_request_choice(void *handle, const char *title, const char *primary,
@@ -734,6 +758,8 @@
  * documentation.
  *
  * Returns: A UI-specific handle.
+ *
+ * Since: 2.0
  */
 PURPLE_AVAILABLE_IN_ALL
 void *purple_request_choice_varg(void *handle, const char *title,
@@ -774,6 +800,8 @@
  * This is often represented as a dialog with a button for each action.
  *
  * Returns: A UI-specific handle.
+ *
+ * Since: 2.0
  */
 PURPLE_AVAILABLE_IN_ALL
 void *
@@ -812,6 +840,8 @@
  * documentation.
  *
  * Returns: A UI-specific handle.
+ *
+ * Since: 2.0
  */
 PURPLE_AVAILABLE_IN_ALL
 void *
@@ -905,6 +935,8 @@
  * Displays groups of fields for the user to fill in.
  *
  * Returns: A UI-specific handle.
+ *
+ * Since: 2.0
  */
 PURPLE_AVAILABLE_IN_ALL
 void *
@@ -952,6 +984,8 @@
  * @uihandle: The request UI handle.
  *
  * Closes a request.
+ *
+ * Since: 2.0
  */
 PURPLE_AVAILABLE_IN_ALL
 void purple_request_close(PurpleRequestType type, void *uihandle);
@@ -964,6 +998,8 @@
  * Closes all requests registered with the specified handle.
  *
  * See purple_request_input().
+ *
+ * Since: 2.0
  */
 PURPLE_AVAILABLE_IN_ALL
 void purple_request_close_with_handle(void *handle);
@@ -989,6 +1025,8 @@
  *
  * A wrapper for purple_request_action() that uses <literal>Yes</literal> and
  * <literal>No</literal> buttons.
+ *
+ * Since: 2.0
  */
 #define purple_request_yes_no(handle, title, primary, secondary, default_action, cpar, user_data, yes_cb, no_cb) \
 	purple_request_action((handle), (title), (primary), (secondary), \
@@ -1016,6 +1054,8 @@
  *
  * A wrapper for purple_request_action() that uses <literal>OK</literal> and
  * <literal>Cancel</literal> buttons.
+ *
+ * Since: 2.0
  */
 #define purple_request_ok_cancel(handle, title, primary, secondary, default_action, cpar, user_data, ok_cb, cancel_cb) \
 	purple_request_action((handle), (title), (primary), (secondary), \
@@ -1042,6 +1082,8 @@
  * @cancel_cb:      A #PurpleRequestActionCb to call when cancel is selected.
  *
  * A wrapper for purple_request_action() that uses Accept and Cancel buttons.
+ *
+ * Since: 2.0
  */
 #define purple_request_accept_cancel(handle, title, primary, secondary, default_action, cpar, user_data, accept_cb, cancel_cb) \
 	purple_request_action((handle), (title), (primary), (secondary), \
@@ -1068,6 +1110,8 @@
  * the callback.  Can be used for either opening a file or saving a file.
  *
  * Returns: A UI-specific handle.
+ *
+ * Since: 2.0
  */
 PURPLE_AVAILABLE_IN_ALL
 void *
@@ -1093,6 +1137,8 @@
  * the callback.
  *
  * Returns: A UI-specific handle.
+ *
+ * Since: 2.0
  */
 PURPLE_AVAILABLE_IN_ALL
 void *
@@ -1122,6 +1168,8 @@
  *
  * Sets the UI operations structure to be used when displaying a
  * request.
+ *
+ * Since: 2.0
  */
 PURPLE_AVAILABLE_IN_ALL
 void purple_request_set_ui_ops(PurpleRequestUiOps *ops);
@@ -1133,6 +1181,8 @@
  * request.
  *
  * Returns: The UI operations structure.
+ *
+ * Since: 2.0
  */
 PURPLE_AVAILABLE_IN_ALL
 PurpleRequestUiOps *purple_request_get_ui_ops(void);

mercurial