OpenCores
URL https://opencores.org/ocsvn/or1k/or1k/trunk

Subversion Repositories or1k

[/] [or1k/] [trunk/] [insight/] [tix/] [man/] [Balloon.n] - Blame information for rev 1765

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 578 markom
'\"
2
'\" Copyright (c) 1996, Expert Interface Technologies
3
'\"
4
'\" See the file "license.terms" for information on usage and redistribution
5
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
6
'\"
7
'\" The file man.macros and some of the macros used by this file are
8
'\" copyrighted: (c) 1990 The Regents of the University of California.
9
'\"              (c) 1994-1995 Sun Microsystems, Inc.
10
'\" The license terms of the Tcl/Tk distrobution are in the file
11
'\" license.tcl.
12
.so man.macros
13
'----------------------------------------------------------------------
14
.HS tixBalloon tix 4.0
15
.BS
16
'
17
'
18
'----------------------------------------------------------------------
19
.SH NAME
20
tixBalloon \- Create and manipulate tixBalloon widgets
21
'
22
'
23
'
24
'----------------------------------------------------------------------
25
.SH SYNOPSIS
26
\fBtixBalloon\fI \fIpathName ?\fIoptions\fR?
27
'
28
'
29
'----------------------------------------------------------------------
30
.PP
31
.SH SUPER-CLASS
32
The \fBtixBalloon\fR class is derived from the \fBTixShell\fR
33
class and inherits all the commands, options and subwidgets of its
34
super-class.
35
'
36
'----------------------------------------------------------------------
37
.SH "STANDARD OPTIONS"
38
'
39
The Balloon widget supports all the standard options of a frame widget.
40
See the \fBoptions(n)\fR manual entry for details on the standard options.
41
'
42
'
43
'----------------------------------------------------------------------
44
.SH "WIDGET-SPECIFIC OPTIONS"
45
'
46
'----------BEGIN
47
.LP
48
.nf
49
Name:           \fBinitWait\fR
50
Class:          \fBInitWait\fR
51
Switch:         \fB\-initwait\fR
52
.fi
53
.IP
54
In milliseconds. Specifies how long the balloon should wait before
55
popping up in a widget.
56
'----------END
57
'
58
'----------BEGIN
59
.LP
60
.nf
61
Name:           \fBstate\fR
62
Class:          \fBState\fR
63
Switch:         \fB\-state\fR
64
.fi
65
.IP
66
Specifies the which help message to display when the mouse pointer
67
enters a widget associated with this balloon. Valid options are
68
\fBboth\fR: display both the balloon message and the status bar
69
message, \fBballoon\fR: display only the balloon message,
70
\fBstatus\fR: display only the status bar message and \fBnone\fR:
71
display no messages.
72
'----------END
73
'
74
'
75
'----------BEGIN
76
.LP
77
.nf
78
Name:           \fBstatusBar\fR
79
Class:          \fBstatusBar\fR
80
Switch:         \fB\-statusbar\fR
81
.fi
82
.IP
83
Specifies the widget to use as the status bar of this balloon. This
84
widget must have a "-text" option. Usually a label widget is used.
85
'----------END
86
'
87
'----------------------------------------------------------------------
88
.SH SUBWIDGETS
89
'----------BEGIN
90
.LP
91
.nf
92
Name:           \fBlabel\fR
93
Class:          \fBLabel\fR
94
.fi
95
.IP
96
The label widget that shows the little arrow bitmap in the pop-up
97
balloon window.
98
'----------END
99
'
100
'----------BEGIN
101
.LP
102
.nf
103
Name:           \fBmessage\fR
104
Class:          \fBLabel\fR
105
.fi
106
.IP
107
The message widget that shows the descriptive message in the the pop-up
108
balloon window.
109
'----------END
110
'
111
.BE
112
'
113
'
114
'----------------------------------------------------------------------
115
.SH DESCRIPTION
116
'
117
.PP
118
'
119
The \fBtixBalloon\fR command creates a new window (given by the
120
\fIpathName\fR argument) and makes it into a Balloon widget.
121
Additional options, described above, may be specified on the command
122
line or in the option database to configure aspects of the
123
Balloon widget such as its cursor and relief.
124
 
