Function

Purplerequest_action

Declaration [src] 

void*
purple_request_action (
  void* handle,
  const char* title,
  const char* primary,
  const char* secondary,
  int default_action,
  PurpleRequestCommonParameters* cpar,
  void* user_data,
  size_t action_count,
  ...
)

Description [src]

Prompts the user for an action.

This is often represented as a dialog with a button for each action.

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_action

Type: int

The default action, zero-indexed; if the third action supplied should be the default, supply 2. This should be the action that users are most likely to select.

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.
action_count

Type: size_t

The number of actions.

...

Type: 

A list of actions. These are pairs of arguments. The first of each pair is the char * label that appears on the button. It should have an underscore before the letter you want to use as the accelerator key for the button. The second of each pair is the PurpleRequestActionCb function to use when the button is clicked.

Return value

Type: void*

A UI-specific handle.

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