File: tk2methods.Rd

package info (click to toggle)
r-cran-tcltk2 1.2-10-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 5,356 kB
  • ctags: 1,386
  • sloc: tcl: 37,888; ansic: 792; python: 324; sh: 68; sed: 16; makefile: 1
file content (149 lines) | stat: -rwxr-xr-x 3,999 bytes parent folder | download | duplicates (4)
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
\name{tk2methods}
\alias{tk2methods}
\alias{is.tk2widget}
\alias{print.tk2widget}
\alias{tk2cfglist}
\alias{print.tk2cfglist}
\alias{state}
\alias{state.tk2widget}
\alias{label}
\alias{label.tk2widget}
\alias{label<-}
\alias{label<-.tk2widget}
\alias{tag}
\alias{tag.tk2widget}
\alias{tag<-}
\alias{tag<-.tk2widget}
\alias{disabled}
\alias{disabled.tk2widget}
\alias{disabled<-}
\alias{disabled<-.tk2widget}
\alias{values}
\alias{values.tk2widget}
\alias{values.tk2listbox}
\alias{values<-}
\alias{values<-.tk2widget}
\alias{values<-.tk2listbox}
\alias{value}
\alias{value.tk2widget}
\alias{value.tk2listbox}
\alias{value<-}
\alias{value<-.tk2widget}
\alias{value<-.tk2listbox}
\alias{selection}
\alias{selection.tk2widget}
\alias{selection.tk2listbox}
\alias{selection<-}
\alias{selection<-.tk2widget}
\alias{selection<-.tk2listbox}
\alias{visibleItem}
\alias{visibleItem.tk2widget}
\alias{visibleItem.tk2listbox}
\alias{size}
\alias{size.tk2widget}
\alias{size.tk2listbox}
\alias{config}
\alias{config.tk2widget}
\alias{config.tk2label}
\alias{config<-}
\alias{config<-.tk2widget}
\alias{config<-.tk2label}

\title{ A series of methods applicable to tk2widget or tk2cfglist objects }
\description{
  Tk2widgets can be used as tcltk widgets, but they propose also an
  object-oriented interaction through these different methods.
}
\usage{
is.tk2widget(x)
\method{print}{tk2widget}(x, \dots)

tk2cfglist(\dots)
\method{print}{tk2cfglist}(x, \dots)

state(x, \dots)
\method{state}{tk2widget}(x, \dots)

label(x, \dots)
\method{label}{tk2widget}(x, \dots)
label(x) <- value
\method{label}{tk2widget}(x) <- value

tag(x, \dots)
\method{tag}{tk2widget}(x, \dots)
tag(x) <- value
\method{tag}{tk2widget}(x) <- value

disabled(x, \dots)
\method{disabled}{tk2widget}(x, \dots)
disabled(x) <- value
\method{disabled}{tk2widget}(x) <- value

values(x, \dots)
\method{values}{tk2widget}(x, \dots)
\method{values}{tk2listbox}(x, \dots)
values(x) <- value
\method{values}{tk2widget}(x) <- value
\method{values}{tk2listbox}(x) <- value

value(x, \dots)
\method{value}{tk2widget}(x, \dots)
\method{value}{tk2listbox}(x, \dots)
value(x) <- value
\method{value}{tk2widget}(x) <- value
\method{value}{tk2listbox}(x) <- value

selection(x, \dots)
\method{selection}{tk2widget}(x, \dots)
\method{selection}{tk2listbox}(x, \dots)
selection(x) <- value
\method{selection}{tk2widget}(x) <- value
\method{selection}{tk2listbox}(x) <- value

visibleItem(x, index, \dots)
\method{visibleItem}{tk2widget}(x, index, \dots)
\method{visibleItem}{tk2listbox}(x, index, \dots)

size(x, \dots)
\method{size}{tk2widget}(x, \dots)
\method{size}{tk2listbox}(x, \dots)

config(x, \dots)
\method{config}{tk2widget}(x, cfglist, \dots)
\method{config}{tk2label}(x, cfglist, \dots)
config(x) <- value
\method{config}{tk2widget}(x) <- value
\method{config}{tk2label}(x) <- value
}

\arguments{
  \item{x}{ a tk2widget object. }
  \item{\dots}{ a series of named arguments corresponding to parameters and
    values to use for the configuration for \code{tk2cfglist()}, or reserved
    arguments for future use for the other function (not used yet). }
  \item{value}{ a value to assign to the object's method. }
  \item{index}{ the index of the item in the list to make visible. }
  \item{cfglist}{ a named list with configuration parameters and values to
    apply (usually, a \code{tk2cfglist} object). }
}

\value{
  Depnds on the function (TODO: complete this...).
}

\author{ Philippe Grosjean }

\seealso{ \code{\link{tk2widgets}}, \code{\link{tk2tip}} }

\examples{
\dontrun{
## These cannot be run by examples() but should be OK when pasted
## into an interactive R session with the tcltk package loaded

## TODO: examples illustrating the use of these methods...
}
}

\keyword{ utilities }

\concept{ Tcl/Tk widgets notebook, combobox, paned window, progress bar, text area, tree }