svDialogs (version 1.0.0)

dlg_message: Display a modal message box.

Description

A message box with icon, text, and one to three buttons.

Usage

dlg_message(message, type = c("ok", "okcancel", "yesno", "yesnocancel"), ...,
  gui = .GUI)
dlgMessage(message, type = c("ok", "okcancel", "yesno", "yesnocancel"), ...,
  gui = .GUI)
msg_box(message)
msgBox(message)
ok_cancel_box(message)
okCancelBox(message)
# S3 method for gui
dlgMessage(message, type = c("ok", "okcancel", "yesno",
  "yesnocancel"), ..., gui = .GUI)
# S3 method for textCLI
dlgMessage(message, type = c("ok", "okcancel", "yesno",
  "yesnocancel"), ..., gui = .GUI)
# S3 method for nativeGUI
dlgMessage(message, type = c("ok", "okcancel", "yesno",
  "yesnocancel"), ..., gui = .GUI)

Arguments

message

The message to display in the dialog box. Use \n for line break, or provide a vector of character strings, one for each line.

type

The type of dialog box: 'ok', 'okcancel', 'yesno' or 'yesnocancel'.

...

Pass further arguments to methods.

gui

The 'gui' object concerned by this dialog box.

Value

The modified 'gui' object is returned invisibly. A string with the name of the button ("ok", "cancel", "yes" or "no") that the user pressed can be obtained from gui$res (see example). msg_box() just returns the name of the button ("ok"), while ok_cancel_box() returns TRUE if "ok" was clicked or FALSE if "cancel" was clicked.

See Also

dlg_list(), dlg_input()

Examples

# NOT RUN {
# A simple information box
dlg_message("Hello world!")$res

# Ask to continue
dlg_message(c("This is a long task!", "Continue?"), "okcancel")$res

# Ask a question
dlg_message("Do you like apples?", "yesno")$res

# Idem, but one can interrupt too
res <- dlg_message("Do you like oranges?", "yesnocancel")$res
if (res == "cancel")
  cat("Ah, ah! You refuse to answer!\n")

# Simpler version with msgBox and okCancelBox
msg_box("Information message") # Use this to interrupt script and inform user
if (ok_cancel_box("Continue?")) cat("we continue\n") else cat("stop it!\n")
# }