125
The Balloon widget can be used to show popped-up messages
126
that describe the functions of the widgets in an application. A
127
Balloon widget can be bound to a number of widgets. When the user
128
moves the cursor inside a widget to which a Balloon widget has been
129
bound, a small pop-up window with a descriptive message will be shown
130
on the screen.
131
'
132
'----------------------------------------------------------------------
133
.SH WIDGET COMMANDS
134
.PP
135
'
136
The \fBtixBalloon\fR command creates a new Tcl command whose name is
137
the same as the path name of the Balloon widget's window.  This
138
command may be used to invoke various operations on the widget. It has
139
the following general form:
140
'
141
.DS C
142
'
143
\fIpathName option \fR?\fIarg arg ...\fR?
144
.PP
145
.DE
146
'
147
\fIPathName\fR is the name of the command, which is the same as the
148
Balloon widget's path name. \fIOption\fR and the \fIarg\fRs
149
determine the exact behavior of the command. The following commands
150
are possible for Balloon widgets:
151
.TP
152
\fIpathName \fBbind\fR widget ?\fIoption value ... \fR?
153
'
154
Binds the Balloon widget to the \fIwidget\fR. The messages to be
155
shown can be passed as extra arguments to this command in \fIoption
156
value\fR pairs. Possible options: \fB\-balloonmsg\fR specifies the
157
string to show on the pop-up balloon window; \fB\-statusmsg\fR
158
specifies the string to show on the status bar; \fB\-msg\fR specifies a
159
string to show on both the balloon window and the stats bar window.
160
When used together, the \fB\-msg\fR option has a lower precedence than
161
the \fB\-balloonmsg\fR and \fB\-statusmsg\fR options.
162
 
163
The \fBbind\fR command can also be used to change the messages after
164
the initial bindings were set. Example:
165
.PP
166
.nf
167
        button .b
168
        tixBalloon .bal
169
 
170
        # Add balloon binding
171
        .bal bind .b -msg "This is a button"
172
 
173
        ...
174
 
175
        # Change the balloon binding
176
        .bal bind .b -msg "This is a useful button"
177
.fi
178
'
179
.TP
180
\fIpathName \fBcget\fR \fIoption\fR
181
'
182
Returns the current value of the configuration option given by
183
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
184
\fBtixBalloon\fR command.
185
'
186
.TP
187
'
188
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
189
'
190
Query or modify the configuration options of the widget.  If no
191
\fIoption\fR is specified, returns a list describing all of the
192
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
193
information on the format of this list).  If \fIoption\fR is specified
194
with no \fIvalue\fR, then the command returns a list describing the
195
one named option (this list will be identical to the corresponding
196
sublist of the value returned if no \fIoption\fR is specified).  If
197
one or more \fIoption\-value\fR pairs are specified, then the command
198
modifies the given widget option(s) to have the given value(s); in
199
this case the command returns an empty string.  \fIOption\fR may have
200
any of the values accepted by the \fBtixBalloon\fR command.
201
'
202
'
203
'
204
.TP
205
\fIpathName \fBunbind\fI widget\fR
206
'
207
Cancels the Balloon widget's binding with \fIwidget\fR.
208
'
209
'
210
.TP
211
\fIpathName \fBsubwidget \fI name ?args?\fR
212
'
213
When no options are given, this command returns the pathname of the
214
subwidget of the specified name.
215
 
216
When options are given, the widget command of the specified subwidget
217
will be called with these options.
218
'
219
'
220
'----------------------------------------------------------------------
221
.SH BINDINGS
222
.PP
223
After a widget has be bound to a Balloon widget, when the user moves
224
the cursor into this widget, the Balloon widget is activated: if the
225
\fB\-balloonmsg\fR option of this widget is set, the balloon window
226
pops up; if the \fB\-statusmsg\fR option of this widget is set, the
227
message will be displayed in the status bar widget.
228
.PP
229
When the user moves the cursor out of the widget, the Balloon widget
230
is de-activated: the balloon window is withdrawn and the status-bar
231
message removed.
232
'
233
'
234
'
235
'----------------------------------------------------------------------
236
.SH KEYWORDS
237
Tix(n)

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.