Re: Krusader developer
Jan Lepper
> Hello Jan,
> as you read from Frank's email i'd like to join krusader team to
> contribute to this project.
> If possible i'd like to have some documentation (if you have) or just a
> fast explanation about the project structure maybe on a irc chat or by
> skype.
>
> Thank you for your time
> Giorgio
Hi Giorgio,
first of all thanks for offering your help, and welcome to the team !
Actually I have to say you are right in time :-) - as I'm currently a little
more busy than before.
As for documentation - here is a short overview of what I consider the most
central files/classes of the source tree:
krusader/
--------------------------
krglobal.h
KrGlobal: pointers to global objects -
these shall be removed in the future.
kractions.h
KrActions: historically all actions
(see http://api.kde.org/4.x-api/kdelibs-apidocs/kdeui/html/classKAction.html)
were created by this class.
I have started to split this up and move actions to classes like TabActions,
ListPanelActions and ViewActions,
which all inherit ActionsBase (actionsbase.h).
krslots.h
KRslots: slots for actions in KrAction.
These should be moved to more appropriate places.
krusader.h
Krusader: the main window.
krusaderview.h
KrusaderView: widget containing the actual content of the main window:
the two panelmanagers, the commandline and embedded terminal
and the function buttons.
panelmanager.h
PanelManager: the panelmanager mentioned above,
which contains at least one ore more panels (see below) in tabs.
krusader/Panel/
--------------------------
listpanel.h
ListPanel: this is the container widget which contains the file list view,
the popup panel, various panel-specific buttons and status bars.
panelfunc.h
ListPanelFunc: implementation of of panel-specific actions like
copy/move/etc.
Also maintains the browsing history of the panel.
It holds a reference to a vfs object (see below).
listpanelactions.h
ListPanelActions: panel-specific actions connected
to slots of ListPanel and ListPanelFunc.
krview.h
KrView: abstract class for the file-list view -
ultimately inherited currently by KrInterDetailedView (krinterdetailedview.h)
and KrInterBriefView (krinterbriefview.h).
viewactions.h
ViewActions: view-specific actions.
krusader/VFS/
--------------------------
The filesytem abstraction layer.
This was introduced to Krusader before the KIO framework was there. I'm
currently working on replacing this with KIO in a separate git branch.
--------------------------
vfs.h
vfs: this abstract class represents a directory and,
besides enumerating the content, offers various file operations.
If you've got further questions I suggest we discuss them at
irc://irc.freenode.org/krusader.
Bye,
Jan