Federated_Computer/federated-calendar
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated docs to reflect the changes.

Browse Source
This commit is contained in:
Erick Pérez Castellanos
2014-12-04 17:10:18 -05:00
parent 96b5c26926
commit daeeed6af5
4 changed files with 38 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
TODO
+9 -1
View File
@@ -1,5 +1,12 @@
TODO TODO
- Rework toolbar, migrate to GdHeaderBar
- Remove GcalToolbar actor
- Handle prev/next operation from GcalWindow
- Remove stuff in GcalView and views for handling navigation
- Update views for handle forward/backward vfuncs
- Add disable/enable of views
- Review all-day checkbox and date/time fields interaction in GcalEditDialog - Review all-day checkbox and date/time fields interaction in GcalEditDialog
- Check width of read-only layer in GcalEditDialog - Check width of read-only layer in GcalEditDialog
- Review the real need of GcalFloatingContainer - Review the real need of GcalFloatingContainer
@@ -13,7 +20,8 @@ TODO
- Connect keyboard-shortcuts like Ctrl+Q - Connect keyboard-shortcuts like Ctrl+Q
- Check for the real need of adding timezone, and check everywhere - Check for the real need of adding timezone, and check everywhere
- Connect all dconf options to the program - Connect all dconf options to the program
- Remove body_actor if there's no need of it in the end. - Remove body_actor if there's no need of it in the end
- Remove contents_actor if there's no need of it in the end
- Clear/reorder #include in every header file. - Clear/reorder #include in every header file.
- Review every g_return_if_fail statement since G_OBJECT macros does that - Review every g_return_if_fail statement since G_OBJECT macros does that
already already
doc/Drawing
+16 -15
View File
@@ -2,26 +2,27 @@ GcalWindow
+- GtkClutter.Embed::ClutterActor (stage) -----------------------------------+ +- GtkClutter.Embed::ClutterActor (stage) -----------------------------------+
| | | |
| +-- ClutterActor (searchbar_actor) -----------------------------------+ | | +-- ClutterActor (contents_actor) ------------------------------------+ |
| | | |
| | | |
| +---------------------------------------------------------------------+ |
| |
| +-- ClutterActor (toolbar_actor) -------------------------------------+ |
| | | |
| | | |
| +---------------------------------------------------------------------+ |
| |
| +-- ClutterActor (contenst_actor) ------------------------------------+ |
| | | | | | | |
| | +- ClutterActor (sources_actor) --------------------------------+ | | | | +- ClutterActor (sources_actor) --------------------------------+ | |
| | | | | | | | | | | |
| | +---------------------------------------------------------------+ | | | | +---------------------------------------------------------------+ | |
| | | | | | | |
| | +- ClutterActor (notebook_actor) -------------------------------+ | | | | +- ClutterActor (box_actor) ------------------------------------+ | |
| | | | | | | | | +- GdHeaderBar (main_toolbar) -----------------------------+ | | |
| | | | | | | | | | | | | |
| | | | | | | | | +----------------------------------------------------------+ | | |
| | | +- GdRevealer (search_bar) --------------------------------+ | | |
| | | | | | | |
| | | +----------------------------------------------------------+ | | |
| | | +- Gdstack ------------------------------------------------+ | | |
| | | | | | | |
| | | | | | | |
| | | | | | | |
| | | | | | | |
| | | | | | | |
| | | | | | | |
| | | +----------------------------------------------------------+ | | |
| | +---------------------------------------------------------------+ | | | | +---------------------------------------------------------------+ | |
| | | | | | | |
| | +- ClutterActor (new_event_actor) ------------------------------+ | | | | +- ClutterActor (new_event_actor) ------------------------------+ | |
doc/Flows
+10
View File
@@ -3,6 +3,7 @@
These are some of the flows followed inside the application. These are some of the flows followed inside the application.
### Adding calendar (`gcal_store_add_source`) ### ### Adding calendar (`gcal_store_add_source`) ###
Sources are added defined by an URI, at least for now. I think there's Sources are added defined by an URI, at least for now. I think there's
work been done on improving this, but for now, there and URI defining every work been done on improving this, but for now, there and URI defining every
source we're adding. source we're adding.
@@ -18,7 +19,9 @@ source we're adding.
//FIXME this wil be later implemented, when needed //FIXME this wil be later implemented, when needed
* Get Object list based on the existing query * Get Object list based on the existing query
### Setting a view in the main window (`gcal_main_window_set_view`) ### ### Setting a view in the main window (`gcal_main_window_set_view`) ###
This will work for setting a new view (the app hasn't instanced a view This will work for setting a new view (the app hasn't instanced a view
of that type yet), or for updating an old view with a new time lapse of that type yet), or for updating an old view with a new time lapse
@@ -26,3 +29,10 @@ of that type yet), or for updating an old view with a new time lapse
* Retrieve new time range from view. * Retrieve new time range from view.
* Update time range in store (a `GcalStore`) * Update time range in store (a `GcalStore`)
* Update `GcalMainWindow.view_type` * Update `GcalMainWindow.view_type`
### Starting the application ###
* Instantiate every view (here I'm doubt yet if I'll fill the view with it's children event widgets)
* Set every view to the actual date (or the one got from the settings)
* Set the last active view as active (got from the settings)
doc/Internals
+3 -5
View File
@@ -2,13 +2,11 @@
Description of some internals of Gnome Calendar Application Description of some internals of Gnome Calendar Application
* mainToolbar object: * mainToolbar object (GdHeaderBar type):
Has 3 states: Has 2 states:
1. Overview 1. Overview
2. View Event 2. Search
3. Edit Event (this one could act as New Event View,
or even as New anything view)
* GcalApplication * GcalApplication