source: http://tenr.de/howtos/style_fbox/style_fbox.html


version 0.7 -> HowTo Style Fluxbox

Intro

This still is a "buggy" version of the !styleHowTo. I know it is full of mistakes of any kind. If you find any of them please do me and all other users the favour and contact me either via email: tenner AT fluxbox DOT org or meet me tenner in #fluxbox or #fluxstyle on irc.freenode.net to give me a hint of what i did wrong. If anyone wants to tell me what is not clearly explained, please let me know the same way, i'm gonna say thank you, that's for sure

I bow to all people who helped me deleting mistakes and told me additional information. Extra thanks to lmg aka M.G. Kishalmi, who reported a bunch of mistakes and had great ideas for additional informations and hints.

Some Rules To Know

Some rules to know (please read this first, maybe your problem is solved after that)

This are some basics you should follow:

Due to the fact that it's not enabled by default yet and probably never will be, i recommend using pixmaps.

There seems to be no advantage of using jpg/png-files, at least in a style.

The second way is to put the file into its own directory that will be afterwards put into the "styles dir" the menu-file is pointing to.

The filename then MUST be: theme.cfg (it's case-sensitive, so take care of that).

A style using images is almost like the second way described for the "classic style" above. The structure of the directory has to look like this:

      name_of_the_style/
        |
        |____ theme.cfg
        |
        |____ preview.jpg (additional)
        |
        |____ pixmaps/
                |
                |____ * (all image files)

I recommend the way of putting the style file into a separate directory in any case to keep it more uniform.

Even if mouseWheeling is a great feature, some still have the buttons enabled. So make sure you deliver a "complete" style with textures/images for all parts.

This little program will use preview.jpg to display a preview of the style and then lets you apply it. The image should have size of something like 320x120. It can be smaller or bigger but please not as big as the users screen, because it will fill out the entire monitor then. This will help having a look at the style before using it.

For me (and for the most people i know) the use of HEX-colors is the easiest way.

Some apps that i use and recommend are: gcolor (gtk1), gcolor2 (gtk2), xcolorsel (this should be in any distro's repo's, except for the slackware vanilla install), kcolorchooser (part of kde) and of course, gimp.

If you really made a matching wallpaper, put it into the style file, but don't force the user to use your background, it's a matter of personal choice. It's just a mean thing and also very annoying to a lot of people.

The Main Parts

This are the main components a Fluxbox style consists of:

rootmenu.png

toolbar.png

windowdecoration.png

Fonts

Most people ask about the font-handling, so i will start with it first.


one useful thing to know is that you can include fontsettings. that does mean you can put your whole *.font settings in a seperate file and and point to it in the style file. imagine you have some fonts you prefer and don't want to change every style you have downloaded. then you can simply make a file e.g. "~/.fluxbox/myfonts" and write the normal fonts-stuff (as you would write it in the style-file) in this local file. then put the following line in the style:

# include "~/.fluxbox/myfonts"

Don't forget the #. Due to Fluxbox will use the last entry in a style file, if something is double, just make sure it's the last one (echo "foo" >> ~/.fluxbox/styles/bar/theme.cfg). That lets you always use your local style-fonts. This has nothing to do with the making of a style but it's good to know

</end deleted part>


But back to the fonts in a style ..

.. there are seven elements you can define a font for:

menu.title.font: <fontname>

menu.frame.font: <fontname>

window.font: <fontname>

toolbar.clock.font: <fontname>

toolbar.workspace.font: <fontname>

toolbar.iconbar.focused.font: <fontname>
toolbar.iconbar.unfocused.font: <fontname>

Fontnames

If using xft-fonts (so called ttf-fonts) you use them like this: <fontname>-size. you can set them bold by adding :bold. This gets easier with an example. the next line will give you the tahoma font in bold, with a size of 12.

tahoma-12:bold

If using x-fonts please run xfontsel to find out what the right names are. for example:

-misc-*-*-*-*-*-*-200-*-*-*-*-*-*

Furthermore you can make Fluxbox try to load several fonts

arial-10|-artwiz-snap-*-

That will cause Fluxbox to load (if compiled with xft) arial-10, otherwise, if the loading failes, it will load a different xft-font.

While a Fluxbox not compiled with xft support will try to load the artwiz-font. If everything fails all will fall back to "fixed". So in the end it will always load a font even though it is not the one you have set in the style.

Font Effects

If using xft-fonts you can set up two nifty effects on the fonts.

*.font.effect: shadow
*.font.shadow.color: <color>
*.font.shadow.x: <int>
*.font.shadow.y: <int>

*.font.effect: halo
*.font.halo.color: <color>

You can set one effect either a shadow or a halo. If set once there is no need to set a color for those items, but you can. Look at the example below to get an impression of what i mean:

menu.title.font: sans-8:bold
menu.title.font.effect: shadow
menu.title.font.shadow.color: #ffffff
menu.title.font.shadow.x: 2
menu.title.font.shadow.y: 5

rootmenu2.png

As you can see the title (meaTbox) has a black shadow with a horizontal offset of 2 and a vertical offset of 5. The values can be negative too. Positive values will be right for x, down for y. Negative values will be the opposite (left and up).

Classic style

overview.png

The way to style the parts of Fluxbox is basicly always the same. every part consists of similar components (sometimes the same components) that will repeat within the other parts. That sounds very weired and if you know a better sentence to explain it please let me know, but let me make this clear with an example:

The menu can have a border and a bevel. This border around the menu can have a color and a width. The window can have the same items as the menu. It can have a border, a border-color, the border around the window can have an own width and color and so forth.

This was only to show that the way to make a style is almost the same for all components of Fluxbox. This situation gives you a simple way to "style all in one", but more of that later in the next chapter generalizing (wildcards).

To give you an overview of all options avaliable we start with the menu.

If you can't remember what the texture options are or don't even know what they look like, check the texture-examples section.

menu.bevelWidth: <int>

menu.borderWidth: <int>
menu.borderColor: <color>

menu.bullet: <empty|triangle|square|diamond>
menu.bullet.position: <left|right>

menu.itemHeight: <int>

menu.title: <texture>
menu.title.justify: <left|center|right>
menu.title.color: <color>
menu.title.colorTo: <color>
menu.title.textColor: <color>
menu.titleHeight: <int>

menu.frame: <texture>
menu.frame.justify: <left|center|right>
menu.frame.color: <color>
menu.frame.colorTo: <color>
menu.frame.textColor: <color>
menu.frame.disableColor: <color>

menu.hilite: <texture>
menu.hilite.color: <color>
menu.hilite.colorTo: <color>
menu.hilite.textColor: <color>

The explanation is really easy.

*.width sets the width in pixel for the border and the bevel.

*.borderColor does what it says.

menu.bullet defines the bullet (little thing in the root-menu that indicates a submenu). The bullet addapts the color of the frame-text that is set with menu.frame.textColor and the hilite-color from menu.hilite.textColor. I won't say anything about menu.bullet.position. The bullet-types are self-explanary, don't tell me anything else.

menu.frame.disableColor is the color of the menuselections of the layer-menu, the placement-menu, the iconbar-mode-menu and such.

The selection indicator gets its normal color AND the texture from the menu.hilite settings. The color AND texture in hilited state is the same as of the menu.frame settings.

menu.itemHeight sets the padding of each line in the menu, so you can increase the height of each line of the menu. That will put more space between the entries if the font is too small. This has NO effect on the title! just try it out if you think the menu looks too wedged and keep in mind that you cannot make it smaller than the height needed to display the font correctly. You have to try different values or even change to a smaller font. There are no general settings for that. But be aware of this: if you have icons in your menu, then you will stretch them too.

menu.titleHeight is the same as above but it only affects the menutitle. Again: you can't make the height smaller than the minimal space that is needed to display the font properly.

The rest are usual options for each item (texture, justify, color, colorTo, textColor).

*.title|frame|hilite: <texture> for examples of what textures are, you can go to the texture-examples section.

*.justify: <left|center|right> this is the allignment of the text.

*.color: <color> this is the background color of the item (title, frame ...).

*.colorTo: <color> this is the second color for a gradient texture. If you have a texture such as "flat" or "sunken", you only need the *.color: ...

Something like "flat gradient horizontal" will use the second color to render the texture. See the texture-examples section again.

Toolbar

The next item is the toolbar.

toolbar.bevelWidth: <int>

toolbar.borderWidth: <int>
toolbar.borderColor: <color>

toolbar.height: <int>

toolbar: <texture>
toolbar.color: <color>
toolbar.colorTo: <color>

toolbar.clock: <texture>
toolbar.clock.borderWidth: <int>
toolbar.clock.borderColor: <color>
toolbar.clock.justify: <left|center|right>
toolbar.clock.textColor: <color>
toolbar.clock.color: <color>
toolbar.clock.colorTo: <color>

toolbar.systray: <texture>
toolbar.systray.borderWidth: <int>
toolbar.systray.borderColor: <color>
toolbar.systray.color: <color>
toolbar.systray.colorTo: <color>

toolbar.workspace: <texture>
toolbar.workspace.borderWidth: <int>
toolbar.workspace.borderColor: <color>
toolbar.workspace.justify: <left|center|right>
toolbar.workspace.textColor: <color>
toolbar.workspace.color: <color>
toolbar.workspace.colorTo: <color>

toolbar.button: <texture>
toolbar.button.borderWidth: <int>
toolbar.button.borderColor: <color>
toolbar.button.picColor: <color>
toolbar.button.color: <color>
toolbar.button.colorTo: <color>
toolbar.button.pressed.picColor: <color>
toolbar.button.pressed.color: <color>
toolbar.button.pressed.colorTo: <color>

toolbar.iconbar.empty: <texture>
toolbar.iconbar.empty.color: <color>
toolbar.iconbar.empty.colorTo: <color>

toolbar.iconbar.focused: <texture>
toolbar.iconbar.focused.borderWidth: <int>
toolbar.iconbar.focused.borderColor: <color>
toolbar.iconbar.focused.justify: <left|center|right>
toolbar.iconbar.focused.textColor: <color>
toolbar.iconbar.focused.color: <color>
toolbar.iconbar.focused.colorTo: <color>

toolbar.iconbar.unfocused: <texture>
toolbar.iconbar.unfocused.borderWidth: <int>
toolbar.iconbar.unfocused.borderColor: <color>
toolbar.iconbar.unfocused.justify: <left|center|right>
toolbar.iconbar.unfocused.textColor: <color>
toolbar.iconbar.unfocused.color: <color>
toolbar.iconbar.unfocused.colorTo: <color>

I won't explain the texturizing again its the same as for the menu. I'll just explain the new items.

toolbar.systray colorizing, texturizing and the use of images does not have any influence on the background of gnome-app backgrounds. Icons from applications such as gaim or xchat (all based on gtk2) get their background from the actual gnome/gtk theme. Inly icons of kde-apps (qt) such as klipper or k3b manage to use the toolbar.systray background.

toolbar.height sets the height of the toolbar, BUT only if the value for session.screen*.toolbar.height is set to 0 in the used init file (~/.fluxbox/init in most cases). This prevents the takeover of user settings by the style. You should know that.

toolbar, toolbar.color and toolbar.colorTo are only used if toolbar.bevelWidth is >0. You have the opportunity to colorize the toolbar-bevel with this settings. Look at the picture on the texture-examples section, it is the same as the title for the titlebar and remember: if the bevel is 0, the toolbar settings are not visible.

toolbar.button.picColor sets the color of the arrow inside the toolbar-buttons.

toolbar.button.color sets the background color for all buttons in the toolbar.

toolbar.button.colorTo sets the second background color for gradients.

toolbar.button.pressed.* this is the same as above, only that you can set different colors for the pressed state of the buttons.

toolbar.iconbar.empty.* this is how the iconbar will look like, if no window is open.

toolbar.iconbar.focused.* a window in the iconbar that is focused.

toolbar.iconbar.unfocused.* a window in the iconbar that is unfocused.

Windows

And least but not last the windowdecorations

window.bevelWidth: <int>

window.borderWidth: <int>
window.borderColor: <color>

window.title.height: <int>

window.justify: <left|center|right>

window.label.focus: <texture>
window.label.focus.color: <color>
window.label.focus.colorTo: <color>
window.label.focus.textColor: <color>
window.label.unfocus: <texture>
window.label.unfocus.color: <color>
window.label.unfocus.colorTo: <color>
window.label.unfocus.textColor: <color>

window.button.focus: <texture>
window.button.focus.color: <color>
window.button.focus.colorTo: <color>
window.button.focus.picColor: <color>
window.button.unfocus: <texture>
window.button.unfocus.Color: <color>
window.button.unfocus.ColorTo: <color>
window.button.unfocus.picColor: <color>
window.button.pressed: <texture>
window.button.pressed.color: <color>
window.button.pressed.colorTo: <color>
window.button.pressed.picColor: <color>

window.title.focus: <texture>
window.title.focus.color: <color>
window.title.focus.colorTo: <color>
window.title.unfocus: <texture>
window.title.unfocus.color: <color>
window.title.unfocus.colorTo: <color>

window.handleWidth: <int>
window.handle.focus: <texture>
window.handle.focus.color: <color>
window.handle.focus.colorTo: <color>
window.handle.unfocus: <texture>
window.handle.unfocus.color: <color>
window.handle.unfocus.colorTo: <color>

window.grip.focus: <texture>
window.grip.focus.color: <color>
window.grip.focus.colorTo: <color>
window.grip.unfocus: <texture>
window.grip.unfocus.color: <color>
window.grip.unfocus.colorTo: <color>

Again only the new items. To get a clue of what the components of the window are look at my screenshot and check out the picture at the top of the texture-examples section.

window.title.height: <int> sets the titlebar's height.

window.justify sets the alignment of the text that appears in the titlebar.

window.label.focus.* is for the focused window.

window.label.unfocus.* is for all other windows. Pretty obvious I think.

The window.title.* is only used if window.bevelWidth is >0. Look at the picture on the texture-examples section. If the bevel is 0, the title settings are not visible.

window.handleWidth is a confusing expression. It doesn't set the width of the handle, it sets the height of the handle/grip.

Round Corners

Fluxbox offers some sort of eye-candy if you want to call it like that. You can make the corners of the toolbar/window/menu round.

menu.roundCorners: TopRight TopLeft BottomRight BottomLeft
window.roundCorners: TopRight TopLeft BottomRight BottomLeft
toolbar.shaped: true|false

You can set all corners round or just one or two or three and you can combine them as you like (e.g. only TopLeft BottomRight).

Another thing to know is that e.g. borderless applications with window.roundCorners set, stay round, if you've ever asked yourself how to get this round borderless terms.

The toolbar can only have round corners on the upper side, so toolbar.shaped (true OR false) is all you have to set.

Generalizing (wildcards)

Maybe you have recognized that all components have the same elements such as "border", borderColor. That will lead to an interesting part of Fluxbox styling.

Let's say you want to have the same font for all components. As discribed in Fonts you will have to define the fonts for every single part, but there's a quicker way Fluxbox can handle that.

Instead of writing...

menu.title.font: sans-7
menu.frame.font: sans-7
window.font: sans-7
toolbar.clock.font: sans-7
toolbar.workspace.font: sans-7
toolbar.iconbar.focused.font: sans-7
toolbar.iconbar.unfocused.font: sans-7

...You can simply write

*.font: sans-7

The same wildcard can be used if e.g. you want the entire toolbar to have the same font. Simply wite:

toolbar.*.unfocused.font: sans-7

Just try it out, this way makes it even easier to style Fluxbox.

By the way, due to the asterisk (*) works as a wildcard for the dot (.) you could also write *font: sans-8, but don't try to use this in the middle of an expression. Better use the way above to avoid mistakes.

Pixmap-styles

As for classic styles toolbar.systray colorizing, texturizing and the use of images does not have any influence on the background of gnome-app backgrounds. Icons from applications such as gaim or xchat (all based on gtk2) get their background from the actual gnome/gtk theme. Inly icons of kde-apps (qt) such as klipper or k3b manage to use the toolbar.systray background.

Doing pixmap styles (or any other supported image format) is quite the same as writing a classic style. The only signifficant global change is that the classic texturizing is replaced with an image. To add an important thing:

Just look at the examples below to understand what i mean. This is the clock from the toolbar...

toolbar.clock: <texture>
toolbar.clock.borderWidth: <int>
toolbar.clock.borderColor: <color>
toolbar.clock.justify: <left|center|right>
toolbar.clock.textColor: <color>
toolbar.clock.color: <color>
toolbar.clock.colorTo: <color>

...Replacing the texture relevant parts and replace them with pixmaps means:

toolbar.clock.pixmap: <image file>
toolbar.clock.borderWidth: <int>
toolbar.clock.borderColor: <color>
toolbar.clock.justify: <left|center|right>
toolbar.clock.textColor: <color>

As you can see the things that have changed are:

toolbar.clock: <texture>, toolbar.clock.color: <color> and toolbar.clock.colorTo: <color> are gone.

The line toolbar.clock.pixmap: <image file> was added.

The three exchanged lines from above can be erased or you can leave them in the style, it doesn't matter they have no use in this case. Actually it is logical, because the components's background is no longer rendered. So there's no need for texture options or gradient colors at all.

The following images appear as high as defined by the corresponding *.height value. These images will be stretched horizontally to the length of the part:

The image size for a button should be a 1:1 ratio with the the height/width = *.height since the image is stretched horizontally and vertically if you define *.height bigger than the button-image is.

This sounds confusing the way I explain it, but if you try it should get it clear.

You may play around with different image sizes but believe me, it's just a pain in the back usually.

Furthermore another important thing is: in a classic style all buttons are defined through window.button.*. In a pixmap style you CAN make a image for each button and their states (focused, unfocused, pressed).

You don't have to but you can. To give an example of the buttons you can style look at this:

window.shade.pixmap: shadefcs.xpm
window.shade.unfocus.pixmap: shadeufcs.xpm
window.shade.pressed.pixmap: shadepr.xpm

window.unshade.pixmap: unshadefcs.xpm
window.unshade.unfocus.pixmap: unshadeufcs.xpm
window.unshade.pressed.pixmap: unshadepr.xpm

window.menuicon.pixmap: menuiconfcs.xpm
window.menuicon.unfocus.pixmap: menuiconufcs.xpm
window.menuicon.pressed.pixmap: menuiconpr.xpm

window.close.pixmap: closefcs.xpm
window.close.unfocus.pixmap: closeufcs.xpm
window.close.pressed.pixmap: closepr.xpm

window.iconify.pixmap: minfcs.xpm
window.iconify.unfocus.pixmap: minufcs.xpm
window.iconify.pressed.pixmap: minpr.xpm

window.maximize.pixmap: maxfcs.xpm
window.maximize.unfocus.pixmap: maxufcs.xpm
window.maximize.pressed.pixmap: maxpr.xpm

window.stick.pixmap: stickufcs.xpm
window.stick.unfocus.pixmap: stickufcs.xpm
window.stick.pressed.pixmap: stickpr.xpm

window.stuck.pixmap: stuckfcs.xpm
window.stuck.unfocus.pixmap: stuckufcs.xpm
window.stuck.pressed.pixmap: stuckufcs.xpm

The syntax differs a little bit from the other parts, but again it's really simple to understand. Look at the little screenshot to get a clue what the buttons are.

Some other things are different from classic styles. The bullet and the selection indicator (the little thing to show what configuration options are enabled or what style is selected) can be images.

Furthermore those elements can have different states:

menu.submenu.pixmap: <image file>
menu.hilite.submenu.pixmap: <image file>

menu.selected.pixmap: <image file>
menu.hilite.selected.pixmap: <image file>

menu.unselected.pixmap: <image file>
menu.hilite.unselected.pixmap: <image file>

menu.selected.pixmap and menu.unselected.pixmap are selfexplanary, I think (they are the selection indicators).

The menu.submenu.pixmap entry simply is the well known bullet.

A size of 16x16 for the bullets and selection images seem to be most appropriate. It depents on the fontsize and the menu's bevel how much they will be streched.

The *.hilite.* calls the images that show up when the mouse comes over the line of the menu. You don't have to set them. If nothing is defined, Fluxbox will use the images that are shown when not highlighted.


Style Texture Examples

the common window (only the bar)

bevel1

bevel2

interlaced


flat gradient

window.label.focus: *
window.label.focus.textColor: #a9a9a9
window.label.focus.color: #ffffff
window.label.focus.colorTo: #000000

window.bevelWidth: 4

flat gradient vertical

fl_gr_ver.png

flat gradient horizontal

flat gradient diagonal

flat gradient crossdiagonal

fl_gr_crdia.png

flat gradient elliptic

flat gradient pipecross

flat gradient rectangle

flat gradient pyramid


raised gradient vertical

raised gradient horizontal

raised gradient diagonal

raised gradient crossdiagonal

raised gradient elliptic

raised gradient pipecross

raised gradient rectangle

raised gradient pyramid


sunken gradient vertical

sunken gradient horizontal

sunken gradient diagonal

sunken gradient

sunken gradient elliptic

sunken gradient pipecross

sunken gradient rectangle

sunken gradient pyramid


last update 03/08/2006

HowToFluxboxStyles (last edited 2008-08-06 16:24:42 by localhost)