The R Project SVN R

Rev

Rev 85981 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 85981 Rev 87366
Line 1... Line 1...
1
% File src/library/grDevices/man/bringToTop.Rd
1
% File src/library/grDevices/man/bringToTop.Rd
2
% Part of the R package, https://www.R-project.org
2
% Part of the R package, https://www.R-project.org
3
% Copyright 1995-2014 R Core Team
3
% Copyright 1995-2024 R Core Team
4
% Distributed under GPL 2 or later
4
% Distributed under GPL 2 or later
5
 
5
 
6
\name{bringToTop}
6
\name{bringToTop}
7
\alias{bringToTop}
7
\alias{bringToTop}
8
\alias{stayOnTop}
8
\alias{stayOnTop}
9
 
9
 
10
\title{Assign Focus to a Window}
10
\title{Assign Focus to a Window}
11
 
-
 
12
\usage{
11
\usage{
13
bringToTop(which = dev.cur(), stay = FALSE)
12
bringToTop(which = dev.cur(), stay = FALSE)
14
}
13
}
15
 
-
 
16
\arguments{
14
\arguments{
17
  \item{which}{a device number, or \code{-1}.}
15
  \item{which}{a device number, or \code{-1}.}
18
  \item{stay}{whether to make the window stay on top.}
16
  \item{stay}{whether to make the window stay on top.}
19
}
17
}
20
 
-
 
21
\description{
18
\description{
-
 
19
  Available only on Windows.
-
 
20
 
22
  \code{bringToTop} brings the specified screen device's window to the
21
  \code{bringToTop} brings the specified screen device's window to the
23
  front of the window stack (and gives it focus).  With first argument
22
  front of the window stack (and gives it focus).  With first argument
24
  \code{-1} it brings the console to the top.
23
  \code{-1} it brings the console to the top.
25
 
24
 
26
  If \code{stay =  TRUE}, the window is designated as a topmost window,
25
  If \code{stay = TRUE}, the window is designated as a topmost window,
27
  i.e.\sspace{}it will stay on top of any regular window.  \code{stay} may only be used
26
  i.e.\sspace{}it will stay on top of any regular window.  \code{stay} may only be used
28
  when \I{RGui} is run in SDI mode.  This corresponds to the \dQuote{Stay on top}
27
  when \I{RGui} is run in SDI mode.  This corresponds to the \dQuote{Stay on top}
29
  popup menu item in \I{RGui}.
28
  popup menu item in \I{RGui}.
30
}
29
}
31
 
-
 
32
\seealso{
30
\seealso{
33
  \code{\link{msgWindow}}, \code{\link{windows}}
31
  \code{\link{msgWindow}}, \code{\link{windows}}
34
}
32
}
35
 
-
 
36
\keyword{device}
33
\keyword{device}