Xfce Wiki

Sub domains
 

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
howto:xfwm4_theme [2012/05/04 19:04] – [Window Sidebars and bottom] killermoehrehowto:xfwm4_theme [2020/10/15 04:26] (current) – [Introduction] kevinbowen
Line 1: Line 1:
 +~~NOTOC~~
 ====== Xfwm4 theme how-to ====== ====== Xfwm4 theme how-to ======
 +
 +
 +
 +  * **[[#Themes locations|Themes locations]]**
 +  * **[[#Titlebar decorations|Titlebar decorations]]**
 +  * **[[#Window Sidebars and bottom|Window Sidebars and bottom]]**
 +  * **[[#Xfwm4 Buttons|Xfwm4 Buttons]]**
 +  * **[[#Themerc file|Themerc file]]**
 +  * **[[#Gtk Color pickup|Gtk Color pickup]]**
 +  * **[[#XPM (X PixMap) format|XPM (X PixMap) format]]**
 +  * **[[#Xfwm 4.2 new functionality|Xfwm 4.2 new functionality]]**
 +  * **[[#List of frame and button part names|List of frame and button part names]]**
 +  * **[[#Conclusion|Conclusion]]**
 +
 +----
  
  
 ===== Introduction ===== ===== Introduction =====
-Xfwm4, Xfce4's native window manager uses a simple yet flexible pixmap based theme engine using images in .xpm format. Xfwm4 also uses a text file for other configuration options (see themerc section). Further to this you can also make a theme pick up gtk theme colours which will be covered in the gtk color pickup section of the document.+Xfwm4, Xfce's native window manageruses a simple yet flexible pixmap based theme engine using images in .xpm format. Xfwm4 also uses a text file for other configuration options (see themerc section). Further to this you can also make a theme pick up gtk theme colours which will be covered in the gtk color pickup section of the document.
  
 {{ howto:xfwm4:xfwm4-window.gif |Figure 1 - A sample window}} {{ howto:xfwm4:xfwm4-window.gif |Figure 1 - A sample window}}
  
 +----
 ===== Themes locations ===== ===== Themes locations =====
 In Xfwm4 version 4.0, the themes are searched in the following directories: In Xfwm4 version 4.0, the themes are searched in the following directories:
Line 16: Line 33:
  
     * User's home dir /.themes/theme_name/xfwm4 (e.g.: "/home/joe/.themes/b5/xfwm4")     * User's home dir /.themes/theme_name/xfwm4 (e.g.: "/home/joe/.themes/b5/xfwm4")
-    * System's shared data directory /themes/theme_name/xfwm4 (e.g.: "/usr/share/themes/b5/xfwm4"+    * System's shared data directory /themes/theme_name/xfwm4 controlled by the package manager (e.g.: "/usr/share/themes/b5/xfwm4"
 +    * System's shared data directory /local/themes/theme_name/xfwm4 controlled by the local administrator (e.g.: "/usr/local/share/themes/b5/xfwm4")
  
 +[[|Back to Top]]
 +----
  
 ===== Titlebar decorations ===== ===== Titlebar decorations =====
 As windows can be in either active ((focused)) or inactive ((unfocused)) states for which xfwm4 use pixmaps named accordingly e.g. title-1-active.xpm and title-1-inactive.xpm. As windows can be in either active ((focused)) or inactive ((unfocused)) states for which xfwm4 use pixmaps named accordingly e.g. title-1-active.xpm and title-1-inactive.xpm.
  
-For title bar decorations, xfwm4 uses 5 pixmaps named title-1-active.xpm to title-5-active.xpm with top-left-active.xpm and top-right-active.xpm making up the corners on each end as per figure below. +For title bar decorations, xfwm4 uses 5 pixmaps named title-1-active.xpm to title-5-active.xpm with top-left-active.xpm and top-right-active.xpm making up the corners on each end as per figure below.
- +
-{{ howto:xfwm4:xfwm4-window-pixmaps.gif |Figure 2 - The pixmaps that compose the whole window}}+
  
-Pixmaps of a xfwm4 window+|  {{ howto:xfwm4:xfwm4-window-pixmaps.gif |Figure 2 - The pixmaps that compose the whole window}} 
 +|  Figure 2 - The pixmaps that compose the whole window  |
 The same naming convention is true for unfocused windows with the word inactive substituted.e.g. title-1-inactive.xpm The same naming convention is true for unfocused windows with the word inactive substituted.e.g. title-1-inactive.xpm
  
 Title text colour and shadow options, alignment etc are set in the themerc file (detailed in the themerc section). Title text colour and shadow options, alignment etc are set in the themerc file (detailed in the themerc section).
  
 +[[|Back to Top]] 
 +----
  
 ===== Window Sidebars and bottom ===== ===== Window Sidebars and bottom =====
-Each side of a window is made up of  two pixmaps. The pixmaps on the left side are named left-active.xpm and bottom-left-active.xpm. with the right side (of course) being made up of right-active.xpm and bottom-right.active.xpm.+Each side of a window is made up of  two pixmaps. The pixmaps on the left side are named left-active.xpm and bottom-left-active.xpm. with the right side (of course) being made up of right-active.xpm and bottom-right-active.xpm.
  
 The Window bottom grab bar is made up of bottom-active.xpm and bottom-inactive.xpm pixmaps which will be repeated to fit as the window is resized. The Window bottom grab bar is made up of bottom-active.xpm and bottom-inactive.xpm pixmaps which will be repeated to fit as the window is resized.
  
 N.B These pixmaps also make up the mouse grab handles so keep that in mind when deciding how many pixels wide they should be (particularly the bottom-left and bottom right pixmaps which make up the main resize handles on the windows). N.B These pixmaps also make up the mouse grab handles so keep that in mind when deciding how many pixels wide they should be (particularly the bottom-left and bottom right pixmaps which make up the main resize handles on the windows).
 +
 +[[|Back to Top]]
 +----
 +
 ===== Xfwm4 Buttons ===== ===== Xfwm4 Buttons =====
  
 Xfwm4 can use up to six action buttons - stick (sticky windows), menu, shade, hide, maximize and close. Xfwm4 can use up to six action buttons - stick (sticky windows), menu, shade, hide, maximize and close.
  
-Buttons have active ((focused)), inactive ((unfocused)) and pressed states. as per figures 3 below:+Buttons have active ((focused)), inactive ((unfocused)), prelight and pressed states. As per figures 3 below:
 AbiWord Image menu-active.gif    AbiWord Image menu-inactive.gif   AbiWord Image image_2.gif AbiWord Image menu-active.gif    AbiWord Image menu-inactive.gif   AbiWord Image image_2.gif
  
Line 55: Line 78:
 ^ Figure 4 - Stick buttons with extra toggled buttons ^^ ^ Figure 4 - Stick buttons with extra toggled buttons ^^
 |  {{howto:xfwm4:stick-active.gif}} {{howto:xfwm4:stick-inactive.gif}} {{howto:xfwm4:stick-pressed.gif}}     {{howto:xfwm4:stick-toggled-pressed.gif}} {{howto:xfwm4:stick-toggled-active.gif}} {{howto:xfwm4:image_3.gif}}   | |  {{howto:xfwm4:stick-active.gif}} {{howto:xfwm4:stick-inactive.gif}} {{howto:xfwm4:stick-pressed.gif}}     {{howto:xfwm4:stick-toggled-pressed.gif}} {{howto:xfwm4:stick-toggled-active.gif}} {{howto:xfwm4:image_3.gif}}   |
 +
 +Xfwm4 4.6 brings a new button effect of the active window called prelight. Hovering the mouse over the buttons, the picture becomes clearer. Can be used in the six active buttons.
 +
 +[[|Back to Top]]
 +----
  
 ===== Themerc file ===== ===== Themerc file =====
Line 103: Line 131:
  
 The "button_spacing" value gives the number of pixels between each button. The "button_spacing" value gives the number of pixels between each button.
 +
 +The "maximized_offset" value places a space between the right edge (top-right-active) and the button (close, hide...) when maximized.
 +
 +==== App icon ====
 +With **show_app_icon** option you can replace the menu button with application icon. The application icon will be limited by width of menu button. Stay tuned!
 +
 +  * show_app_icon=true //#Shows the application icon//
 +  * show_app_icon=false //#Shows the menu button//
 +
 +If you don't have a menu button, you can use a blank square. Or you cannot use this option.
 +
 +==== Frame border top====
 +XFWM Versions 4.14.1 and above can take advantage of this feature to crop the top frame border of maximized application windows.
 +
 +  * frame_border_top=0 //#Default//
 +
 +{{ howto:xfwm4:frame_border_top-default.png }}
 +
 +  * frame_border_top=2 //#Will crop the top 2 pixels off//
 +
 +{{ howto:xfwm4:frame_border_top-2.png }}
 +
 +
 +[[|Back to Top]]
 +----
  
 ===== Gtk Color pickup ==== ===== Gtk Color pickup ====
-As you have no doubt noticed when using Xfwm4's default theme it is possible to make themes "pick-up" gtk theme colours. It's not just running the gimp and draw the buttonsMost themes use a color symbol table. That means the xpm file must be opened and edited by hand.+As you have no doubt noticed when using Xfwm4's default theme, the theme uses the colors of the current Gtk themeColors for an XFWM theme can be defined in the theme's themrc file. If they are not defined there, they are picked up from the current Gtk theme. The following colors are used:
  
-The color symbols are as follow : +^ Name ^ Gtk value ^ Description ^ 
-^ Name ^ Description ^ +| active_text_color          | fg[selected] | Text color on title for active window | 
-| active_text_color  | Text color on title for active window | +| inactive_text_color        | fg[insensitive] | Text color on title for inactive window 
-| inactive_text_color | Text color on title for inactive window | +| active_text_shadow_color   | dark[selected] | Shadow color for active window's title | 
-| active_border_color | Very rarely used usually set to black | +| inactive_text_shadow_color | dark[insensitive] | Shadow color for inactive window's title 
-| inactive_border_color | Idem | +| active_border_color        | fg[normal] | Very rarely used usually set to black | 
-| active_color_1 | Background color for active title | +| inactive_border_color      | fg[normal] | Idem | 
-| active_color_2 | Background color for active window | +| active_color_1             | bg[selected] | Background color for active title | 
-| active_hilight_1 | Lighter color for active title for 3D look | +| active_color_2             | bg[normal] | Background color for active window | 
-| active_hilight_2 | Lighter color for active window | +| active_hilight_1           | light[selected] | Lighter color for active title for 3D look | 
-| active_mid_1 | Slightly darker color for active title | +| active_hilight_2           | light[normal] | Lighter color for active window | 
-| active_mid_2 | Slightly darker color for active window | +| active_mid_1               | mid[selected] | Slightly darker color for active title | 
-| active_shadow_1 | Darker color for active title for 3D look | +| active_mid_2               | mid[normal] | Slightly darker color for active window | 
-| active_shadow_2 | Darker color for active window | +| active_shadow_1            | darkselected[] | Darker color for active title for 3D look | 
-| inactive_color_1 | Background color for inactive title | +| active_shadow_2            | dark[normal] | Darker color for active window | 
-| inactive_color_2 | Background color for inactive window | +| inactive_color_1           | bg[insensitive] | Background color for inactive title | 
-| inactive_hilight_1 | Lighter color for inactive title for 3D look | +| inactive_color_2           | bg[normal] | Background color for inactive window | 
-| inactive_hilight_2 | Lighter color for inactive window | +| inactive_hilight_1         | light[insensitive] | Lighter color for inactive title for 3D look | 
-| inactive_mid_1 | Slightly darker color for inactive title | +| inactive_hilight_2         | light[normal] | Lighter color for inactive window | 
-| inactive_mid_2 | Slightly darker color for inactive window | +| inactive_mid_1             | mid[insensitive] | Slightly darker color for inactive title | 
-| inactive_shadow_1 | Darker color for inactive title for 3D look | +| inactive_mid_2             | mid[normal] | Slightly darker color for inactive window | 
-| inactive_shadow_2 | Darker color for inactive window |+| inactive_shadow_1          | dark[insensitive] | Darker color for inactive title for 3D look | 
 +| inactive_shadow_2          | dark[normal] | Darker color for inactive window |
  
-The symbols get replaced by the actual color values at runtime so that the window borders inherits GTK theme colors automatically+The Gtk values "fg" and "bg" are defined in the gtkrc file of the current Gtk theme. Please notice that the values "dark", "light" and "mid" can not be defined in the gtkrc but are computed (dark = 0.7 * bg, light = 1.3 * bg, mid = 0.5 * (dark + light)). 
-Xpm file format used natively by xfwm4 is no more than a plain text file that can be edited with your favorite text editor.+The symbols get replaced by the actual color values at runtime so that the window border can inherit Gtk theme colors automatically, unless they are defined in the themerc.
  
-===== From Wikipedia, the free encyclopedia. =====+To use the defined colors in the XFWM theme, the XPM files have to be edited. Since XPM files are plain text, they can be edited with your favorite text editor. 
 + 
 +[[|Back to Top]] 
 +---- 
 + 
 +===== XPM (X PixMap) format =====
 XPM (X PixMap) is an ASCII image format used by the X Window System. It was created in 1989 by Daniel Dardailler and Colas Nahaboo working in Inria Laboratories, France, and was later enhanced by Arnaud Le Hors. It is intended primarily for creating icons, and supports transparent color. It has a simple structure, deriving from the earlier XBM syntax. It can be created and manipulated using any text editor and can be included in a C language file. XPM (X PixMap) is an ASCII image format used by the X Window System. It was created in 1989 by Daniel Dardailler and Colas Nahaboo working in Inria Laboratories, France, and was later enhanced by Arnaud Le Hors. It is intended primarily for creating icons, and supports transparent color. It has a simple structure, deriving from the earlier XBM syntax. It can be created and manipulated using any text editor and can be included in a C language file.
  
Line 205: Line 264:
 As a matter of fact, "thinking" of the gtk colors as early as drawing the theme can save a lot of time in this phase. If you use the exact same color across all the pixmaps, you can use the Search/Replace functionnality of the text editor to add the color symbols. You could even use a tool such as "sed" to perform mass changes in all the XPM files of the theme. As a matter of fact, "thinking" of the gtk colors as early as drawing the theme can save a lot of time in this phase. If you use the exact same color across all the pixmaps, you can use the Search/Replace functionnality of the text editor to add the color symbols. You could even use a tool such as "sed" to perform mass changes in all the XPM files of the theme.
  
 +[[|Back to Top]] 
 +----
  
  
  
 ===== Xfwm 4.2 new functionality ===== ===== Xfwm 4.2 new functionality =====
-As simple as it is, the color symbol replacement table of the XPM format is not powerfull enough to achive the nice color gradients seen in most recent themes.+As simple as it is, the color symbol replacement table of the XPM format is not powerfull enough to achieve the nice color gradients seen in most recent themes.
  
 Xfwm 4.2 includes yet another functionality that gives real nice result while being still compatible with the previous theme format: It composes the final image from the XPM file and it colors replacement table, and another PNG file with transparency, if present. Xfwm 4.2 includes yet another functionality that gives real nice result while being still compatible with the previous theme format: It composes the final image from the XPM file and it colors replacement table, and another PNG file with transparency, if present.
Line 223: Line 283:
     * It's backward compatible with xfwm4 from Xfce 4.0, the PNG files are just ignored by xfwm4 4.0.     * It's backward compatible with xfwm4 from Xfce 4.0, the PNG files are just ignored by xfwm4 4.0.
  
 +[[|Back to Top]]
  
- +----
-===== Conclusion ===== +
-I hope this small "how-to" for creating themes for xfwm4 will help you design your own themes. It would be great if you could share your themes with others on [[http://www.themedepot.org]] (which is the prefered site for xfce related themes) or from [[http://themes.freshmeat.net]]. +
- +
-you can also find xfce theme at [[http://www.xfce-look.org]]+
  
 ===== List of frame and button part names ===== ===== List of frame and button part names =====
Line 234: Line 291:
 This is a list of all possible part names in a decoration, so you can easily copy and paste them. (Tip: if using Firefox hold Ctrl while dragging, to select cells instead of lines. ;-)) This is a list of all possible part names in a decoration, so you can easily copy and paste them. (Tip: if using Firefox hold Ctrl while dragging, to select cells instead of lines. ;-))
  
-^ Active              ^ Inactive              ^ Pressed (buttons only) ^ +^ Active              ^ Inactive              ^ Prelight (buttons only) ^ Pressed (buttons only) ^ Toggled active (buttons only) ^ Toggled inactive (buttons only) ^ Toggled prelight (buttons only) ^ Toggled pressed (buttons only) ^ 
-| menu-active         | menu-inactive         | menu-pressed     | +| menu-active         | menu-inactive         | menu-prelight     | menu-pressed     |                                                                                                      
-| shade-active        | shade-inactive        | shade-pressed    | +| shade-active        | shade-inactive        | shade-prelight    | shade-pressed    | shade-toggled-active    | shade-toggled-inactive    | shade-toggled-prelight    | shade-toggled-pressed    | 
-| stick-active        | stick-inactive        | stick-pressed    | +| stick-active        | stick-inactive        | stick-prelight    | stick-pressed    | stick-toggled-active    | stick-toggled-inactive    | stick-toggled-prelight    | stick-toggled-pressed    | 
-| hide-active         | hide-inactive         | hide-pressed     | +| hide-active         | hide-inactive         | hide-prelight     | hide-pressed     |                                                                                                      
-| maximize-active     | maximize-inactive     | maximize-pressed | +| maximize-active     | maximize-inactive     | maximize-prelight | maximize-pressed | maximize-toggled-active | maximize-toggled-inactive | maximize-toggled-prelight | maximize-toggled-pressed | 
-| close-active        | close-inactive        | close-pressed    | +| close-active        | close-inactive        | close-prelight    | close-pressed    |                                                                                                      
-| top-left-active     | top-left-inactive                      | +| top-left-active     | top-left-inactive     |                   |                  |                                                                                                      
-| title-1-active      | title-1-inactive      |                  | +| title-1-active      | title-1-inactive      |                   |                  |                                                                                                      
-| title-2-active      | title-2-inactive      |                  | +| title-2-active      | title-2-inactive      |                   |                  |                                                                                                      
-| title-3-active      | title-3-inactive      |                  | +| title-3-active      | title-3-inactive      |                   |                  |                                                                                                      
-| title-4-active      | title-4-inactive      |                  | +| title-4-active      | title-4-inactive      |                   |                  |                                                                                                      
-| title-5-active      | title-5-inactive      |                  | +| title-5-active      | title-5-inactive      |                   |                  |                                                                                                      
-| top-right-active    | top-right-inactive    |                  | +| top-right-active    | top-right-inactive    |                   |                  |                                                                                                      
-| right-active        | right-inactive        |                  | +| right-active        | right-inactive        |                   |                  |                                                                                                      
-| bottom-right-active | bottom-right-inactive |                  | +| bottom-right-active | bottom-right-inactive |                   |                  |                                                                                                      
-| bottom-active       | bottom-inactive                        | +| bottom-active       | bottom-inactive       |                   |                  |                                                                                                      
-| bottom-left-active  | bottom-left-inactive  |                  | +| bottom-left-active  | bottom-left-inactive  |                   |                  |                                                                                                      
-| left-active         | left-inactive                          |+| left-active         | left-inactive         |                   |                  |                         |                                                                              | 
 + 
 +---- 
 + 
 +===== Conclusion ===== 
 +I hope this small "how-to" for creating themes for xfwm4 will help you design your own themes. It would be great if you could share your themes with others on [[http://www.xfce-look.org]] (which is the preferred site for Xfce related themes) or from [[http://browse.deviantart.com/customization/skins/linuxutil/xfce/?alltime=yes#order=9]]. 
  
-===== Credits ===== +[[|Back to Top]] 
-This how-to has been started by Drewbian (drewbian at tsn dot cc) and later modifed by Olivier Fourdan (fourdan at xfce dot org).+---- 
 +[[:howto:install_new_themes:|Back to HowTo install themes page]]