/usr/include/libpurple/request.h is in libpurple-dev 2.12.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 | /**
* @file request.h Request API
* @ingroup core
*/
/* purple
*
* Purple is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#ifndef _PURPLE_REQUEST_H_
#define _PURPLE_REQUEST_H_
#include <stdlib.h>
#include <glib-object.h>
#include <glib.h>
/** @copydoc _PurpleRequestField */
typedef struct _PurpleRequestField PurpleRequestField;
#include "account.h"
#define PURPLE_DEFAULT_ACTION_NONE -1
/**
* Request types.
*/
typedef enum
{
PURPLE_REQUEST_INPUT = 0, /**< Text input request. */
PURPLE_REQUEST_CHOICE, /**< Multiple-choice request. */
PURPLE_REQUEST_ACTION, /**< Action request. */
PURPLE_REQUEST_FIELDS, /**< Multiple fields request. */
PURPLE_REQUEST_FILE, /**< File open or save request. */
PURPLE_REQUEST_FOLDER /**< Folder selection request. */
} PurpleRequestType;
/**
* A type of field.
*/
typedef enum
{
PURPLE_REQUEST_FIELD_NONE,
PURPLE_REQUEST_FIELD_STRING,
PURPLE_REQUEST_FIELD_INTEGER,
PURPLE_REQUEST_FIELD_BOOLEAN,
PURPLE_REQUEST_FIELD_CHOICE,
PURPLE_REQUEST_FIELD_LIST,
PURPLE_REQUEST_FIELD_LABEL,
PURPLE_REQUEST_FIELD_IMAGE,
PURPLE_REQUEST_FIELD_ACCOUNT
} PurpleRequestFieldType;
/**
* Multiple fields request data.
*/
typedef struct
{
GList *groups;
GHashTable *fields;
GList *required_fields;
void *ui_data;
} PurpleRequestFields;
/**
* A group of fields with a title.
*/
typedef struct
{
PurpleRequestFields *fields_list;
char *title;
GList *fields;
} PurpleRequestFieldGroup;
#if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_REQUEST_C_)
/**
* A request field.
*/
struct _PurpleRequestField
{
PurpleRequestFieldType type;
PurpleRequestFieldGroup *group;
char *id;
char *label;
char *type_hint;
gboolean visible;
gboolean required;
union
{
struct
{
gboolean multiline;
gboolean masked;
gboolean editable;
char *default_value;
char *value;
} string;
struct
{
int default_value;
int value;
} integer;
struct
{
gboolean default_value;
gboolean value;
} boolean;
struct
{
int default_value;
int value;
GList *labels;
} choice;
struct
{
GList *items;
GList *icons;
GHashTable *item_data;
GList *selected;
GHashTable *selected_table;
gboolean multiple_selection;
} list;
struct
{
PurpleAccount *default_account;
PurpleAccount *account;
gboolean show_all;
PurpleFilterAccountFunc filter_func;
} account;
struct
{
unsigned int scale_x;
unsigned int scale_y;
const char *buffer;
gsize size;
} image;
} u;
void *ui_data;
};
#endif
/**
* Request UI operations.
*/
typedef struct
{
/** @see purple_request_input(). */
void *(*request_input)(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, void *user_data);
/** @see purple_request_choice_varg(). */
void *(*request_choice)(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, void *user_data,
va_list choices);
/** @see purple_request_action_varg(). */
void *(*request_action)(const char *title, const char *primary,
const char *secondary, int default_action,
PurpleAccount *account, const char *who,
PurpleConversation *conv, void *user_data,
size_t action_count, va_list actions);
/** @see purple_request_fields(). */
void *(*request_fields)(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, void *user_data);
/** @see purple_request_file(). */
void *(*request_file)(const char *title, const char *filename,
gboolean savedialog, GCallback ok_cb,
GCallback cancel_cb, PurpleAccount *account,
const char *who, PurpleConversation *conv,
void *user_data);
void (*close_request)(PurpleRequestType type, void *ui_handle);
/** @see purple_request_folder(). */
void *(*request_folder)(const char *title, const char *dirname,
GCallback ok_cb, GCallback cancel_cb,
PurpleAccount *account, const char *who,
PurpleConversation *conv, void *user_data);
/** @see purple_request_action_with_icon_varg(). */
void *(*request_action_with_icon)(const char *title, const char *primary,
const char *secondary, int default_action,
PurpleAccount *account, const char *who,
PurpleConversation *conv,
gconstpointer icon_data, gsize icon_size,
void *user_data,
size_t action_count, va_list actions);
void (*_purple_reserved1)(void);
void (*_purple_reserved2)(void);
void (*_purple_reserved3)(void);
} PurpleRequestUiOps;
typedef void (*PurpleRequestInputCb)(void *, const char *);
/** The type of callbacks passed to purple_request_action(). The first
* argument is the @a user_data parameter; the second is the index in the list
* of actions of the one chosen.
*/
typedef void (*PurpleRequestActionCb)(void *, int);
typedef void (*PurpleRequestChoiceCb)(void *, int);
typedef void (*PurpleRequestFieldsCb)(void *, PurpleRequestFields *fields);
typedef void (*PurpleRequestFileCb)(void *, const char *filename);
#ifdef __cplusplus
extern "C" {
#endif
/**************************************************************************/
/** @name Field List API */
/**************************************************************************/
/*@{*/
/**
* Creates a list of fields to pass to purple_request_fields().
*
* @return A PurpleRequestFields structure.
*/
PurpleRequestFields *purple_request_fields_new(void);
/**
* Destroys a list of fields.
*
* @param fields The list of fields to destroy.
*/
void purple_request_fields_destroy(PurpleRequestFields *fields);
/**
* Adds a group of fields to the list.
*
* @param fields The fields list.
* @param group The group to add.
*/
void purple_request_fields_add_group(PurpleRequestFields *fields,
PurpleRequestFieldGroup *group);
/**
* Returns a list of all groups in a field list.
*
* @param fields The fields list.
*
* @constreturn A list of groups.
*/
GList *purple_request_fields_get_groups(const PurpleRequestFields *fields);
/**
* Returns whether or not the field with the specified ID exists.
*
* @param fields The fields list.
* @param id The ID of the field.
*
* @return TRUE if the field exists, or FALSE.
*/
gboolean purple_request_fields_exists(const PurpleRequestFields *fields,
const char *id);
/**
* Returns a list of all required fields.
*
* @param fields The fields list.
*
* @constreturn The list of required fields.
*/
GList *purple_request_fields_get_required(const PurpleRequestFields *fields);
/**
* Returns whether or not a field with the specified ID is required.
*
* @param fields The fields list.
* @param id The field ID.
*
* @return TRUE if the specified field is required, or FALSE.
*/
gboolean purple_request_fields_is_field_required(const PurpleRequestFields *fields,
const char *id);
/**
* Returns whether or not all required fields have values.
*
* @param fields The fields list.
*
* @return TRUE if all required fields have values, or FALSE.
*/
gboolean purple_request_fields_all_required_filled(
const PurpleRequestFields *fields);
/**
* Return the field with the specified ID.
*
* @param fields The fields list.
* @param id The ID of the field.
*
* @return The field, if found.
*/
PurpleRequestField *purple_request_fields_get_field(
const PurpleRequestFields *fields, const char *id);
/**
* Returns the string value of a field with the specified ID.
*
* @param fields The fields list.
* @param id The ID of the field.
*
* @return The string value, if found, or @c NULL otherwise.
*/
const char *purple_request_fields_get_string(const PurpleRequestFields *fields,
const char *id);
/**
* Returns the integer value of a field with the specified ID.
*
* @param fields The fields list.
* @param id The ID of the field.
*
* @return The integer value, if found, or 0 otherwise.
*/
int purple_request_fields_get_integer(const PurpleRequestFields *fields,
const char *id);
/**
* Returns the boolean value of a field with the specified ID.
*
* @param fields The fields list.
* @param id The ID of the field.
*
* @return The boolean value, if found, or @c FALSE otherwise.
*/
gboolean purple_request_fields_get_bool(const PurpleRequestFields *fields,
const char *id);
/**
* Returns the choice index of a field with the specified ID.
*
* @param fields The fields list.
* @param id The ID of the field.
*
* @return The choice index, if found, or -1 otherwise.
*/
int purple_request_fields_get_choice(const PurpleRequestFields *fields,
const char *id);
/**
* Returns the account of a field with the specified ID.
*
* @param fields The fields list.
* @param id The ID of the field.
*
* @return The account value, if found, or NULL otherwise.
*/
PurpleAccount *purple_request_fields_get_account(const PurpleRequestFields *fields,
const char *id);
/*@}*/
/**************************************************************************/
/** @name Fields Group API */
/**************************************************************************/
/*@{*/
/**
* Creates a fields group with an optional title.
*
* @param title The optional title to give the group.
*
* @return A new fields group
*/
PurpleRequestFieldGroup *purple_request_field_group_new(const char *title);
/**
* Destroys a fields group.
*
* @param group The group to destroy.
*/
void purple_request_field_group_destroy(PurpleRequestFieldGroup *group);
/**
* Adds a field to the group.
*
* @param group The group to add the field to.
* @param field The field to add to the group.
*/
void purple_request_field_group_add_field(PurpleRequestFieldGroup *group,
PurpleRequestField *field);
/**
* Returns the title of a fields group.
*
* @param group The group.
*
* @return The title, if set.
*/
const char *purple_request_field_group_get_title(
const PurpleRequestFieldGroup *group);
/**
* Returns a list of all fields in a group.
*
* @param group The group.
*
* @constreturn The list of fields in the group.
*/
GList *purple_request_field_group_get_fields(
const PurpleRequestFieldGroup *group);
/*@}*/
/**************************************************************************/
/** @name Field API */
/**************************************************************************/
/*@{*/
/**
* Creates a field of the specified type.
*
* @param id The field ID.
* @param text The text label of the field.
* @param type The type of field.
*
* @return The new field.
*/
PurpleRequestField *purple_request_field_new(const char *id, const char *text,
PurpleRequestFieldType type);
/**
* Destroys a field.
*
* @param field The field to destroy.
*/
void purple_request_field_destroy(PurpleRequestField *field);
/**
* Sets the label text of a field.
*
* @param field The field.
* @param label The text label.
*/
void purple_request_field_set_label(PurpleRequestField *field, const char *label);
/**
* Sets whether or not a field is visible.
*
* @param field The field.
* @param visible TRUE if visible, or FALSE if not.
*/
void purple_request_field_set_visible(PurpleRequestField *field, gboolean visible);
/**
* Sets the type hint for the field.
*
* This is optionally used by the UIs to provide such features as
* auto-completion for type hints like "account" and "screenname".
*
* @param field The field.
* @param type_hint The type hint.
*/
void purple_request_field_set_type_hint(PurpleRequestField *field,
const char *type_hint);
/**
* Sets whether or not a field is required.
*
* @param field The field.
* @param required TRUE if required, or FALSE.
*/
void purple_request_field_set_required(PurpleRequestField *field,
gboolean required);
/**
* Returns the type of a field.
*
* @param field The field.
*
* @return The field's type.
*/
PurpleRequestFieldType purple_request_field_get_type(const PurpleRequestField *field);
/**
* Returns the group for the field.
*
* @param field The field.
*
* @return The UI data.
*
* @since 2.6.0
*/
PurpleRequestFieldGroup *purple_request_field_get_group(const PurpleRequestField *field);
/**
* Returns the ID of a field.
*
* @param field The field.
*
* @return The ID
*/
const char *purple_request_field_get_id(const PurpleRequestField *field);
/**
* Returns the label text of a field.
*
* @param field The field.
*
* @return The label text.
*/
const char *purple_request_field_get_label(const PurpleRequestField *field);
/**
* Returns whether or not a field is visible.
*
* @param field The field.
*
* @return TRUE if the field is visible. FALSE otherwise.
*/
gboolean purple_request_field_is_visible(const PurpleRequestField *field);
/**
* Returns the field's type hint.
*
* @param field The field.
*
* @return The field's type hint.
*/
const char *purple_request_field_get_type_hint(const PurpleRequestField *field);
/**
* Returns whether or not a field is required.
*
* @param field The field.
*
* @return TRUE if the field is required, or FALSE.
*/
gboolean purple_request_field_is_required(const PurpleRequestField *field);
/**
* Returns the ui_data for a field.
*
* @param field The field.
*
* @return The UI data.
*
* @since 2.6.0
*/
gpointer purple_request_field_get_ui_data(const PurpleRequestField *field);
/**
* Sets the ui_data for a field.
*
* @param field The field.
* @param ui_data The UI data.
*
* @return The UI data.
*
* @since 2.6.0
*/
void purple_request_field_set_ui_data(PurpleRequestField *field,
gpointer ui_data);
/*@}*/
/**************************************************************************/
/** @name String Field API */
/**************************************************************************/
/*@{*/
/**
* Creates a string request field.
*
* @param id The field ID.
* @param text The text label of the field.
* @param default_value The optional default value.
* @param multiline Whether or not this should be a multiline string.
*
* @return The new field.
*/
PurpleRequestField *purple_request_field_string_new(const char *id,
const char *text,
const char *default_value,
gboolean multiline);
/**
* Sets the default value in a string field.
*
* @param field The field.
* @param default_value The default value.
*/
void purple_request_field_string_set_default_value(PurpleRequestField *field,
const char *default_value);
/**
* Sets the value in a string field.
*
* @param field The field.
* @param value The value.
*/
void purple_request_field_string_set_value(PurpleRequestField *field,
const char *value);
/**
* Sets whether or not a string field is masked
* (commonly used for password fields).
*
* @param field The field.
* @param masked The masked value.
*/
void purple_request_field_string_set_masked(PurpleRequestField *field,
gboolean masked);
/**
* Sets whether or not a string field is editable.
*
* @param field The field.
* @param editable The editable value.
*/
void purple_request_field_string_set_editable(PurpleRequestField *field,
gboolean editable);
/**
* Returns the default value in a string field.
*
* @param field The field.
*
* @return The default value.
*/
const char *purple_request_field_string_get_default_value(
const PurpleRequestField *field);
/**
* Returns the user-entered value in a string field.
*
* @param field The field.
*
* @return The value.
*/
const char *purple_request_field_string_get_value(const PurpleRequestField *field);
/**
* Returns whether or not a string field is multi-line.
*
* @param field The field.
*
* @return @c TRUE if the field is mulit-line, or @c FALSE otherwise.
*/
gboolean purple_request_field_string_is_multiline(const PurpleRequestField *field);
/**
* Returns whether or not a string field is masked.
*
* @param field The field.
*
* @return @c TRUE if the field is masked, or @c FALSE otherwise.
*/
gboolean purple_request_field_string_is_masked(const PurpleRequestField *field);
/**
* Returns whether or not a string field is editable.
*
* @param field The field.
*
* @return @c TRUE if the field is editable, or @c FALSE otherwise.
*/
gboolean purple_request_field_string_is_editable(const PurpleRequestField *field);
/*@}*/
/**************************************************************************/
/** @name Integer Field API */
/**************************************************************************/
/*@{*/
/**
* Creates an integer field.
*
* @param id The field ID.
* @param text The text label of the field.
* @param default_value The default value.
*
* @return The new field.
*/
PurpleRequestField *purple_request_field_int_new(const char *id,
const char *text,
int default_value);
/**
* Sets the default value in an integer field.
*
* @param field The field.
* @param default_value The default value.
*/
void purple_request_field_int_set_default_value(PurpleRequestField *field,
int default_value);
/**
* Sets the value in an integer field.
*
* @param field The field.
* @param value The value.
*/
void purple_request_field_int_set_value(PurpleRequestField *field, int value);
/**
* Returns the default value in an integer field.
*
* @param field The field.
*
* @return The default value.
*/
int purple_request_field_int_get_default_value(const PurpleRequestField *field);
/**
* Returns the user-entered value in an integer field.
*
* @param field The field.
*
* @return The value.
*/
int purple_request_field_int_get_value(const PurpleRequestField *field);
/*@}*/
/**************************************************************************/
/** @name Boolean Field API */
/**************************************************************************/
/*@{*/
/**
* Creates a boolean field.
*
* This is often represented as a checkbox.
*
* @param id The field ID.
* @param text The text label of the field.
* @param default_value The default value.
*
* @return The new field.
*/
PurpleRequestField *purple_request_field_bool_new(const char *id,
const char *text,
gboolean default_value);
/**
* Sets the default value in an boolean field.
*
* @param field The field.
* @param default_value The default value.
*/
void purple_request_field_bool_set_default_value(PurpleRequestField *field,
gboolean default_value);
/**
* Sets the value in an boolean field.
*
* @param field The field.
* @param value The value.
*/
void purple_request_field_bool_set_value(PurpleRequestField *field,
gboolean value);
/**
* Returns the default value in an boolean field.
*
* @param field The field.
*
* @return The default value.
*/
gboolean purple_request_field_bool_get_default_value(
const PurpleRequestField *field);
/**
* Returns the user-entered value in an boolean field.
*
* @param field The field.
*
* @return The value.
*/
gboolean purple_request_field_bool_get_value(const PurpleRequestField *field);
/*@}*/
/**************************************************************************/
/** @name Choice Field API */
/**************************************************************************/
/*@{*/
/**
* Creates a multiple choice field.
*
* This is often represented as a group of radio buttons.
*
* @param id The field ID.
* @param text The optional label of the field.
* @param default_value The default choice.
*
* @return The new field.
*/
PurpleRequestField *purple_request_field_choice_new(const char *id,
const char *text,
int default_value);
/**
* Adds a choice to a multiple choice field.
*
* @param field The choice field.
* @param label The choice label.
*/
void purple_request_field_choice_add(PurpleRequestField *field,
const char *label);
/**
* Sets the default value in an choice field.
*
* @param field The field.
* @param default_value The default value.
*/
void purple_request_field_choice_set_default_value(PurpleRequestField *field,
int default_value);
/**
* Sets the value in an choice field.
*
* @param field The field.
* @param value The value.
*/
void purple_request_field_choice_set_value(PurpleRequestField *field, int value);
/**
* Returns the default value in an choice field.
*
* @param field The field.
*
* @return The default value.
*/
int purple_request_field_choice_get_default_value(const PurpleRequestField *field);
/**
* Returns the user-entered value in an choice field.
*
* @param field The field.
*
* @return The value.
*/
int purple_request_field_choice_get_value(const PurpleRequestField *field);
/**
* Returns a list of labels in a choice field.
*
* @param field The field.
*
* @constreturn The list of labels.
*/
GList *purple_request_field_choice_get_labels(const PurpleRequestField *field);
/*@}*/
/**************************************************************************/
/** @name List Field API */
/**************************************************************************/
/*@{*/
/**
* Creates a multiple list item field.
*
* @param id The field ID.
* @param text The optional label of the field.
*
* @return The new field.
*/
PurpleRequestField *purple_request_field_list_new(const char *id, const char *text);
/**
* Sets whether or not a list field allows multiple selection.
*
* @param field The list field.
* @param multi_select TRUE if multiple selection is enabled,
* or FALSE otherwise.
*/
void purple_request_field_list_set_multi_select(PurpleRequestField *field,
gboolean multi_select);
/**
* Returns whether or not a list field allows multiple selection.
*
* @param field The list field.
*
* @return TRUE if multiple selection is enabled, or FALSE otherwise.
*/
gboolean purple_request_field_list_get_multi_select(
const PurpleRequestField *field);
/**
* Returns the data for a particular item.
*
* @param field The list field.
* @param text The item text.
*
* @return The data associated with the item.
*/
void *purple_request_field_list_get_data(const PurpleRequestField *field,
const char *text);
/**
* Adds an item to a list field.
*
* @param field The list field.
* @param item The list item.
* @param data The associated data.
*
* @deprecated Use purple_request_field_list_add_icon() instead.
*/
void purple_request_field_list_add(PurpleRequestField *field,
const char *item, void *data);
/**
* Adds an item to a list field.
*
* @param field The list field.
* @param item The list item.
* @param icon_path The path to icon file, or @c NULL for no icon.
* @param data The associated data.
*/
void purple_request_field_list_add_icon(PurpleRequestField *field,
const char *item, const char* icon_path, void* data);
/**
* Adds a selected item to the list field.
*
* @param field The field.
* @param item The item to add.
*/
void purple_request_field_list_add_selected(PurpleRequestField *field,
const char *item);
/**
* Clears the list of selected items in a list field.
*
* @param field The field.
*/
void purple_request_field_list_clear_selected(PurpleRequestField *field);
/**
* Sets a list of selected items in a list field.
*
* @param field The field.
* @param items The list of selected items, which is not modified or freed.
*/
void purple_request_field_list_set_selected(PurpleRequestField *field,
GList *items);
/**
* Returns whether or not a particular item is selected in a list field.
*
* @param field The field.
* @param item The item.
*
* @return TRUE if the item is selected. FALSE otherwise.
*/
gboolean purple_request_field_list_is_selected(const PurpleRequestField *field,
const char *item);
/**
* Returns a list of selected items in a list field.
*
* To retrieve the data for each item, use
* purple_request_field_list_get_data().
*
* @param field The field.
*
* @constreturn The list of selected items.
*/
GList *purple_request_field_list_get_selected(
const PurpleRequestField *field);
/**
* Returns a list of items in a list field.
*
* @param field The field.
*
* @constreturn The list of items.
*/
GList *purple_request_field_list_get_items(const PurpleRequestField *field);
/**
* Returns a list of icons in a list field.
*
* The icons will correspond with the items, in order.
*
* @param field The field.
*
* @constreturn The list of icons or @c NULL (i.e. the empty GList) if no
* items have icons.
*/
GList *purple_request_field_list_get_icons(const PurpleRequestField *field);
/*@}*/
/**************************************************************************/
/** @name Label Field API */
/**************************************************************************/
/*@{*/
/**
* Creates a label field.
*
* @param id The field ID.
* @param text The label of the field.
*
* @return The new field.
*/
PurpleRequestField *purple_request_field_label_new(const char *id,
const char *text);
/*@}*/
/**************************************************************************/
/** @name Image Field API */
/**************************************************************************/
/*@{*/
/**
* Creates an image field.
*
* @param id The field ID.
* @param text The label of the field.
* @param buf The image data.
* @param size The size of the data in @a buffer.
*
* @return The new field.
*/
PurpleRequestField *purple_request_field_image_new(const char *id, const char *text,
const char *buf, gsize size);
/**
* Sets the scale factors of an image field.
*
* @param field The image field.
* @param x The x scale factor.
* @param y The y scale factor.
*/
void purple_request_field_image_set_scale(PurpleRequestField *field, unsigned int x, unsigned int y);
/**
* Returns pointer to the image.
*
* @param field The image field.
*
* @return Pointer to the image.
*/
const char *purple_request_field_image_get_buffer(PurpleRequestField *field);
/**
* Returns size (in bytes) of the image.
*
* @param field The image field.
*
* @return Size of the image.
*/
gsize purple_request_field_image_get_size(PurpleRequestField *field);
/**
* Returns X scale coefficient of the image.
*
* @param field The image field.
*
* @return X scale coefficient of the image.
*/
unsigned int purple_request_field_image_get_scale_x(PurpleRequestField *field);
/**
* Returns Y scale coefficient of the image.
*
* @param field The image field.
*
* @return Y scale coefficient of the image.
*/
unsigned int purple_request_field_image_get_scale_y(PurpleRequestField *field);
/*@}*/
/**************************************************************************/
/** @name Account Field API */
/**************************************************************************/
/*@{*/
/**
* Creates an account field.
*
* By default, this field will not show offline accounts.
*
* @param id The field ID.
* @param text The text label of the field.
* @param account The optional default account.
*
* @return The new field.
*/
PurpleRequestField *purple_request_field_account_new(const char *id,
const char *text,
PurpleAccount *account);
/**
* Sets the default account on an account field.
*
* @param field The account field.
* @param default_value The default account.
*/
void purple_request_field_account_set_default_value(PurpleRequestField *field,
PurpleAccount *default_value);
/**
* Sets the account in an account field.
*
* @param field The account field.
* @param value The account.
*/
void purple_request_field_account_set_value(PurpleRequestField *field,
PurpleAccount *value);
/**
* Sets whether or not to show all accounts in an account field.
*
* If TRUE, all accounts, online or offline, will be shown. If FALSE,
* only online accounts will be shown.
*
* @param field The account field.
* @param show_all Whether or not to show all accounts.
*/
void purple_request_field_account_set_show_all(PurpleRequestField *field,
gboolean show_all);
/**
* Sets the account filter function in an account field.
*
* This function will determine which accounts get displayed and which
* don't.
*
* @param field The account field.
* @param filter_func The account filter function.
*/
void purple_request_field_account_set_filter(PurpleRequestField *field,
PurpleFilterAccountFunc filter_func);
/**
* Returns the default account in an account field.
*
* @param field The field.
*
* @return The default account.
*/
PurpleAccount *purple_request_field_account_get_default_value(
const PurpleRequestField *field);
/**
* Returns the user-entered account in an account field.
*
* @param field The field.
*
* @return The user-entered account.
*/
PurpleAccount *purple_request_field_account_get_value(
const PurpleRequestField *field);
/**
* Returns whether or not to show all accounts in an account field.
*
* If TRUE, all accounts, online or offline, will be shown. If FALSE,
* only online accounts will be shown.
*
* @param field The account field.
* @return Whether or not to show all accounts.
*/
gboolean purple_request_field_account_get_show_all(
const PurpleRequestField *field);
/**
* Returns the account filter function in an account field.
*
* This function will determine which accounts get displayed and which
* don't.
*
* @param field The account field.
*
* @return The account filter function.
*/
PurpleFilterAccountFunc purple_request_field_account_get_filter(
const PurpleRequestField *field);
/*@}*/
/**************************************************************************/
/** @name Request API */
/**************************************************************************/
/*@{*/
/**
* Prompts the user for text input.
*
* @param handle The plugin or connection handle. For some
* things this is <em>extremely</em> important. The
* handle is used to programmatically close the request
* dialog when it is no longer needed. For PRPLs this
* is often a pointer to the #PurpleConnection
* instance. For plugins this should be a similar,
* unique memory location. This value is important
* because it allows a request to be closed with
* purple_request_close_with_handle() when, for
* example, you sign offline. If the request is
* <em>not</em> closed it is <strong>very</strong>
* likely to cause a crash whenever the callback
* handler functions are triggered.
* @param title The title of the message, or @c NULL if it should have
* no title.
* @param primary The main point of the message, or @c NULL if you're
* feeling enigmatic.
* @param secondary Secondary information, or @c NULL if there is none.
* @param default_value The default value.
* @param multiline @c TRUE if the inputted text can span multiple lines.
* @param masked @c TRUE if the inputted text should be masked in some
* way (such as by displaying characters as stars). This
* might be because the input is some kind of password.
* @param hint Optionally suggest how the input box should appear.
* Use "html", for example, to allow the user to enter
* HTML.
* @param ok_text The text for the @c OK button, which may not be @c NULL.
* @param ok_cb The callback for the @c OK button, which may not be @c
* NULL.
* @param cancel_text The text for the @c Cancel button, which may not be @c
* NULL.
* @param cancel_cb The callback for the @c Cancel button, which may be
* @c NULL.
* @param account The #PurpleAccount associated with this request, or @c
* NULL if none is.
* @param who The username of the buddy associated with this request,
* or @c NULL if none is.
* @param conv The #PurpleConversation associated with this request, or
* @c NULL if none is.
* @param user_data The data to pass to the callback.
*
* @return A UI-specific handle.
*/
void *purple_request_input(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,
void *user_data);
/**
* Prompts the user for multiple-choice input.
*
* @param handle The plugin or connection handle. For some things this
* is <em>extremely</em> important. See the comments on
* purple_request_input().
* @param title The title of the message, or @c NULL if it should have
* no title.
* @param primary The main point of the message, or @c NULL if you're
* feeling enigmatic.
* @param secondary Secondary information, or @c NULL if there is none.
* @param default_value The default choice; this should be one of the values
* listed in the varargs.
* @param ok_text The text for the @c OK button, which may not be @c NULL.
* @param ok_cb The callback for the @c OK button, which may not be @c
* NULL.
* @param cancel_text The text for the @c Cancel button, which may not be @c
* NULL.
* @param cancel_cb The callback for the @c Cancel button, or @c NULL to
* do nothing.
* @param account The #PurpleAccount associated with this request, or @c
* NULL if none is.
* @param who The username of the buddy associated with this request,
* or @c NULL if none is.
* @param conv The #PurpleConversation associated with this request, or
* @c NULL if none is.
* @param user_data The data to pass to the callback.
* @param ... The choices, which should be pairs of <tt>char *</tt>
* descriptions and <tt>int</tt> values, terminated with a
* @c NULL parameter.
*
* @return A UI-specific handle.
*/
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,
void *user_data, ...) G_GNUC_NULL_TERMINATED;
/**
* <tt>va_list</tt> version of purple_request_choice(); see its documentation.
*/
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,
void *user_data, va_list choices);
/**
* Prompts the user for an action.
*
* This is often represented as a dialog with a button for each action.
*
* @param handle The plugin or connection handle. For some things this
* is <em>extremely</em> important. See the comments on
* purple_request_input().
* @param title The title of the message, or @c NULL if it should have
* no title.
* @param primary The main point of the message, or @c NULL if you're
* feeling enigmatic.
* @param secondary Secondary information, or @c NULL if there is none.
* @param default_action The default action, zero-indexed; if the third action
* supplied should be the default, supply <tt>2</tt>.
* The should be the action that users are most likely
* to select.
* @param account The #PurpleAccount associated with this request, or @c
* NULL if none is.
* @param who The username of the buddy associated with this request,
* or @c NULL if none is.
* @param conv The #PurpleConversation associated with this request, or
* @c NULL if none is.
* @param user_data The data to pass to the callback.
* @param action_count The number of actions.
* @param ... A list of actions. These are pairs of
* arguments. The first of each pair is the
* <tt>char *</tt> 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 A UI-specific handle.
*/
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, void *user_data,
size_t action_count, ...);
/**
* <tt>va_list</tt> version of purple_request_action(); see its documentation.
*/
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,
void *user_data, size_t action_count, va_list actions);
/**
* Version of purple_request_action() supplying an image for the UI to
* optionally display as an icon in the dialog; see its documentation
* @since 2.7.0
*/
void *purple_request_action_with_icon(void *handle, const char *title,
const char *primary, const char *secondary, int default_action,
PurpleAccount *account, const char *who, PurpleConversation *conv,
gconstpointer icon_data, gsize icon_size, void *user_data,
size_t action_count, ...);
/**
* <tt>va_list</tt> version of purple_request_action_with_icon();
* see its documentation.
* @since 2.7.0
*/
void *purple_request_action_with_icon_varg(void *handle, const char *title,
const char *primary, const char *secondary, int default_action,
PurpleAccount *account, const char *who, PurpleConversation *conv,
gconstpointer icon_data, gsize icon_size,
void *user_data, size_t action_count, va_list actions);
/**
* Displays groups of fields for the user to fill in.
*
* @param handle The plugin or connection handle. For some things this
* is <em>extremely</em> important. See the comments on
* purple_request_input().
* @param title The title of the message, or @c NULL if it should have
* no title.
* @param primary The main point of the message, or @c NULL if you're
* feeling enigmatic.
* @param secondary Secondary information, or @c NULL if there is none.
* @param fields The list of fields.
* @param ok_text The text for the @c OK button, which may not be @c NULL.
* @param ok_cb The callback for the @c OK button, which may not be @c
* NULL.
* @param cancel_text The text for the @c Cancel button, which may not be @c
* NULL.
* @param cancel_cb The callback for the @c Cancel button, which may be
* @c NULL.
* @param account The #PurpleAccount associated with this request, or @c
* NULL if none is
* @param who The username of the buddy associated with this request,
* or @c NULL if none is
* @param conv The #PurpleConversation associated with this request, or
* @c NULL if none is
* @param user_data The data to pass to the callback.
*
* @return A UI-specific handle.
*/
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,
void *user_data);
/**
* Closes a request.
*
* @param type The request type.
* @param uihandle The request UI handle.
*/
void purple_request_close(PurpleRequestType type, void *uihandle);
/**
* Closes all requests registered with the specified handle.
*
* @param handle The handle, as supplied as the @a handle parameter to one of the
* <tt>purple_request_*</tt> functions.
*
* @see purple_request_input().
*/
void purple_request_close_with_handle(void *handle);
/**
* A wrapper for purple_request_action() that uses @c Yes and @c No buttons.
*/
#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, (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, \
default_action, account, who, conv, \
user_data, ok_cb, cancel_cb) \
purple_request_action((handle), (title), (primary), (secondary), \
(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, \
default_action, account, who, conv, \
user_data, accept_cb, cancel_cb) \
purple_request_action((handle), (title), (primary), (secondary), \
(default_action), account, who, conv, (user_data), 2, \
_("_Accept"), (accept_cb), _("_Cancel"), (cancel_cb))
/**
* A wrapper for purple_request_action_with_icon() that uses Accept and Cancel
* buttons.
*/
#define purple_request_accept_cancel_with_icon(handle, title, primary, secondary, \
default_action, account, who, conv, \
icon_data, icon_size, \
user_data, accept_cb, cancel_cb) \
purple_request_action_with_icon((handle), (title), (primary), (secondary), \
(default_action), account, who, conv, icon_data, icon_size, \
(user_data), 2, \
_("_Accept"), (accept_cb), _("_Cancel"), (cancel_cb))
/**
* Displays a file selector request dialog. Returns the selected filename to
* the callback. Can be used for either opening a file or saving a file.
*
* @param handle The plugin or connection handle. For some things this
* is <em>extremely</em> important. See the comments on
* purple_request_input().
* @param title The title of the message, or @c NULL if it should have
* no title.
* @param filename The default filename (may be @c NULL)
* @param savedialog True if this dialog is being used to save a file.
* False if it is being used to open a file.
* @param ok_cb The callback for the @c OK button.
* @param cancel_cb The callback for the @c Cancel button, which may be @c NULL.
* @param account The #PurpleAccount associated with this request, or @c
* NULL if none is
* @param who The username of the buddy associated with this request,
* or @c NULL if none is
* @param conv The #PurpleConversation associated with this request, or
* @c NULL if none is
* @param user_data The data to pass to the callback.
*
* @return A UI-specific handle.
*/
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,
void *user_data);
/**
* Displays a folder select dialog. Returns the selected filename to
* the callback.
*
* @param handle The plugin or connection handle. For some things this
* is <em>extremely</em> important. See the comments on
* purple_request_input().
* @param title The title of the message, or @c NULL if it should have
* no title.
* @param dirname The default directory name (may be @c NULL)
* @param ok_cb The callback for the @c OK button.
* @param cancel_cb The callback for the @c Cancel button, which may be @c NULL.
* @param account The #PurpleAccount associated with this request, or @c
* NULL if none is
* @param who The username of the buddy associated with this request,
* or @c NULL if none is
* @param conv The #PurpleConversation associated with this request, or
* @c NULL if none is
* @param user_data The data to pass to the callback.
*
* @return A UI-specific handle.
*/
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,
void *user_data);
/*@}*/
/**************************************************************************/
/** @name UI Registration Functions */
/**************************************************************************/
/*@{*/
/**
* Sets the UI operations structure to be used when displaying a
* request.
*
* @param ops The UI operations structure.
*/
void purple_request_set_ui_ops(PurpleRequestUiOps *ops);
/**
* Returns the UI operations structure to be used when displaying a
* request.
*
* @return The UI operations structure.
*/
PurpleRequestUiOps *purple_request_get_ui_ops(void);
/*@}*/
#ifdef __cplusplus
}
#endif
#endif /* _PURPLE_REQUEST_H_ */
|