From a26e51cc4e5af7eae340fcf20e31e991239def2d Mon Sep 17 00:00:00 2001 From: Alain Romedenne Date: Tue, 13 Apr 2021 11:59:28 +0200 Subject: [PATCH] tdf#141474 MsgBox function signature Change-Id: I4a9a49a3af3379f96ae95c19135a44e7ae5fd29a Reviewed-on: https://gerrit.libreoffice.org/c/help/+/113998 Tested-by: Jenkins Reviewed-by: Olivier Hallot --- source/text/sbasic/shared/03010101.xhp | 21 ++- source/text/sbasic/shared/03010102.xhp | 176 +------------------------ 2 files changed, 16 insertions(+), 181 deletions(-) diff --git a/source/text/sbasic/shared/03010101.xhp b/source/text/sbasic/shared/03010101.xhp index 0959768442..c87987c709 100644 --- a/source/text/sbasic/shared/03010101.xhp +++ b/source/text/sbasic/shared/03010101.xhp @@ -26,27 +26,25 @@ - -
MsgBox statement - -MsgBox Statement +

MsgBox Statement

Displays a dialog box containing a message.
-Syntax: + -MsgBox Text As String [,Type As Integer [,Dialogtitle As String]] (As Statement) or MsgBox (Text As String [,Type As Integer [,Dialogtitle As String]]) (As Function) +MsgBox Prompt As String [,Buttons = MB_OK [,Title As String]] -Parameter: - Text: String expression displayed as a message in the dialog box. Line breaks can be inserted with Chr$(13). - DialogTitle: String expression displayed in the title bar of the dialog. If omitted, the title bar displays the name of the respective application. - Type: Any integer expression that specifies the dialog type, as well as the number and type of buttons to display, and the icon type. Type represents a combination of bit patterns, that is, a combination of elements can be defined by adding their respective values: +
+ + Prompt: String expression displayed as a message in the dialog box. Line breaks can be inserted with Chr$(13). + Title: String expression displayed in the title bar of the dialog. If omitted, the title bar displays the name of the respective application. + Buttons: Any integer expression that specifies the dialog type, as well as the number and type of buttons to display, and the icon type. Buttons represents a combination of bit patterns, that is, a combination of elements can be defined by adding their respective values: @@ -204,11 +202,12 @@
+
-Example: + Sub ExampleMsgBox Const sText1 = "An unexpected error occurred." diff --git a/source/text/sbasic/shared/03010102.xhp b/source/text/sbasic/shared/03010102.xhp index 68eeba306e..54ea9ad0f2 100644 --- a/source/text/sbasic/shared/03010102.xhp +++ b/source/text/sbasic/shared/03010102.xhp @@ -34,183 +34,19 @@ -MsgBox Function +

MsgBox Function

Displays a dialog box containing a message and returns a value. -Syntax: + -MsgBox (Text As String [,Type As Integer [,Dialogtitle As String]]) +MsgBox (Prompt As String [,Buttons = MB_OK [,Title As String]]) As Integer -Return value: + + + Integer - -Parameter: - Text: String expression displayed as a message in the dialog box. Line breaks can be inserted with Chr$(13). - DialogTitle: String expression displayed in the title bar of the dialog. If omitted, the name of the respective application is displayed. - Type: Any integer expression that specifies the dialog type and defines the number and type of buttons or icons displayed. Type represents a combination of bit patterns (dialog elements defined by adding the respective values): - Values - - - - - Named constant - - - Integer value - - - Definition - - - - - MB_OK - - - 0 - - - Display OK button only. - - - - - MB_OKCANCEL - - - 1 - - - Display OK and Cancel buttons. - - - - - MB_ABORTRETRYCANCEL - - - 2 - - - Display Abort, Retry, and Ignore buttons. - - - - - MB_YESNOCANCEL - - - 3 - - - Display Yes, No, and Cancel buttons. - - - - - MB_YESNO - - - 4 - - - Display Yes and No buttons. - - - - - MB_RETRYCANCEL - - - 5 - - - Display Retry and Cancel buttons. - - - - - MB_ICONSTOP - - - 16 - - - Add the Stop icon to the dialog. - - - - - MB_ICONQUESTION - - - 32 - - - Add the Question icon to the dialog. - - - - - MB_ICONEXCLAMATION - - - 48 - - - Add the Exclamation Point icon to the dialog. - - - - - MB_ICONINFORMATION - - - 64 - - - Add the Information icon to the dialog. - - - - - - - - 128 - - - First button in the dialog as default button. - - - - - MB_DEFBUTTON2 - - - 256 - - - Second button in the dialog as default button. - - - - - MB_DEFBUTTON3 - - - 512 - - - Third button in the dialog as default button. - - -
- - Return value: -