also allow timeout for other dialog fns

R/dialogs.R

@@ -1,25 +1,25 @@
 #' Show Dialog Box
-#' 
+#'
 #' Shows a dialog box with a given title and contents.
-#' 
+#'
 #' @param title The title to display in the dialog box.
-#' 
+#'
 #' @param message A character vector with the contents to display in the main
 #'   dialog area. Contents can contain the following HTML tags: "p", "em",
 #'   "strong", "b" and "i".
-#'   
+#'
 #' @param url An optional URL to display under the \code{message}.
-#' 
-#' @param timeout An optional timeout (in seconds). When set, if the user takes
+#'
+#' @param timeout A timeout (in seconds). When set, if the user takes
 #'   longer than this timeout to provide a response, the request will be aborted.
-#'   
+#'
 #' @note The \code{showDialog} function was added in version 1.1.67 of RStudio.
-#' 
+#'
 #' @examples
 #' if (rstudioapi::isAvailable()) {
 #'   rstudioapi::showDialog("Example Dialog", "This is an <b>example</b> dialog.")
 #' }
-#' 
+#'
 #' @export
 showDialog <- function(title, message, url = "", timeout = 60) {
   opts <- options(rstudioapi.remote.timeout = timeout)
@@ -30,14 +30,14 @@ showDialog <- function(title, message, url = "", timeout = 60) {
 
 
 #' Updates a Dialog Box
-#' 
+#'
 #' Updates specific properties from the current dialog box.
-#' 
+#'
 #' Currently, the only dialog with support for this action is the New
 #' Connection dialog in which the code preview can be updated through this API.
-#' 
+#'
 #' \preformatted{ updateDialog(code = "con <- NULL") }
-#' 
+#'
 #' @param ... Named parameters and values to update a dialog box.
 #' @note The \code{updateDialog} function was added in version 1.1.67 of
 #' RStudio.
@@ -49,39 +49,57 @@ updateDialog <- function(...) {
 
 
 #' Show Prompt Dialog Box
-#' 
+#'
 #' Shows a dialog box with a prompt field.
-#' 
-#' 
+#'
+#'
 #' @param title The title to display in the dialog box.
+#'
 #' @param message A character vector with the contents to display in the main
-#' dialog area.
+#'   dialog area.
+#'
 #' @param default An optional character vector that fills the prompt field with
-#' a default value.
+#'   a default value.
+#'
+#' @param timeout A timeout (in seconds). When set, if the user takes
+#'   longer than this timeout to provide a response, the request will be aborted.
+#'
 #' @note The \code{showPrompt} function was added in version 1.1.67 of RStudio.
+#'
 #' @export showPrompt
-showPrompt <- function(title, message, default = NULL) {
+showPrompt <- function(title, message, default = NULL, timeout = 60) {
+  opts <- options(rstudioapi.remote.timeout = timeout)
+  on.exit(options(opts), add = TRUE)
   callFun("showPrompt", title, message, default)
 }
 
 
 
 #' Show Question Dialog Box
-#' 
+#'
 #' Shows a dialog box asking a question.
-#' 
-#' 
+#'
 #' @param title The title to display in the dialog box.
+#'
 #' @param message A character vector with the contents to display in the main
-#' dialog area.
+#'   dialog area.
+#'
 #' @param ok And optional character vector that overrides the caption for the
-#' OK button.
+#'   OK button.
+#'
 #' @param cancel An optional character vector that overrides the caption for
-#' the Cancel button.
+#'   the Cancel button.
+#'
+#' @param timeout A timeout (in seconds). When set, if the user takes
+#'   longer than this timeout to provide a response, the request will be aborted.
+#'
 #' @note The \code{showQuestion} function was added in version 1.1.67 of
-#' RStudio.
+#'   RStudio.
+#'
 #' @export showQuestion
-showQuestion <- function(title, message, ok = NULL, cancel = NULL) {
+showQuestion <- function(title, message, ok = NULL, cancel = NULL, timeout = 60) {
+  opts <- options(rstudioapi.remote.timeout = timeout)
+  on.exit(options(opts), add = TRUE)
   callFun("showQuestion", title, message, ok, cancel)
 }
 
@@ -91,18 +109,18 @@ showQuestion <- function(title, message, ok = NULL, cancel = NULL) {
 #'
 #' Request a secret from the user. If the `keyring` package is installed, it
 #' will be used to cache requested secrets.
-#' 
-#' 
+#'
+#'
 #' @param name The name of the secret.
-#' 
+#'
 #' @param message A character vector with the contents to display in the main
 #'   dialog area.
-#'   
+#'
 #' @param title The title to display in the dialog box.
-#' 
+#'
 #' @note The \code{askForSecret} function was added in version 1.1.419 of
 #'   RStudio.
-#' 
+#'
 #' @export
 askForSecret <- function(
   name,

rstudioapi.Rproj

@@ -13,6 +13,7 @@ RnwWeave: Sweave
 LaTeX: pdfLaTeX
 
 AutoAppendNewline: Yes
+StripTrailingWhitespace: Yes
 
 BuildType: Package
 PackageUseDevtools: Yes