The R Project SVN R

Rev

Rev 68948 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 68948 Rev 75092
Line 1... Line 1...
1 
% File src/library/utils/man/windows/getWindowsHandles.Rd
 1 
% File src/library/utils/man/getWindowsHandles.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 2009-10 Duncan Murdoch and the R Core Team
 3 
% Copyright 2009-2018 Duncan Murdoch and the R Core Team
4 
% Distributed under GPL 2 or later
 4 
% Distributed under GPL 2 or later
5 
 
 5 
 
6 
\name{getWindowsHandles}
 6 
\name{getWindowsHandles}
7 
\alias{getWindowsHandles}
 7 
\alias{getWindowsHandles}
8 
\title{
 - 
 
9 
  Get handles of windows.
 8 
\title{Get handles of Windows in the MS Windows RGui}
10 
}
 - 
 
11 
\description{
 9 
\description{
12 
  This function gets the Windows handles of visible top level windows or
 10 
  This function gets the Windows handles of visible top level windows or
13 
  windows within the \R MDI frame.
 11 
  windows within the \R MDI frame (when using the \command{Rgui}).
14 
}
 12 
}
15 
\usage{
 13 
\usage{
16 
getWindowsHandles(which = "R", pattern = "", minimized = FALSE)
 14 
getWindowsHandles(which = "R", pattern = "", minimized = FALSE)
17 
}
 15 
}
18 
\arguments{
 16 
\arguments{
Line 40... Line 38...
40 
    each of the searches.
 38 
    each of the searches.
41 
  }
 39 
  }
42 
 
 40 
 
43 
  If an element of \code{which} is \code{"R"}, only windows belonging to
 41 
  If an element of \code{which} is \code{"R"}, only windows belonging to
44 
  the current \R process will be returned.  In MDI mode, those will be the
 42 
  the current \R process will be returned.  In MDI mode, those will be the
45 
  child windows within the \R GUI frame.  In SDI mode, all windows
 43 
  child windows within the \R GUI (\command{Rgui}) frame.  In SDI mode,
46 
  belonging to the process will be included.
 44 
  all windows belonging to the process will be included.
47 
 
 45 
 
48 
  If the element is \code{"all"}, then top level windows will be returned.
 46 
  If the element is \code{"all"}, then top level windows will be returned.
49 
 
 47 
 
50 
  The elements of \code{pattern} will be used to make a subset of windows
 48 
  The elements of \code{pattern} will be used to make a subset of windows
51 
  whose title text matches (according to \code{\link{grep}}) the pattern.
 49 
  whose title text matches (according to \code{\link{grep}}) the pattern.
Line 60... Line 58...
60 
}
 58 
}
61 
\author{
 59 
\author{
62 
  Duncan Murdoch
 60 
  Duncan Murdoch
63 
}
 61 
}
64 
\seealso{
 62 
\seealso{
65 
  \code{\link{arrangeWindows}}
 63 
  \code{\link{arrangeWindows}},
- 
 
 64 
  \code{\link{getWindowsHandle}} (singular).
66 
}
 65 
}
67 
\examples{\donttest{
 66 
\examples{\donttest{
- 
 
 67 
if(.Platform$OS.type == "windows") withAutoprint({
68 
getWindowsHandles()
 68 
  getWindowsHandles()
69 
getWindowsHandles("all")
 69 
  getWindowsHandles("all")
- 
 
 70 
})
70 
}}
 71 
}}
71 
\keyword{ utilities }
 72 
\keyword{ utilities }