1tixBalloon(n)                Tix Built-In Commands               tixBalloon(n)
2
3
4

NAME

6       tixBalloon - Create and manipulate tixBalloon widgets
7

SYNOPSIS

9       tixBalloon pathName ?options?
10

SUPER-CLASS

12       The  tixBalloon  class  is derived from the TixShell class and inherits
13       all the commands, options and subwidgets of its super-class.
14

STANDARD OPTIONS

16       The Balloon widget supports all the standard options of a frame widget.
17       See the options(n) manual entry for details on the standard options.
18

WIDGET-SPECIFIC OPTIONS

20       [-initwait initWait]  In  milliseconds.  Specifies how long the balloon
21       should wait before popping up in a  widget.   [-state state]  Specifies
22       the  which help message to display when the mouse pointer enters a wid‐
23       get associated with this balloon. Valid options are both: display  both
24       the  balloon  message and the status bar message, balloon: display only
25       the balloon message, status: display only the status  bar  message  and
26       none: display no messages.  [-statusbar statusBar] Specifies the widget
27       to use as the status bar of this  balloon.  This  widget  must  have  a
28       "-text" option. Usually a label widget is used.
29

SUBWIDGETS

31       Name:          label
32       Class:         Label
33
34              The  label widget that shows the little arrow bitmap in the pop-
35              up balloon window.
36
37       Name:          message
38       Class:         Label
39
40              The message widget that shows the descriptive message in the the
41              pop-up balloon window.
42

DESCRIPTION

44       The  tixBalloon  command  creates  a  new window (given by the pathName
45       argument) and makes it into  a  Balloon  widget.   Additional  options,
46       described  above, may be specified on the command line or in the option
47       database to configure aspects of the Balloon widget such as its  cursor
48       and relief.
49
50       The Balloon widget can be used to show popped-up messages that describe
51       the functions of the widgets in an application. A Balloon widget can be
52       bound  to  a number of widgets. When the user moves the cursor inside a
53       widget to which a Balloon widget has been bound, a small pop-up  window
54       with a descriptive message will be shown on the screen.
55

WIDGET COMMANDS

57       The tixBalloon command creates a new Tcl command whose name is the same
58       as the path name of the Balloon widget's window.  This command  may  be
59       used  to  invoke various operations on the widget. It has the following
60       general form:
61              pathName option ?arg arg ...?
62       PathName is the name of the command, which is the same as  the  Balloon
63       widget's path name. Option and the args determine the exact behavior of
64       the command. The following commands are possible for Balloon widgets:
65
66       pathName bind widget ?option value ... ?
67              Binds the Balloon widget to the widget. The messages to be shown
68              can be passed as extra arguments to this command in option value
69              pairs. Possible options: -balloonmsg  specifies  the  string  to
70              show  on  the  pop-up  balloon  window; -statusmsg specifies the
71              string to show on the status bar; -msg  specifies  a  string  to
72              show  on both the balloon window and the stats bar window.  When
73              used together, the -msg option has a lower precedence  than  the
74              -balloonmsg and -statusmsg options.
75
76              The  bind  command can also be used to change the messages after
77              the initial bindings were set. Example:
78
79            button .b
80            tixBalloon .bal
81
82            # Add balloon binding
83            .bal bind .b -msg "This is a button"
84
85            ...
86
87            # Change the balloon binding
88            .bal bind .b -msg "This is a useful button"
89
90       pathName cget option
91              Returns the current value of the configuration option  given  by
92              option.  Option  may  have  any  of  the  values accepted by the
93              tixBalloon command.
94
95       pathName configure ?option? ?value option value ...?
96              Query or modify the configuration options of the widget.  If  no
97              option is specified, returns a list describing all of the avail‐
98              able options for pathName (see Tk_ConfigureInfo for  information
99              on  the  format  of  this list).  If option is specified with no
100              value, then the command returns a list describing the one  named
101              option (this list will be identical to the corresponding sublist
102              of the value returned if no option is  specified).   If  one  or
103              more option-value pairs are specified, then the command modifies
104              the given widget option(s) to have the given value(s);  in  this
105              case  the  command returns an empty string.  Option may have any
106              of the values accepted by the tixBalloon command.
107
108       pathName unbind widget
109              Cancels the Balloon widget's binding with widget.
110
111       pathName subwidget  name ?args?
112              When no options are given, this command returns the pathname  of
113              the subwidget of the specified name.
114
115              When options are given, the widget command of the specified sub‐
116              widget will be called with these options.
117

BINDINGS

119       After a widget has be bound to a Balloon widget, when  the  user  moves
120       the  cursor  into  this widget, the Balloon widget is activated: if the
121       -balloonmsg option of this widget is set, the balloon window  pops  up;
122       if  the  -statusmsg  option  of this widget is set, the message will be
123       displayed in the status bar widget.
124
125       When the user moves the cursor out of the widget, the Balloon widget is
126       de-activated:  the  balloon window is withdrawn and the status-bar mes‐
127       sage removed.
128

KEYWORDS

130       Tix(n)
131
132
133
134
135
136
137Tix                                   4.0                        tixBalloon(n)
Impressum