The R Project SVN R

Rev

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

Rev 76043 Rev 76085
Line 5... Line 5...
5 
 
 5 
 
6 
\name{drawDetails}
 6 
\name{drawDetails}
7 
\alias{drawDetails}
 7 
\alias{drawDetails}
8 
\alias{preDrawDetails}
 8 
\alias{preDrawDetails}
9 
\alias{postDrawDetails}
 9 
\alias{postDrawDetails}
10 
\alias{preDraw}
 - 
 
11 
\alias{postDraw}
 - 
 
12 
\title{ Customising grid Drawing }
 10 
\title{ Customising grid Drawing }
13 
\description{
 11 
\description{
14 
  These generic hook functions are called whenever a grid grob is drawn.
 12 
  These generic hook functions are called whenever a grid grob is drawn.
15 
  They provide an opportunity for customising the drawing of a
 13 
  They provide an opportunity for customising the drawing of a
16 
  new class derived from grob (or gTree).
 14 
  new class derived from grob (or gTree).
17 
}
 15 
}
18 
\usage{
 16 
\usage{
19 
drawDetails(x, recording)
 17 
drawDetails(x, recording)
20 
preDrawDetails(x)
 18 
preDrawDetails(x)
21 
postDrawDetails(x)
 19 
postDrawDetails(x)
22 
preDraw(x)
 - 
 
23 
postDraw(x)
 - 
 
24 
}
 20 
}
25 
\arguments{
 21 
\arguments{
26 
  \item{x}{ A grid grob. }
 22 
  \item{x}{ A grid grob. }
27 
  \item{recording}{ A logical value indicating whether a grob
 23 
  \item{recording}{ A logical value indicating whether a grob
28 
  is being added to the display list or redrawn from the display list. }
 24 
  is being added to the display list or redrawn from the display list. }
Line 52... Line 48...
52 
  so there is typically nothing to do here.
 48 
  so there is typically nothing to do here.
53 
 
 49 
 
54 
  Note that \code{preDrawDetails} and \code{postDrawDetails} are
 50 
  Note that \code{preDrawDetails} and \code{postDrawDetails} are
55 
  also called in the calculation of \code{"grobwidth"} and
 51 
  also called in the calculation of \code{"grobwidth"} and
56 
  \code{"grobheight"} units.
 52 
  \code{"grobheight"} units.
57
53 
 }
58 
  The functions \code{preDraw} and \code{postDraw} are what call
 - 
 
59 
  \code{preDrawDetails} and \code{postDrawDetails} respectively.
 - 
 
60 
  These functions are exported so that external packages can
- 
 
61 
  write functions that work with grobs and perform the same
 - 
 
62 
  set up as usually happens when a grob is drawn.  Note that the
 - 
 
63 
  result of calling the \code{preDraw} function is a potentially
 - 
 
64 
  modified copy of the grob, so \code{preDraw} should be used like
 - 
 
65 
  this: \code{x <- preDraw(x)}.
- 
 
66 
}
 - 
 
67 
\value{
 54 
\value{
68 
  None of these functions are expected to return a value.
 55 
  None of these functions are expected to return a value.
69 
}
 56 
}
70 
\author{ Paul Murrell }
 57 
\author{ Paul Murrell }
71 
\seealso{ \code{\link{grid.draw}} }
 58 
\seealso{ \code{\link{grid.draw}} }