R/addDate.pptx.R

In davidgohel/ReporteRs: Microsoft Word and PowerPoint Documents Generation

#' @title Insert a date
#'
#' @description Insert a date into a document object
#'
#' @param doc document object
#' @param ... further arguments passed to other methods
#' @return a document object
#' @details
#' addDate only works for pptx documents.
#' @export
#' @seealso \code{\link{pptx}}, \code{\link{addFooter}},
#' \code{\link{addPageNumber}}
addDate = function(doc, ...){
  checkHasSlide(doc)
  UseMethod("addDate")
}


#' @param value character value to add into the date
#' shape of the current slide. optionnal. If missing
#' current date will be used.
#' @param str.format character value to use to format
#' current date (if \code{value} is missing).
#' @examples
#' \donttest{
#' if( check_valid_java_version() ){
#' doc <- pptx()
#'
#' doc <- addSlide( doc, slide.layout = "Title and Content" )
#' ## add a date on the current slide
#' doc = addDate( doc )
#'
#' doc <- addSlide( doc, slide.layout = "Title and Content" )
#' ## add a page number on the current slide but not
#' ## the default text (slide number)
#' doc = addDate( doc, "Dummy date" )
#' }
#' }
#' @export
#' @rdname addDate
#' @export
addDate.pptx = function(doc, value, str.format = "%Y-%m-%d", ... ) {

	slide = doc$current_slide
	if( missing( value ) )
		out = .jcall( slide, "I", "addDate" , format( Sys.time(), str.format ))
	else {
		if( length( value ) != 1 )
			stop("length of value should be 1.")
		out = .jcall( slide, "I", "addDate" , as.character(value))
	}

	if( isSlideError( out ) ){
		stop( getSlideErrorString( out , "date") )
	}

	doc
}