The R Project SVN R

Rev

Rev 85953 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
55828 ripley 1 
% File src/library/grDevices/man/devSet.Rd
68948 ripley 2 
% Part of the R package, https://www.R-project.org
64662 ripley 3 
% Copyright 2011-2013 R Core Team
55828 ripley 4 
% Distributed under GPL 2 or later
5 
 
6 
\name{dev.flush}
7 
\alias{dev.hold}
56186 murdoch 8 
\alias{dev.flush}
55828 ripley 9 
\title{
84534 smeyer 10 
  Hold or Flush Output on an On-Screen Graphics Device
55828 ripley 11 
}
12 
\description{
13 
  This gives a way to hold/flush output on certain on-screen devices,
14 
  and is ignored by other devices.
15 
}
16 
\usage{
17 
dev.hold(level = 1L)
18 
dev.flush(level = 1L)
19 
}
20 
\arguments{
21 
  \item{level}{Integer >= 0.  The amount by which to change the hold
22 
    level.  Negative values will be silently replaced by zero.}
23 
}
24 
\details{
25 
  Devices which implement this maintain a stack of hold levels: calling
55871 ripley 26 
  \code{dev.hold} increases the level and \code{dev.flush} decreases it.
27 
  Calling \code{dev.hold} when the hold level is zero increases the hold
28 
  level and inhibits graphics display.  When calling \code{dev.flush}
29 
  clears all pending holds the screen display is refreshed and normal
30 
  operation is resumed.
55834 ripley 31 
 
85953 hornik 32 
  This is implemented for the \I{cairo}-based \code{X11} types
55828 ripley 33 
  with buffering.  When the hold level is positive the \sQuote{watch}
55834 ripley 34 
  cursor is set on the device's window.
55970 ripley 35 
 
70779 ripley 36 
  It is available on the \code{quartz} device on macOS.
58206 ripley 37 
 
55871 ripley 38 
  This is implemented for the \code{windows} device with
55834 ripley 39 
  buffering selected (the default).  When the hold level is positive the
40 
  \sQuote{busy} cursor is set on the device's window.
55828 ripley 41 
}
58206 ripley 42 
 
55828 ripley 43 
\value{
44 
  The current level after the change, invisibly.  This is \code{0} on
45 
  devices where hold levels are not supported.
46 
}
47 
\keyword{ dplot }