The R Project SVN R

Rev

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

Rev 68948 Rev 86005
Line 10... Line 10...
10 
  This generic hook function is called whenever a grid grob is created
 10 
  This generic hook function is called whenever a grid grob is created
11 
  or
 11 
  or
12 
  edited
 12 
  edited
13 
  via \code{grob}, \code{gTree}, \code{grid.edit} or \code{editGrob}.
 13 
  via \code{grob}, \code{gTree}, \code{grid.edit} or \code{editGrob}.
14 
  This provides an opportunity for customising the validation of a
 14 
  This provides an opportunity for customising the validation of a
15 
  new class derived from grob (or gTree).
 15 
  new class derived from grob (or \I{gTree}).
16 
}
 16 
}
17 
\usage{
 17 
\usage{
18 
validDetails(x)
 18 
validDetails(x)
19 
}
 19 
}
20 
\arguments{
 20 
\arguments{
21 
  \item{x}{ A grid grob. }
 21 
  \item{x}{ A grid grob. }
22 
}
 22 
}
23 
\details{
 23 
\details{
24 
  This function is called by \code{grob}, \code{gTree},
 24 
  This function is called by \code{grob}, \code{gTree},
25 
  \code{grid.edit} and \code{editGrob}.
 25 
  \code{grid.edit} and \code{editGrob}.
26 
  A method should be written for classes derived from grob or gTree
 26 
  A method should be written for classes derived from grob or \I{gTree}
27 
  to validate the values of slots specific to the new class.
 27 
  to validate the values of slots specific to the new class.
28 
  (e.g., see \code{grid:::validDetails.axis}).
 28 
  (e.g., see \code{grid:::validDetails.axis}).
29 
 
 29 
 
30 
  Note that the standard slots for grobs and gTrees are automatically
 30 
  Note that the standard slots for grobs and \I{gTree}s are automatically
31 
  validated (e.g., \code{vp}, \code{gp} slots for grobs and,
 31 
  validated (e.g., \code{vp}, \code{gp} slots for grobs and,
32 
  in addition, \code{children}, and \code{childrenvp} slots for
 32 
  in addition, \code{children}, and \code{childrenvp} slots for
33 
  gTrees) so only slots specific to a new class need to be addressed.
 33 
  \I{gTree}s) so only slots specific to a new class need to be addressed.
34 
}
 34 
}
35 
\value{
 35 
\value{
36 
  The function MUST return the validated grob.
 36 
  The function MUST return the validated grob.
37 
}
 37 
}
38 
\author{ Paul Murrell }
 38 
\author{ Paul Murrell }