Function

Purplerequest_choice

Declaration [src]

void*
purple_request_choice (
  void* handle,
  const char* title,
  const char* primary,
  const char* secondary,
  gpointer default_value,
  const char* ok_text,
  GCallback ok_cb,
  const char* cancel_text,
  GCallback cancel_cb,
  PurpleRequestCommonParameters* cpar,
  void* user_data,
  ...
)

Description [src]

Prompts the user for multiple-choice input.

This function is not directly available to language bindings.

Parameters

handle

Type: void*

The plugin or connection handle. For some things this is extremely important. See the comments on purple_request_input().

The argument can be NULL.
The data is owned by the caller of the function.
title

Type: const char*

The title of the message, or NULL if it should have no title.

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
primary

Type: const char*

The main point of the message, or NULL if you’re feeling enigmatic.

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
secondary

Type: const char*

Secondary information, or NULL if there is none.

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
default_value

Type: gpointer

The default choice; this should be one of the values listed in the varargs.

The argument can be NULL.
The data is owned by the caller of the function.
ok_text

Type: const char*

The text for the OK button, which may not be NULL.

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
ok_cb

Type: GCallback

The callback for the OK button, which may not be NULL.

cancel_text

Type: const char*

The text for the Cancel button, which may not be NULL.

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
cancel_cb

Type: GCallback

The callback for the Cancel button, or NULL to do nothing.

cpar

Type: PurpleRequestCommonParameters

The PurpleRequestCommonParameters object, which gets unref’ed after this call.

The data is owned by the caller of the function.
user_data

Type: void*

The data to pass to the callback.

The argument can be NULL.
The data is owned by the caller of the function.
...

Type: 

The choices, which should be pairs of char * descriptions and int values, terminated with a NULL parameter.

Return value

Type: void*

A UI-specific handle.

The data is owned by the called function.
The return value can be NULL.