File: printer_callback.Rd

package info (click to toggle)
r-cran-igraph 2.2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 27,772 kB
  • sloc: ansic: 206,420; cpp: 21,827; fortran: 4,090; yacc: 1,229; lex: 518; sh: 52; makefile: 8
file content (45 lines) | stat: -rw-r--r-- 1,104 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/printr.R
\name{printer_callback}
\alias{printer_callback}
\title{Create a printer callback function}
\usage{
printer_callback(fun)
}
\arguments{
\item{fun}{The function to use as a printer callback function.}
}
\description{
A printer callback function is a function can performs the actual
printing. It has a number of subcommands, that are called by
the \code{printer} package, in a form \preformatted{
    printer_callback("subcommand", argument1, argument2, ...)
} See the examples below.
}
\details{
The subcommands:

\describe{
\item{\code{length}}{
The length of the data to print, the number of items, in natural units.
E.g. for a list of objects, it is the number of objects.
}
\item{\code{min_width}}{
TODO
}
\item{\code{width}}{
Width of one item, if \code{no} items will be printed. TODO
}
\item{\code{print}}{
Argument: \code{no}. Do the actual printing, print \code{no} items.
}
\item{\code{done}}{
TODO
}
}
}
\seealso{
Other printer callbacks: 
\code{\link{is_printer_callback}()}
}
\concept{printer callbacks}