MAN page from RedHat Other AfterStep-1.4-2.i386.rpm

Wharf

Section: Misc. Reference Manual Pages (1.0)
Updated: October 1996
Index

NAME

Wharf - the AfterStep application "dock" module

SYNOPSIS

Wharf is spawned by afterstep, so no command line invocation will work.

DESCRIPTION

The Wharf module is a free-floating application loader that canexecute programs, "Swallow" running programs, and contain "Folders" ofmore applications, among other things. The user can press the firstbutton at any time to trigger invocation of one of these functions, orthe user can press button two in order to cause the entire Wharfto withdraw to the nearest corner in an iconized state.Wharf only works when afterstep is used as the window manager.

INITIALIZATION

During initialization, Wharf will search for a configurationfile which describes the button panel geometry, color, icons, andactions. The format of this file will be described later.

If the Wharf executable is linked to another name, ie ln -sWharf Pier, then another module called Pier can be started, with a completelydifferent configuration than Wharf, simply by changing the keywords Wharf??? toPier???. This way multiple button-bars can be used.

INVOCATION

Wharf can be invoked by inserting the line 'Module Wharf' in the autoexecfile. This can be placed on a line by itself, if Wharf is to be spawned duringAfterStep's initialization, or can be bound to a menu or mouse button orkeystroke in feel file to invoke it later. AfterStep will search directoryspecified in the ModulePath configuration option to attempt to locate Wharf.

CONFIGURATION OPTIONS

The following options can be placed in the ~/GNUstep/Library/AfterStep/wharffile :

*WharfAnimate

If specified, the opening and closing of Folders will be animated, rather than simply drawn in one frame.

*WharfAnimateMain

Designates that full-length Wharf windraws will be animated.

*WharfBgColor color

If *WharfTextureType 0 is specified, Wharf's buttonswill be filled with color.

*WharfColumns columns

Specifies the number of columns of buttons to be created. 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 numberof columns with enough rows to satisfy the requested number of buttons.

*WharfForceSize

If specified, will force pixmaps larger than 64x64 to the defaultsize. Pixmaps smaller than 64x64 are not supported.

*WharfFullPush

If specified, the entire Wharf button background will be moved downand to the right when pushed. Especially useful with *WharfNoBordertextures.

*WharfGeometry geometry

Specifies the Wharf window location and/or size. If the size isnot specified, Wharf will auto-size itself in a reasonable manner.The geometry is a standard X11 window geometry specification. This option ispre-set in the NEXTSTEP(tm) style section for a consistent look and feel with NEXTSTEP(tm).Secondary Wharf invocations from links may have their own geometry.

*WharfMaxColors number

Specifies the maximum number of colors to use on a gradientfill.

*WharfNoBorder

Denotes that beveled borders should not be drawn around the Wharf button.Useful with textures that include their own bevels.

*WharfPixmap pixmap

Sets the pixmap file to be used as Wharf's button. To be usedwith *WharfTextureType 128.

*WharfTextureColor from to

When used with a *WharfTextureType of 1 to 5, designates theends of the gradient range to be used on Wharf's buttons.

*WharfTextureType type

Specifies the type of gradient fill to be used on Wharf's buttons. Valid values are:

0 - No texture - use WharfBgColor to set the desired color1 - Gradient from upper-left to lower right2 - Horizontal one way gradient from top to bottom3 - Horizontal cylindrical gradient from top/bottom to center4 - Vertical one way gradient from left to right5 - Vertical cylindrical gradient from left/right to center128 - User specified pixmap

The default is the builtin Wharf texture pixmap.

*Wharf label icon command

Specifies a window manager built-in command or folder to activate(folders will be discussed below), as described in the afterstepman page, which should be executed when a button is pressed. The labelfield is an internal item that is still around from the GoodStuff module.The icon fieldspecifies an X11 bitmap file, XPM color icon file, or a comma-delimited set of pixmaps containing theicon(s) to display on the button. Wharf will search through the pathspecified in the afterstep IconPath or PixmapPath configuration items tofind the icon file.

If command is an afterstep Exec command, then the button willappear pushed in until the mouse button is released.

A single extension to the afterstep built-in command set is provided.A command of the form:

*Wharf junk clock.xpm Swallow "Clock" asclock -shape -12 &

will cause Wharf to spawn an asclock process, and capture the first window whose name or resource is "Clock", and display it inthe button-bar. This is handy for applications like xclock, xbiff,xload, asclock, and asmail.Modules can be swallowed by specifying SwallowModule instead of just "swallow"

NOTE: if you use xclock for this application, you will want to specify

For certain applications that overrun the 48 pixel by 48 pixel boundary of Wharficons and Swallowed programs there is a special option calledMaxSwallow.MaxSwallowwill allow the application to draw itself larger than the 48x48 boundary.It is invoked the same way Swallow is.

To create folder "slide-outs" inWharfthe following format must be used:

*Wharf files Folders.xpm Folder*Wharf xftp 3DRings.xpm Exec "" xftp &*Wharf xdir FolderDeposit.xpm Exec "" xdir &*Wharf moxfm FilingCabinet.xpm Exec "" moxfm &*Wharf ~Folders

The first line of this set tells Wharf that this button definition will be a folder. All of the button definitions between theFolderand the line with the definition of *Wharf ~Folderswill appear on the "files" folder when it is exposed. To expose the "files"folder simply click on the Wharf button with the Folders.xpm icon showing. Abutton bar will appear perpendicular to your Wharf bar and toward the centerof the screen. On this smaller bar will be the three icons that were configured between the Folderand~Folderparts of the Wharf configuration. As many folder buttons may be configured asis room on your screen. The only items that may not be configured withinfolders are Swallowed applications and more folders.

DRAG AND DROP

Wharf supports the OffiX Drag and Drop standard. In order tohave Drag and Drop enabled on a particular button, the following syntaxmust be adhered to:

*Wharf  nil      nil         DropExec "program" program %s*Wharf  program  iconname       Exec "program" program

The button will call program when pushed. If a file is draggedonto into it, program will be called with %s being replaced bythe dropped filename.

AUTHORS

Beat Christen <bchristeAATTiiic.ethz.ch>

Frank Fejes <frankAATTssax.com>

Alfredo Kengi Kojima <kojimaAATTinf.ufrgs.br>

Dan Weeks <danAATTmango.sfasu.edu>

Bo Yang <ericAATTcoeus.ucsd.edu>

Robert Nation

This document was created byman2html,using the manual pages.