software/tcl/man/balloon.n.html

   1 <!-- Creator     : groff version 1.18.1 -->
   2 <!-- CreationDate: Tue Dec 13 16:23:56 2005 -->
   3 <html>
   4 <head>
   5 <meta name="generator" content="groff -Thtml, see www.gnu.org">
   6 <meta name="Content-Style" content="text/css">
   7 <title>balloon</title>
   8 </head>
   9 <body>
  10
  11 <h1 align=center>balloon</h1>
  12 <a href="#NAME">NAME</a><br>
  13 <a href="#SYNOPSIS">SYNOPSIS</a><br>
  14 <a href="#STANDARD OPTIONS">STANDARD OPTIONS</a><br>
  15 <a href="#SPECIFIC OPTIONS">SPECIFIC OPTIONS</a><br>
  16 <a href="#DESCRIPTION">DESCRIPTION</a><br>
  17 <a href="#OPTION DATABASE NOTES">OPTION DATABASE NOTES</a><br>
  18 <a href="#KEYWORDS">KEYWORDS</a><br>
  19
  20 <hr>
  21 <a name="NAME"></a>
  22 <h2>NAME</h2>
  23 <!-- INDENTATION -->
  24 <table width="100%" border=0 rules="none" frame="void"
  25        cols="2" cellspacing="0" cellpadding="0">
  26 <tr valign="top" align="left">
  27 <td width="10%"></td>
  28 <td width="89%">
  29 <p>balloon &minus; provides popup tooltips (balloon help)
  30 for Tk widgets</p>
  31 </td>
  32 </table>
  33 <a name="SYNOPSIS"></a>
  34 <h2>SYNOPSIS</h2>
  35 <!-- INDENTATION -->
  36 <table width="100%" border=0 rules="none" frame="void"
  37        cols="2" cellspacing="0" cellpadding="0">
  38 <tr valign="top" align="left">
  39 <td width="10%"></td>
  40 <td width="89%">
  41 <p>package require <b>balloon</b></p>
  42 <!-- INDENTATION -->
  43 <p><b>balloon</b> <i>$widget</i> ?<i>options</i>?</p>
  44 </td>
  45 </table>
  46 <a name="STANDARD OPTIONS"></a>
  47 <h2>STANDARD OPTIONS</h2>
  48 <!-- TABS -->
  49
  50 <p><b>&minus;foreground &minus;background &minus;font
  51 &minus;relief &minus;borderwidth</b></p>
  52
  53 <p>See the &lsquo;&lsquo;options&rsquo;&rsquo; manual entry
  54 for details on the standard options.</p>
  55 <a name="SPECIFIC OPTIONS"></a>
  56 <h2>SPECIFIC OPTIONS</h2>
  57 <!-- INDENTATION -->
  58 <table width="100%" border=0 rules="none" frame="void"
  59        cols="2" cellspacing="0" cellpadding="0">
  60 <tr valign="top" align="left">
  61 <td width="10%"></td>
  62 <td width="89%">
  63 <pre>Command-Line Name:<b>&minus;showdelay
  64 </b></pre>
  65 </td>
  66 </table>
  67 <!-- TABS -->
  68
  69 <table width="100%" border=0 rules="none" frame="void"
  70        cols="3" cellspacing="0" cellpadding="0">
  71 <tr valign="top" align="left">
  72 <td width="10%"></td>
  73 <td width="23%">
  74
  75 <p>Database Name:</p>
  76 </td>
  77 <td width="66%">
  78
  79 <p><b>showDelay</b></p>
  80 </td>
  81 <tr valign="top" align="left">
  82 <td width="10%"></td>
  83 <td width="23%">
  84
  85 <p>Database Class:</p>
  86 </td>
  87 <td width="66%">
  88
  89 <p><b>ShowDelay</b></p>
  90 </td>
  91 </table>
  92 <!-- INDENTATION -->
  93 <table width="100%" border=0 rules="none" frame="void"
  94        cols="2" cellspacing="0" cellpadding="0">
  95 <tr valign="top" align="left">
  96 <td width="20%"></td>
  97 <td width="79%">
  98 <p>Specifies time of mouse inactivityin the widget in
  99 milliseconds, after which tooltip would be shown. Default is
 100 500 ms.</p>
 101 </td>
 102 </table>
 103 <!-- INDENTATION -->
 104 <table width="100%" border=0 rules="none" frame="void"
 105        cols="2" cellspacing="0" cellpadding="0">
 106 <tr valign="top" align="left">
 107 <td width="10%"></td>
 108 <td width="89%">
 109 <pre>Command-Line Name:<b>&minus;dismissdelay
 110 </b></pre>
 111 </td>
 112 </table>
 113 <!-- TABS -->
 114
 115 <table width="100%" border=0 rules="none" frame="void"
 116        cols="3" cellspacing="0" cellpadding="0">
 117 <tr valign="top" align="left">
 118 <td width="10%"></td>
 119 <td width="23%">
 120
 121 <p>Database Name:</p>
 122 </td>
 123 <td width="66%">
 124
 125 <p><b>dismissDelay</b></p>
 126 </td>
 127 <tr valign="top" align="left">
 128 <td width="10%"></td>
 129 <td width="23%">
 130
 131 <p>Database Class:</p>
 132 </td>
 133 <td width="66%">
 134
 135 <p><b>DismissDelay</b></p>
 136 </td>
 137 </table>
 138 <!-- INDENTATION -->
 139 <table width="100%" border=0 rules="none" frame="void"
 140        cols="2" cellspacing="0" cellpadding="0">
 141 <tr valign="top" align="left">
 142 <td width="20%"></td>
 143 <td width="79%">
 144 <p>Specifies time of inactivity after tooltip was shown,
 145 before it would be dismissed automatically.</p>
 146 </td>
 147 </table>
 148 <a name="DESCRIPTION"></a>
 149 <h2>DESCRIPTION</h2>
 150 <!-- INDENTATION -->
 151 <table width="100%" border=0 rules="none" frame="void"
 152        cols="2" cellspacing="0" cellpadding="0">
 153 <tr valign="top" align="left">
 154 <td width="10%"></td>
 155 <td width="89%">
 156 <p>This package provides balloon tooltips for Tk widget. You
 157 invoke procedure balloon with name of widget and it&rsquo;s
 158 all. User positiones mouse cursor over widget and after
 159 specified <b>-showdelay</b> small toplevel window with
 160 specified text would appear. At least one of options:
 161 <b>-label</b>, <b>-text</b> or <b>-textvariable</b> should
 162 be provided.</p>
 163 <!-- INDENTATION -->
 164 <p>Procedure <b>balloon</b> doesn&rsquo;t return anything,
 165 and even doesn&rsquo;t actually create widget.</p>
 166 <!-- INDENTATION -->
 167 <p>If <b>-label</b> option is specified, message would be
 168 placed into toplevel as <b>label</b> widget. Otherwise
 169 <b>message</b> widget is used.</p>
 170 <!-- INDENTATION -->
 171 <p>To disable tooltip set invoke <b>balloon</b> command
 172 again and specify -1 as <b>-showdelay</b>.</p>
 173 </td>
 174 </table>
 175 <a name="OPTION DATABASE NOTES"></a>
 176 <h2>OPTION DATABASE NOTES</h2>
 177 <!-- INDENTATION -->
 178 <table width="100%" border=0 rules="none" frame="void"
 179        cols="2" cellspacing="0" cellpadding="0">
 180 <tr valign="top" align="left">
 181 <td width="10%"></td>
 182 <td width="89%">
 183 <p>All the behavoir of balloon help, excluding text can be
 184 controlled via option database. We use class <b>Balloon</b>
 185 for the balloon widget and it is always child of widget it
 186 describes.</p>
 187 <!-- INDENTATION -->
 188 <p>All unlisted options of label/message widget can be set
 189 via option database using *.Balloon.Message.option or
 190 *.Balloon.Label.option</p>
 191 </td>
 192 </table>
 193 <a name="KEYWORDS"></a>
 194 <h2>KEYWORDS</h2>
 195 <!-- INDENTATION -->
 196 <table width="100%" border=0 rules="none" frame="void"
 197        cols="2" cellspacing="0" cellpadding="0">
 198 <tr valign="top" align="left">
 199 <td width="10%"></td>
 200 <td width="89%">
 201 <p>widget, balloon help, tooltip</p>
 202 </td>
 203 </table>
 204 <hr>
 205 </body>
 206 </html>