/usr/include/kmessagebox.h is in kdelibs5-dev 4:4.13.3-0ubuntu0.5.
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 | /* This file is part of the KDE libraries
Copyright (C) 1999 Waldo Bastian (bastian@kde.org)
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; version 2
of the License.
This library 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
//krazy:excludeall=dpointer
#ifndef KMESSAGEBOX_H
#define KMESSAGEBOX_H
#include <QtGui/QMessageBox>
#include <kguiitem.h>
#include <kstandardguiitem.h>
class QWidget;
class QStringList;
class KConfig;
class KDialog;
/**
* Easy message dialog box.
*
* Provides convenience functions for some i18n'ed standard dialogs,
* as well as audible notification via @ref KNotification
*
* The text in message boxes is wrapped automatically. The text may either
* be plaintext or richtext. If the text is plaintext, a newline-character
* may be used to indicate the end of a paragraph.
*
* @port4 Where applicable, the static functions now take an additional
* argument to specify the cancel button. Since a default argument is
* provided, this will affect your code only, if you specified
* dontAskAgainName and/or options. In those cases, adding an additional
* parameter KStandardGuiItem::cancel() leads to the old behavior. The
* following functions are affected (omitting function arguments in the
* list): questionYesNoCancel(), questionYesNoCancelWId(),
* warningContinueCancel(), warningContinueCancelWId(),
* warningContinueCancelList(), warningContinueCancelListWId(),
* warningYesNoCancel(), warningYesNoCancelWId(),
* warningYesNoCancelList(), warningYesNoCancelListWId(), messageBox(),
* messageBoxWId().
*
* \image html kmessagebox.png "KDE Message Box (using questionYesNo())"
*
* @author Waldo Bastian (bastian@kde.org)
*/
class KDEUI_EXPORT KMessageBox
{
public:
/**
* Button types.
**/
enum ButtonCode
{
Ok = 1,
Cancel = 2,
Yes = 3,
No = 4,
Continue = 5
};
enum DialogType
{
QuestionYesNo = 1,
WarningYesNo = 2,
WarningContinueCancel = 3,
WarningYesNoCancel = 4,
Information = 5,
// Reserved for: SSLMessageBox = 6
Sorry = 7,
Error = 8,
QuestionYesNoCancel = 9
};
enum Option
{
Notify = 1, ///< Emit a KNotify event
AllowLink = 2, ///< The message may contain links.
Dangerous = 4, ///< The action to be confirmed by the dialog is a potentially destructive one. The default button will be set to Cancel or No, depending on which is available.
PlainCaption = 8, ///< Do not use KApplication::makeStdCaption()
NoExec = 16, ///< Do not call exec() in createKMessageBox()
WindowModal = 32 ///< The window is to be modal relative to its parent. By default, it is application modal.
};
Q_DECLARE_FLAGS(Options,Option)
/**
* Display a simple "question" dialog.
*
* @param parent Parent widget.
* @param text Message string.
* @param caption Message box title. The application name is added to
* the title. The default title is i18n("Question").
* @param buttonYes The text for the first button.
* The default is KStandardGuiItem::yes().
* @param buttonNo The text for the second button.
* The default is KStandardGuiItem::no().
* @param dontAskAgainName If provided, a checkbox is added with which
* further confirmation can be turned off.
* The string is used to lookup and store the setting
* in the applications config file.
* The setting is stored in the "Notification Messages" group.
* If @p dontAskAgainName starts with a ':' then the setting
* is stored in the global config file.
* @param options see Option
*
* @return 'Yes' is returned if the Yes-button is pressed. 'No' is returned
* if the No-button is pressed.
*
* To be used for questions like "Do you have a printer?"
*
* The default button is "Yes". Pressing "Esc" selects "No".
*/
static int questionYesNo(QWidget *parent,
const QString &text,
const QString &caption = QString(),
const KGuiItem &buttonYes = KStandardGuiItem::yes(),
const KGuiItem &buttonNo = KStandardGuiItem::no(),
const QString &dontAskAgainName = QString(),
Options options = Notify);
/**
* This function accepts the window id of the parent window, instead
* of QWidget*. It should be used only when necessary.
*/
static int questionYesNoWId(WId parent_id,
const QString &text,
const QString &caption = QString(),
const KGuiItem &buttonYes = KStandardGuiItem::yes(),
const KGuiItem &buttonNo = KStandardGuiItem::no(),
const QString &dontAskAgainName = QString(),
Options options = Notify);
/**
* Display a simple "question" dialog.
*
* @param parent Parent widget.
* @param text Message string.
* @param caption Message box title. The application name is added to
* the title. The default title is i18n("Question").
* @param buttonYes The text for the first button.
* The default is KStandardGuiItem::yes().
* @param buttonNo The text for the second button.
* The default is KStandardGuiItem::no().
* @param buttonCancel The text for the third button.
* The default is KStandardGuiItem::cancel().
* @param dontAskAgainName If provided, a checkbox is added with which
* further confirmation can be turned off.
* The string is used to lookup and store the setting
* in the applications config file.
* The setting is stored in the "Notification Messages" group.
* If @p dontAskAgainName starts with a ':' then the setting
* is stored in the global config file.
* @param options see Options
*
* @return 'Yes' is returned if the Yes-button is pressed. 'No' is returned
* if the No-button is pressed.
*
* To be used for questions like "Do you want to discard the message or save it for later?",
*
* The default button is "Yes". Pressing "Esc" selects "Cancel".
*/
static int questionYesNoCancel(QWidget *parent,
const QString &text,
const QString &caption = QString(),
const KGuiItem &buttonYes = KStandardGuiItem::yes(),
const KGuiItem &buttonNo = KStandardGuiItem::no(),
const KGuiItem &buttonCancel = KStandardGuiItem::cancel(),
const QString &dontAskAgainName = QString(),
Options options = Notify);
/**
* This function accepts the window id of the parent window, instead
* of QWidget*. It should be used only when necessary.
*/
static int questionYesNoCancelWId(WId parent_id,
const QString &text,
const QString &caption = QString(),
const KGuiItem &buttonYes = KStandardGuiItem::yes(),
const KGuiItem &buttonNo = KStandardGuiItem::no(),
const KGuiItem &buttonCancel = KStandardGuiItem::cancel(),
const QString &dontAskAgainName = QString(),
Options options = Notify);
/**
* Display a "question" dialog with a listbox to show information to the user
*
* @param parent Parent widget.
* @param text Message string.
* @param strlist List of strings to be written in the listbox. If the list is
* empty, it doesn't show any listbox, working as questionYesNo.
* @param caption Message box title. The application name is added to
* the title. The default title is i18n("Question").
* @param buttonYes The text for the first button.
* The default is KStandardGuiItem::yes().
* @param buttonNo The text for the second button.
* The default is KStandardGuiItem::no().
* @param dontAskAgainName If provided, a checkbox is added with which
* further confirmation can be turned off.
* The string is used to lookup and store the setting
* in the applications config file.
* The setting is stored in the "Notification Messages" group.
* If @p dontAskAgainName starts with a ':' then the setting
* is stored in the global config file.
* @param options see Options
*
* @return 'Yes' is returned if the Yes-button is pressed. 'No' is returned
* if the No-button is pressed.
*
* To be used for questions like "Do you really want to delete these files?"
* And show the user exactly which files are going to be deleted in case
* he presses "Yes"
*
* The default button is "Yes". Pressing "Esc" selects "No".
*/
static int questionYesNoList(QWidget *parent,
const QString &text,
const QStringList &strlist,
const QString &caption = QString(),
const KGuiItem &buttonYes = KStandardGuiItem::yes(),
const KGuiItem &buttonNo = KStandardGuiItem::no(),
const QString &dontAskAgainName = QString(),
Options options = Notify);
/**
* This function accepts the window id of the parent window, instead
* of QWidget*. It should be used only when necessary.
*/
static int questionYesNoListWId(WId parent_id,
const QString &text,
const QStringList &strlist,
const QString &caption = QString(),
const KGuiItem &buttonYes = KStandardGuiItem::yes(),
const KGuiItem &buttonNo = KStandardGuiItem::no(),
const QString &dontAskAgainName = QString(),
Options options = Notify);
/**
* Display a "warning" dialog.
*
* @param parent Parent widget.
* @param text Message string.
* @param caption Message box title. The application name is added to
* the title. The default title is i18n("Warning").
* @param buttonYes The text for the first button.
* The default is KStandardGuiItem::yes().
* @param buttonNo The text for the second button.
* The default is KStandardGuiItem::no().
* @param dontAskAgainName If provided, a checkbox is added with which
* further confirmation can be turned off.
* The string is used to lookup and store the setting
* in the applications config file.
* The setting is stored in the "Notification Messages" group.
* If @p dontAskAgainName starts with a ':' then the setting
* is stored in the global config file.
* @param options see Options
*
* @return @p Yes is returned if the Yes-button is pressed. @p No is returned
* if the No-button is pressed.
*
* To be used for questions "Shall I update your configuration?"
* The text should explain the implication of both options.
*
* The default button is "No". Pressing "Esc" selects "No".
*/
static int warningYesNo(QWidget *parent,
const QString &text,
const QString &caption = QString(),
const KGuiItem &buttonYes = KStandardGuiItem::yes(),
const KGuiItem &buttonNo = KStandardGuiItem::no(),
const QString &dontAskAgainName = QString(),
Options options = Options(Notify | Dangerous));
/**
* This function accepts the window id of the parent window, instead
* of QWidget*. It should be used only when necessary.
*/
static int warningYesNoWId(WId parent_id,
const QString &text,
const QString &caption = QString(),
const KGuiItem &buttonYes = KStandardGuiItem::yes(),
const KGuiItem &buttonNo = KStandardGuiItem::no(),
const QString &dontAskAgainName = QString(),
Options options = Options(Notify | Dangerous));
/**
* Display a "warning" dialog with a listbox to show information to the user
*
* @param parent Parent widget.
* @param text Message string.
* @param strlist List of strings to be written in the listbox. If the list is
* empty, it doesn't show any listbox, working as questionYesNo.
* @param caption Message box title. The application name is added to
* the title. The default title is i18n("Question").
* @param buttonYes The text for the first button.
* The default is KStandardGuiItem::yes().
* @param buttonNo The text for the second button.
* The default is KStandardGuiItem::no().
* @param dontAskAgainName If provided, a checkbox is added with which
* further confirmation can be turned off.
* The string is used to lookup and store the setting
* in the applications config file.
* The setting is stored in the "Notification Messages" group.
* If @p dontAskAgainName starts with a ':' then the setting
* is stored in the global config file.
* @param options see Options
*
* @return 'Yes' is returned if the Yes-button is pressed. 'No' is returned
* if the No-button is pressed.
*
* To be used for questions like "Do you really want to delete these files?"
* And show the user exactly which files are going to be deleted in case
* he presses "Yes"
*
* The default button is "No". Pressing "Esc" selects "No".
*/
static int warningYesNoList(QWidget *parent,
const QString &text,
const QStringList &strlist,
const QString &caption = QString(),
const KGuiItem &buttonYes = KStandardGuiItem::yes(),
const KGuiItem &buttonNo = KStandardGuiItem::no(),
const QString &dontAskAgainName = QString(),
Options options = Options(Notify | Dangerous));
/**
* This function accepts the window id of the parent window, instead
* of QWidget*. It should be used only when necessary.
*/
static int warningYesNoListWId(WId parent_id,
const QString &text,
const QStringList &strlist,
const QString &caption = QString(),
const KGuiItem &buttonYes = KStandardGuiItem::yes(),
const KGuiItem &buttonNo = KStandardGuiItem::no(),
const QString &dontAskAgainName = QString(),
Options options = Options(Notify | Dangerous));
/**
* Display a "warning" dialog.
*
* @param parent Parent widget.
* @param text Message string.
* @param caption Message box title. The application name is added to
* the title. The default title is i18n("Warning").
* @param buttonContinue The text for the first button.
* The default is KStandardGuiItem::cont().
* @param buttonCancel The text for the second button.
* The default is KStandardGuiItem::cancel().
* @param dontAskAgainName If provided, a checkbox is added with which
* further confirmation can be turned off.
* The string is used to lookup and store the setting
* in the applications config file.
* The setting is stored in the "Notification Messages" group.
* If @p dontAskAgainName starts with a ':' then the setting
* is stored in the global config file.
* @param options see Options
*
* @return @p Continue is returned if the Continue-button is pressed.
* @p Cancel is returned if the Cancel-button is pressed.
*
* To be used for questions like "You are about to Print. Are you sure?"
* the continueButton should then be labeled "Print".
*
* The default button is buttonContinue. Pressing "Esc" selects "Cancel".
*/
static int warningContinueCancel(QWidget *parent,
const QString &text,
const QString &caption = QString(),
const KGuiItem &buttonContinue = KStandardGuiItem::cont(),
const KGuiItem &buttonCancel = KStandardGuiItem::cancel(),
const QString &dontAskAgainName = QString(),
Options options = Notify);
/**
* This function accepts the window id of the parent window, instead
* of QWidget*. It should be used only when necessary.
*/
static int warningContinueCancelWId(WId parent_id,
const QString &text,
const QString &caption = QString(),
const KGuiItem &buttonContinue = KStandardGuiItem::cont(),
const KGuiItem &buttonCancel = KStandardGuiItem::cancel(),
const QString &dontAskAgainName = QString(),
Options options = Notify);
/**
* Display a "warning" dialog with a listbox to show information to the user.
*
* @param parent Parent widget.
* @param text Message string.
* @param strlist List of strings to be written in the listbox. If the
* list is empty, it doesn't show any listbox, working
* as warningContinueCancel.
* @param caption Message box title. The application name is added to
* the title. The default title is i18n("Warning").
* @param buttonContinue The text for the first button.
* The default is KStandardGuiItem::cont().
* @param buttonCancel The text for the second button.
* The default is KStandardGuiItem::cancel().
* @param dontAskAgainName If provided, a checkbox is added with which
* further confirmation can be turned off.
* The string is used to lookup and store the setting
* in the applications config file.
* The setting is stored in the "Notification Messages" group.
* If @p dontAskAgainName starts with a ':' then the setting
* is stored in the global config file.
*
* @param options see Options
*
* @return @p Continue is returned if the Continue-button is pressed.
* @p Cancel is returned if the Cancel-button is pressed.
*
* To be used for questions like "You are about to Print. Are you sure?"
* the continueButton should then be labeled "Print".
*
* The default button is buttonContinue. Pressing "Esc" selects "Cancel".
*/
static int warningContinueCancelList(QWidget *parent,
const QString &text,
const QStringList &strlist,
const QString &caption = QString(),
const KGuiItem &buttonContinue = KStandardGuiItem::cont(),
const KGuiItem &buttonCancel = KStandardGuiItem::cancel(),
const QString &dontAskAgainName = QString(),
Options options = Notify);
/**
* This function accepts the window id of the parent window, instead
* of QWidget*. It should be used only when necessary.
*/
static int warningContinueCancelListWId(WId parent_id,
const QString &text,
const QStringList &strlist,
const QString &caption = QString(),
const KGuiItem &buttonContinue = KStandardGuiItem::cont(),
const KGuiItem &buttonCancel = KStandardGuiItem::cancel(),
const QString &dontAskAgainName = QString(),
Options options = Notify);
/**
* Display a Yes/No/Cancel "warning" dialog.
*
* @param parent Parent widget.
* @param text Message string.
* @param caption Message box title. The application name is added to
* the title. The default title is i18n("Warning").
* @param buttonYes The text for the first button.
* The default is KStandardGuiItem::yes().
* @param buttonNo The text for the second button.
* The default is KStandardGuiItem::no().
* @param buttonCancel The text for the third button.
* The default is KStandardGuiItem::cancel().
* @param dontAskAgainName If provided, a checkbox is added with which
* further questions can be turned off. If turned off
* all questions will be automatically answered with the
* last answer (either Yes or No).
* The string is used to lookup and store the setting
* in the applications config file.
* The setting is stored in the "Notification Messages" group.
* If @p dontAskAgainName starts with a ':' then the setting
* is stored in the global config file.
* @param options see Options
*
* @return @p Yes is returned if the Yes-button is pressed. @p No is returned
* if the No-button is pressed. @p Cancel is retunred if the Cancel-
* button is pressed.
*
* To be used for questions "Do you want to save your changes?"
* The text should explain the implication of choosing 'No'.
*
* The default button is "Yes". Pressing "Esc" selects "Cancel"
*/
static int warningYesNoCancel(QWidget *parent,
const QString &text,
const QString &caption = QString(),
const KGuiItem &buttonYes = KStandardGuiItem::yes(),
const KGuiItem &buttonNo = KStandardGuiItem::no(),
const KGuiItem &buttonCancel = KStandardGuiItem::cancel(),
const QString &dontAskAgainName = QString(),
Options options = Notify);
/**
* This function accepts the window id of the parent window, instead
* of QWidget*. It should be used only when necessary.
*/
static int warningYesNoCancelWId(WId parent_id,
const QString &text,
const QString &caption = QString(),
const KGuiItem &buttonYes = KStandardGuiItem::yes(),
const KGuiItem &buttonNo = KStandardGuiItem::no(),
const KGuiItem &buttonCancel = KStandardGuiItem::cancel(),
const QString &dontAskAgainName = QString(),
Options options = Notify);
/**
* Display a Yes/No/Cancel "warning" dialog with a listbox to show information
* to the user.
*
* @param parent Parent widget.
* @param text Message string.
* @param strlist List of strings to be written in the listbox. If the
* list is empty, it doesn't show any listbox, working
* as warningYesNoCancel.
* @param caption Message box title. The application name is added to
* the title. The default title is i18n("Warning").
* @param buttonYes The text for the first button.
* The default is KStandardGuiItem::yes().
* @param buttonNo The text for the second button.
* The default is KStandardGuiItem::no().
* @param buttonCancel The text for the third button.
* The default is KStandardGuiItem::cancel().
* @param dontAskAgainName If provided, a checkbox is added with which
* further questions can be turned off. If turned off
* all questions will be automatically answered with the
* last answer (either Yes or No).
* The string is used to lookup and store the setting
* in the applications config file.
* The setting is stored in the "Notification Messages" group.
* If @p dontAskAgainName starts with a ':' then the setting
* is stored in the global config file.
* @param options see Options
*
* @return @p Yes is returned if the Yes-button is pressed. @p No is returned
* if the No-button is pressed. @p Cancel is retunred if the Cancel-
* button is pressed.
*
* To be used for questions "Do you want to save your changes?"
* The text should explain the implication of choosing 'No'.
*
* The default button is "Yes". Pressing "Esc" selects "Cancel"
*/
static int warningYesNoCancelList(QWidget *parent,
const QString &text,
const QStringList &strlist,
const QString &caption = QString(),
const KGuiItem &buttonYes = KStandardGuiItem::yes(),
const KGuiItem &buttonNo = KStandardGuiItem::no(),
const KGuiItem &buttonCancel = KStandardGuiItem::cancel(),
const QString &dontAskAgainName = QString(),
Options options = Notify);
/**
* This function accepts the window id of the parent window, instead
* of QWidget*. It should be used only when necessary.
*/
static int warningYesNoCancelListWId(WId parent_id,
const QString &text,
const QStringList &strlist,
const QString &caption = QString(),
const KGuiItem &buttonYes = KStandardGuiItem::yes(),
const KGuiItem &buttonNo = KStandardGuiItem::no(),
const KGuiItem &buttonCancel = KStandardGuiItem::cancel(),
const QString &dontAskAgainName = QString(),
Options options = Notify);
/**
* Display an "Error" dialog.
*
* @param parent Parent widget.
* @param text Message string.
* @param caption Message box title. The application name is added to
* the title. The default title is i18n("Error").
* @param options see Options
*
* Your program messed up and now it's time to inform the user.
* To be used for important things like "Sorry, I deleted your hard disk."
*
* If your program detects the action specified by the user is somehow
* not allowed, this should never be reported with error(). Use sorry()
* instead to explain to the user that this action is not allowed.
*
* The default button is "&OK". Pressing "Esc" selects the OK-button.
*
* NOTE: The OK button will always have the i18n'ed text '&OK'.
*/
static void error(QWidget *parent,
const QString &text,
const QString &caption = QString(),
Options options = Notify);
/**
* This function accepts the window id of the parent window, instead
* of QWidget*. It should be used only when necessary.
*/
static void errorWId(WId parent_id,
const QString &text,
const QString &caption = QString(),
Options options = Notify);
/**
* Display an "Error" dialog with a listbox.
*
* @param parent Parent widget.
* @param text Message string.
* @param strlist List of strings to be written in the listbox. If the
* list is empty, it doesn't show any listbox, working
* as error().
* @param caption Message box title. The application name is added to
* the title. The default title is i18n("Error").
* @param options see Options
*
* Your program messed up and now it's time to inform the user.
* To be used for important things like "Sorry, I deleted your hard disk."
*
* If your program detects the action specified by the user is somehow
* not allowed, this should never be reported with error(). Use sorry()
* instead to explain to the user that this action is not allowed.
*
* The default button is "&OK". Pressing "Esc" selects the OK-button.
*
* NOTE: The OK button will always have the i18n'ed text '&OK'.
*/
static void errorList(QWidget *parent,
const QString &text,
const QStringList &strlist,
const QString &caption = QString(),
Options options = Notify);
/**
* This function accepts the window id of the parent window, instead
* of QWidget*. It should be used only when necessary.
*/
static void errorListWId(WId parent_id,
const QString &text,
const QStringList &strlist,
const QString &caption = QString(),
Options options = Notify);
/**
* Displays an "Error" dialog with a "Details >>" button.
*
* @param parent Parent widget.
* @param text Message string.
* @param details Detailed message string.
* @param caption Message box title. The application name is added to
* the title. The default title is i18n("Error").
* @param options see Options
*
* Your program messed up and now it's time to inform the user.
* To be used for important things like "Sorry, I deleted your hard disk."
*
* The @p details message can contain additional information about
* the problem and can be shown on request to advanced/interested users.
*
* If your program detects the action specified by the user is somehow
* not allowed, this should never be reported with error(). Use sorry()
* instead to explain to the user that this action is not allowed.
*
* The default button is "&OK". Pressing "Esc" selects the OK-button.
*
* NOTE: The OK button will always have the i18n'ed text '&OK'.
*/
static void detailedError(QWidget *parent,
const QString &text,
const QString &details,
const QString &caption = QString(),
Options options = Notify);
/**
* This function accepts the window id of the parent window, instead
* of QWidget*. It should be used only when necessary.
*/
static void detailedErrorWId(WId parent_id,
const QString &text,
const QString &details,
const QString &caption = QString(),
Options options = Notify);
/**
* Like detailedError
*
* This function will return immediately, the messagebox will be shown
* once the application enters an event loop and no other messagebox
* is being shown.
*
* Note that if the parent gets deleted, the messagebox will not be
* shown.
*/
static void queuedDetailedError( QWidget *parent,
const QString &text,
const QString &details,
const QString &caption = QString());
/**
* This function accepts the window id of the parent window, instead
* of QWidget*. It should be used only when necessary.
*/
static void queuedDetailedErrorWId( WId parent_id,
const QString &text,
const QString &details,
const QString &caption = QString());
/**
* Display an "Sorry" dialog.
*
* @param parent Parent widget.
* @param text Message string.
* @param caption Message box title. The application name is added to
* the title. The default title is i18n("Sorry").
* @param options see OptionsType
*
* Either your program messed up and asks for understanding
* or your user did something stupid.
*
* To be used for small problems like
* "Sorry, I can't find the file you specified."
*
* The default button is "&OK". Pressing "Esc" selects the OK-button.
*
* NOTE: The ok button will always have the i18n'ed text '&OK'.
*/
static void sorry(QWidget *parent,
const QString &text,
const QString &caption = QString(),
Options options = Notify);
/**
* This function accepts the window id of the parent window, instead
* of QWidget*. It should be used only when necessary.
*/
static void sorryWId(WId parent_id,
const QString &text,
const QString &caption = QString(),
Options options = Notify);
/**
* Displays a "Sorry" dialog with a "Details >>" button.
*
* @param parent Parent widget.
* @param text Message string.
* @param details Detailed message string.
* @param caption Message box title. The application name is added to
* the title. The default title is i18n("Sorry").
* @param options see Options
*
* Either your program messed up and asks for understanding
* or your user did something stupid.
*
* To be used for small problems like
* "Sorry, I can't find the file you specified."
*
* And then @p details can contain something like
* "foobar.txt was not found in any of
* the following directories:
* /usr/bin,/usr/local/bin,/usr/sbin"
*
* The default button is "&OK". Pressing "Esc" selects the OK-button.
*
* NOTE: The ok button will always have the i18n'ed text '&OK'.
*/
static void detailedSorry(QWidget *parent,
const QString &text,
const QString &details,
const QString &caption = QString(),
Options options = Notify);
/**
* This function accepts the window id of the parent window, instead
* of QWidget*. It should be used only when necessary.
*/
static void detailedSorryWId(WId parent_id,
const QString &text,
const QString &details,
const QString &caption = QString(),
Options options = Notify);
/**
* Display an "Information" dialog.
*
* @param parent Parent widget.
* @param text Message string.
* @param caption Message box title. The application name is added to
* the title. The default title is i18n("Information").
* @param dontShowAgainName If provided, a checkbox is added with which
* further notifications can be turned off.
* The string is used to lookup and store the setting
* in the applications config file.
* The setting is stored in the "Notification Messages" group.
* @param options see Options
*
*
* Your program wants to tell the user something.
* To be used for things like:
* "Your bookmarks have been rearranged."
*
* The default button is "&OK". Pressing "Esc" selects the OK-button.
*
* NOTE: The OK button will always have the i18n'ed text '&OK'.
*/
static void information(QWidget *parent,
const QString &text,
const QString &caption = QString(),
const QString &dontShowAgainName = QString(),
Options options = Notify);
/**
* This function accepts the window id of the parent window, instead
* of QWidget*. It should be used only when necessary.
*/
static void informationWId(WId parent_id,
const QString &text,
const QString &caption = QString(),
const QString &dontShowAgainName = QString(),
Options options = Notify);
/**
* Display an "Information" dialog with a listbox.
*
* @param parent Parent widget.
* @param text Message string.
* @param strlist List of strings to be written in the listbox. If the
* list is empty, it doesn't show any listbox, working
* as information.
* @param caption Message box title. The application name is added to
* the title. The default title is i18n("Information").
* @param dontShowAgainName If provided, a checkbox is added with which
* further notifications can be turned off.
* The string is used to lookup and store the setting
* in the applications config file.
* The setting is stored in the "Notification Messages" group.
* @param options see Options
*
*
* Your program wants to tell the user something.
* To be used for things like:
* "The following bookmarks have been rearranged:"
*
* The default button is "&OK". Pressing "Esc" selects the OK-button.
*
* NOTE: The OK button will always have the i18n'ed text '&OK'.
*/
static void informationList(QWidget *parent,
const QString &text,
const QStringList & strlist,
const QString &caption = QString(),
const QString &dontShowAgainName = QString(),
Options options = Notify);
/**
* This function accepts the window id of the parent window, instead
* of QWidget*. It should be used only when necessary.
*/
static void informationListWId(WId parent_id,
const QString &text,
const QStringList & strlist,
const QString &caption = QString(),
const QString &dontShowAgainName = QString(),
Options options = Notify);
/**
* Enable all messages which have been turned off with the
* @p dontShowAgainName feature.
*/
static void enableAllMessages();
/**
* Re-enable a specific @p dontShowAgainName messages that had
* previously been turned off.
* @see saveDontShowAgainYesNo()
* @see saveDontShowAgainContinue()
*/
static void enableMessage(const QString &dontShowAgainName);
/**
* Display an "About" dialog.
*
* @param parent Parent widget.
* @param text Message string.
* @param caption Message box title. The application name is added to
* the title. The default title is i18n("About \<appname\>").
* @param options see Options
*
*
* Your program wants to show some general information about the application
* like the authors's names and email addresses.
*
* The default button is "&OK".
*
* NOTE: The ok button will always have the i18n'ed text '&OK'.
*/
static void about(QWidget *parent,
const QString& text,
const QString& caption = QString(),
Options options = Notify);
/**
* Alternate method to show a messagebox:
*
* @param parent Parent widget.
* @param type type of message box: QuestionYesNo, WarningYesNo, WarningContinueCancel...
* @param text Message string.
* @param caption Message box title.
* @param buttonYes The text for the first button.
* The default is KStandardGuiItem::yes().
* @param buttonNo The text for the second button.
* The default is KStandardGuiItem::no().
* @param buttonCancel The text for the third button.
* The default is KStandardGuiItem::cancel().
* @param dontShowAskAgainName If provided, a checkbox is added with which
* further questions/information can be turned off. If turned off
* all questions will be automatically answered with the
* last answer (either Yes or No), if the message box needs an answer.
* The string is used to lookup and store the setting
* in the applications config file.
* @param options see Options
* Note: for ContinueCancel, buttonYes is the continue button and buttonNo is unused.
* and for Information, none is used.
* @return a button code, as defined in KMessageBox.
*/
static int messageBox( QWidget *parent, DialogType type, const QString &text,
const QString &caption = QString(),
const KGuiItem &buttonYes = KStandardGuiItem::yes(),
const KGuiItem &buttonNo = KStandardGuiItem::no(),
const KGuiItem &buttonCancel = KStandardGuiItem::cancel(),
const QString &dontShowAskAgainName = QString(),
Options options = Notify);
/**
* This function accepts the window id of the parent window, instead
* of QWidget*. It should be used only when necessary.
*/
static int messageBoxWId( WId parent_id, DialogType type, const QString &text,
const QString &caption = QString(),
const KGuiItem &buttonYes = KStandardGuiItem::yes(),
const KGuiItem &buttonNo = KStandardGuiItem::no(),
const KGuiItem &buttonCancel = KStandardGuiItem::cancel(),
const QString &dontShowAskAgainName = QString(),
Options options = Notify);
/**
* Like messageBox
*
* Only for message boxes of type Information, Sorry or Error.
*
* This function will return immediately, the messagebox will be shown
* once the application enters an event loop and no other messagebox
* is being shown.
*
* Note that if the parent gets deleted, the messagebox will not be
* shown.
*/
static void queuedMessageBox( QWidget *parent,
DialogType type, const QString &text,
const QString &caption,
Options options );
/**
* This function accepts the window id of the parent window, instead
* of QWidget*. It should be used only when necessary.
*/
static void queuedMessageBoxWId( WId parent_id,
DialogType type, const QString &text,
const QString &caption,
Options options );
/**
* @overload
*
* This is an overloaded member function, provided for convenience.
* It behaves essentially like the above function.
*/
static void queuedMessageBox( QWidget *parent,
DialogType type, const QString &text,
const QString &caption = QString() );
/**
* This function accepts the window id of the parent window, instead
* of QWidget*. It should be used only when necessary.
*/
static void queuedMessageBoxWId( WId parent_id,
DialogType type, const QString &text,
const QString &caption = QString() );
/**
* @return true if the corresponding yes/no message box should be shown.
* @param dontShowAgainName the name that identify the message box. If
* empty, true is always returned.
* @param result is set to the result (Yes or No) that was chosen the last
* time the message box was shown. Only meaningful, if the message box
* should not be shown.
*/
static bool shouldBeShownYesNo(const QString &dontShowAgainName,
ButtonCode &result);
/**
* @return true if the corresponding continue/cancel message box should be
* shown.
* @param dontShowAgainName the name that identify the message box. If
* empty, true is always returned.
*/
static bool shouldBeShownContinue(const QString &dontShowAgainName);
/**
* Save the fact that the yes/no message box should not be shown again.
* @param dontShowAgainName the name that identify the message box. If
* empty, this method does nothing.
* @param result the value (Yes or No) that should be used as the result
* for the message box.
*/
static void saveDontShowAgainYesNo(const QString &dontShowAgainName,
ButtonCode result);
/**
* Save the fact that the continue/cancel message box should not be shown
* again.
* @param dontShowAgainName the name that identify the message box. If
* empty, this method does nothing.
*/
static void saveDontShowAgainContinue(const QString &dontShowAgainName);
/**
* Use @p cfg for all settings related to the dontShowAgainName feature.
* If @p cfg is 0 (default) KGlobal::config() will be used.
*/
static void setDontShowAskAgainConfig(KConfig* cfg);
/**
* Create content and layout of a standard dialog
*
* @param dialog The parent dialog base
* @param icon Which predefined icon the message box shall show.
* @param text Message string.
* @param strlist List of strings to be written in the listbox.
* If the list is empty, it doesn't show any listbox
* @param ask The text of the checkbox. If empty none will be shown.
* @param checkboxReturn The result of the checkbox. If it's initially
* true then the checkbox will be checked by default.
* May be 0.
* @param options see Options
* @param details Detailed message string.
* @return A KDialog button code, not a KMessageBox button code,
* based on the buttonmask given to the constructor of the
* @p dialog (ie. will return KDialog::Yes [256] instead of
* KMessageBox::Yes [3]). Will return KMessageBox::Cancel
* if the message box is queued for display instead of
* exec()ed immediately or if the option NoExec is set.
* @note Unless NoExec is used,
* the @p dialog that is passed in is deleted by this
* function. Do not delete it yourself.
*/
static int createKMessageBox(KDialog *dialog, QMessageBox::Icon icon, //krazy:exclude=qclasses
const QString &text, const QStringList &strlist,
const QString &ask, bool *checkboxReturn,
Options options, const QString &details=QString());
/**
* Create content and layout of a standard dialog
*
* @param dialog The parent dialog base
* @param icon A QPixmap containing the icon to be displayed in the
* dialog next to the text.
* @param text Message string.
* @param strlist List of strings to be written in the listbox.
* If the list is empty, it doesn't show any listbox
* @param ask The text of the checkbox. If empty none will be shown.
* @param checkboxReturn The result of the checkbox. If it's initially
* true then the checkbox will be checked by default.
* May be 0.
* @param options see Options
* @param details Detailed message string.
* @param notifyType The type of notification to send when this message
* is presentend.
* @return A KDialog button code, not a KMessageBox button code,
* based on the buttonmask given to the constructor of the
* @p dialog (ie. will return KDialog::Yes [256] instead of
* KMessageBox::Yes [3]). Will return KMessageBox::Cancel
* if the message box is queued for display instead of
* exec()ed immediately or if the option NoExec is set.
* @note Unless NoExec is used,
* the @p dialog that is passed in is deleted by this
* function. Do not delete it yourself.
*/
static int createKMessageBox(KDialog *dialog, const QIcon &icon,
const QString &text, const QStringList &strlist,
const QString &ask, bool *checkboxReturn,
Options options, const QString &details=QString(),
QMessageBox::Icon notifyType=QMessageBox::Information); //krazy:exclude=qclasses
};
Q_DECLARE_OPERATORS_FOR_FLAGS(KMessageBox::Options)
#endif
|