Wharf(1)

NAME
Wharf - AfterStep module for launching or docking applications aka button bar Module:Wharfsound definition Wharf[standard options] MyStyle DEFINITIONSMyStyle "*WharfTile"Specifies the style of the wharf button tiles, including background color, background pixmap (which may be transparent), and background gradient. This method of specifying the background is preferred over the BgColor, MaxColors, Pixmap, TextureColor, and TextureType options, although those (older) options do still work. SeeMyStyleformat for details.MyStyle "*WharfOddTile"Specifies the style of every odd wharf button tile. SeeMyStyleformat for details.MyStyle "*WharfFocusedTile"Specifies the style of the wharf button tile under the mouse pointer, including background color, background pixmap (which may be transparent), and background gradient. SeeMyStyleformat for details.MyStyle "*WharfOddFocusedTile"Specifies the style of every odd wharf button tile under the mouse pointer. SeeMyStyleformat for details.

CONFIGURATION OPTIONS
AlignContentsLeft,Top,Right,Bottom,HTiled,VTiled,HScaled,VScaled,HCenter,VCenterThat will force contents of each Wharf's button to be aligned to either side of the button, when FitContents is not used.See Also:Alignment flagsfor further details. AnimateIf specified, the opening and closing of Folders will be animated, rather than simply drawn in one frame. AnimateDelaySpecifies thedelayin milliseconds that the animation will pause between each move when opening or closing a folder. AnimateMainDesignates that full-lengthWharfwithdraws will be animated. AnimateStepsSpecifies thestepsa Folder takes in animating while opening or closing. This translates into the Folder button moving button-size/stepspixels each step. AnimateStepsMainSpecifies thestepsthe main Wharf takes in iconification or de-iconification upon mouse button 3 being pressed. This translates into the main Wharf moving <button-size>/stepspixels each step. BalloonBorderHiliteDefines bevel to be drawn around balloons - replaces the BorderWidth setting.See Also:Bevel flagsfor further details. BalloonCloseDelaynumberSpecifies the period in milliseconds to delay the disappearance of the balloon when leaving window with the mouse. BalloonDelaynumberSpecifies the period in milliseconds to delay the appearance of the balloon. BalloonStyleMyStyleMyStyle to be used to draw balloon. Note that balloons could be shaped (BackPixmap 125 and 126). BalloonTextPaddingX sizewidth of the border around the text in balloons. BalloonTextPaddingY sizeheight of the border around the text in balloons. BalloonXOffsetThe balloon window is positioned to be horizontally centered against theWharfwindow it is describing. The horizontal position may be set as an offset. Negative offsets of-Nare placedNpixels left of theWharfwindow, positive offsets of+Nare placedNpixels right of the window. Defaults to +2. BalloonYOffsetThe balloon window is positioned to be horizontally centered against theWharfwindow it is describing. The vertical position may be set as an offset. Negative offsets of-Nare placedNpixels above theWharfwindow, positive offsets of+Nare placedNpixels below. Defaults to +2. BalloonsTurns on the balloon feature. A "balloon" is displayed showing the name of the button the pointer is resting on in theWharf. The balloon background and text are configured with the MyStyle "*WharfBalloon". Seeafterstep(1x)for more information on MyStyles. BevelNone|[Left,Top,Right,Bottom,Extra,NoOutline]Determines exact size and shape of the 3D bevel drawn around each button. This option is somewhat synonymous to NoBorder. If NoBorder is encountered after Bevel - then it will override Bevel, otherwise Bevel will override NoBorder.See Also:Bevel flagsfor further details. ColumnsSpecifies the number ofcolumnsof buttons to be created. This will give yourWharfa vertical layout, with the number of columns equal to the number specificed incolumns. If unspecified, the number of columns will be set to 1. If thecolumnsare set 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*WharfRowsor*WharfColumnsshould be specified. CompositionMethodtesture_typeDetermines algorithm used to blend all the icons and Wharf background to form the button's image. Valid es are 130-145 ( see MyStyles section ). The default value is 131 ( alpha-blending ) FitContentsWharf 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. Use in conjunction with ShapeToContents. FlipLabelWill cause Wharf to draw vertical label text. FolderOffsetsizesets the distance between opened folder and its parent. ForceSizeSizeIf specified, will force pixmaps to Size instead of the default of 64x64. This has no effect on the Size of the displayed icons (they will be croped if larger). GeometrySpecifies theWharfwindow location and/or size. If the size is not specified, Wharf will auto-size itself in a reasonable manner. Thegeometryis a standard X11 window geometry specification; seeXParseGeometry(3x), andEXAMPLES(below) for further details. LabelLocationnumberSpecifies 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. MyStyleSpecifies the style of the wharf button tiles, including background color, background pixmap (which may be transparent), and background gradient. This method of specifying the background is preferred over the BgColor, MaxColors, Pixmap, TextureColor, and TextureType options, although those (older) options do still work.See Also:MyStyle definitionfor further details. NoBalloonsFIXME: add proper description here. OrthogonalFolderOffsetsizesets 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 RowsSpecifies the number ofrowsof buttons to be created. This will give yourWharfa horizontal layout, with the number of rows equal to the number specified inrows. If unspecified, the number of rows will be set to 1. If therowsare set 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*WharfRowsor*WharfColumnsshould be specified. ShapeToContentsWill 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 FitContents ), shape of the MyStyle used to draw Wharf background ( if BackPixmap 126 or 125 is used ), contents of each button - such as swallowed app's shape, label and icons. ShowHintsFIXME: add proper description here.See Also:Balloon Contents flagsfor further details. ShowLabelTells Wharf to render a label on each of its buttons, effectively immitating the behaviour of the discontinued Zharf module. SoundFIXME: add proper description here.See Also:Wharf sound definitionfor further details. StretchBackgroundThis should allow for all kinds of skins where each button is just a part of large shaped figure. WithdrawStyleSpecifies 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.