Wharf(1x)

💖 NAME 💖

Wharf — the AfterStep module for launching or docking applications, aka a button bar 🎀✨

okay bestie so Wharf is literally that little bar of buttons hanging out on your screen, and every button is either launching something or holding a docked app. it's giving main character energy for your whole desktop. 💅

---

🌸 MyStyle DEFINITIONS 🌸

these are the MyStyle strings that make Wharf look like that girl. 🌈

• MyStyle "*WharfTile" — sets the style of the wharf button tiles: background color, background pixmap (which may be transparent), and background gradient, all of it. ngl this way of setting the background is preferred over the BgColor, MaxColors, Pixmap, TextureColor, and TextureType options — although those older ones do still work, no cap. see MyStyle format for the deets. 💖
• MyStyle "*WharfOddTile" — sets the style of every odd wharf button tile. see MyStyle format for details. ✨
• MyStyle "*WharfFocusedTile" — the style of the wharf button tile that's under the mouse pointer rn: background color, background pixmap (which may be transparent), and background gradient. see MyStyle format for details. 🫶
• MyStyle "*WharfOddFocusedTile" — the style of every odd wharf button tile under the mouse pointer. see MyStyle format for details. 🦋

---

✨ CONFIGURATION OPTIONS ✨

💜 AlignContents

Left,Top,Right,Bottom,HTiled,VTiled,HScaled,VScaled,HCenter,VCenter

that forces the contents of each Wharf's button to be aligned to either side of the button, when FitContents is not used. 📐

See Also: Alignment flags for further details.

💜 Animate

if you specify this, the opening and closing of Folders gets animated instead of just being drawn in one single frame. it's the glow-up your folders deserved. 🔥

💜 AnimateDelay

specifies the delay in milliseconds that the animation will pause between each move when opening or closing a folder. ⏱️

💜 AnimateMain

designates that full-length Wharf withdraws will be animated. ✨

💜 AnimateSteps

specifies the steps a Folder takes in animating while opening or closing. this translates into the Folder button moving button-size/ steps pixels each step. 🎞️

💜 AnimateStepsMain

specifies the steps the main Wharf takes in iconification or de-iconification upon mouse button 3 being pressed. this translates into the main Wharf moving <button-size>/ steps pixels each step. 💫

💜 BalloonBorderHilite

defines the bevel to be drawn around balloons — it replaces the BorderWidth setting, bestie.

See Also: Bevel flags for further details.

💜 BalloonCloseDelay number

specifies the period in milliseconds to delay the disappearance of the balloon when you leave the window with the mouse. bye balloon 👋

💜 BalloonDelay number

specifies the period in milliseconds to delay the appearance of the balloon. 🎈

💜 BalloonStyle MyStyle

the MyStyle to be used to draw the balloon. heads up: balloons could be shaped (BackPixmap 125 and 126). 🎀

💜 BalloonTextPaddingX size

width of the border around the text in balloons. 📏

💜 BalloonTextPaddingY size

height of the border around the text in balloons. 📐

💜 BalloonXOffset

the balloon window is positioned to be horizontally centered against the Wharf window it is describing. the horizontal position may be set as an offset. negative offsets of -N are placed N pixels left of the Wharf window, positive offsets of +N are placed N pixels right of the window. defaults to +2. ⬅️➡️

💜 BalloonYOffset

the balloon window is positioned to be horizontally centered against the Wharf window it is describing. the vertical position may be set as an offset. negative offsets of -N are placed N pixels above the Wharf window, positive offsets of +N are placed N pixels below. defaults to +2. ⬆️⬇️

💜 Balloons

turns on the balloon feature, periodt. a "balloon" gets displayed showing the name of the button the pointer is resting on in the Wharf. the balloon background and text are configured with the MyStyle "*WharfBalloon". see afterstep(1x) for more info on MyStyles. 🎈💖

💜 Bevel

None|[Left,Top,Right,Bottom,Extra,NoOutline]

determines the 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. it's a whole power struggle fr. ⚔️

See Also: Bevel flags for further details.

💜 Columns

specifies the number of columns of buttons to be created. this gives your Wharf a vertical layout, with the number of columns equal to the number specified in columns. if unspecified, the number of columns will be set to 1. if the columns are 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 *WharfRows or *WharfColumns should be specified — don't be greedy. 🙈

💜 CompositionMethod testure_type

determines the algorithm used to blend all the icons and Wharf background to form the button's image. valid testure_types are 130-145 (see MyStyles section). the default value is 131 (alpha-blending). 🎨

💜 FitContents

Wharf will draw each button so that it fits its contents perfectly (icon or swallowed app). this will cause some of the Wharf's buttons to differ in size from others. use this in conjunction with ShapeToContents. 🧩

💜 FlipLabel

will cause Wharf to draw vertical label text. 🔄

💜 FolderOffset size

sets the distance between an opened folder and its parent. 📂

💜 ForceSize Size

if 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). ✂️

💜 Geometry

specifies the Wharf window location and/or size. if the size is not specified, Wharf will auto-size itself in a reasonable manner. the geometry is a standard X11 window geometry specification; see XParseGeometry(3x), and EXAMPLES (below) for further details. 📍

💜 MyStyle

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. 💖

See Also: MyStyle definition for further details.

💜 NoBalloons

do not show Balloons in Wharf. 🚫🎈

💜 OrthogonalFolderOffset size

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. 📐📂

💜 Rows

specifies the number of rows of buttons to be created. this gives your Wharf a horizontal layout, with the number of rows equal to the number specified in rows. if unspecified, the number of rows will be set to 1. if the rows are 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 *WharfRows or *WharfColumns should be specified — pick a lane bestie. 🙈

💜 ShapeToContents

will cause Wharf to use X Shaped extensions and have a window of non-rectangular shape. the shape is composed from the overall geometry of buttons (see FitContents), the shape of the MyStyle used to draw Wharf background (if BackPixmap 126 or 125 is used), and the contents of each button — such as swallowed app's shape, label and icons. 🦋✨

💜 ShowHints

FIXME: add proper description here. 😭 (yes, really, that's what it says)

See Also: Balloon Contents flags for further details.

💜 ShowLabel

tells Wharf to render a label on each of its buttons, effectively immitating the behaviour of the discontinued Zharf module. 🏷️

💜 Sound

FIXME: add proper description here. 😭 (again — iconic honestly)

See Also: Wharf sound definition for further details.

💜 StretchBackground

this should allow for all kinds of skins where each button is just a part of a large shaped figure. 🎨🫶

💜 WithdrawStyle

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.

choose your fighter. 👑

---

and that's the whole vibe check bestie — go make your button bar iconic 💅

this little love letter to Wharf shipped from the 3rd Berkeley Distribution, AfterStep v.2.2.12, and it's filed under Wharf(1x). drink water, read your man pages, slay. 💖🌸🦋✨🎀