~ubuntu-branches/ubuntu/wily/zanshin/wily-proposed

« back to all changes in this revision

Viewing changes to HACKING

Committer: Bazaar Package Importer
Author(s): Jonathan Riddell
Date: 2009-08-13 23:19:32 UTC
Revision ID: james.westby@ubuntu.com-20090813231932-lewqphiry1qs7w80

Tags: upstream-0.1+svn1006410

Import upstream version 0.1+svn1006410

files added:

AUTHORS

CMakeLists.txt

COPYING

COPYING.LIB

HACKING

Messages.sh

TODO

gpl-2.0.txt

gpl-3.0.txt

src/CMakeLists.txt

src/actionduedatedelegate.cpp

src/actionduedatedelegate.h

src/actionlistdelegate.cpp

src/actionlistdelegate.h

src/actionlisteditor.cpp

src/actionlisteditor.h

src/actionlistmodel.cpp

src/actionlistmodel.h

src/actionlistview.cpp

src/actionlistview.h

src/configdialog.cpp

src/configdialog.h

src/contextsmodel.cpp

src/contextsmodel.h

src/globalmodel.cpp

src/globalmodel.h

src/globalsettings.kcfg

src/globalsettings.kcfgc

src/kdateedit.cpp

src/kdateedit.h

src/kdatepickerpopup.cpp

src/kdatepickerpopup.h

src/librarymodel.cpp

src/librarymodel.h

src/main.cpp

src/mainwindow.cpp

src/mainwindow.h

src/projectsmodel.cpp

src/projectsmodel.h

src/quickselectdialog.cpp

src/quickselectdialog.h

src/sidebar.cpp

src/sidebar.h

src/tests

src/tests/CMakeLists.txt

src/tests/librarymodeltest.cpp

src/tests/modeltestbase.cpp

src/tests/modeltestbase.h

src/tests/todocategoriesmodeltest.cpp

src/tests/todoflatmodeltest.cpp

src/tests/todotreemodeltest.cpp

src/tests/unittestenv

src/tests/unittestenv/config.xml

src/tests/unittestenv/kdehome

src/tests/unittestenv/kdehome/share

src/tests/unittestenv/kdehome/share/config

src/tests/unittestenv/kdehome/share/config/akonadi-firstrunrc

src/tests/unittestenv/kdehome/share/config/akonadi_ical_resource_0rc

src/tests/unittestenv/kdehome/share/config/kdebugrc

src/tests/unittestenv/kdehome/share/config/kdedrc

src/tests/unittestenv/kdehome/testdata.ics

src/tests/unittestenv/xdgconfig

src/tests/unittestenv/xdglocal

src/todocategoriesattribute.cpp

src/todocategoriesattribute.h

src/todocategoriesmodel.cpp

src/todocategoriesmodel.h

src/todoflatmodel.cpp

src/todoflatmodel.h

src/todotreemodel.cpp

src/todotreemodel.h

src/zanshin.desktop

src/zanshinui.rc

Show diffs side-by-side

added added

removed removed

HACKING

* Coding style: http://techbase.kde.org/Policies/Kdelibs_Coding_Style

It's basically the same than the kdelibs coding style as linked above.

* Contributing to Zanshin

Patches should be sent for review to Kevin Ottens <ervin@kde.org> before

being committed to Subversion. If major user interface changes are being

made, a screenshot of what the application looks like after the change

should be sent along with the patch.

* Design

Model Layer:

------------

The application is built around a set of item models and views. GlobalModel

is a singleton in charge of creating all the models used in the application.

- At the there's TodoFlatModel, which lists all the todo contained in a

resource.

- Above it there's TodoTreeModel, which exposes a tree of todo based on their

relateToUid property.

- There's also TodoCategoriesModel, which exposes a tree of todo based on

their categories (a todo can have several categories, then it appears

several times in the tree).

- ProjectsModel and ContextsModel expose only the non-todo subset of the two

previous models.

- LibraryModel which wraps a model and add two entries to it: Inbox and

Library (Inbox is empty, and Library contains the source model).

So inside GlobalModel the link between models is the following:

tree model --------- projects model --- library model

flat model

categories model --- contexts model --- library model

View Layer:

-----------

Also we have a special model to show action lists, this model should be

considered as being part of the view layer since it has no other feature

than ensuring a proper layout of our lists. It can be used on top of:

- TodoFlatModel

- TodoTreeModel

- TodoCategoriesModel

This model works along with with ActionListView and ActionListDelegate to

visually obtain a nice action list with sections. It is part of the central

view.

The mainwindow is split into a sidebar and the action list editor. They both

provide the actions you can use with them.

- SideBar allows to display the contexts LibraryModel or the projects

LibraryModel depending on which mode the application is on.

- ActionListEditor allows to display action lists and add (or remove) items

to them.

Older »