<- Back to projects page

Cbar - scriptable context sidebar for KDE


Cbar is a sidebar with the following goals:
Cbar wouldn't be created without many other people. Thanks go to:
Author: Krzysztof Lichota <krzysiek-cbar@lichota.net>
Homepage: http://lichota.net/~krzysiek/projects/cbar/
License: GPL v2


October 18, 2006

Release first Ubuntu/Debian package for version 0.9.3.

October 11, 2006

Version 0.9.3 released with new features.

September 28, 2006

Version 0.9.2 released with speedup improvements and removing Kross dependency.

August 27, 2006

Version 0.9.1 with bugfix for configuration saving released.

August 25, 2006

Initial version 0.9.0 released.


Version 0.9.3

New script manager

New script manager

New widget - file management actions

File management actions widget

Version 0.9.0 (beta1 aka "Warsaw Uprising")

Screenshot 1 - Cbar after selecting archive file

Screenshot 2 - HTML file, open with contains 2 applications. Clicking on app starts it.

Screenshot 3 - preview of image file

Screenshot 4 - 2 items selected, note that "Open with" group automatically hidden itself as there are no actions possible

Screenshot 5 - metadata information for image file, Places group has been folded to not use space

Screenshot 6 - script configuration dialog

Screenshot 7 - context information for opened image file

Screenshot 8 - eject button appears when CD item is selected


Version 0.9.3 (October 11, 2006) 

Download source: cbar-0.9.3.tar.gz
Download Ubuntu/Debian package (warning - no dependencies!): cbar_0.9.3-1_i386.deb

Changes since last version:
Requirements and installation the same as in version 0.9.2.

Version 0.9.2 (September 28, 2006) 

First beta version for users.

Download: cbar-0.9.2.tar.gz
Requirements (for compilation):
Changes since last version:

Installation has been tested on Kubuntu 6.06 and KDE 3.5.3.

Version 0.9.1 (August 27, 2006)

Bugfix release fixing problem with saving configuration of enabled scripts.
Download: cbar-0.9.1.tar.gz

Version 0.9.0 (August 25, 2006)

This is beta release aimed mainly at developers (although fully functional) to get feedback.
Installation has been tested on Kubuntu 6.06 and KDE 3.5.3.

Download: cbar-0.9.0.tar.gz
Current issues:
Requirements (for compilation):



For users

Compile and install package. Then add Cbar sidebar into Konqueror sidebar - open Konqueror, press F9 to show sidebar, click on configuration button, then "Add new"->"Cbar".
You can configure, which scripts will be enabled by clicking button "Configure scripts" at the top.

For developers

Cbar consists of Cbar library and Cbar sidebar.
Cbar library is aimed at providing generic bar widget, which can be reused in many types of applications. Cbar sidebar is a Konqueror sidebar which uses Cbar library.
As library can be reused in different components, configuration is two-tiered, first subdirectory for specific type of Cbar is checked (based on Cbar name, passed in Cbar constructor), then common configuration file is checked.
Please keep it in mind, for example do not assume Konqueror instance will always be the available in script.

For script writers


In Cbar library C++ part is kept to the minimum possible, all work is delegated to scripts.
There are 3 types of scripts:
All scripts can be replaced. If theme or script loader script is not present, Cbar will try to fall back to default script. Paths to scripts are kept in file ~/.kde/share/config/CbarSidebar/cbarrc. You can modify it to load your scripts for testing. Note that ScriptsToLoad section is modified by script configuration dialog, so using it will overwrite your changes in this section.
Example contents of cbarrc:


If you provide paths to your development directory, you don't have to install scripts every time you edit them. Just modify script and run Konqueror again :)

API for scripts

NOTE: API is still unstable and subject to change in future versions.
API for scripts is in module "cbar".  Then you have to create Cbar class instance and you can use its methods.
For widget scripts the most important method is "addCbarWidget(widget, params)".
It takes the following parameters:
addCbarWidget() returns QObject reference, which can be used to connect signals to your widget's slots.
The following signals are currently available:
IMPORTANT: For unknown for me reasons, you have to import all necessary modules in each method. Importing at the module level does not provide proper symbols. 
In your widget you can use any KDE/Qt feature thanks to pyKDE and pyQt. For example, to perform action on Konqueror, you can use DCOP (see otherPlaces script for example how to use DCOP).

Scripts provided with cbar should give you a template how to create your own script. Remember to change .desktop file if you change name of python script!
If you want to install your new script manually, copy .desktop and .py file to directory ~/.kde/share/apps/cbar/scripts/ (or global /usr/share/apps/cbar/scripts/)

Preparing package with script

Script can be installed using configuration window. Such package must contain at least 2 files: scriptname.desktop and scriptname.py. Desktop file contains properties of script (name, type, etc.) and location of .py file. For examples, see desktop files of scripts in package. If there are any other files needed by script, they should be put in subdirectory to avoid clashes between scripts.

To prepare package, pack files into tarred gzip, for example like that:
tar zcf myscript.tgz myscript.desktop myscript.py myscriptfiles/ 

Package must have extension .tgz

This tool is provided "as is". Author is not responsible for any damages done by this tool.

This project is dedicated to OU.