From daeeed6af5275386bed826f600fb2f880a8448e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Erick=20P=C3=A9rez=20Castellanos?= Date: Wed, 22 May 2013 13:38:35 -0400 Subject: [PATCH] Updated docs to reflect the changes. --- TODO | 10 +++++++++- doc/Drawing | 31 ++++++++++++++++--------------- doc/Flows | 10 ++++++++++ doc/Internals | 8 +++----- 4 files changed, 38 insertions(+), 21 deletions(-) diff --git a/TODO b/TODO index 4683d990..6d7161d3 100644 --- a/TODO +++ b/TODO @@ -1,5 +1,12 @@ 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 - Check width of read-only layer in GcalEditDialog - Review the real need of GcalFloatingContainer @@ -13,7 +20,8 @@ TODO - Connect keyboard-shortcuts like Ctrl+Q - Check for the real need of adding timezone, and check everywhere - 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. - Review every g_return_if_fail statement since G_OBJECT macros does that already diff --git a/doc/Drawing b/doc/Drawing index ed57ec47..2dd115dc 100644 --- a/doc/Drawing +++ b/doc/Drawing @@ -2,26 +2,27 @@ GcalWindow +- GtkClutter.Embed::ClutterActor (stage) -----------------------------------+ | | -| +-- ClutterActor (searchbar_actor) -----------------------------------+ | -| | | | -| | | | -| +---------------------------------------------------------------------+ | -| | -| +-- ClutterActor (toolbar_actor) -------------------------------------+ | -| | | | -| | | | -| +---------------------------------------------------------------------+ | -| | -| +-- ClutterActor (contenst_actor) ------------------------------------+ | +| +-- ClutterActor (contents_actor) ------------------------------------+ | | | | | | | +- ClutterActor (sources_actor) --------------------------------+ | | | | | | | | | | +---------------------------------------------------------------+ | | | | | | -| | +- ClutterActor (notebook_actor) -------------------------------+ | | -| | | | | | -| | | | | | -| | | | | | +| | +- ClutterActor (box_actor) ------------------------------------+ | | +| | | +- GdHeaderBar (main_toolbar) -----------------------------+ | | | +| | | | | | | | +| | | +----------------------------------------------------------+ | | | +| | | +- GdRevealer (search_bar) --------------------------------+ | | | +| | | | | | | | +| | | +----------------------------------------------------------+ | | | +| | | +- Gdstack ------------------------------------------------+ | | | +| | | | | | | | +| | | | | | | | +| | | | | | | | +| | | | | | | | +| | | | | | | | +| | | | | | | | +| | | +----------------------------------------------------------+ | | | | | +---------------------------------------------------------------+ | | | | | | | | +- ClutterActor (new_event_actor) ------------------------------+ | | diff --git a/doc/Flows b/doc/Flows index b16cb41b..3fde7367 100644 --- a/doc/Flows +++ b/doc/Flows @@ -3,6 +3,7 @@ These are some of the flows followed inside the application. ### Adding calendar (`gcal_store_add_source`) ### + 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 source we're adding. @@ -18,7 +19,9 @@ source we're adding. //FIXME this wil be later implemented, when needed * Get Object list based on the existing query + ### 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 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. * Update time range in store (a `GcalStore`) * 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) diff --git a/doc/Internals b/doc/Internals index e08d6844..b5138dd9 100644 --- a/doc/Internals +++ b/doc/Internals @@ -2,13 +2,11 @@ Description of some internals of Gnome Calendar Application -* mainToolbar object: +* mainToolbar object (GdHeaderBar type): - Has 3 states: + Has 2 states: 1. Overview - 2. View Event - 3. Edit Event (this one could act as New Event View, - or even as New anything view) + 2. Search * GcalApplication