/usr/share/doc/afterstep-data/html/Wharf.html is in afterstep-data 2.2.12-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
<title>Module:Wharf</title>
<style type="text/css">
<!--
body {
margin-top: 5px;
background-repeat: repeat;
}
.copy {
margin-top: 10px;
margin-left: 4%;
margin-right: 4%;
}
.copy a:link, .copy a:visited {
color:#0FF;
text-decoration:none
}
.copy a:active, .copy a:hover {
color:#FC3;
text-decoration:underline
}
.copy2 {
margin-top: 10px;
margin-left: 0;
margin-right: 0;
}
.copy2 a:link, .copy a:visited {
color:#0FF;
text-decoration:none
}
.copy2 a:active, .copy a:hover {
color:#FC3;
text-decoration:underline
}
p.codeBlock {
background: #444444;
padding: 1em;
margin-left: 4em;
font-family:Tahoma, Arial, Verdana, Helvetica;
font-size:14px;
}
.container {
padding: -1em;
margin-left: 0em;
margin-right: 1em;
width: 100%;
background: #ccc;
border: 1px solid #000;
font-size:13px;
}
p.dense {
text-align: justify;
margin-top: 0em;
padding: 0em;
line-height: 110%;
}
p.sect_header
{
background-color: #dddddd;
color: #000000;
text-align: right;
font-size: 11pt;
}
p.refsect_header
{
text-align: left;
font-size: 14px;
line-height: 90%;
}
dl.dense {
padding: 0;
margin: 0;
font-size:14px;
}
ul.dense {
}
li.dense {
line-height: 110%;
}
dt.dense {
line-height: 110%;
text-align: bottom;
}
dd.dense {
font-size:14px;
}
-->
</style>
</head>
<body>
<A name="page_top"></A>
<A href="preface.html">Preface</A> <A href="visualselect.html">Introduction</A> <A href="index.html">Topic index</A> <A href="Glossary.html">Glossary</A><p>
<h1>Module:Wharf</h1><font size=4>AfterStep module for launching or docking applications aka button bar</font><hr>
<A NAME="related"><UL>
</A>
<A href="WharfSounds.html">sound definition</A>
</UL>
<A NAME="synopsis"><UL>
<LI><h3>SYNOPSIS</h3></A>
<B>Wharf</B> [
<A href="AfterStep.html#standard_options_list">standard options</A>]
</LI>
</UL>
<A NAME="mystyles"><UL>
</A>
<A NAME="MyStyles"><LI>
<p class="refsect_header"><B>MyStyle DEFINITIONS</B></p></A>
<DL class="dense">
<DT class="dense"><B><A href="MyStyle.html#options.MyStyle">MyStyle</A> "*WharfTile"</B></DT>
<DD class="dense">
<P class="dense">Specifies the style of the wharf button tiles, including <A href="asimagexml.html#background">background</A> <A href="asimagexml.html#color">color</A>,
<A href="asimagexml.html#background">background</A> pixmap (which may be transparent), and <A href="asimagexml.html#background">background</A> <A href="asimagexml.html#gradient">gradient</A>.
This method of specifying the <A href="asimagexml.html#background">background</A> is preferred over the BgColor,
MaxColors, Pixmap, TextureColor, and TextureType options, although those
(older) options do still work. See <I>MyStyle</I> format
for details.</P>
</DD>
<DT class="dense"><B><A href="MyStyle.html#options.MyStyle">MyStyle</A> "*WharfOddTile"</B></DT>
<DD class="dense">
<P class="dense">Specifies the style of every odd wharf button <A href="asimagexml.html#tile">tile</A>.
See <I>MyStyle</I> format
for details.</P>
</DD>
<DT class="dense"><B><A href="MyStyle.html#options.MyStyle">MyStyle</A> "*WharfFocusedTile"</B></DT>
<DD class="dense">
<P class="dense">Specifies the style of the wharf button <A href="asimagexml.html#tile">tile</A> under the mouse pointer,
including <A href="asimagexml.html#background">background</A> <A href="asimagexml.html#color">color</A>, <A href="asimagexml.html#background">background</A> pixmap (which may be transparent), and <A href="asimagexml.html#background">background</A> <A href="asimagexml.html#gradient">gradient</A>.
See <I>MyStyle</I> format
for details.</P>
</DD>
<DT class="dense"><B><A href="MyStyle.html#options.MyStyle">MyStyle</A> "*WharfOddFocusedTile"</B></DT>
<DD class="dense">
<P class="dense">Specifies the style of every odd wharf button <A href="asimagexml.html#tile">tile</A> under the mouse pointer.
See <I>MyStyle</I> format
for details.</P>
</DD>
</DL>
</LI>
</UL>
<p><A href="preface">Preface</A> <A href="viusalselect.html">Introduction</A> <A href="index.html">Topic index</A> <A href="Glossary.html">Glossary</A> <A href="#page_top">Back to Top</A><hr>
<UL><LI><A NAME="options"></A><h3>CONFIGURATION OPTIONS :</h3>
<DL>
<A NAME="options.AlignContents">
</A><DT class="dense"><B><A href="Wharf.html#options.AlignContents">AlignContents</A> <I><A href="Align.html#options.Left">Left</A>,<A href="Align.html#options.Top">Top</A>,<A href="Align.html#options.Right">Right</A>,<A href="Align.html#options.Bottom">Bottom</A>,<A href="Align.html#options.HTiled">HTiled</A>,<A href="Align.html#options.VTiled">VTiled</A>,<A href="Align.html#options.HScaled">HScaled</A>,<A href="Align.html#options.VScaled">VScaled</A>,<A href="Align.html#options.HCenter">HCenter</A>,VCenter</I></B></DT>
<DD class="dense">
<P class="dense">That will force contents of each Wharf's button to be aligned to either
side of the button, when <A href="Wharf.html#options.FitContents">FitContents</A> is not used.</P>
<P class="dense">See Also:
<A href="Align.html#synopsis">Alignment flags</A> for further details.</P>
</DD>
<A NAME="options.Animate">
</A><DT class="dense"><B>Animate</B></DT>
<DD class="dense">
<P class="dense">If specified, the opening and closing of Folders will be animated,
rather than simply drawn in one frame.
</P>
</DD>
<A NAME="options.AnimateDelay">
</A><DT class="dense"><B>AnimateDelay</B></DT>
<DD class="dense">
<P class="dense">Specifies the <I>delay</I> in milliseconds that the animation will pause
between each move when opening or closing a folder.</P>
</DD>
<A NAME="options.AnimateMain">
</A><DT class="dense"><B>AnimateMain</B></DT>
<DD class="dense">
<P class="dense">Designates that full-length <B>Wharf</B> withdraws will be animated.</P>
</DD>
<A NAME="options.AnimateSteps">
</A><DT class="dense"><B>AnimateSteps</B></DT>
<DD class="dense">
<P class="dense">Specifies the <I>steps</I> a <A href="Functions.html#options.Folder">Folder</A> takes in animating while opening or
closing. This translates into the <A href="Functions.html#options.Folder">Folder</A> button moving
button-size/<I>steps</I> pixels each step.</P>
</DD>
<A NAME="options.AnimateStepsMain">
</A><DT class="dense"><B>AnimateStepsMain</B></DT>
<DD class="dense">
<P class="dense">Specifies the <I>steps</I> the main Wharf takes in iconification or
de-iconification upon mouse button 3 being pressed. This translates into
the main Wharf moving <button-size>/<I>steps</I> pixels each step.
</P>
</DD>
<A NAME="options.BalloonBorderHilite">
</A><DT class="dense"><B>BalloonBorderHilite</B></DT>
<DD class="dense">
<P class="dense">Defines <A href="asimagexml.html#bevel">bevel</A> to be drawn around balloons - replaces the
<A href="ASDatabaseEntry.html#options.BorderWidth">BorderWidth</A> setting.</P>
<P class="dense">See Also:
<A href="Bevel.html#synopsis">Bevel flags</A> for further details.</P>
</DD>
<A NAME="options.BalloonCloseDelay">
</A><DT class="dense"><B><A href="Pager.html#options.BalloonCloseDelay">BalloonCloseDelay</A> <I>number</I></B></DT>
<DD class="dense">
<P class="dense">Specifies the period in milliseconds to delay the disappearance of
the balloon when leaving window with the mouse.</P>
</DD>
<A NAME="options.BalloonDelay">
</A><DT class="dense"><B><A href="Pager.html#options.BalloonDelay">BalloonDelay</A> <I>number</I></B></DT>
<DD class="dense">
<P class="dense">Specifies the period in milliseconds to delay the appearance of
the balloon.</P>
</DD>
<A NAME="options.BalloonStyle">
</A><DT class="dense"><B><A href="Pager.html#options.BalloonStyle">BalloonStyle</A> <I>MyStyle</I></B></DT>
<DD class="dense">
<P class="dense"><A href="MyStyle.html#options.MyStyle">MyStyle</A> to be used to draw balloon. Note that balloons could be
shaped (BackPixmap 125 and 126).</P>
</DD>
<A NAME="options.BalloonTextPaddingX">
</A><DT class="dense"><B><A href="Pager.html#options.BalloonTextPaddingX">BalloonTextPaddingX</A> size</B></DT>
<DD class="dense">
<P class="dense">width of the border around the <A href="asimagexml.html#text">text</A> in balloons.</P>
</DD>
<A NAME="options.BalloonTextPaddingY">
</A><DT class="dense"><B><A href="Pager.html#options.BalloonTextPaddingY">BalloonTextPaddingY</A> size</B></DT>
<DD class="dense">
<P class="dense">height of the border around the <A href="asimagexml.html#text">text</A> in balloons.</P>
</DD>
<A NAME="options.BalloonXOffset">
</A><DT class="dense"><B>BalloonXOffset</B></DT>
<DD class="dense">
<P class="dense">The balloon window is positioned to be horizontally centered against
the <B>Wharf</B> window it is describing. The horizontal position may be
<A href="asimagexml.html#set">set</A> as an offset. Negative offsets of <B>-N</B> are placed <I>N</I>
pixels left of the <B>Wharf</B> window, positive offsets of <I>+N</I> are
placed <I>N</I> pixels right of the window. Defaults to +2.</P>
</DD>
<A NAME="options.BalloonYOffset">
</A><DT class="dense"><B>BalloonYOffset</B></DT>
<DD class="dense">
<P class="dense">The balloon window is positioned to be horizontally centered against
the <B>Wharf</B> window it is describing. The vertical position may be
<A href="asimagexml.html#set">set</A> as an offset. Negative offsets of <B>-N</B> are placed <I>N</I>
pixels above the <B>Wharf</B> window, positive offsets of <I>+N</I> are
placed <I>N</I> pixels below. Defaults to +2.</P>
</DD>
<A NAME="options.Balloons">
</A><DT class="dense"><B>Balloons</B></DT>
<DD class="dense">
<P class="dense">Turns on the balloon feature. A "balloon" is displayed showing the name
of the button the pointer is resting on in the <B>Wharf</B>. The balloon
<A href="asimagexml.html#background">background</A> and <A href="asimagexml.html#text">text</A> are configured with the <A href="MyStyle.html#options.MyStyle">MyStyle</A> "*WharfBalloon".
See <I>afterstep(1x)</I> for more information on MyStyles.</P>
</DD>
<A NAME="options.Bevel">
</A><DT class="dense"><B><A href="Wharf.html#options.Bevel">Bevel</A> <I><A href="Align.html#options.None">None</A>|[<A href="Align.html#options.Left">Left</A>,<A href="Align.html#options.Top">Top</A>,<A href="Align.html#options.Right">Right</A>,<A href="Align.html#options.Bottom">Bottom</A>,<A href="Bevel.html#options.Extra">Extra</A>,<A href="Bevel.html#options.NoOutline">NoOutline</A>]</I></B></DT>
<DD class="dense">
<P class="dense">Determines exact size and shape of the 3D <A href="asimagexml.html#bevel">bevel</A> drawn around each
button. This option is somewhat synonymous to <A href="MyFrame.html#options.NoBorder">NoBorder</A>. If <A href="MyFrame.html#options.NoBorder">NoBorder</A> is
encountered after <A href="Wharf.html#options.Bevel">Bevel</A> - then it will override <A href="Wharf.html#options.Bevel">Bevel</A>, otherwise <A href="Wharf.html#options.Bevel">Bevel</A>
will override <A href="MyFrame.html#options.NoBorder">NoBorder</A>.</P>
<P class="dense">See Also:
<A href="Bevel.html#synopsis">Bevel flags</A> for further details.</P>
</DD>
<A NAME="options.Columns">
</A><DT class="dense"><B>Columns</B></DT>
<DD class="dense">
<P class="dense">Specifies the number of <I>columns</I> of buttons to be created. This will
give your <B>Wharf</B> a vertical layout, with the number of columns equal
to the number specificed in <I>columns</I>. If unspecified, the number of
columns will be <A href="asimagexml.html#set">set</A> to 1. If the <I>columns</I> are <A href="asimagexml.html#set">set</A> to a number
greater than 1, then there will be that number of columns with enough
rows to satisfy the requested number of buttons. Only one of
<I>*WharfRows</I> or <I>*WharfColumns</I> should be specified.</P>
</DD>
<A NAME="options.CompositionMethod">
</A><DT class="dense"><B><A href="Wharf.html#options.CompositionMethod">CompositionMethod</A> <I>testure_type</I></B></DT>
<DD class="dense">
<P class="dense">Determines algorithm used to blend all the icons and
Wharf <A href="asimagexml.html#background">background</A> to form the button's image. Valid es are
130-145 ( see MyStyles section ). The default value is 131
( <A href="ColorScheme.html#color_values.alpha">alpha</A>-blending )</P>
</DD>
<A NAME="options.FitContents">
</A><DT class="dense"><B>FitContents</B></DT>
<DD class="dense">
<P class="dense">Wharf will draw each button so that it fits its contents perfectly
(icon or swallowed app ). That will cause some of the Wharf's buttons to
differ in size from others. <A href="MyBackground.html#options.Use">Use</A> in conjunction with <A href="Wharf.html#options.ShapeToContents">ShapeToContents</A>.</P>
</DD>
<A NAME="options.FlipLabel">
</A><DT class="dense"><B>FlipLabel</B></DT>
<DD class="dense">
<P class="dense">Will cause Wharf to draw vertical label <A href="asimagexml.html#text">text</A>.</P>
</DD>
<A NAME="options.FolderOffset">
</A><DT class="dense"><B><A href="Wharf.html#options.FolderOffset">FolderOffset</A> <I>size</I></B></DT>
<DD class="dense">
<P class="dense">sets the distance between opened folder and its parent.</P>
</DD>
<A NAME="options.ForceSize">
</A><DT class="dense"><B><A href="Wharf.html#options.ForceSize">ForceSize</A> <I>Size</I></B></DT>
<DD class="dense">
<P class="dense">If specified, will force pixmaps to <A href="Functions.html#options.Size">Size</A> instead of the default
of 64x64. This has no effect on the <A href="Functions.html#options.Size">Size</A> of the displayed icons (they will be croped <A href="asimagexml.html#if">if</A> larger).</P>
</DD>
<A NAME="options.Geometry">
</A><DT class="dense"><B>Geometry</B></DT>
<DD class="dense">
<P class="dense">Specifies the <B>Wharf</B> window location and/or size. If the size is
not specified, Wharf will auto-size itself in a reasonable manner. The
<I>geometry</I> is a standard X11 window geometry specification; see
<I>XParseGeometry(3x)</I>, and <I>EXAMPLES</I> (below) for further details.</P>
</DD>
<A NAME="options.LabelLocation">
</A><DT class="dense"><B><A href="Wharf.html#options.LabelLocation">LabelLocation</A> <I>number</I></B></DT>
<DD class="dense">
<P class="dense">Specifies the location of the label. Correct values are
integers from 0-32. label could be drawn on each side of
the button and just on top of icon. It could also be aligned to
different sides.</P>
</DD>
<A NAME="options.MyStyle">
</A><DT class="dense"><B>MyStyle</B></DT>
<DD class="dense">
<P class="dense">Specifies the style of the wharf button tiles, including <A href="asimagexml.html#background">background</A> <A href="asimagexml.html#color">color</A>,
<A href="asimagexml.html#background">background</A> pixmap (which may be transparent), and <A href="asimagexml.html#background">background</A> <A href="asimagexml.html#gradient">gradient</A>.
This method of specifying the <A href="asimagexml.html#background">background</A> is preferred over the BgColor,
MaxColors, Pixmap, TextureColor, and TextureType options, although those
(older) options do still work.</P>
<P class="dense">See Also:
<A href="MyStyle.html#synopsis">MyStyle definition</A> for further details.</P>
</DD>
<A NAME="options.NoBalloons">
</A><DT class="dense"><B>NoBalloons</B></DT>
<DD class="dense">
<P class="dense">Do not show <A href="Pager.html#options.Balloons">Balloons</A> in Wharf.</P>
</DD>
<A NAME="options.OrthogonalFolderOffset">
</A><DT class="dense"><B><A href="Wharf.html#options.OrthogonalFolderOffset">OrthogonalFolderOffset</A> <I>size</I></B></DT>
<DD class="dense">
<P class="dense">sets the offset of an opened folder relative to its parent orthogonal to the opening direction. In
other words this can be used to move the opened folder parallel to its parent</P>
</DD>
<A NAME="options.Rows">
</A><DT class="dense"><B>Rows</B></DT>
<DD class="dense">
<P class="dense">Specifies the number of <I>rows</I> of buttons to be created. This will
give your <B>Wharf</B> a horizontal layout, with the number of rows equal
to the number specified in <I>rows</I>. If unspecified, the number of rows
will be <A href="asimagexml.html#set">set</A> to 1. If the <I>rows</I> are <A href="asimagexml.html#set">set</A> to a number greater than 1,
then there will be that number of rows with enough columns to satisfy the
requested number of buttons. Only one of <I>*WharfRows</I> or
<I>*WharfColumns</I> should be specified.</P>
</DD>
<A NAME="options.ShapeToContents">
</A><DT class="dense"><B>ShapeToContents</B></DT>
<DD class="dense">
<P class="dense">Will cause Wharf to use X Shaped extentions and have a window of
non-rectangular shape. Shape is composed from the overall geometry of
buttons ( see <A href="Wharf.html#options.FitContents">FitContents</A> ), shape of the <A href="MyStyle.html#options.MyStyle">MyStyle</A> used to draw Wharf
<A href="asimagexml.html#background">background</A> ( <A href="asimagexml.html#if">if</A> <A href="MyStyle.html#options.BackPixmap">BackPixmap</A> 126 or 125 is used ), contents of each
button - such as swallowed app's shape, label and icons.</P>
</DD>
<A NAME="options.ShowHints">
</A><DT class="dense"><B>ShowHints</B></DT>
<DD class="dense">
<P class="dense">FIXME: add proper description here.</P>
<P class="dense">See Also:
<A href="Balloon Contents.html#synopsis">Balloon Contents flags</A> for further details.</P>
</DD>
<A NAME="options.ShowLabel">
</A><DT class="dense"><B>ShowLabel</B></DT>
<DD class="dense">
<P class="dense">Tells Wharf to render a label on each
of its buttons, effectively immitating the behaviour of
the discontinued Zharf module.</P>
</DD>
<A NAME="options.Sound">
</A><DT class="dense"><B>Sound</B></DT>
<DD class="dense">
<P class="dense">FIXME: add proper description here.</P>
<P class="dense">See Also:
<A href="WharfSounds.html#synopsis">Wharf sound definition</A> for further details.</P>
</DD>
<A NAME="options.StretchBackground">
</A><DT class="dense"><B>StretchBackground</B></DT>
<DD class="dense">
<P class="dense">This should allow for all kinds of skins where each button
is just a part of large shaped figure.</P>
</DD>
<A NAME="options.WithdrawStyle">
</A><DT class="dense"><B>WithdrawStyle</B></DT>
<DD class="dense">
<P class="dense">Specifies the circumstances under which button 3 should cause
the Wharf to withdraw to a corner. If style is 0, button 3 will
do nothing. If style is 1 (the default), a click on any button
in the toplevel bar will cause Wharf to withdraw to the nearest
corner. If style is 2, a click on either the first or the last
button in the toplevel bar will cause the withdrawal.</P>
</DD>
</DL></P></LI>
</UL>
<p><A href="preface.html">Preface</A> <A href="visualselect.html">Introduction</A> <A href="index.html">Topic index</A> <A href="Glossary.html">Glossary</A> <A href="#page_top">Back to Top</A>
<hr>
<p><FONT face="Verdana, Arial, Helvetica, sans-serif" size="-2">AfterStep version 2.2.12</a></FONT>
</body>
</html>
|