From 6f34c0ceafd92a5266d531484d8ec5b822c10aa2 Mon Sep 17 00:00:00 2001 From: Jean Sirmai Date: Fri, 25 Oct 2024 17:32:30 +0200 Subject: [PATCH] doxygen: all functions documented --- doc/docbook/annotated.xml | 4 +- doc/docbook/d0/d00/middle_8c.xml | 21 +- doc/docbook/d1/d00/camera_8c.xml | 18 +- doc/docbook/d1/d04/investigate_8c.xml | 18 +- ..._2main__window_2one__rule_2dispatch_8c.xml | 39 +- doc/docbook/d3/d09/widget_2manager_8c.xml | 24 +- ...2main__window_2all__rules_2dispatch_8c.xml | 18 +- doc/docbook/d4/d01/identity_8c.xml | 10 +- doc/docbook/d4/d02/edit_8c.xml | 18 +- doc/docbook/d5/d02/data__list_8c.xml | 10 +- doc/docbook/d5/d03/left_8c.xml | 75 +- doc/docbook/d5/d05/organize_8c.xml | 18 +- doc/docbook/d5/d0a/modal_8c.xml | 26 +- doc/docbook/d6/d07/freq_8c.xml | 18 +- doc/docbook/d6/d08/labo_8c.xml | 14 +- doc/docbook/d7/d00/pilot__box_8c.xml | 33 +- doc/docbook/d7/d06/utilities_8c.xml | 8 +- doc/docbook/d7/d07/structStack.xml | 11 +- doc/docbook/d8/d06/signal_8c.xml | 49 + doc/docbook/d8/d09/signal_8h.xml | 49 + ...et_2main__window_2measure_2dispatch_8c.xml | 243 ++++- doc/docbook/d9/d0d/interest_8c.xml | 20 +- doc/docbook/da/d0e/center_8c.xml | 38 +- doc/docbook/db/d02/designer_8c.xml | 10 +- doc/docbook/db/d02/geometry_8c.xml | 18 +- doc/docbook/db/d05/display_8c.xml | 33 +- ...dget_2main__window_2synth_2dispatch_8c.xml | 48 +- doc/docbook/db/d07/assign_8c.xml | 8 +- doc/docbook/db/d07/bottom_8c.xml | 33 +- doc/docbook/dc/d04/top_8c.xml | 15 +- doc/docbook/dc/d0b/disp__list_8c.xml | 14 +- ...et_2main__window_2results_2dispatch_8c.xml | 18 +- ...indow_2one__rule_2algebra_2dispatch_8c.xml | 14 +- doc/docbook/dd/d01/fsm_8h.xml | 8 +- doc/docbook/dd/d09/dialog_8c.xml | 8 +- doc/docbook/de/d0e/conditions_8c.xml | 8 +- doc/docbook/df/d03/time_8c.xml | 18 +- doc/docbook/df/d05/widget_8h.xml | 908 +++++++++++++----- ...ndow_2one__rule_2geometry_2dispatch_8c.xml | 24 +- ...dget_2main__window_2state_2dispatch_8c.xml | 82 +- doc/rtfm/Once upon a time, | 34 + doc/rtfm/man3/Stack.3 | 12 +- doc/rtfm/man3/WANT_TO_START_ON_ANOTHER_PAGE.3 | 1 + .../man3/WANT_TO_START_ON_ANOTHER_PAGE_.3 | 1 + doc/rtfm/man3/assign.c.3 | 5 +- doc/rtfm/man3/bottom.c.3 | 22 +- doc/rtfm/man3/camera.c.3 | 12 +- doc/rtfm/man3/center.c.3 | 16 +- doc/rtfm/man3/conditions.c.3 | 5 +- doc/rtfm/man3/data_list.c.3 | 8 +- doc/rtfm/man3/designer.c.3 | 10 +- doc/rtfm/man3/dialog.c.3 | 3 - doc/rtfm/man3/disp_list.c.3 | 12 +- doc/rtfm/man3/display.c.3 | 22 +- doc/rtfm/man3/edit.c.3 | 12 +- doc/rtfm/man3/freq.c.3 | 12 +- doc/rtfm/man3/fsm.h.3 | 6 +- doc/rtfm/man3/geometry.c.3 | 12 +- doc/rtfm/man3/identity.c.3 | 3 - doc/rtfm/man3/interest.c.3 | 13 +- doc/rtfm/man3/investigate.c.3 | 12 +- doc/rtfm/man3/labo.c.3 | 5 +- doc/rtfm/man3/left.c.3 | 62 +- doc/rtfm/man3/manager.c.3 | 9 - doc/rtfm/man3/middle.c.3 | 8 +- doc/rtfm/man3/modal.c.3 | 11 +- doc/rtfm/man3/on_switch_state_rules_data.3 | 1 + doc/rtfm/man3/organize.c.3 | 12 +- doc/rtfm/man3/pilot_box.c.3 | 22 +- doc/rtfm/man3/signal.c.3 | 43 + doc/rtfm/man3/signal.h.3 | 43 + doc/rtfm/man3/time.c.3 | 12 +- doc/rtfm/man3/top.c.3 | 10 +- doc/rtfm/man3/utilities.c.3 | 5 +- doc/rtfm/man3/widget.h.3 | 583 +++++++++-- ...t_get_selected_rule_assignments_list_btt.3 | 1 + include/fsm.h | 6 +- include/signal.h | 1 + include/widget.h | 2 +- src/fsm/measures/data_list.c | 14 +- src/fsm/measures/disp_list.c | 28 +- src/signal.c | 41 +- src/widget/dialog.c | 2 - .../main_window/all_rules/compare/interest.c | 4 +- src/widget/main_window/all_rules/dispatch.c | 2 +- src/widget/main_window/all_rules/tree/freq.c | 2 +- src/widget/main_window/all_rules/tree/labo.c | 2 +- .../main_window/all_rules/tree/pilot_box.c | 7 +- src/widget/main_window/designer.c | 7 +- src/widget/main_window/measure/dispatch.c | 32 +- .../main_window/one_rule/algebra/assign.c | 4 +- .../main_window/one_rule/algebra/conditions.c | 4 +- .../main_window/one_rule/algebra/dispatch.c | 6 +- .../main_window/one_rule/algebra/identity.c | 3 +- .../main_window/one_rule/algebra/utilities.c | 2 +- src/widget/main_window/one_rule/dispatch.c | 10 +- .../main_window/one_rule/geometry/camera.c | 2 +- .../main_window/one_rule/geometry/dispatch.c | 9 +- .../main_window/one_rule/geometry/edit.c | 2 +- .../main_window/one_rule/geometry/geometry.c | 2 +- .../one_rule/geometry/investigate.c | 2 +- src/widget/main_window/results/dispatch.c | 2 +- src/widget/main_window/results/display.c | 4 +- src/widget/main_window/results/organize.c | 2 +- src/widget/main_window/state/bottom.c | 4 +- src/widget/main_window/state/dispatch.c | 47 +- src/widget/main_window/state/middle.c | 10 +- src/widget/main_window/state/top.c | 2 +- src/widget/main_window/synth/dispatch.c | 6 +- src/widget/main_window/synth/time.c | 2 +- src/widget/main_window/topbar/center.c | 4 +- src/widget/main_window/topbar/left.c | 23 +- src/widget/manager.c | 3 - src/widget/modal.c | 6 +- 114 files changed, 2634 insertions(+), 786 deletions(-) create mode 100644 doc/rtfm/Once upon a time, create mode 100644 doc/rtfm/man3/WANT_TO_START_ON_ANOTHER_PAGE.3 create mode 100644 doc/rtfm/man3/WANT_TO_START_ON_ANOTHER_PAGE_.3 create mode 100644 doc/rtfm/man3/on_switch_state_rules_data.3 create mode 100644 doc/rtfm/man3/widget_get_selected_rule_assignments_list_btt.3 diff --git a/doc/docbook/annotated.xml b/doc/docbook/annotated.xml index d36b461..9f37989 100644 --- a/doc/docbook/annotated.xml +++ b/doc/docbook/annotated.xml @@ -23,9 +23,7 @@ Here are the classes, structs, unions and interfaces with brief descriptions:
  • Phantom documentation preferencesslist Phantom documentation -Stack -Phantom documentation -stack_index_t +Stackstack_index_t Phantom documentation TreeNode_t Phantom documentation used to test the functioning of doxygen diff --git a/doc/docbook/d0/d00/middle_8c.xml b/doc/docbook/d0/d00/middle_8c.xml index c6137ba..c49d4d3 100644 --- a/doc/docbook/d0/d00/middle_8c.xml +++ b/doc/docbook/d0/d00/middle_8c.xml @@ -10,9 +10,7 @@ #include "../../../../include/fsm.h"#include "../../../../include/widget.h"#include "../../../../include/signal.h"#include "../../../../include/util.h" Functions - void widget_reset_XYZ_in_state_pane () - -Phantom documentation. + void widget_reset_XYZ_in_state_pane () void * widget_get_space_view (int partition_space_vs_camera) @@ -41,16 +39,25 @@ Parameters -partition_space_vs_camera - - +partition_space_vs_camera - + Returns + +GTK_WIDGET (view_space_vs_camera) + + + +
    + widget_reset_XYZ_in_state_pane() +widget_reset_XYZ_in_state_panemiddle.c +middle.cwidget_reset_XYZ_in_state_pane +void widget_reset_XYZ_in_state_pane ( ) +phantom documentation
    diff --git a/doc/docbook/d1/d00/camera_8c.xml b/doc/docbook/d1/d00/camera_8c.xml index 1c36cdd..5289773 100644 --- a/doc/docbook/d1/d00/camera_8c.xml +++ b/doc/docbook/d1/d00/camera_8c.xml @@ -10,9 +10,7 @@ #include "../../../../../include/fsm.h"#include "../../../../../include/widget.h"#include "../../../../../include/signal.h" Functions - void * widget_get_selected_rule_camera () - -Phantom documentation. + void * widget_get_selected_rule_camera () @@ -23,4 +21,18 @@ This file is part of Gem-graph. +
    +Function Documentation +
    + widget_get_selected_rule_camera() +widget_get_selected_rule_cameracamera.c +camera.cwidget_get_selected_rule_camera +void * widget_get_selected_rule_camera ( ) +Returns + +camera + + +
    +
    diff --git a/doc/docbook/d1/d04/investigate_8c.xml b/doc/docbook/d1/d04/investigate_8c.xml index 37f544b..066de73 100644 --- a/doc/docbook/d1/d04/investigate_8c.xml +++ b/doc/docbook/d1/d04/investigate_8c.xml @@ -10,9 +10,7 @@ #include "../../../../../include/fsm.h"#include "../../../../../include/widget.h"#include "../../../../../include/signal.h" Functions - void * widget_get_rule_investigation_tools () - -Phantom documentation. + void * widget_get_rule_investigation_tools () @@ -23,4 +21,18 @@ This file is part of Gem-graph. +
    +Function Documentation +
    + widget_get_rule_investigation_tools() +widget_get_rule_investigation_toolsinvestigate.c +investigate.cwidget_get_rule_investigation_tools +void * widget_get_rule_investigation_tools ( ) +Returns + +gtk_label_new ("RULE INVESTIGATION") + + +
    +
    diff --git a/doc/docbook/d1/d0b/widget_2main__window_2one__rule_2dispatch_8c.xml b/doc/docbook/d1/d0b/widget_2main__window_2one__rule_2dispatch_8c.xml index f8f80a0..a192150 100644 --- a/doc/docbook/d1/d0b/widget_2main__window_2one__rule_2dispatch_8c.xml +++ b/doc/docbook/d1/d0b/widget_2main__window_2one__rule_2dispatch_8c.xml @@ -10,13 +10,9 @@ #include "../../../../include/fsm.h"#include "../../../../include/widget.h"#include "../../../../include/signal.h" Functions - void * widget_get_selected_rule () - -Phantom documentation. + void * widget_get_selected_rule () - void * widget_get_pane_selected_rule_right () - -Phantom documentation. + void * widget_get_pane_selected_rule_right () @@ -27,4 +23,35 @@ This file is part of Gem-graph. +
    +Function Documentation +
    + widget_get_pane_selected_rule_right() +widget_get_pane_selected_rule_rightdispatch.c +dispatch.cwidget_get_pane_selected_rule_right +void * widget_get_pane_selected_rule_right ( ) +Returns + +GTK_WIDGET (rule_itself_vs_explore_edit_pane) + + +
    +
    + widget_get_selected_rule() +widget_get_selected_ruledispatch.c +dispatch.cwidget_get_selected_rule +void * widget_get_selected_rule ( ) +start_child in GtkPaned rule_itself_vs_explore_edit_pane + +See also + +src/widget/main_window/one_rule/algebra/dispatch/widget_get_selected_rule_algebra() + +src/widget/main_window/one_rule/geometry/dispatch/widget_get_selected_rule_geometry() + +src/widget/main_window/one_rule/dispatch/widget_get_pane_selected_rule_right() + + +
    +
    diff --git a/doc/docbook/d3/d09/widget_2manager_8c.xml b/doc/docbook/d3/d09/widget_2manager_8c.xml index 8817989..99f6cc1 100644 --- a/doc/docbook/d3/d09/widget_2manager_8c.xml +++ b/doc/docbook/d3/d09/widget_2manager_8c.xml @@ -11,16 +11,10 @@ Functions GtkWindow * widget_get_main_window () - -getter GtkWindow * widget_get_dialog_window () - -getter GtkWindow * widget_get_text_window () - -getter void on_windows_startup (GtkApplication *app) @@ -121,11 +115,7 @@ Parameters widget_get_dialog_window() widget_get_dialog_windowmanager.c manager.cwidget_get_dialog_window -GtkWindow * widget_get_dialog_window ( ) - -getter - - +GtkWindow * widget_get_dialog_window ( ) Since 2024-07 @@ -144,11 +134,7 @@ Parameters widget_get_main_window() widget_get_main_windowmanager.c manager.cwidget_get_main_window -GtkWindow * widget_get_main_window ( ) - -getter - - +GtkWindow * widget_get_main_window ( ) Since 2024-07 @@ -167,11 +153,7 @@ Parameters widget_get_text_window() widget_get_text_windowmanager.c manager.cwidget_get_text_window -GtkWindow * widget_get_text_window ( ) - -getter - - +GtkWindow * widget_get_text_window ( ) Since 2024-07 diff --git a/doc/docbook/d3/d0c/widget_2main__window_2all__rules_2dispatch_8c.xml b/doc/docbook/d3/d0c/widget_2main__window_2all__rules_2dispatch_8c.xml index 223d185..dec40e7 100644 --- a/doc/docbook/d3/d0c/widget_2main__window_2all__rules_2dispatch_8c.xml +++ b/doc/docbook/d3/d0c/widget_2main__window_2all__rules_2dispatch_8c.xml @@ -10,9 +10,7 @@ #include "../../../../include/fsm.h"#include "../../../../include/widget.h"#include "../../../../include/signal.h" Functions - void * widget_get_pane_all_rules_left () - -phantom documentation + void * widget_get_pane_all_rules_left () @@ -23,4 +21,18 @@ This file is part of Gem-graph. +
    +Function Documentation +
    + widget_get_pane_all_rules_left() +widget_get_pane_all_rules_leftdispatch.c +dispatch.cwidget_get_pane_all_rules_left +void * widget_get_pane_all_rules_left ( ) +Returns + +rules_tree_and_pilot_box + + +
    +
    diff --git a/doc/docbook/d4/d01/identity_8c.xml b/doc/docbook/d4/d01/identity_8c.xml index bfa925c..42c8370 100644 --- a/doc/docbook/d4/d01/identity_8c.xml +++ b/doc/docbook/d4/d01/identity_8c.xml @@ -11,8 +11,6 @@ Functions void * widget_get_selected_rule_identity_btt () - -Hosts a list of character strings that can be combined to provide a "human readable" rule identifier.     @@ -29,12 +27,8 @@ widget_get_selected_rule_identity_btt() widget_get_selected_rule_identity_bttidentity.c identity.cwidget_get_selected_rule_identity_btt -void * widget_get_selected_rule_identity_btt ( ) - -Hosts a list of character strings that can be combined to provide a "human readable" rule identifier. - - -This list can also contain non-mandatory elements. +void * widget_get_selected_rule_identity_btt ( ) +Hosts a list of character strings that can be combined to provide a "human readable" rule identifier. This list can also contain non-mandatory elements. Each rule can have a specific "human readable" name chosen by its designer. This name can be used to identify the rule. It is desirable for a unique name to be accepted and shared by as many users as possible. diff --git a/doc/docbook/d4/d02/edit_8c.xml b/doc/docbook/d4/d02/edit_8c.xml index e5ee305..adce89d 100644 --- a/doc/docbook/d4/d02/edit_8c.xml +++ b/doc/docbook/d4/d02/edit_8c.xml @@ -10,9 +10,7 @@ #include "../../../../../include/fsm.h"#include "../../../../../include/widget.h"#include "../../../../../include/signal.h" Functions - void * widget_get_rule_edition_tools () - -Phantom documentation. + void * widget_get_rule_edition_tools () @@ -23,4 +21,18 @@ This file is part of Gem-graph. +
    +Function Documentation +
    + widget_get_rule_edition_tools() +widget_get_rule_edition_toolsedit.c +edit.cwidget_get_rule_edition_tools +void * widget_get_rule_edition_tools ( ) +Returns + +gtk_label_new ("RULE EDITION") + + +
    +
    diff --git a/doc/docbook/d5/d02/data__list_8c.xml b/doc/docbook/d5/d02/data__list_8c.xml index 4efa716..b197e39 100644 --- a/doc/docbook/d5/d02/data__list_8c.xml +++ b/doc/docbook/d5/d02/data__list_8c.xml @@ -29,7 +29,15 @@ a list of available measurements, including those currently in use -This file is part of Gem-graph. An editable list of results is defined and maintained here. Some operations can be performed on them. ex : filter, concat, inverse, scale, correlate, etc. See also +This file is part of Gem-graph. The operations that can be performed on the measurements include: select, copy, edit, erase, parameter (frequency, variable, etc.) + +See also + +http://www.gnuplot.info/ + +https://fr.wikipedia.org/wiki/Gnuplot + +https://fr.wikibooks.org/wiki/Mathc_gnuplot : fsm/measure/manage.c diff --git a/doc/docbook/d5/d03/left_8c.xml b/doc/docbook/d5/d03/left_8c.xml index 1e031d7..4834068 100644 --- a/doc/docbook/d5/d03/left_8c.xml +++ b/doc/docbook/d5/d03/left_8c.xml @@ -4,7 +4,7 @@ src/widget/main_window/topbar/left.c -Topbar left. +Topbar left design. #include "../../../../include/base.h"#include "../../../../include/signal.h"#include "../../../../include/widget.h"#include "../../../../include/fsm.h" @@ -20,55 +20,80 @@ Functions const char * widget_get_btt_label_synth () - -! WARNING ! THE LABELS OF THE PREVIOUS FOUR BUTTONS MUST ONLY BE DEFINED ONCE IN THE PROGRAMME (HERE), AND ONLY USING THE FOUR FOLLOWING FUNCTIONS: - const char * widget_get_btt_label_state () - -btt_state + const char * widget_get_btt_label_state () - const char * widget_get_btt_label_rules () - -btt_rules + const char * widget_get_btt_label_rules () - const char * widget_get_btt_label_data () - -btt_data + const char * widget_get_btt_label_data () void window_design_topbar_left (GtkWidget *header_bar) - -The rules page consists of two half-pages in a GtkPaned widget :
    Detailed Description -Topbar left. +Topbar left design. + +Warning + +THE LABELS OF THE FOUR BUTTONS USED TO SELECT A PAGE IN THE MAIN WINDOW MUST ONLY BE DEFINED ONCE IN THE PROGRAM (in src/main_window/topbar/left/) AND ONLY USING ONE OF THE FOUR 'get_btt_label_' FUNCTIONS DEFINED IN THIS FILE + +
    Function Documentation +
    + widget_get_btt_label_data() +widget_get_btt_label_dataleft.c +left.cwidget_get_btt_label_data +const char * widget_get_btt_label_data ( ) +Returns + +"data" + + +
    +
    + widget_get_btt_label_rules() +widget_get_btt_label_rulesleft.c +left.cwidget_get_btt_label_rules +const char * widget_get_btt_label_rules ( ) +Returns + +"rules" + + +
    +
    + widget_get_btt_label_state() +widget_get_btt_label_stateleft.c +left.cwidget_get_btt_label_state +const char * widget_get_btt_label_state ( ) +Returns + +"state" + + +
    widget_get_btt_label_synth() widget_get_btt_label_synthleft.c left.cwidget_get_btt_label_synth -const char * widget_get_btt_label_synth ( ) +const char * widget_get_btt_label_synth ( ) +Returns -! WARNING ! THE LABELS OF THE PREVIOUS FOUR BUTTONS MUST ONLY BE DEFINED ONCE IN THE PROGRAMME (HERE), AND ONLY USING THE FOUR FOLLOWING FUNCTIONS: +"synth" + - -btt_synth
    window_design_topbar_left() window_design_topbar_leftleft.c left.cwindow_design_topbar_left -void window_design_topbar_left (GtkWidget * header_bar) - -The rules page consists of two half-pages in a GtkPaned widget : - - - +void window_design_topbar_left (GtkWidget * header_bar) +The rules page consists of two half-pages in a GtkPaned widget : on the left, widgets for controlling or editing all the rules. diff --git a/doc/docbook/d5/d05/organize_8c.xml b/doc/docbook/d5/d05/organize_8c.xml index 8825568..96372d3 100644 --- a/doc/docbook/d5/d05/organize_8c.xml +++ b/doc/docbook/d5/d05/organize_8c.xml @@ -10,9 +10,7 @@ #include "../../../../include/base.h"#include "../../../../include/signal.h"#include "../../../../include/widget.h" Functions - void * widget_get_results_box_organize () - -Phantom documentation. + void * widget_get_results_box_organize () @@ -23,4 +21,18 @@ This file is part of Gem-graph.
    +
    +Function Documentation +
    + widget_get_results_box_organize() +widget_get_results_box_organizeorganize.c +organize.cwidget_get_results_box_organize +void * widget_get_results_box_organize ( ) +Returns + +GTK_WIDGET (all_box) + + +
    +
    diff --git a/doc/docbook/d5/d0a/modal_8c.xml b/doc/docbook/d5/d0a/modal_8c.xml index ebce635..d183e00 100644 --- a/doc/docbook/d5/d0a/modal_8c.xml +++ b/doc/docbook/d5/d0a/modal_8c.xml @@ -11,12 +11,8 @@ Functions void widget_design_text_window (GtkWindow *main_window, GtkWindow *text_window) - -modal void * widget_get_text_from_address (gchar *text_address) - -getter @@ -33,11 +29,7 @@ widget_design_text_window() widget_design_text_windowmodal.c modal.cwidget_design_text_window -void widget_design_text_window (GtkWindow * main_window, GtkWindow * text_window) - -modal - - +void widget_design_text_window (GtkWindow * main_window, GtkWindow * text_window) See also src/widget/modal/widget_get_text_from_address() @@ -75,11 +67,7 @@ Parameters widget_get_text_from_address() widget_get_text_from_addressmodal.c modal.cwidget_get_text_from_address -void * widget_get_text_from_address (gchar * text_address) - -getter - - +void * widget_get_text_from_address (gchar * text_address) See also src/widget/modal/widget_design_text_window() @@ -95,16 +83,18 @@ Parameters -*text_address - - +*text_address - + Returns + +GTK_WIDGET (scrolled_window) + +     diff --git a/doc/docbook/d6/d07/freq_8c.xml b/doc/docbook/d6/d07/freq_8c.xml index d57d792..f3074a6 100644 --- a/doc/docbook/d6/d07/freq_8c.xml +++ b/doc/docbook/d6/d07/freq_8c.xml @@ -10,9 +10,7 @@ #include "../../../../../include/fsm.h"#include "../../../../../include/widget.h"#include "../../../../../include/signal.h" Functions - void * widget_get_rules_use () - -phantom documentation + void * widget_get_rules_use () @@ -23,4 +21,18 @@ This file is part of Gem-graph. +
    +Function Documentation +
    + widget_get_rules_use() +widget_get_rules_usefreq.c +freq.cwidget_get_rules_use +void * widget_get_rules_use ( ) +Returns + +scroll_rules_use + + +
    +
    diff --git a/doc/docbook/d6/d08/labo_8c.xml b/doc/docbook/d6/d08/labo_8c.xml index e030d9b..079e6eb 100644 --- a/doc/docbook/d6/d08/labo_8c.xml +++ b/doc/docbook/d6/d08/labo_8c.xml @@ -10,9 +10,7 @@ #include "../../../../../include/widget.h" Functions - void widget_let_us_create_a_complex_useless_and_expensive_tree (struct TreeNode_t *tree_root) - -phantom documentation + void widget_let_us_create_a_complex_useless_and_expensive_tree (struct TreeNode_t *tree_root) @@ -23,4 +21,14 @@ This file is part of Gem-graph. +
    +Function Documentation +
    + widget_let_us_create_a_complex_useless_and_expensive_tree() +widget_let_us_create_a_complex_useless_and_expensive_treelabo.c +labo.cwidget_let_us_create_a_complex_useless_and_expensive_tree +void widget_let_us_create_a_complex_useless_and_expensive_tree (struct TreeNode_t * tree_root) +phantom documentation in a phantom tree... +
    +
    diff --git a/doc/docbook/d7/d00/pilot__box_8c.xml b/doc/docbook/d7/d00/pilot__box_8c.xml index 9023762..a9bb6b0 100644 --- a/doc/docbook/d7/d00/pilot__box_8c.xml +++ b/doc/docbook/d7/d00/pilot__box_8c.xml @@ -10,13 +10,9 @@ #include "../../../../../include/fsm.h"#include "../../../../../include/widget.h"#include "../../../../../include/signal.h" Functions - void * widget_get_rules_pilot_box () - -phantom documentation + void * widget_get_rules_pilot_box () - void * widget_get_rules_tree_tools () - -phantom documentation + void * widget_get_rules_tree_tools () @@ -27,4 +23,29 @@ This file is part of Gem-graph. +
    +Function Documentation +
    + widget_get_rules_pilot_box() +widget_get_rules_pilot_boxpilot_box.c +pilot_box.cwidget_get_rules_pilot_box +void * widget_get_rules_pilot_box ( ) +Returns + +rules_pilot_box + + +
    +
    + widget_get_rules_tree_tools() +widget_get_rules_tree_toolspilot_box.c +pilot_box.cwidget_get_rules_tree_tools +void * widget_get_rules_tree_tools ( ) +Returns + +GTK_WIDGET (rules_tree_box) + + +
    +
    diff --git a/doc/docbook/d7/d06/utilities_8c.xml b/doc/docbook/d7/d06/utilities_8c.xml index 667621c..6bfd9dd 100644 --- a/doc/docbook/d7/d06/utilities_8c.xml +++ b/doc/docbook/d7/d06/utilities_8c.xml @@ -24,8 +24,6 @@ Functions GtkEntry widget_set_item_text (GtkWidget *list_box, const char *text, bool editable) - -Format an entry (a text item) in a list. @@ -44,10 +42,8 @@ widget_set_item_text() widget_set_item_textutilities.c utilities.cwidget_set_item_text -GtkEntry widget_set_item_text (GtkWidget * list_box, const char * text, bool editable) - -Format an entry (a text item) in a list. - +GtkEntry widget_set_item_text (GtkWidget * list_box, const char * text, bool editable) +Format an entry (a text item) in a list. Since diff --git a/doc/docbook/d7/d07/structStack.xml b/doc/docbook/d7/d07/structStack.xml index 9ab8561..e9f2110 100644 --- a/doc/docbook/d7/d07/structStack.xml +++ b/doc/docbook/d7/d07/structStack.xml @@ -2,11 +2,6 @@
    Stack Struct Reference Stack - - -phantom documentation - - Public Attributes @@ -23,7 +18,11 @@
    Detailed Description -phantom documentation +Returns + +popped + + The documentation for this struct was generated from the following file: src/widget/main_window/all_rules/compare/interest.c
    diff --git a/doc/docbook/d8/d06/signal_8c.xml b/doc/docbook/d8/d06/signal_8c.xml index ef08b6a..8516632 100644 --- a/doc/docbook/d8/d06/signal_8c.xml +++ b/doc/docbook/d8/d06/signal_8c.xml @@ -53,6 +53,10 @@ void on_toggle_state_rules_data (GtkWidget *toggled_button, gpointer widget_all_vs_selected_one) since 2024-06 + + void on_switch_state_rules_data () + +This function could remain static in src/signal. void on_clicked_topbar_right_search (GtkWidget *btt_menu, gpointer list_box) @@ -806,6 +810,51 @@ Parameters
    +
    + on_switch_state_rules_data() +on_switch_state_rules_datasignal.c +signal.con_switch_state_rules_data +void on_switch_state_rules_data ( ) + +This function could remain static in src/signal. + + +It is provisionally non static to be visible from the documentation (2024-10) + +See also + +fsm_get_state_rules_data() + +widget_get_main_window() + +widget_get_page_synth() + +widget_get_page_state() + +widget_get_pane_all_rules_left() + +widget_get_pane_selected_rule_right() + +? see src/widget/main_window/measure/widget_get_page_measure() + +See also + +src/widget/main_window/widget_get_page_data() + +on_toggle_exec_edit() + +on_toggle_state_rules_data() + +The rules page consists of two half-pages in a GtkPaned widget : + +on the left, widgets for controlling or editing all the rules. + +on the right, widgets for controlling or editing the selected rule. + + + +Instead of having a: "widget_get_rules_page()" function, this distribution is moved here. (see also widget/topbar/left design) window_design_topbar_left() +
    on_toggle_exec_edit() on_toggle_exec_editsignal.c diff --git a/doc/docbook/d8/d09/signal_8h.xml b/doc/docbook/d8/d09/signal_8h.xml index 3e1a8fd..cd5636c 100644 --- a/doc/docbook/d8/d09/signal_8h.xml +++ b/doc/docbook/d8/d09/signal_8h.xml @@ -21,6 +21,10 @@ void on_toggle_state_rules_data (GtkWidget *btt_STATE_RULES_DATA, gpointer user_data) since 2024-06 + + void on_switch_state_rules_data () + +This function could remain static in src/signal. void on_save_current_model_before_editing (GtkWidget *btt_SAVE_CURRENT_MODEL, gpointer data) @@ -814,6 +818,51 @@ Parameters
    +
    + on_switch_state_rules_data() +on_switch_state_rules_datasignal.h +signal.hon_switch_state_rules_data +void on_switch_state_rules_data ( ) + +This function could remain static in src/signal. + + +It is provisionally non static to be visible from the documentation (2024-10) + +See also + +fsm_get_state_rules_data() + +widget_get_main_window() + +widget_get_page_synth() + +widget_get_page_state() + +widget_get_pane_all_rules_left() + +widget_get_pane_selected_rule_right() + +? see src/widget/main_window/measure/widget_get_page_measure() + +See also + +src/widget/main_window/widget_get_page_data() + +on_toggle_exec_edit() + +on_toggle_state_rules_data() + +The rules page consists of two half-pages in a GtkPaned widget : + +on the left, widgets for controlling or editing all the rules. + +on the right, widgets for controlling or editing the selected rule. + + + +Instead of having a: "widget_get_rules_page()" function, this distribution is moved here. (see also widget/topbar/left design) window_design_topbar_left() +
    on_toggle_exec_edit() on_toggle_exec_editsignal.h diff --git a/doc/docbook/d9/d01/widget_2main__window_2measure_2dispatch_8c.xml b/doc/docbook/d9/d01/widget_2main__window_2measure_2dispatch_8c.xml index 4edf2a8..06fb5f8 100644 --- a/doc/docbook/d9/d01/widget_2main__window_2measure_2dispatch_8c.xml +++ b/doc/docbook/d9/d01/widget_2main__window_2measure_2dispatch_8c.xml @@ -10,69 +10,37 @@ #include "../../../../include/util.h"#include "../../../../include/base.h"#include "../../../../include/signal.h"#include "../../../../include/widget.h"#include "../../../../include/fsm.h" Functions - void * widget_measure_event_occurences_nb () - -Phantom documentation. + void * widget_measure_event_occurences_nb () - void * widget_measure_event_occurences_dates () - -Phantom documentation. + void * widget_measure_event_occurences_dates () - void * widget_measure_event_occurences_situations () - -Phantom documentation. + void * widget_measure_event_occurences_situations () - void * widget_measure_time_elapsed_between_two_events () - -Phantom documentation. + void * widget_measure_time_elapsed_between_two_events () - void * widget_measure_third_event_occurences_in_between () - -Phantom documentation. + void * widget_measure_third_event_occurences_in_between () - void * widget_measure_do_end_creation_of_measurement_process () - -Phantom documentation. + void * widget_measure_do_end_creation_of_measurement_process () - void * widget_measure_do_insert_in_measurements_list () - -Phantom documentation. + void * widget_measure_do_insert_in_measurements_list () - void * widget_measure_do_correlate () - -Phantom documentation. + void * widget_measure_do_correlate () - void * widget_measure_do_depends_on_a_single_event () - -Phantom documentation. + void * widget_measure_do_depends_on_a_single_event () - void * widget_measure_do_select_a_second_rules_set () - -Phantom documentation. + void * widget_measure_do_select_a_second_rules_set () - void * widget_measure_do_choose_an_event_type () - -Phantom documentation. + void * widget_measure_do_choose_an_event_type () - void * widget_measure_new () - -Phantom documentation. + void * widget_measure_new () - void * widget_measure_do_depends_on_two_events () - -Phantom documentation. + void * widget_measure_do_depends_on_two_events () - void * widget_measure_do_depends_on_one_or_two_events () - -Phantom documentation. + void * widget_measure_do_depends_on_one_or_two_events () - void * widget_measure_do_select_rules_first () - -Phantom documentation. + void * widget_measure_do_select_rules_first () - void * widget_get_page_measure () - -Phantom documentation. + void * widget_get_page_measure () @@ -83,4 +51,183 @@ This file is part of Gem-graph.
    +
    +Function Documentation +
    + widget_get_page_measure() +widget_get_page_measuredispatch.c +dispatch.cwidget_get_page_measure +void * widget_get_page_measure ( ) +Returns + +measure_page + + +
    +
    + widget_measure_do_choose_an_event_type() +widget_measure_do_choose_an_event_typedispatch.c +dispatch.cwidget_measure_do_choose_an_event_type +void * widget_measure_do_choose_an_event_type ( ) +Returns + +measure_page + + +
    +
    + widget_measure_do_correlate() +widget_measure_do_correlatedispatch.c +dispatch.cwidget_measure_do_correlate +void * widget_measure_do_correlate ( ) +Returns + +measure_page + + +
    +
    + widget_measure_do_depends_on_a_single_event() +widget_measure_do_depends_on_a_single_eventdispatch.c +dispatch.cwidget_measure_do_depends_on_a_single_event +void * widget_measure_do_depends_on_a_single_event ( ) +Returns + +measure_page + + +
    +
    + widget_measure_do_depends_on_one_or_two_events() +widget_measure_do_depends_on_one_or_two_eventsdispatch.c +dispatch.cwidget_measure_do_depends_on_one_or_two_events +void * widget_measure_do_depends_on_one_or_two_events ( ) +Returns + +measure_page + + +
    +
    + widget_measure_do_depends_on_two_events() +widget_measure_do_depends_on_two_eventsdispatch.c +dispatch.cwidget_measure_do_depends_on_two_events +void * widget_measure_do_depends_on_two_events ( ) +Returns + +NULL + + +
    +
    + widget_measure_do_end_creation_of_measurement_process() +widget_measure_do_end_creation_of_measurement_processdispatch.c +dispatch.cwidget_measure_do_end_creation_of_measurement_process +void * widget_measure_do_end_creation_of_measurement_process ( ) +Returns + +measure_page + + +
    +
    + widget_measure_do_insert_in_measurements_list() +widget_measure_do_insert_in_measurements_listdispatch.c +dispatch.cwidget_measure_do_insert_in_measurements_list +void * widget_measure_do_insert_in_measurements_list ( ) +Returns + +measure_page + + +
    +
    + widget_measure_do_select_a_second_rules_set() +widget_measure_do_select_a_second_rules_setdispatch.c +dispatch.cwidget_measure_do_select_a_second_rules_set +void * widget_measure_do_select_a_second_rules_set ( ) +Returns + +measure_page + + +
    +
    + widget_measure_do_select_rules_first() +widget_measure_do_select_rules_firstdispatch.c +dispatch.cwidget_measure_do_select_rules_first +void * widget_measure_do_select_rules_first ( ) +Returns + +measure_page + + +
    +
    + widget_measure_event_occurences_dates() +widget_measure_event_occurences_datesdispatch.c +dispatch.cwidget_measure_event_occurences_dates +void * widget_measure_event_occurences_dates ( ) +Returns + +measure_page + + +
    +
    + widget_measure_event_occurences_nb() +widget_measure_event_occurences_nbdispatch.c +dispatch.cwidget_measure_event_occurences_nb +void * widget_measure_event_occurences_nb ( ) +Returns + +measure_page + + +
    +
    + widget_measure_event_occurences_situations() +widget_measure_event_occurences_situationsdispatch.c +dispatch.cwidget_measure_event_occurences_situations +void * widget_measure_event_occurences_situations ( ) +Returns + +measure_page + + +
    +
    + widget_measure_new() +widget_measure_newdispatch.c +dispatch.cwidget_measure_new +void * widget_measure_new ( ) +Returns + +NULL + + +
    +
    + widget_measure_third_event_occurences_in_between() +widget_measure_third_event_occurences_in_betweendispatch.c +dispatch.cwidget_measure_third_event_occurences_in_between +void * widget_measure_third_event_occurences_in_between ( ) +Returns + +measure_page + + +
    +
    + widget_measure_time_elapsed_between_two_events() +widget_measure_time_elapsed_between_two_eventsdispatch.c +dispatch.cwidget_measure_time_elapsed_between_two_events +void * widget_measure_time_elapsed_between_two_events ( ) +Returns + +measure_page + + +
    +
    diff --git a/doc/docbook/d9/d0d/interest_8c.xml b/doc/docbook/d9/d0d/interest_8c.xml index 71372eb..2f4469a 100644 --- a/doc/docbook/d9/d0d/interest_8c.xml +++ b/doc/docbook/d9/d0d/interest_8c.xml @@ -11,8 +11,6 @@ Classes struct Stack - -phantom documentation @@ -32,9 +30,7 @@ Functions - void * widget_get_an_impression_of_what_a_rules_comparator_could_be () - -phantom documentation + void * widget_get_an_impression_of_what_a_rules_comparator_could_be () @@ -45,4 +41,18 @@ This file is part of Gem-graph. +
    +Function Documentation +
    + widget_get_an_impression_of_what_a_rules_comparator_could_be() +widget_get_an_impression_of_what_a_rules_comparator_could_beinterest.c +interest.cwidget_get_an_impression_of_what_a_rules_comparator_could_be +void * widget_get_an_impression_of_what_a_rules_comparator_could_be ( ) +Returns + +comparator + + +
    +
    diff --git a/doc/docbook/da/d0e/center_8c.xml b/doc/docbook/da/d0e/center_8c.xml index 541901c..9b4e83c 100644 --- a/doc/docbook/da/d0e/center_8c.xml +++ b/doc/docbook/da/d0e/center_8c.xml @@ -4,21 +4,49 @@ src/widget/main_window/topbar/center.c -Topbar center. +Topbar center design. #include "../../../../include/base.h"#include "../../../../include/signal.h"#include "../../../../include/widget.h"#include "../../../../include/fsm.h" Functions - void window_design_topbar_center (GtkWidget *topbar) - -title + void window_design_topbar_center (GtkWidget *topbar)
    Detailed Description -Topbar center. +Topbar center design. +
    +
    +Function Documentation +
    + window_design_topbar_center() +window_design_topbar_centercenter.c +center.cwindow_design_topbar_center +void window_design_topbar_center (GtkWidget * topbar) + + + +Parameters + + + + + + + +*topbar + + + + + +
    +     +     +     +
    diff --git a/doc/docbook/db/d02/designer_8c.xml b/doc/docbook/db/d02/designer_8c.xml index a1ac7ce..dd679cf 100644 --- a/doc/docbook/db/d02/designer_8c.xml +++ b/doc/docbook/db/d02/designer_8c.xml @@ -4,7 +4,7 @@ src/widget/main_window/designer.c -builds ans present +designs and presents #include "../../../include/widget.h"#include "../../../include/fsm.h"#include "../../../include/util.h" @@ -17,11 +17,9 @@
    Detailed Description -builds ans present +designs and presents -This file is part of Gem-graph. - -ensure the titlebar and the pages are available and init them +ensures the titlebar and the pages are available and init them triggers assembly of the topbar and the default page @@ -39,7 +37,7 @@ ‍the "all rules" page gives access to the hierarchy of all rules
    ‍the "selected rule" page lets you examine and modify one selected rule -
    +This file is part of Gem-graph.
    diff --git a/doc/docbook/db/d02/geometry_8c.xml b/doc/docbook/db/d02/geometry_8c.xml index 9ed49d4..0c4e926 100644 --- a/doc/docbook/db/d02/geometry_8c.xml +++ b/doc/docbook/db/d02/geometry_8c.xml @@ -10,9 +10,7 @@ #include "../../../../../include/fsm.h"#include "../../../../../include/widget.h"#include "../../../../../include/signal.h" Functions - void * widget_get_selected_rule_before_after () - -Phantom documentation. + void * widget_get_selected_rule_before_after () @@ -23,4 +21,18 @@ This file is part of Gem-graph. +
    +Function Documentation +
    + widget_get_selected_rule_before_after() +widget_get_selected_rule_before_aftergeometry.c +geometry.cwidget_get_selected_rule_before_after +void * widget_get_selected_rule_before_after ( ) +Returns + +GTK_WIDGET (before_vs_after) + + +
    +
    diff --git a/doc/docbook/db/d05/display_8c.xml b/doc/docbook/db/d05/display_8c.xml index b90538f..06b2f72 100644 --- a/doc/docbook/db/d05/display_8c.xml +++ b/doc/docbook/db/d05/display_8c.xml @@ -10,13 +10,9 @@ #include "../../../../include/base.h"#include "../../../../include/signal.h"#include "../../../../include/widget.h" Functions - void * widget_get_results_box_time () - -Phantom documentation. + void * widget_get_results_box_time () - void * widget_get_results_box_display () - -Phantom documentation. + void * widget_get_results_box_display () @@ -27,4 +23,29 @@ This file is part of Gem-graph. +
    +Function Documentation +
    + widget_get_results_box_display() +widget_get_results_box_displaydisplay.c +display.cwidget_get_results_box_display +void * widget_get_results_box_display ( ) +Returns + +GTK_WIDGET (data_box) + + +
    +
    + widget_get_results_box_time() +widget_get_results_box_timedisplay.c +display.cwidget_get_results_box_time +void * widget_get_results_box_time ( ) +Returns + +GTK_WIDGET (time_box) + + +
    +
    diff --git a/doc/docbook/db/d06/widget_2main__window_2synth_2dispatch_8c.xml b/doc/docbook/db/d06/widget_2main__window_2synth_2dispatch_8c.xml index 12392b0..74e89cd 100644 --- a/doc/docbook/db/d06/widget_2main__window_2synth_2dispatch_8c.xml +++ b/doc/docbook/db/d06/widget_2main__window_2synth_2dispatch_8c.xml @@ -10,17 +10,11 @@ #include "../../../../include/base.h"#include "../../../../include/signal.h"#include "../../../../include/widget.h" Functions - void * widget_get_non_time_dependent () - -Phantom documentation. + void * widget_get_non_time_dependent () - void * widget_get_space_vs_non_time_dependent () - -Phantom documentation. + void * widget_get_space_vs_non_time_dependent () - void * widget_get_page_synth () - -Phantom documentation. + void * widget_get_page_synth () @@ -29,4 +23,40 @@ main_window synthetic view +
    +Function Documentation +
    + widget_get_non_time_dependent() +widget_get_non_time_dependentdispatch.c +dispatch.cwidget_get_non_time_dependent +void * widget_get_non_time_dependent ( ) +Returns + +results_box + + +
    +
    + widget_get_page_synth() +widget_get_page_synthdispatch.c +dispatch.cwidget_get_page_synth +void * widget_get_page_synth ( ) +Returns + +space_and_analysis_vs_history + + +
    +
    + widget_get_space_vs_non_time_dependent() +widget_get_space_vs_non_time_dependentdispatch.c +dispatch.cwidget_get_space_vs_non_time_dependent +void * widget_get_space_vs_non_time_dependent ( ) +Returns + +space_vs_non_time_dependent_analysis + + +
    +
    diff --git a/doc/docbook/db/d07/assign_8c.xml b/doc/docbook/db/d07/assign_8c.xml index 4c6fec8..d44b415 100644 --- a/doc/docbook/db/d07/assign_8c.xml +++ b/doc/docbook/db/d07/assign_8c.xml @@ -11,8 +11,6 @@ Functions void * widget_get_selected_rule_assignments_list_btt () - -Presents the list of all the elementary actions (assignments) performed when the rule is applied.     @@ -29,10 +27,8 @@ widget_get_selected_rule_assignments_list_btt() widget_get_selected_rule_assignments_list_bttassign.c assign.cwidget_get_selected_rule_assignments_list_btt -void * widget_get_selected_rule_assignments_list_btt ( ) - -Presents the list of all the elementary actions (assignments) performed when the rule is applied. - +void * widget_get_selected_rule_assignments_list_btt ( ) +Presents the list of all the elementary actions (assignments) performed when the rule is applied. Today, an arbitrary presentation with no link to the XML model and no verification of compliance with the meta-rules. (see below) TODO diff --git a/doc/docbook/db/d07/bottom_8c.xml b/doc/docbook/db/d07/bottom_8c.xml index 31befb3..c4da115 100644 --- a/doc/docbook/db/d07/bottom_8c.xml +++ b/doc/docbook/db/d07/bottom_8c.xml @@ -10,13 +10,9 @@ #include "../../../../include/fsm.h"#include "../../../../include/widget.h"#include "../../../../include/signal.h" Functions - void * widget_get_space_edit_control () - -Phantom documentation. + void * widget_get_space_edit_control () - void * widget_get_sequence_control () - -Phantom documentation. + void * widget_get_sequence_control () @@ -25,4 +21,29 @@ main_window state view > bottom part of the view +
    +Function Documentation +
    + widget_get_sequence_control() +widget_get_sequence_controlbottom.c +bottom.cwidget_get_sequence_control +void * widget_get_sequence_control ( ) +Returns + +GTK_WIDGET (SEQUENCE_CONTROL_box) + + +
    +
    + widget_get_space_edit_control() +widget_get_space_edit_controlbottom.c +bottom.cwidget_get_space_edit_control +void * widget_get_space_edit_control ( ) +Returns + +GTK_WIDGET ("SPACE EDIT") + + +
    +
    diff --git a/doc/docbook/dc/d04/top_8c.xml b/doc/docbook/dc/d04/top_8c.xml index ff90a16..44dc442 100644 --- a/doc/docbook/dc/d04/top_8c.xml +++ b/doc/docbook/dc/d04/top_8c.xml @@ -16,9 +16,7 @@ void widget_set_situations_value (int value) - void * widget_get_graph_view_control () - -Phantom documentation. + void * widget_get_graph_view_control () @@ -29,6 +27,17 @@
    Function Documentation +
    + widget_get_graph_view_control() +widget_get_graph_view_controltop.c +top.cwidget_get_graph_view_control +void * widget_get_graph_view_control ( ) +Returns + +objects_vs_situations_horizontal_pane + + +
    widget_get_object_transparency() widget_get_object_transparencytop.c diff --git a/doc/docbook/dc/d0b/disp__list_8c.xml b/doc/docbook/dc/d0b/disp__list_8c.xml index 189a52e..b1d933c 100644 --- a/doc/docbook/dc/d0b/disp__list_8c.xml +++ b/doc/docbook/dc/d0b/disp__list_8c.xml @@ -4,7 +4,7 @@ src/fsm/measures/disp_list.c -a list of displayable results, including those currently displayed Gem-graph-client list (and current use) +A list of displayable results (whether currently displayed or not). #include <stdbool.h>#include <stdio.h>#include <stdlib.h>#include "../../../include/fsm.h" @@ -21,9 +21,17 @@
    Detailed Description -a list of displayable results, including those currently displayed Gem-graph-client list (and current use) +A list of displayable results (whether currently displayed or not). -This file is part of Gem-graph. An editable list of results is defined and maintained here. Some operations can be performed on them. ex : filter, concat, inverse, scale, correlate, etc. See also +This file is part of Gem-graph. The operations that can be performed on the results include: select, copy, erase, filter, concat, inverse, scale, correlate, etc. + +The format of the results must be compatible with the formats recognised by the usual presentation software. + +"graph", "chart", "plot" and "diagram" are ambiguous terms, used interchangeably. + +NB some data may be displayed simultaneously in different pages ex : pages 'synth' & 'results' + +See also : fsm/measure/manage.c diff --git a/doc/docbook/dc/d0c/widget_2main__window_2results_2dispatch_8c.xml b/doc/docbook/dc/d0c/widget_2main__window_2results_2dispatch_8c.xml index 5ba555d..3ebe524 100644 --- a/doc/docbook/dc/d0c/widget_2main__window_2results_2dispatch_8c.xml +++ b/doc/docbook/dc/d0c/widget_2main__window_2results_2dispatch_8c.xml @@ -10,9 +10,7 @@ #include "../../../../include/base.h"#include "../../../../include/signal.h"#include "../../../../include/widget.h" Functions - void * widget_get_page_data () - -Phantom documentation. + void * widget_get_page_data () @@ -23,4 +21,18 @@ This file is part of Gem-graph.
    +
    +Function Documentation +
    + widget_get_page_data() +widget_get_page_datadispatch.c +dispatch.cwidget_get_page_data +void * widget_get_page_data ( ) +Returns + +measures_and_results + + +
    +
    diff --git a/doc/docbook/dc/d0e/widget_2main__window_2one__rule_2algebra_2dispatch_8c.xml b/doc/docbook/dc/d0e/widget_2main__window_2one__rule_2algebra_2dispatch_8c.xml index 15e7e22..9bf9dcb 100644 --- a/doc/docbook/dc/d0e/widget_2main__window_2one__rule_2algebra_2dispatch_8c.xml +++ b/doc/docbook/dc/d0e/widget_2main__window_2one__rule_2algebra_2dispatch_8c.xml @@ -11,8 +11,6 @@ Functions void * widget_get_selected_rule_algebra () - -Provides the three lists needed to describe a rule algebraically. @@ -31,10 +29,8 @@ widget_get_selected_rule_algebra() widget_get_selected_rule_algebradispatch.c dispatch.cwidget_get_selected_rule_algebra -void * widget_get_selected_rule_algebra ( ) - -Provides the three lists needed to describe a rule algebraically. - +void * widget_get_selected_rule_algebra ( ) +Provides the three lists needed to describe a rule algebraically. The algebraic definition of a rule comprises three types of character strings organised into three lists: @@ -58,7 +54,11 @@ src/widget/one_rule/algebra/identity() -src/widget/one_rule/dispatch() +src/widget/one_rule/dispatch() + +Returns + +GTK_WIDGET (conditions_actions_names_box)
    diff --git a/doc/docbook/dd/d01/fsm_8h.xml b/doc/docbook/dd/d01/fsm_8h.xml index 0a39119..3f15f6a 100644 --- a/doc/docbook/dd/d01/fsm_8h.xml +++ b/doc/docbook/dd/d01/fsm_8h.xml @@ -4,7 +4,7 @@ include/fsm.h -fsm (Finite State Machine) header +FSM (Finite State Machine) header. #include <stdbool.h>#include <stddef.h>#include <string.h>#include <gtk-4.0/gtk/gtk.h> @@ -110,7 +110,7 @@ , RULES_PAGE , MEASURES_PAGE , RESULTS_PAGE -, SenumYNTH_GLAREA +, SYNTH_GLAREA , SYNTH_ALL_RESULTS , SYNTH_TIME_DEP_RESULTS , SYNTH_TIME_INDEP_RESULTS @@ -144,7 +144,7 @@ , SLIDER , EXPANDER , ENTRY -, SWITCH_STATE_RULES_DATA +, ON_SWITCH_STATE_RULES_DATA , SLIDER_X , SLIDER_Y , SLIDER_Z @@ -318,7 +318,7 @@
    Detailed Description -fsm (Finite State Machine) header +FSM (Finite State Machine) header. This file is part of Gem-graph.
    diff --git a/doc/docbook/dd/d09/dialog_8c.xml b/doc/docbook/dd/d09/dialog_8c.xml index 124ecd6..f27fe11 100644 --- a/doc/docbook/dd/d09/dialog_8c.xml +++ b/doc/docbook/dd/d09/dialog_8c.xml @@ -11,8 +11,6 @@ Functions void widget_design_dialog_window (GtkWindow *main_window, GtkWindow *dialog_window) - -modal     @@ -29,11 +27,7 @@ widget_design_dialog_window() widget_design_dialog_windowdialog.c dialog.cwidget_design_dialog_window -void widget_design_dialog_window (GtkWindow * main_window, GtkWindow * dialog_window) - -modal - - +void widget_design_dialog_window (GtkWindow * main_window, GtkWindow * dialog_window) See also src/fsm/dispatch/fsm_journal_event() diff --git a/doc/docbook/de/d0e/conditions_8c.xml b/doc/docbook/de/d0e/conditions_8c.xml index 73b4e9b..3aba2cb 100644 --- a/doc/docbook/de/d0e/conditions_8c.xml +++ b/doc/docbook/de/d0e/conditions_8c.xml @@ -11,8 +11,6 @@ Functions void * widget_get_selected_rule_conditions_list_btt () - -Builds and presents the conditions list of a rule. @@ -29,10 +27,8 @@ widget_get_selected_rule_conditions_list_btt() widget_get_selected_rule_conditions_list_bttconditions.c conditions.cwidget_get_selected_rule_conditions_list_btt -void * widget_get_selected_rule_conditions_list_btt ( ) - -Builds and presents the conditions list of a rule. - +void * widget_get_selected_rule_conditions_list_btt ( ) +Builds and presents the conditions list of a rule. This list sets out all the conditions that the rule must meet in order to be applied. diff --git a/doc/docbook/df/d03/time_8c.xml b/doc/docbook/df/d03/time_8c.xml index 64c9b01..6ce32e0 100644 --- a/doc/docbook/df/d03/time_8c.xml +++ b/doc/docbook/df/d03/time_8c.xml @@ -10,9 +10,7 @@ #include "../../../../include/base.h"#include "../../../../include/signal.h"#include "../../../../include/widget.h" Functions - void * widget_get_time_dependent () - -Phantom documentation. + void * widget_get_time_dependent () @@ -21,4 +19,18 @@ main_window synthetic view time dependent functions +
    +Function Documentation +
    + widget_get_time_dependent() +widget_get_time_dependenttime.c +time.cwidget_get_time_dependent +void * widget_get_time_dependent ( ) +Returns + +time_box + + +
    +
    diff --git a/doc/docbook/df/d05/widget_8h.xml b/doc/docbook/df/d05/widget_8h.xml index bf8332f..ba816e4 100644 --- a/doc/docbook/df/d05/widget_8h.xml +++ b/doc/docbook/df/d05/widget_8h.xml @@ -125,96 +125,54 @@ Functions GtkWindow * widget_get_main_window () - -getter GtkWindow * widget_get_dialog_window () - -getter GtkWindow * widget_get_text_window () - -getter void widget_design_main_window (GtkWindow *main_window, GtkApplication *app) void widget_design_dialog_window (GtkWindow *main_window, GtkWindow *dialog_window) - -modal void widget_design_text_window (GtkWindow *main_window, GtkWindow *text_window) - -modal const char * widget_get_btt_label_synth () - -! WARNING ! THE LABELS OF THE PREVIOUS FOUR BUTTONS MUST ONLY BE DEFINED ONCE IN THE PROGRAMME (HERE), AND ONLY USING THE FOUR FOLLOWING FUNCTIONS: - const char * widget_get_btt_label_state () - -btt_state + const char * widget_get_btt_label_state () - const char * widget_get_btt_label_rules () - -btt_rules + const char * widget_get_btt_label_rules () - const char * widget_get_btt_label_data () - -btt_data + const char * widget_get_btt_label_data () - void window_design_topbar_center (GtkWidget *topbar) - -title + void window_design_topbar_center (GtkWidget *topbar) void window_design_topbar_left (GtkWidget *header_bar) - -The rules page consists of two half-pages in a GtkPaned widget : void window_design_topbar_right (GtkWidget *header_bar, GtkApplication *app) GtkWidget * widget_get_topbar (GtkApplication *app) - void * widget_get_page_synth () - -Phantom documentation. + void * widget_get_page_synth () - void * widget_get_page_state () - -Phantom documentation. + void * widget_get_page_state () - void * widget_get_page_data () - -Phantom documentation. + void * widget_get_page_data () - void * widget_get_page_measure () - -Phantom documentation. + void * widget_get_page_measure () - void * widget_get_time_dependent () - -Phantom documentation. + void * widget_get_time_dependent () - void * widget_get_space_vs_non_time_dependent () - -Phantom documentation. + void * widget_get_space_vs_non_time_dependent () - void * widget_get_non_time_dependent () - -Phantom documentation. + void * widget_get_non_time_dependent () void * widget_get_space_view (int partition_space_vs_camera) - void * widget_get_graph_view_control () - -Phantom documentation. + void * widget_get_graph_view_control () - void * widget_get_space_edit_control () - -Phantom documentation. + void * widget_get_space_edit_control () - void * widget_get_sequence_control () - -Phantom documentation. + void * widget_get_sequence_control () void widget_set_situations_value (int value) @@ -222,85 +180,45 @@ int widget_get_object_transparency (int i) - void widget_reset_XYZ_in_state_pane () - -Phantom documentation. + void widget_reset_XYZ_in_state_pane () - void * widget_get_pane_all_rules_left () - -phantom documentation + void * widget_get_pane_all_rules_left () - void * widget_get_pane_selected_rule_right () - -Phantom documentation. + void * widget_get_pane_selected_rule_right () - void * widget_get_rules_pilot_box () - -phantom documentation + void * widget_get_rules_pilot_box () - void * widget_get_rules_tree_tools () - -phantom documentation + void * widget_get_rules_tree_tools () - void * widget_get_rules_use () - -phantom documentation + void * widget_get_rules_use () - void * widget_get_selected_rule () - -Phantom documentation. + void * widget_get_selected_rule () - void * widget_get_rule_edition_tools () - -Phantom documentation. + void * widget_get_rule_edition_tools () - void * widget_get_rule_investigation_tools () - -Phantom documentation. + void * widget_get_rule_investigation_tools () void * widget_get_selected_rule_algebra () - -Provides the three lists needed to describe a rule algebraically. - void * widget_get_selected_rule_geometry () - -Phantom documentation. + void * widget_get_selected_rule_geometry () void * widget_get_selected_rule_conditions_list_btt () - -Builds and presents the conditions list of a rule. void * widget_get_selected_rule_assignments_list_btt () - -Presents the list of all the elementary actions (assignments) performed when the rule is applied. void * widget_get_selected_rule_identity_btt () - -Hosts a list of character strings that can be combined to provide a "human readable" rule identifier. GtkEntry widget_set_item_text (GtkWidget *list_box, const char *text, bool editable) - -Format an entry (a text item) in a list. - void * widget_get_selected_rule_camera () - -Phantom documentation. + void * widget_get_selected_rule_camera () - void * widget_get_selected_rule_before_after () - -Phantom documentation. + void * widget_get_selected_rule_before_after () - void * widget_get_results_box_organize () - -Phantom documentation. + void * widget_get_results_box_organize () - void * widget_get_results_box_display () - -Phantom documentation. + void * widget_get_results_box_display () - void * widget_get_results_box_time () - -Phantom documentation. + void * widget_get_results_box_time () struct TreeNode_t * widget_create_user_rules_tree_node (const gchar *text) @@ -309,8 +227,6 @@ void * widget_get_user_rules_tree () void * widget_get_text_from_address (gchar *text_name) - -getter char * widget_get_address_text_theory () @@ -318,73 +234,39 @@ char * widget_get_address_text_alpha_index () - void * widget_get_an_impression_of_what_a_rules_comparator_could_be () - -phantom documentation + void * widget_get_an_impression_of_what_a_rules_comparator_could_be () - void widget_let_us_create_a_complex_useless_and_expensive_tree (struct TreeNode_t *tree_root) - -phantom documentation + void widget_let_us_create_a_complex_useless_and_expensive_tree (struct TreeNode_t *tree_root) - void * widget_measure_new () - -Phantom documentation. + void * widget_measure_new () - void * widget_measure_do_select_rules_first () - -Phantom documentation. + void * widget_measure_do_select_rules_first () - void * widget_measure_do_depends_on_one_or_two_events () - -Phantom documentation. + void * widget_measure_do_depends_on_one_or_two_events () - void * widget_measure_do_depends_on_a_single_event () - -Phantom documentation. + void * widget_measure_do_depends_on_a_single_event () - void * widget_measure_do_depends_on_two_events () - -Phantom documentation. + void * widget_measure_do_depends_on_two_events () - void * widget_measure_do_select_a_second_rules_set () - -Phantom documentation. + void * widget_measure_do_select_a_second_rules_set () - void * widget_measure_do_choose_an_event_type () - -Phantom documentation. + void * widget_measure_do_choose_an_event_type () - void * widget_measure_do_correlate () - -Phantom documentation. + void * widget_measure_do_correlate () - void * widget_measure_do_insert_in_measurements_list () - -Phantom documentation. + void * widget_measure_do_insert_in_measurements_list () - void * widget_measure_do_end_creation_of_measurement_process () - -Phantom documentation. + void * widget_measure_do_end_creation_of_measurement_process () - void * widget_measure_event_occurences_nb () - -Phantom documentation. + void * widget_measure_event_occurences_nb () - void * widget_measure_event_occurences_dates () - -Phantom documentation. + void * widget_measure_event_occurences_dates () - void * widget_measure_event_occurences_situations () - -Phantom documentation. + void * widget_measure_event_occurences_situations () - void * widget_measure_time_elapsed_between_two_events () - -Phantom documentation. + void * widget_measure_time_elapsed_between_two_events () - void * widget_measure_third_event_occurences_in_between () - -Phantom documentation. + void * widget_measure_third_event_occurences_in_between () @@ -462,11 +344,7 @@ Parameters widget_design_dialog_window() widget_design_dialog_windowwidget.h widget.hwidget_design_dialog_window -void widget_design_dialog_window (GtkWindow * main_window, GtkWindow * dialog_window) - -modal - - +void widget_design_dialog_window (GtkWindow * main_window, GtkWindow * dialog_window) See also src/fsm/dispatch/fsm_journal_event() @@ -536,11 +414,7 @@ Parameters widget_design_text_window() widget_design_text_windowwidget.h widget.hwidget_design_text_window -void widget_design_text_window (GtkWindow * main_window, GtkWindow * text_window) - -modal - - +void widget_design_text_window (GtkWindow * main_window, GtkWindow * text_window) See also src/widget/modal/widget_get_text_from_address() @@ -607,26 +481,66 @@ Parameters +
    + widget_get_an_impression_of_what_a_rules_comparator_could_be() +widget_get_an_impression_of_what_a_rules_comparator_could_bewidget.h +widget.hwidget_get_an_impression_of_what_a_rules_comparator_could_be +void * widget_get_an_impression_of_what_a_rules_comparator_could_be ( ) +Returns + +comparator + + +
    +
    + widget_get_btt_label_data() +widget_get_btt_label_datawidget.h +widget.hwidget_get_btt_label_data +const char * widget_get_btt_label_data ( ) +Returns + +"data" + + +
    +
    + widget_get_btt_label_rules() +widget_get_btt_label_ruleswidget.h +widget.hwidget_get_btt_label_rules +const char * widget_get_btt_label_rules ( ) +Returns + +"rules" + + +
    +
    + widget_get_btt_label_state() +widget_get_btt_label_statewidget.h +widget.hwidget_get_btt_label_state +const char * widget_get_btt_label_state ( ) +Returns + +"state" + + +
    widget_get_btt_label_synth() widget_get_btt_label_synthwidget.h widget.hwidget_get_btt_label_synth -const char * widget_get_btt_label_synth ( ) +const char * widget_get_btt_label_synth ( ) +Returns -! WARNING ! THE LABELS OF THE PREVIOUS FOUR BUTTONS MUST ONLY BE DEFINED ONCE IN THE PROGRAMME (HERE), AND ONLY USING THE FOUR FOLLOWING FUNCTIONS: +"synth" + - -btt_synth
    widget_get_dialog_window() widget_get_dialog_windowwidget.h widget.hwidget_get_dialog_window -GtkWindow * widget_get_dialog_window ( ) - -getter - - +GtkWindow * widget_get_dialog_window ( ) Since 2024-07 @@ -641,15 +555,22 @@ Parameters
    +
    + widget_get_graph_view_control() +widget_get_graph_view_controlwidget.h +widget.hwidget_get_graph_view_control +void * widget_get_graph_view_control ( ) +Returns + +objects_vs_situations_horizontal_pane + + +
    widget_get_main_window() widget_get_main_windowwidget.h widget.hwidget_get_main_window -GtkWindow * widget_get_main_window ( ) - -getter - - +GtkWindow * widget_get_main_window ( ) Since 2024-07 @@ -664,6 +585,17 @@ Parameters
    +
    + widget_get_non_time_dependent() +widget_get_non_time_dependentwidget.h +widget.hwidget_get_non_time_dependent +void * widget_get_non_time_dependent ( ) +Returns + +results_box + + +
    widget_get_object_transparency() widget_get_object_transparencywidget.h @@ -693,14 +625,245 @@ Parameters
    +
    + widget_get_page_data() +widget_get_page_datawidget.h +widget.hwidget_get_page_data +void * widget_get_page_data ( ) +Returns + +measures_and_results + + +
    +
    + widget_get_page_measure() +widget_get_page_measurewidget.h +widget.hwidget_get_page_measure +void * widget_get_page_measure ( ) +Returns + +measure_page + + +
    +
    + widget_get_page_state() +widget_get_page_statewidget.h +widget.hwidget_get_page_state +void * widget_get_page_state ( ) +L'image de l'état de l'espace (au centre) fait partie d'un panneau "milieu", qui est encadré par les deux panneaux: "haut" et "bas". La partie droite du panneau "milieu" est elle-même un panneau de commandes. + +Si l'on nomme ces panneaux selon leur fonction, on trouvera: + +CONTROL ou EDIT en bas permet de contrôler / choisir un état et / ou de l'éditer. ce panneau peut avoir deux apparences (et fonctions) différentes: + +en mode EDIT, seuls les outils d'édition de l'état sont disponibles + +en mode EXEC, seuls les outils de déplacement dans la séquence sont disponibles + + + +CAMERA à droite permet de choisir la position de la caméra + +CONTRAST en haut permet de modifier un à un les contrastes des objets et des situations afin de mieux mettre en évidence l'objet ou le phénomène d'intérêt + + + + + + + +The state page is horizontally divided in three sections + + + +top: controls on the colors or transparencies of the model objects + +middle: space view on the left / camera on the right + +bottom: depends on the fsm exec/edit state + +- if fsm in on exec mode, bottom displays sequence control widgets + +- if fsm in on edit mode, bottom displays space edition control widgets + + + + + + + +See also + +widget_get_graph_view_control() + +widget_get_space_view() + +widget_get_space_edit_control() + +widget_get_sequence_control() + +fsm_get_exec_edit() + +PARTITION_SPACE_VS_CAMERA_IN_STATE + +PARTITION_SPACE_VS_CONTROLS_1 + +PARTITION_SPACE_VS_CONTROLS_2 + +on_switch_state_rules_data() + +Returns + +view_space_vs_controls + + +
    +
    + widget_get_page_synth() +widget_get_page_synthwidget.h +widget.hwidget_get_page_synth +void * widget_get_page_synth ( ) +Returns + +space_and_analysis_vs_history + + +
    +
    + widget_get_pane_all_rules_left() +widget_get_pane_all_rules_leftwidget.h +widget.hwidget_get_pane_all_rules_left +void * widget_get_pane_all_rules_left ( ) +Returns + +rules_tree_and_pilot_box + + +
    +
    + widget_get_pane_selected_rule_right() +widget_get_pane_selected_rule_rightwidget.h +widget.hwidget_get_pane_selected_rule_right +void * widget_get_pane_selected_rule_right ( ) +Returns + +GTK_WIDGET (rule_itself_vs_explore_edit_pane) + + +
    +
    + widget_get_results_box_display() +widget_get_results_box_displaywidget.h +widget.hwidget_get_results_box_display +void * widget_get_results_box_display ( ) +Returns + +GTK_WIDGET (data_box) + + +
    +
    + widget_get_results_box_organize() +widget_get_results_box_organizewidget.h +widget.hwidget_get_results_box_organize +void * widget_get_results_box_organize ( ) +Returns + +GTK_WIDGET (all_box) + + +
    +
    + widget_get_results_box_time() +widget_get_results_box_timewidget.h +widget.hwidget_get_results_box_time +void * widget_get_results_box_time ( ) +Returns + +GTK_WIDGET (time_box) + + +
    +
    + widget_get_rule_edition_tools() +widget_get_rule_edition_toolswidget.h +widget.hwidget_get_rule_edition_tools +void * widget_get_rule_edition_tools ( ) +Returns + +gtk_label_new ("RULE EDITION") + + +
    +
    + widget_get_rule_investigation_tools() +widget_get_rule_investigation_toolswidget.h +widget.hwidget_get_rule_investigation_tools +void * widget_get_rule_investigation_tools ( ) +Returns + +gtk_label_new ("RULE INVESTIGATION") + + +
    +
    + widget_get_rules_pilot_box() +widget_get_rules_pilot_boxwidget.h +widget.hwidget_get_rules_pilot_box +void * widget_get_rules_pilot_box ( ) +Returns + +rules_pilot_box + + +
    +
    + widget_get_rules_tree_tools() +widget_get_rules_tree_toolswidget.h +widget.hwidget_get_rules_tree_tools +void * widget_get_rules_tree_tools ( ) +Returns + +GTK_WIDGET (rules_tree_box) + + +
    +
    + widget_get_rules_use() +widget_get_rules_usewidget.h +widget.hwidget_get_rules_use +void * widget_get_rules_use ( ) +Returns + +scroll_rules_use + + +
    +
    + widget_get_selected_rule() +widget_get_selected_rulewidget.h +widget.hwidget_get_selected_rule +void * widget_get_selected_rule ( ) +start_child in GtkPaned rule_itself_vs_explore_edit_pane + +See also + +src/widget/main_window/one_rule/algebra/dispatch/widget_get_selected_rule_algebra() + +src/widget/main_window/one_rule/geometry/dispatch/widget_get_selected_rule_geometry() + +src/widget/main_window/one_rule/dispatch/widget_get_pane_selected_rule_right() + + +
    widget_get_selected_rule_algebra() widget_get_selected_rule_algebrawidget.h widget.hwidget_get_selected_rule_algebra -void * widget_get_selected_rule_algebra ( ) - -Provides the three lists needed to describe a rule algebraically. - +void * widget_get_selected_rule_algebra ( ) +Provides the three lists needed to describe a rule algebraically. The algebraic definition of a rule comprises three types of character strings organised into three lists: @@ -724,7 +887,11 @@ Parameters src/widget/one_rule/algebra/identity() -src/widget/one_rule/dispatch() +src/widget/one_rule/dispatch() + +Returns + +GTK_WIDGET (conditions_actions_names_box)
    @@ -732,10 +899,8 @@ Parameters widget_get_selected_rule_assignments_list_btt() widget_get_selected_rule_assignments_list_bttwidget.h widget.hwidget_get_selected_rule_assignments_list_btt -void * widget_get_selected_rule_assignments_list_btt ( ) - -Presents the list of all the elementary actions (assignments) performed when the rule is applied. - +void * widget_get_selected_rule_assignments_list_btt ( ) +Presents the list of all the elementary actions (assignments) performed when the rule is applied. Today, an arbitrary presentation with no link to the XML model and no verification of compliance with the meta-rules. (see below) TODO @@ -763,14 +928,34 @@ Parameters     +
    + widget_get_selected_rule_before_after() +widget_get_selected_rule_before_afterwidget.h +widget.hwidget_get_selected_rule_before_after +void * widget_get_selected_rule_before_after ( ) +Returns + +GTK_WIDGET (before_vs_after) + + +
    +
    + widget_get_selected_rule_camera() +widget_get_selected_rule_camerawidget.h +widget.hwidget_get_selected_rule_camera +void * widget_get_selected_rule_camera ( ) +Returns + +camera + + +
    widget_get_selected_rule_conditions_list_btt() widget_get_selected_rule_conditions_list_bttwidget.h widget.hwidget_get_selected_rule_conditions_list_btt -void * widget_get_selected_rule_conditions_list_btt ( ) - -Builds and presents the conditions list of a rule. - +void * widget_get_selected_rule_conditions_list_btt ( ) +Builds and presents the conditions list of a rule. This list sets out all the conditions that the rule must meet in order to be applied. @@ -802,16 +987,29 @@ Parameters
    +
    + widget_get_selected_rule_geometry() +widget_get_selected_rule_geometrywidget.h +widget.hwidget_get_selected_rule_geometry +void * widget_get_selected_rule_geometry ( ) +split two images versus camera + +See also + +src/widget/main_window/one_rule/dispatch/widget_get_selected_rule() + +widget_get_selected_rule_before_after() + +widget_get_selected_rule_camera() + + +
    widget_get_selected_rule_identity_btt() widget_get_selected_rule_identity_bttwidget.h widget.hwidget_get_selected_rule_identity_btt -void * widget_get_selected_rule_identity_btt ( ) - -Hosts a list of character strings that can be combined to provide a "human readable" rule identifier. - - -This list can also contain non-mandatory elements. +void * widget_get_selected_rule_identity_btt ( ) +Hosts a list of character strings that can be combined to provide a "human readable" rule identifier. This list can also contain non-mandatory elements. Each rule can have a specific "human readable" name chosen by its designer. This name can be used to identify the rule. It is desirable for a unique name to be accepted and shared by as many users as possible. @@ -843,6 +1041,28 @@ Parameters
    +
    + widget_get_sequence_control() +widget_get_sequence_controlwidget.h +widget.hwidget_get_sequence_control +void * widget_get_sequence_control ( ) +Returns + +GTK_WIDGET (SEQUENCE_CONTROL_box) + + +
    +
    + widget_get_space_edit_control() +widget_get_space_edit_controlwidget.h +widget.hwidget_get_space_edit_control +void * widget_get_space_edit_control ( ) +Returns + +GTK_WIDGET ("SPACE EDIT") + + +
    widget_get_space_view() widget_get_space_viewwidget.h @@ -859,26 +1079,35 @@ Parameters -partition_space_vs_camera - - +partition_space_vs_camera - + Returns + +GTK_WIDGET (view_space_vs_camera) + + +
    +
    + widget_get_space_vs_non_time_dependent() +widget_get_space_vs_non_time_dependentwidget.h +widget.hwidget_get_space_vs_non_time_dependent +void * widget_get_space_vs_non_time_dependent ( ) +Returns + +space_vs_non_time_dependent_analysis + +
    widget_get_text_from_address() widget_get_text_from_addresswidget.h widget.hwidget_get_text_from_address -void * widget_get_text_from_address (gchar * text_address) - -getter - - +void * widget_get_text_from_address (gchar * text_address) See also src/widget/modal/widget_design_text_window() @@ -894,26 +1123,24 @@ Parameters -*text_address - - +*text_address - + Returns + +GTK_WIDGET (scrolled_window) + +
    widget_get_text_window() widget_get_text_windowwidget.h widget.hwidget_get_text_window -GtkWindow * widget_get_text_window ( ) - -getter - - +GtkWindow * widget_get_text_window ( ) Since 2024-07 @@ -928,6 +1155,17 @@ Parameters
    +
    + widget_get_time_dependent() +widget_get_time_dependentwidget.h +widget.hwidget_get_time_dependent +void * widget_get_time_dependent ( ) +Returns + +time_box + + +
    widget_get_topbar() widget_get_topbarwidget.h @@ -968,14 +1206,191 @@ Parameters
    +
    + widget_let_us_create_a_complex_useless_and_expensive_tree() +widget_let_us_create_a_complex_useless_and_expensive_treewidget.h +widget.hwidget_let_us_create_a_complex_useless_and_expensive_tree +void widget_let_us_create_a_complex_useless_and_expensive_tree (struct TreeNode_t * tree_root) +phantom documentation in a phantom tree... +
    +
    + widget_measure_do_choose_an_event_type() +widget_measure_do_choose_an_event_typewidget.h +widget.hwidget_measure_do_choose_an_event_type +void * widget_measure_do_choose_an_event_type ( ) +Returns + +measure_page + + +
    +
    + widget_measure_do_correlate() +widget_measure_do_correlatewidget.h +widget.hwidget_measure_do_correlate +void * widget_measure_do_correlate ( ) +Returns + +measure_page + + +
    +
    + widget_measure_do_depends_on_a_single_event() +widget_measure_do_depends_on_a_single_eventwidget.h +widget.hwidget_measure_do_depends_on_a_single_event +void * widget_measure_do_depends_on_a_single_event ( ) +Returns + +measure_page + + +
    +
    + widget_measure_do_depends_on_one_or_two_events() +widget_measure_do_depends_on_one_or_two_eventswidget.h +widget.hwidget_measure_do_depends_on_one_or_two_events +void * widget_measure_do_depends_on_one_or_two_events ( ) +Returns + +measure_page + + +
    +
    + widget_measure_do_depends_on_two_events() +widget_measure_do_depends_on_two_eventswidget.h +widget.hwidget_measure_do_depends_on_two_events +void * widget_measure_do_depends_on_two_events ( ) +Returns + +NULL + + +
    +
    + widget_measure_do_end_creation_of_measurement_process() +widget_measure_do_end_creation_of_measurement_processwidget.h +widget.hwidget_measure_do_end_creation_of_measurement_process +void * widget_measure_do_end_creation_of_measurement_process ( ) +Returns + +measure_page + + +
    +
    + widget_measure_do_insert_in_measurements_list() +widget_measure_do_insert_in_measurements_listwidget.h +widget.hwidget_measure_do_insert_in_measurements_list +void * widget_measure_do_insert_in_measurements_list ( ) +Returns + +measure_page + + +
    +
    + widget_measure_do_select_a_second_rules_set() +widget_measure_do_select_a_second_rules_setwidget.h +widget.hwidget_measure_do_select_a_second_rules_set +void * widget_measure_do_select_a_second_rules_set ( ) +Returns + +measure_page + + +
    +
    + widget_measure_do_select_rules_first() +widget_measure_do_select_rules_firstwidget.h +widget.hwidget_measure_do_select_rules_first +void * widget_measure_do_select_rules_first ( ) +Returns + +measure_page + + +
    +
    + widget_measure_event_occurences_dates() +widget_measure_event_occurences_dateswidget.h +widget.hwidget_measure_event_occurences_dates +void * widget_measure_event_occurences_dates ( ) +Returns + +measure_page + + +
    +
    + widget_measure_event_occurences_nb() +widget_measure_event_occurences_nbwidget.h +widget.hwidget_measure_event_occurences_nb +void * widget_measure_event_occurences_nb ( ) +Returns + +measure_page + + +
    +
    + widget_measure_event_occurences_situations() +widget_measure_event_occurences_situationswidget.h +widget.hwidget_measure_event_occurences_situations +void * widget_measure_event_occurences_situations ( ) +Returns + +measure_page + + +
    +
    + widget_measure_new() +widget_measure_newwidget.h +widget.hwidget_measure_new +void * widget_measure_new ( ) +Returns + +NULL + + +
    +
    + widget_measure_third_event_occurences_in_between() +widget_measure_third_event_occurences_in_betweenwidget.h +widget.hwidget_measure_third_event_occurences_in_between +void * widget_measure_third_event_occurences_in_between ( ) +Returns + +measure_page + + +
    +
    + widget_measure_time_elapsed_between_two_events() +widget_measure_time_elapsed_between_two_eventswidget.h +widget.hwidget_measure_time_elapsed_between_two_events +void * widget_measure_time_elapsed_between_two_events ( ) +Returns + +measure_page + + +
    +
    + widget_reset_XYZ_in_state_pane() +widget_reset_XYZ_in_state_panewidget.h +widget.hwidget_reset_XYZ_in_state_pane +void widget_reset_XYZ_in_state_pane ( ) +phantom documentation +
    widget_set_item_text() widget_set_item_textwidget.h widget.hwidget_set_item_text -GtkEntry widget_set_item_text (GtkWidget * list_box, const char * text, bool editable) - -Format an entry (a text item) in a list. - +GtkEntry widget_set_item_text (GtkWidget * list_box, const char * text, bool editable) +Format an entry (a text item) in a list. Since @@ -1082,16 +1497,39 @@ Parameters
    +
    + window_design_topbar_center() +window_design_topbar_centerwidget.h +widget.hwindow_design_topbar_center +void window_design_topbar_center (GtkWidget * topbar) + + + +Parameters + + + + + + + +*topbar + + + + + +
    +     +     +     +
    window_design_topbar_left() window_design_topbar_leftwidget.h widget.hwindow_design_topbar_left -void window_design_topbar_left (GtkWidget * header_bar) - -The rules page consists of two half-pages in a GtkPaned widget : - - - +void window_design_topbar_left (GtkWidget * header_bar) +The rules page consists of two half-pages in a GtkPaned widget : on the left, widgets for controlling or editing all the rules. diff --git a/doc/docbook/df/d06/widget_2main__window_2one__rule_2geometry_2dispatch_8c.xml b/doc/docbook/df/d06/widget_2main__window_2one__rule_2geometry_2dispatch_8c.xml index c2234bb..67291f6 100644 --- a/doc/docbook/df/d06/widget_2main__window_2one__rule_2geometry_2dispatch_8c.xml +++ b/doc/docbook/df/d06/widget_2main__window_2one__rule_2geometry_2dispatch_8c.xml @@ -10,9 +10,7 @@ #include "../../../../../include/fsm.h"#include "../../../../../include/widget.h"#include "../../../../../include/signal.h" Functions - void * widget_get_selected_rule_geometry () - -Phantom documentation. + void * widget_get_selected_rule_geometry () @@ -23,4 +21,24 @@ This file is part of Gem-graph.
    +
    +Function Documentation +
    + widget_get_selected_rule_geometry() +widget_get_selected_rule_geometrydispatch.c +dispatch.cwidget_get_selected_rule_geometry +void * widget_get_selected_rule_geometry ( ) +split two images versus camera + +See also + +src/widget/main_window/one_rule/dispatch/widget_get_selected_rule() + +widget_get_selected_rule_before_after() + +widget_get_selected_rule_camera() + + +
    +
    diff --git a/doc/docbook/df/d0e/widget_2main__window_2state_2dispatch_8c.xml b/doc/docbook/df/d0e/widget_2main__window_2state_2dispatch_8c.xml index c9ccccd..589c1fb 100644 --- a/doc/docbook/df/d0e/widget_2main__window_2state_2dispatch_8c.xml +++ b/doc/docbook/df/d0e/widget_2main__window_2state_2dispatch_8c.xml @@ -10,9 +10,7 @@ #include "../../../../include/fsm.h"#include "../../../../include/widget.h"#include "../../../../include/signal.h" Functions - void * widget_get_page_state () - -Phantom documentation. + void * widget_get_page_state () @@ -20,5 +18,83 @@ Detailed Description main_window state view dispatcher + +The only function here is widget_get_page_state() which defines the structure of the state page. + +
    +Function Documentation +
    + widget_get_page_state() +widget_get_page_statedispatch.c +dispatch.cwidget_get_page_state +void * widget_get_page_state ( ) +L'image de l'état de l'espace (au centre) fait partie d'un panneau "milieu", qui est encadré par les deux panneaux: "haut" et "bas". La partie droite du panneau "milieu" est elle-même un panneau de commandes. + +Si l'on nomme ces panneaux selon leur fonction, on trouvera: + +CONTROL ou EDIT en bas permet de contrôler / choisir un état et / ou de l'éditer. ce panneau peut avoir deux apparences (et fonctions) différentes: + +en mode EDIT, seuls les outils d'édition de l'état sont disponibles + +en mode EXEC, seuls les outils de déplacement dans la séquence sont disponibles + + + +CAMERA à droite permet de choisir la position de la caméra + +CONTRAST en haut permet de modifier un à un les contrastes des objets et des situations afin de mieux mettre en évidence l'objet ou le phénomène d'intérêt + + + + + + + +The state page is horizontally divided in three sections + + + +top: controls on the colors or transparencies of the model objects + +middle: space view on the left / camera on the right + +bottom: depends on the fsm exec/edit state + +- if fsm in on exec mode, bottom displays sequence control widgets + +- if fsm in on edit mode, bottom displays space edition control widgets + + + + + + + +See also + +widget_get_graph_view_control() + +widget_get_space_view() + +widget_get_space_edit_control() + +widget_get_sequence_control() + +fsm_get_exec_edit() + +PARTITION_SPACE_VS_CAMERA_IN_STATE + +PARTITION_SPACE_VS_CONTROLS_1 + +PARTITION_SPACE_VS_CONTROLS_2 + +on_switch_state_rules_data() + +Returns + +view_space_vs_controls + + +
    diff --git a/doc/rtfm/Once upon a time, b/doc/rtfm/Once upon a time, new file mode 100644 index 0000000..4cb3341 --- /dev/null +++ b/doc/rtfm/Once upon a time, @@ -0,0 +1,34 @@ +Wellcome to Gem-graph ! + +Gem-graph lets you move or transform drawn objects. You can draw anything you like. You can make it move or transform as you like. You can use it to make a game. You can use it to make an animated representation of a phenomenon that interests you (a model). You can represent what you want simply or in more realistic detail. Simple parts and more detailed parts can coexist in the same design. You can watch what you've created evolve without interfering or guiding it towards what you want to achieve. You can observe it in detail, go back, start again, measure, compare and keep the results that interest you so that you can play them again. + +All this comes at a price. A complicated model will require more work than a simpler one, but it is possible to start with something simple and develop it little by little. In any case, you must draw what you want to see and say how you want it to move. Gem-graph can't do that for you. Gem-graph can only help you to draw and say how you want your drawings to be transformed. It can give you powerful tools to do this. All this is possible because the drawings that gem-graph manipulates are made up of simple elements and the mechanisms that move them are also based on combinations of simple rules that can therefore be processed automatically. The tools provided by gem-graph give you the power of the automaton it uses to draw and animate your designs, and this manual is here to help you learn how to master them. + +One way of doing this is to reproduce a very simple example, such as when a word processing program asks you to write "Hello world". For gem-graph, the equivalent of "Hello world" will be to move a some small line on your screen. Once you've done this simple example, you'll know enough to quickly build and animate much more complex drawings that suit your desires. If you like learning this way, this example is explained (here). If you prefer to learn by reading what the commands you see on the screen do, they have been detailed (here). The table of contents goes from the simplest to the most complicated. How to set up a simple model, observe it and measure what it does, then transform it by changing what you see and how it reacts. + +------------ + +Our "Hello world" is the simplest program that gem-graph can execute. It consists of a single short arrow, which moves in a straight line in a single direction. To do this, we first had to draw this little arrow and then make it move. The result is certainly not very exciting, but this example is enough to show how a drawing is made and how it is animated. One state and one rule are enough. The rule only says: if an arrow is drawn here, I erase it and redraw it on the next square. For the moment, you don't need to know in detail how the rule works (it's described here). All that gem-graph needs to know is written in the "Hello world" file (here). If you open this file, you'll find a description of the arrow (here) and its movement (here). + +------------ + +To improve this model, it is possible to give the arrow the ability to move in two directions: forwards or backwards. To do this, we need to add a second rule. This second rule says: if an arrow is drawn here, I erase it and redraw it on the previous square. A random draw (described here) is also necessary to determine whether the first or second rule applies. With these two rules and the random draw, the arrow now sometimes goes forwards, sometimes backwards. We can call this second model a "random walk". + +------------ + +The second model (the random walk) had one state (the arrow) and two rules (forward/backward). Now here's a model with two states and two rules: the pendulum. This time, the arrow can be drawn either tilted forwards or tilted backwards (these are the two possible states) and the two rules switch the drawn arrow from one state to the other or vice versa. In the file, the states are (here) and the rules (here). The pendulum does not change place, but alternates between left and right. Like the previous ones, the programme is slowed down so that you can see the movements. + +------------ + +Once you know how to write a state and a rule, you can write thousands of them: they will always be combinations of the same elementary form. However, it is also possible to combine programs: for example, you can combine the reports and rules from the two previous models to create a new model that shows both phenomena simultaneously. Once again, in the file, the states are (here) and the rules (here). + +------------ + +A final simple example shows how a single rule can be applied to a multitude of states. The rule is the same as for the first model: an arrow can only be moved one square forward, but this time you have to check that the square forward is free. If it isn't, the arrow won't move. And this time, the space contains a multitude of arrows that have been randomly placed all over the place (see details here). +When you open this model, you see a multitude of small lines, all similar, some vertical, some horizontal, placed on a grid. When you set the model in motion, you see these little lines moving from left to right if they are horizontal, and up and down if they are vertical (a second rule vas added to do that). Their number is constant. They don't change shape or direction. There seems to be no accident when they cross. Nothing else happens. + +------------ + +These five examples give an initial idea of the diversity of possible models and the operations that can be performed on them. + + diff --git a/doc/rtfm/man3/Stack.3 b/doc/rtfm/man3/Stack.3 index eb5a7aa..1be0329 100644 --- a/doc/rtfm/man3/Stack.3 +++ b/doc/rtfm/man3/Stack.3 @@ -2,8 +2,7 @@ .ad l .nh .SH NAME -Stack \- phantom documentation - +Stack .SH SYNOPSIS .br .PP @@ -21,7 +20,14 @@ Stack \- phantom documentation .in -1c .SH "Detailed Description" .PP -phantom documentation + +.PP +\fBReturns\fP +.RS 4 +popped +.RE +.PP + .SH "Author" .PP diff --git a/doc/rtfm/man3/WANT_TO_START_ON_ANOTHER_PAGE.3 b/doc/rtfm/man3/WANT_TO_START_ON_ANOTHER_PAGE.3 new file mode 100644 index 0000000..798b5e2 --- /dev/null +++ b/doc/rtfm/man3/WANT_TO_START_ON_ANOTHER_PAGE.3 @@ -0,0 +1 @@ +.so man3/left.c.3 diff --git a/doc/rtfm/man3/WANT_TO_START_ON_ANOTHER_PAGE_.3 b/doc/rtfm/man3/WANT_TO_START_ON_ANOTHER_PAGE_.3 new file mode 100644 index 0000000..798b5e2 --- /dev/null +++ b/doc/rtfm/man3/WANT_TO_START_ON_ANOTHER_PAGE_.3 @@ -0,0 +1 @@ +.so man3/left.c.3 diff --git a/doc/rtfm/man3/assign.c.3 b/doc/rtfm/man3/assign.c.3 index a682d50..1337df5 100644 --- a/doc/rtfm/man3/assign.c.3 +++ b/doc/rtfm/man3/assign.c.3 @@ -24,7 +24,6 @@ src/widget/main_window/one_rule/algebra/assign.c \- Algebra of rule actions\&. .ti -1c .RI "void * \fBwidget_get_selected_rule_assignments_list_btt\fP ()" .br -.RI "Presents the list of all the elementary actions (assignments) performed when the rule is applied\&. " .in -1c .SH "Detailed Description" .PP @@ -34,9 +33,9 @@ This file is part of Gem-graph\&. It hosts the functions needed to describe a ru .SH "Function Documentation" .PP .SS "void * widget_get_selected_rule_assignments_list_btt ()" - +Presents the list of all the elementary actions (assignments) performed when the rule is applied\&. .PP -Presents the list of all the elementary actions (assignments) performed when the rule is applied\&. Today, an arbitrary presentation with no link to the XML model and no verification of compliance with the meta-rules\&. (see below) TODO +Today, an arbitrary presentation with no link to the XML model and no verification of compliance with the meta-rules\&. (see below) TODO .PP |- - - - - - - - - - - - - - meta-rules - - - - - - - - - - - - - - - > .PP diff --git a/doc/rtfm/man3/bottom.c.3 b/doc/rtfm/man3/bottom.c.3 index 076dfc0..a20e570 100644 --- a/doc/rtfm/man3/bottom.c.3 +++ b/doc/rtfm/man3/bottom.c.3 @@ -20,17 +20,35 @@ src/widget/main_window/state/bottom.c \- main_window state view > bottom part of .ti -1c .RI "void * \fBwidget_get_space_edit_control\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_get_sequence_control\fP ()" .br -.RI "Phantom documentation\&. " .in -1c .SH "Detailed Description" .PP main_window state view > bottom part of the view +.SH "Function Documentation" +.PP +.SS "void * widget_get_sequence_control ()" + +.PP +\fBReturns\fP +.RS 4 +GTK_WIDGET (SEQUENCE_CONTROL_box) +.RE +.PP + +.SS "void * widget_get_space_edit_control ()" + +.PP +\fBReturns\fP +.RS 4 +GTK_WIDGET ('SPACE EDIT') +.RE +.PP + .SH "Author" .PP Generated automatically by Doxygen for Gem-graph from the source code\&. diff --git a/doc/rtfm/man3/camera.c.3 b/doc/rtfm/man3/camera.c.3 index c591be9..b2b28a2 100644 --- a/doc/rtfm/man3/camera.c.3 +++ b/doc/rtfm/man3/camera.c.3 @@ -20,13 +20,23 @@ src/widget/main_window/one_rule/geometry/camera.c \- rules geometric representat .ti -1c .RI "void * \fBwidget_get_selected_rule_camera\fP ()" .br -.RI "Phantom documentation\&. " .in -1c .SH "Detailed Description" .PP rules geometric representation camera This file is part of Gem-graph\&. +.SH "Function Documentation" +.PP +.SS "void * widget_get_selected_rule_camera ()" + +.PP +\fBReturns\fP +.RS 4 +camera +.RE +.PP + .SH "Author" .PP Generated automatically by Doxygen for Gem-graph from the source code\&. diff --git a/doc/rtfm/man3/center.c.3 b/doc/rtfm/man3/center.c.3 index 3a24b87..e0c9527 100644 --- a/doc/rtfm/man3/center.c.3 +++ b/doc/rtfm/man3/center.c.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -src/widget/main_window/topbar/center.c \- Topbar center\&. +src/widget/main_window/topbar/center.c \- Topbar center design\&. .SH SYNOPSIS .br @@ -22,13 +22,23 @@ src/widget/main_window/topbar/center.c \- Topbar center\&. .ti -1c .RI "void \fBwindow_design_topbar_center\fP (GtkWidget *topbar)" .br -.RI "title " .in -1c .SH "Detailed Description" .PP -Topbar center\&. +Topbar center design\&. +.SH "Function Documentation" +.PP +.SS "void window_design_topbar_center (GtkWidget * topbar)" + +.PP +\fBParameters\fP +.RS 4 +\fI*topbar\fP +.RE +.PP + .SH "Author" .PP Generated automatically by Doxygen for Gem-graph from the source code\&. diff --git a/doc/rtfm/man3/conditions.c.3 b/doc/rtfm/man3/conditions.c.3 index fbb3c6a..08f11e4 100644 --- a/doc/rtfm/man3/conditions.c.3 +++ b/doc/rtfm/man3/conditions.c.3 @@ -26,7 +26,6 @@ src/widget/main_window/one_rule/algebra/conditions.c \- Algebra of rule conditio .ti -1c .RI "void * \fBwidget_get_selected_rule_conditions_list_btt\fP ()" .br -.RI "Builds and presents the conditions list of a rule\&. " .in -1c .SH "Detailed Description" .PP @@ -36,9 +35,9 @@ This file is part of Gem-graph\&. It hosts the functions needed to describe the .SH "Function Documentation" .PP .SS "void * widget_get_selected_rule_conditions_list_btt ()" - +Builds and presents the conditions list of a rule\&. .PP -Builds and presents the conditions list of a rule\&. This list sets out all the conditions that the rule must meet in order to be applied\&. +This list sets out all the conditions that the rule must meet in order to be applied\&. .PP Today, an arbitrary presentation with no link to the XML model and no verification of compliance with the meta-rules\&. (see below) TODO .PP diff --git a/doc/rtfm/man3/data_list.c.3 b/doc/rtfm/man3/data_list.c.3 index 6538b90..8ba3f0f 100644 --- a/doc/rtfm/man3/data_list.c.3 +++ b/doc/rtfm/man3/data_list.c.3 @@ -38,10 +38,16 @@ src/fsm/measures/data_list.c \- a list of available measurements, including thos .PP a list of available measurements, including those currently in use -This file is part of Gem-graph\&. An editable list of results is defined and maintained here\&. Some operations can be performed on them\&. ex : filter, concat, inverse, scale, correlate, etc\&. +This file is part of Gem-graph\&. The operations that can be performed on the measurements include: select, copy, edit, erase, parameter (frequency, variable, etc\&.) .PP \fBSee also\fP .RS 4 +http://www.gnuplot.info/ +.PP +https://fr.wikipedia.org/wiki/Gnuplot +.PP +https://fr.wikibooks.org/wiki/Mathc_gnuplot +.PP : fsm/measure/manage\&.c .RE .PP diff --git a/doc/rtfm/man3/designer.c.3 b/doc/rtfm/man3/designer.c.3 index b1a4c85..bdd9110 100644 --- a/doc/rtfm/man3/designer.c.3 +++ b/doc/rtfm/man3/designer.c.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -src/widget/main_window/designer.c \- builds ans present +src/widget/main_window/designer.c \- designs and presents .SH SYNOPSIS .br @@ -23,11 +23,9 @@ src/widget/main_window/designer.c \- builds ans present .in -1c .SH "Detailed Description" .PP -builds ans present +designs and presents -This file is part of Gem-graph\&. -.PP -ensure the titlebar and the pages are available and init them +ensures the titlebar and the pages are available and init them .PP triggers assembly of the topbar and the default page .PP @@ -51,7 +49,7 @@ the 'all rules' page gives access to the hierarchy of all rules the 'selected rule' page lets you examine and modify one selected rule .RE .PP - +This file is part of Gem-graph\&. .PP .SH "Function Documentation" diff --git a/doc/rtfm/man3/dialog.c.3 b/doc/rtfm/man3/dialog.c.3 index f99e8b2..9c90197 100644 --- a/doc/rtfm/man3/dialog.c.3 +++ b/doc/rtfm/man3/dialog.c.3 @@ -22,7 +22,6 @@ src/widget/dialog.c \- dialog window\&. .ti -1c .RI "void \fBwidget_design_dialog_window\fP (GtkWindow *main_window, GtkWindow *dialog_window)" .br -.RI "modal " .in -1c .SH "Detailed Description" .PP @@ -33,8 +32,6 @@ This file is part of Gem-graph\&. .PP .SS "void widget_design_dialog_window (GtkWindow * main_window, GtkWindow * dialog_window)" -.PP -modal .PP \fBSee also\fP .RS 4 diff --git a/doc/rtfm/man3/disp_list.c.3 b/doc/rtfm/man3/disp_list.c.3 index 438c721..86f9111 100644 --- a/doc/rtfm/man3/disp_list.c.3 +++ b/doc/rtfm/man3/disp_list.c.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -src/fsm/measures/disp_list.c \- a list of displayable results, including those currently displayed Gem-graph-client list (and current use) +src/fsm/measures/disp_list.c \- A list of displayable results (whether currently displayed or not)\&. .SH SYNOPSIS .br @@ -31,9 +31,15 @@ src/fsm/measures/disp_list.c \- a list of displayable results, including those c .in -1c .SH "Detailed Description" .PP -a list of displayable results, including those currently displayed Gem-graph-client list (and current use) +A list of displayable results (whether currently displayed or not)\&. -This file is part of Gem-graph\&. An editable list of results is defined and maintained here\&. Some operations can be performed on them\&. ex : filter, concat, inverse, scale, correlate, etc\&. +This file is part of Gem-graph\&. The operations that can be performed on the results include: select, copy, erase, filter, concat, inverse, scale, correlate, etc\&. +.PP +The format of the results must be compatible with the formats recognised by the usual presentation software\&. +.PP +'graph', 'chart', 'plot' and 'diagram' are ambiguous terms, used interchangeably\&. +.PP +NB some data may be displayed simultaneously in different pages ex : pages 'synth' & 'results' .PP \fBSee also\fP .RS 4 diff --git a/doc/rtfm/man3/display.c.3 b/doc/rtfm/man3/display.c.3 index 0853be2..581d9a4 100644 --- a/doc/rtfm/man3/display.c.3 +++ b/doc/rtfm/man3/display.c.3 @@ -20,17 +20,35 @@ src/widget/main_window/results/display.c \- Results display functions\&. .ti -1c .RI "void * \fBwidget_get_results_box_time\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_get_results_box_display\fP ()" .br -.RI "Phantom documentation\&. " .in -1c .SH "Detailed Description" .PP Results display functions\&. This file is part of Gem-graph\&. +.SH "Function Documentation" +.PP +.SS "void * widget_get_results_box_display ()" + +.PP +\fBReturns\fP +.RS 4 +GTK_WIDGET (data_box) +.RE +.PP + +.SS "void * widget_get_results_box_time ()" + +.PP +\fBReturns\fP +.RS 4 +GTK_WIDGET (time_box) +.RE +.PP + .SH "Author" .PP Generated automatically by Doxygen for Gem-graph from the source code\&. diff --git a/doc/rtfm/man3/edit.c.3 b/doc/rtfm/man3/edit.c.3 index ae347a1..0bf8b21 100644 --- a/doc/rtfm/man3/edit.c.3 +++ b/doc/rtfm/man3/edit.c.3 @@ -20,13 +20,23 @@ src/widget/main_window/one_rule/geometry/edit.c \- rules geometric representatio .ti -1c .RI "void * \fBwidget_get_rule_edition_tools\fP ()" .br -.RI "Phantom documentation\&. " .in -1c .SH "Detailed Description" .PP rules geometric representation dispatcher This file is part of Gem-graph\&. +.SH "Function Documentation" +.PP +.SS "void * widget_get_rule_edition_tools ()" + +.PP +\fBReturns\fP +.RS 4 +gtk_label_new ('RULE EDITION') +.RE +.PP + .SH "Author" .PP Generated automatically by Doxygen for Gem-graph from the source code\&. diff --git a/doc/rtfm/man3/freq.c.3 b/doc/rtfm/man3/freq.c.3 index 803f385..07e5b98 100644 --- a/doc/rtfm/man3/freq.c.3 +++ b/doc/rtfm/man3/freq.c.3 @@ -20,13 +20,23 @@ src/widget/main_window/all_rules/tree/freq.c \- Gem-graph-client Rules tree\&. .ti -1c .RI "void * \fBwidget_get_rules_use\fP ()" .br -.RI "phantom documentation " .in -1c .SH "Detailed Description" .PP Gem-graph-client Rules tree\&. This file is part of Gem-graph\&. +.SH "Function Documentation" +.PP +.SS "void * widget_get_rules_use ()" + +.PP +\fBReturns\fP +.RS 4 +scroll_rules_use +.RE +.PP + .SH "Author" .PP Generated automatically by Doxygen for Gem-graph from the source code\&. diff --git a/doc/rtfm/man3/fsm.h.3 b/doc/rtfm/man3/fsm.h.3 index 9da0944..e8fbe02 100644 --- a/doc/rtfm/man3/fsm.h.3 +++ b/doc/rtfm/man3/fsm.h.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -include/fsm.h \- fsm (Finite State Machine) header +include/fsm.h \- FSM (Finite State Machine) header\&. .SH SYNOPSIS .br @@ -88,7 +88,7 @@ include/fsm.h \- fsm (Finite State Machine) header .br .RI "Conforms to canonical log levels: FATAL, ERROR, WARN, INFO, DEBUG, TRACE\&. " .ti -1c -.RI "enum \fBfsm_enum_journal_source\fP { \fBSOURCE\fP, \fBTARGET\fP, \fBJOURNAL\fP, \fBFSM\fP, \fBPREFER\fP, \fBMAIN\fP, \fBAPP\fP, \fBWIDGETS\fP, \fBSIGNAL\fP, \fBMAIN_WINDOW\fP, \fBDIALOG_WINDOW\fP, \fBMODAL_WINDOW\fP, \fBTEXT_WINDOW\fP, \fBAUTO_NOTIFICATION\fP, \fBTOPBAR\fP, \fBTOPBAR_LEFT\fP, \fBTOPBAR_RIGHT\fP, \fBTOPBAR_CENTER\fP, \fBSYNTH_PAGE\fP, \fBSTATE_PAGE\fP, \fBRULES_PAGE\fP, \fBMEASURES_PAGE\fP, \fBRESULTS_PAGE\fP, \fBSenumYNTH_GLAREA\fP, \fBSYNTH_ALL_RESULTS\fP, \fBSYNTH_TIME_DEP_RESULTS\fP, \fBSYNTH_TIME_INDEP_RESULTS\fP, \fBSTATE_TOP\fP, \fBSTATE_BOTTOM\fP, \fBSTATE_GLAREA\fP, \fBSTATE_CAMERA\fP, \fBRULE_GEOMETRY\fP, \fBRULE_GLAREA\fP, \fBRULE_CAMERA\fP, \fBRULE_ALGEBRA\fP, \fBRULE_CONDITION\fP, \fBRULE_ASSIGN\fP, \fBRULE_ID\fP, \fBRULES_TREE\fP, \fBRULES_COMPARE\fP, \fBRULES_USE\fP, \fBMEASURES_TOOLS\fP, \fBMEASURES__ACTIVITY\fP, \fBMEASURES__DISPLAY\fP, \fBRESULTS\fP, \fBTIME_DEP_RESULTS\fP, \fBTIME_INDEP_RESULTS\fP, \fBWIDGET\fP, \fBBUTTON\fP, \fBSCROLL\fP, \fBGLAREA\fP, \fBTEXT\fP, \fBLABEL\fP, \fBTREE\fP, \fBSLIDER\fP, \fBEXPANDER\fP, \fBENTRY\fP, \fBSWITCH_STATE_RULES_DATA\fP, \fBSLIDER_X\fP, \fBSLIDER_Y\fP, \fBSLIDER_Z\fP, \fBSLIDER_A\fP, \fBSLIDER_B\fP, \fBSLIDER_C\fP }" +.RI "enum \fBfsm_enum_journal_source\fP { \fBSOURCE\fP, \fBTARGET\fP, \fBJOURNAL\fP, \fBFSM\fP, \fBPREFER\fP, \fBMAIN\fP, \fBAPP\fP, \fBWIDGETS\fP, \fBSIGNAL\fP, \fBMAIN_WINDOW\fP, \fBDIALOG_WINDOW\fP, \fBMODAL_WINDOW\fP, \fBTEXT_WINDOW\fP, \fBAUTO_NOTIFICATION\fP, \fBTOPBAR\fP, \fBTOPBAR_LEFT\fP, \fBTOPBAR_RIGHT\fP, \fBTOPBAR_CENTER\fP, \fBSYNTH_PAGE\fP, \fBSTATE_PAGE\fP, \fBRULES_PAGE\fP, \fBMEASURES_PAGE\fP, \fBRESULTS_PAGE\fP, \fBSYNTH_GLAREA\fP, \fBSYNTH_ALL_RESULTS\fP, \fBSYNTH_TIME_DEP_RESULTS\fP, \fBSYNTH_TIME_INDEP_RESULTS\fP, \fBSTATE_TOP\fP, \fBSTATE_BOTTOM\fP, \fBSTATE_GLAREA\fP, \fBSTATE_CAMERA\fP, \fBRULE_GEOMETRY\fP, \fBRULE_GLAREA\fP, \fBRULE_CAMERA\fP, \fBRULE_ALGEBRA\fP, \fBRULE_CONDITION\fP, \fBRULE_ASSIGN\fP, \fBRULE_ID\fP, \fBRULES_TREE\fP, \fBRULES_COMPARE\fP, \fBRULES_USE\fP, \fBMEASURES_TOOLS\fP, \fBMEASURES__ACTIVITY\fP, \fBMEASURES__DISPLAY\fP, \fBRESULTS\fP, \fBTIME_DEP_RESULTS\fP, \fBTIME_INDEP_RESULTS\fP, \fBWIDGET\fP, \fBBUTTON\fP, \fBSCROLL\fP, \fBGLAREA\fP, \fBTEXT\fP, \fBLABEL\fP, \fBTREE\fP, \fBSLIDER\fP, \fBEXPANDER\fP, \fBENTRY\fP, \fBON_SWITCH_STATE_RULES_DATA\fP, \fBSLIDER_X\fP, \fBSLIDER_Y\fP, \fBSLIDER_Z\fP, \fBSLIDER_A\fP, \fBSLIDER_B\fP, \fBSLIDER_C\fP }" .br .RI "arbitrary values that can help the logging filter work more efficiently " .ti -1c @@ -246,7 +246,7 @@ include/fsm.h \- fsm (Finite State Machine) header .in -1c .SH "Detailed Description" .PP -fsm (Finite State Machine) header +FSM (Finite State Machine) header\&. This file is part of Gem-graph\&. .SH "Typedef Documentation" diff --git a/doc/rtfm/man3/geometry.c.3 b/doc/rtfm/man3/geometry.c.3 index 779bc44..3ef512e 100644 --- a/doc/rtfm/man3/geometry.c.3 +++ b/doc/rtfm/man3/geometry.c.3 @@ -20,13 +20,23 @@ src/widget/main_window/one_rule/geometry/geometry.c \- rules geometric represent .ti -1c .RI "void * \fBwidget_get_selected_rule_before_after\fP ()" .br -.RI "Phantom documentation\&. " .in -1c .SH "Detailed Description" .PP rules geometric representation This file is part of Gem-graph\&. +.SH "Function Documentation" +.PP +.SS "void * widget_get_selected_rule_before_after ()" + +.PP +\fBReturns\fP +.RS 4 +GTK_WIDGET (before_vs_after) +.RE +.PP + .SH "Author" .PP Generated automatically by Doxygen for Gem-graph from the source code\&. diff --git a/doc/rtfm/man3/identity.c.3 b/doc/rtfm/man3/identity.c.3 index 745700e..07b8f73 100644 --- a/doc/rtfm/man3/identity.c.3 +++ b/doc/rtfm/man3/identity.c.3 @@ -24,7 +24,6 @@ src/widget/main_window/one_rule/algebra/identity.c \- Non algebraic identity of .ti -1c .RI "void * \fBwidget_get_selected_rule_identity_btt\fP ()" .br -.RI "Hosts a list of character strings that can be combined to provide a 'human readable' rule identifier\&. " .in -1c .SH "Detailed Description" .PP @@ -34,8 +33,6 @@ This file is part of Gem-graph\&. It hosts the functions needed to identify a ru .SH "Function Documentation" .PP .SS "void * widget_get_selected_rule_identity_btt ()" - -.PP Hosts a list of character strings that can be combined to provide a 'human readable' rule identifier\&. This list can also contain non-mandatory elements\&. .PP Each rule can have a specific 'human readable' name chosen by its designer\&. This name can be used to identify the rule\&. It is desirable for a unique name to be accepted and shared by as many users as possible\&. diff --git a/doc/rtfm/man3/interest.c.3 b/doc/rtfm/man3/interest.c.3 index 9771ed5..5933c66 100644 --- a/doc/rtfm/man3/interest.c.3 +++ b/doc/rtfm/man3/interest.c.3 @@ -20,7 +20,6 @@ src/widget/main_window/all_rules/compare/interest.c \- Gem-graph-client Rules tr .ti -1c .RI "struct \fBStack\fP" .br -.RI "phantom documentation " .in -1c .SS "Macros" @@ -40,13 +39,23 @@ src/widget/main_window/all_rules/compare/interest.c \- Gem-graph-client Rules tr .ti -1c .RI "void * \fBwidget_get_an_impression_of_what_a_rules_comparator_could_be\fP ()" .br -.RI "phantom documentation " .in -1c .SH "Detailed Description" .PP Gem-graph-client Rules tree\&. This file is part of Gem-graph\&. +.SH "Function Documentation" +.PP +.SS "void * widget_get_an_impression_of_what_a_rules_comparator_could_be ()" + +.PP +\fBReturns\fP +.RS 4 +comparator +.RE +.PP + .SH "Author" .PP Generated automatically by Doxygen for Gem-graph from the source code\&. diff --git a/doc/rtfm/man3/investigate.c.3 b/doc/rtfm/man3/investigate.c.3 index e2d746b..f601b8d 100644 --- a/doc/rtfm/man3/investigate.c.3 +++ b/doc/rtfm/man3/investigate.c.3 @@ -20,13 +20,23 @@ src/widget/main_window/one_rule/geometry/investigate.c \- rules geometric repres .ti -1c .RI "void * \fBwidget_get_rule_investigation_tools\fP ()" .br -.RI "Phantom documentation\&. " .in -1c .SH "Detailed Description" .PP rules geometric representation This file is part of Gem-graph\&. +.SH "Function Documentation" +.PP +.SS "void * widget_get_rule_investigation_tools ()" + +.PP +\fBReturns\fP +.RS 4 +gtk_label_new ('RULE INVESTIGATION') +.RE +.PP + .SH "Author" .PP Generated automatically by Doxygen for Gem-graph from the source code\&. diff --git a/doc/rtfm/man3/labo.c.3 b/doc/rtfm/man3/labo.c.3 index 13fadb5..7a6524b 100644 --- a/doc/rtfm/man3/labo.c.3 +++ b/doc/rtfm/man3/labo.c.3 @@ -16,13 +16,16 @@ src/widget/main_window/all_rules/tree/labo.c \- Gem-graph-client Rules tree\&. .ti -1c .RI "void \fBwidget_let_us_create_a_complex_useless_and_expensive_tree\fP (struct \fBTreeNode_t\fP *tree_root)" .br -.RI "phantom documentation " .in -1c .SH "Detailed Description" .PP Gem-graph-client Rules tree\&. This file is part of Gem-graph\&. +.SH "Function Documentation" +.PP +.SS "void widget_let_us_create_a_complex_useless_and_expensive_tree (struct \fBTreeNode_t\fP * tree_root)" +phantom documentation in a phantom tree\&.\&.\&. .SH "Author" .PP Generated automatically by Doxygen for Gem-graph from the source code\&. diff --git a/doc/rtfm/man3/left.c.3 b/doc/rtfm/man3/left.c.3 index 67bd86f..df5798a 100644 --- a/doc/rtfm/man3/left.c.3 +++ b/doc/rtfm/man3/left.c.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -src/widget/main_window/topbar/left.c \- Topbar left\&. +src/widget/main_window/topbar/left.c \- Topbar left design\&. .SH SYNOPSIS .br @@ -30,41 +30,77 @@ src/widget/main_window/topbar/left.c \- Topbar left\&. .ti -1c .RI "const char * \fBwidget_get_btt_label_synth\fP ()" .br -.RI "! WARNING ! THE LABELS OF THE PREVIOUS FOUR BUTTONS MUST ONLY BE DEFINED ONCE IN THE PROGRAMME (HERE), AND ONLY USING THE FOUR FOLLOWING FUNCTIONS: " .ti -1c .RI "const char * \fBwidget_get_btt_label_state\fP ()" .br -.RI "btt_state " .ti -1c .RI "const char * \fBwidget_get_btt_label_rules\fP ()" .br -.RI "btt_rules " .ti -1c .RI "const char * \fBwidget_get_btt_label_data\fP ()" .br -.RI "btt_data -.br - " .ti -1c .RI "void \fBwindow_design_topbar_left\fP (GtkWidget *header_bar)" .br -.RI "The rules page consists of two half-pages in a GtkPaned widget : " .in -1c .SH "Detailed Description" .PP -Topbar left\&. +Topbar left design\&. +.PP +\fBWarning\fP +.RS 4 +THE LABELS OF THE FOUR BUTTONS USED TO SELECT A PAGE IN THE MAIN WINDOW MUST ONLY BE DEFINED ONCE IN THE PROGRAM (in src/main_window/topbar/left/) AND ONLY USING ONE OF THE FOUR 'get_btt_label_' FUNCTIONS DEFINED IN THIS FILE +.RE +.PP + .SH "Function Documentation" .PP +.SS "const char * widget_get_btt_label_data ()" + +.PP +\fBReturns\fP +.RS 4 +'data' +.RE +.PP + +.SS "const char * widget_get_btt_label_rules ()" + +.PP +\fBReturns\fP +.RS 4 +'rules' +.br + +.RE +.PP + +.SS "const char * widget_get_btt_label_state ()" + +.PP +\fBReturns\fP +.RS 4 +'state' +.br + +.RE +.PP + .SS "const char * widget_get_btt_label_synth ()" .PP -! WARNING ! THE LABELS OF THE PREVIOUS FOUR BUTTONS MUST ONLY BE DEFINED ONCE IN THE PROGRAMME (HERE), AND ONLY USING THE FOUR FOLLOWING FUNCTIONS: btt_synth -.SS "void window_design_topbar_left (GtkWidget * header_bar)" - +\fBReturns\fP +.RS 4 +'synth' +.br + +.RE .PP -The rules page consists of two half-pages in a GtkPaned widget : + +.SS "void window_design_topbar_left (GtkWidget * header_bar)" +The rules page consists of two half-pages in a GtkPaned widget : .IP "\(bu" 2 on the left, widgets for controlling or editing all the rules\&. .IP "\(bu" 2 diff --git a/doc/rtfm/man3/manager.c.3 b/doc/rtfm/man3/manager.c.3 index d5b7260..02d3a1b 100644 --- a/doc/rtfm/man3/manager.c.3 +++ b/doc/rtfm/man3/manager.c.3 @@ -20,15 +20,12 @@ src/widget/manager.c \- all windows .ti -1c .RI "GtkWindow * \fBwidget_get_main_window\fP ()" .br -.RI "getter " .ti -1c .RI "GtkWindow * \fBwidget_get_dialog_window\fP ()" .br -.RI "getter " .ti -1c .RI "GtkWindow * \fBwidget_get_text_window\fP ()" .br -.RI "getter " .ti -1c .RI "void \fBon_windows_startup\fP (GtkApplication *app)" .br @@ -95,8 +92,6 @@ all windows .SS "GtkWindow * widget_get_dialog_window ()" -.PP -getter .PP \fBSince\fP .RS 4 @@ -116,8 +111,6 @@ dialog_window .SS "GtkWindow * widget_get_main_window ()" -.PP -getter .PP \fBSince\fP .RS 4 @@ -137,8 +130,6 @@ main_window .SS "GtkWindow * widget_get_text_window ()" -.PP -getter .PP \fBSince\fP .RS 4 diff --git a/doc/rtfm/man3/middle.c.3 b/doc/rtfm/man3/middle.c.3 index 2dc277a..32894bd 100644 --- a/doc/rtfm/man3/middle.c.3 +++ b/doc/rtfm/man3/middle.c.3 @@ -22,7 +22,6 @@ src/widget/main_window/state/middle.c \- main_window state view > middle part of .ti -1c .RI "void \fBwidget_reset_XYZ_in_state_pane\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_get_space_view\fP (int partition_space_vs_camera)" .br @@ -42,7 +41,14 @@ main_window state view > middle part of the view \fIpartition_space_vs_camera\fP .RE .PP +\fBReturns\fP +.RS 4 +GTK_WIDGET (view_space_vs_camera) +.RE +.PP +.SS "void widget_reset_XYZ_in_state_pane ()" +phantom documentation .SH "Author" .PP Generated automatically by Doxygen for Gem-graph from the source code\&. diff --git a/doc/rtfm/man3/modal.c.3 b/doc/rtfm/man3/modal.c.3 index 1063dae..e751c5c 100644 --- a/doc/rtfm/man3/modal.c.3 +++ b/doc/rtfm/man3/modal.c.3 @@ -20,11 +20,9 @@ src/widget/modal.c \- modal window\&. .ti -1c .RI "void \fBwidget_design_text_window\fP (GtkWindow *main_window, GtkWindow *text_window)" .br -.RI "modal " .ti -1c .RI "void * \fBwidget_get_text_from_address\fP (gchar *text_address)" .br -.RI "getter " .in -1c .SH "Detailed Description" .PP @@ -35,8 +33,6 @@ This file is part of Gem-graph\&. .PP .SS "void widget_design_text_window (GtkWindow * main_window, GtkWindow * text_window)" -.PP -modal .PP \fBSee also\fP .RS 4 @@ -55,8 +51,6 @@ src/widget/manager/on_windows_activation() .SS "void * widget_get_text_from_address (gchar * text_address)" -.PP -getter .PP \fBSee also\fP .RS 4 @@ -68,6 +62,11 @@ src/widget/modal/widget_design_text_window() \fI*text_address\fP .RE .PP +\fBReturns\fP +.RS 4 +GTK_WIDGET (scrolled_window) +.RE +.PP .SH "Author" .PP diff --git a/doc/rtfm/man3/on_switch_state_rules_data.3 b/doc/rtfm/man3/on_switch_state_rules_data.3 new file mode 100644 index 0000000..a26168c --- /dev/null +++ b/doc/rtfm/man3/on_switch_state_rules_data.3 @@ -0,0 +1 @@ +.so man3/signal.h.3 diff --git a/doc/rtfm/man3/organize.c.3 b/doc/rtfm/man3/organize.c.3 index d913e4c..e335991 100644 --- a/doc/rtfm/man3/organize.c.3 +++ b/doc/rtfm/man3/organize.c.3 @@ -20,13 +20,23 @@ src/widget/main_window/results/organize.c \- Results organization\&. .ti -1c .RI "void * \fBwidget_get_results_box_organize\fP ()" .br -.RI "Phantom documentation\&. " .in -1c .SH "Detailed Description" .PP Results organization\&. This file is part of Gem-graph\&. +.SH "Function Documentation" +.PP +.SS "void * widget_get_results_box_organize ()" + +.PP +\fBReturns\fP +.RS 4 +GTK_WIDGET (all_box) +.RE +.PP + .SH "Author" .PP Generated automatically by Doxygen for Gem-graph from the source code\&. diff --git a/doc/rtfm/man3/pilot_box.c.3 b/doc/rtfm/man3/pilot_box.c.3 index 98e13d2..99ac02b 100644 --- a/doc/rtfm/man3/pilot_box.c.3 +++ b/doc/rtfm/man3/pilot_box.c.3 @@ -20,17 +20,35 @@ src/widget/main_window/all_rules/tree/pilot_box.c \- Gem-graph-client Rules tree .ti -1c .RI "void * \fBwidget_get_rules_pilot_box\fP ()" .br -.RI "phantom documentation " .ti -1c .RI "void * \fBwidget_get_rules_tree_tools\fP ()" .br -.RI "phantom documentation " .in -1c .SH "Detailed Description" .PP Gem-graph-client Rules tree\&. This file is part of Gem-graph\&. +.SH "Function Documentation" +.PP +.SS "void * widget_get_rules_pilot_box ()" + +.PP +\fBReturns\fP +.RS 4 +rules_pilot_box +.RE +.PP + +.SS "void * widget_get_rules_tree_tools ()" + +.PP +\fBReturns\fP +.RS 4 +GTK_WIDGET (rules_tree_box) +.RE +.PP + .SH "Author" .PP Generated automatically by Doxygen for Gem-graph from the source code\&. diff --git a/doc/rtfm/man3/signal.c.3 b/doc/rtfm/man3/signal.c.3 index 0723b25..f5034c9 100644 --- a/doc/rtfm/man3/signal.c.3 +++ b/doc/rtfm/man3/signal.c.3 @@ -66,6 +66,10 @@ src/signal.c \- events callbacks .br .RI "since 2024-06 " .ti -1c +.RI "void \fBon_switch_state_rules_data\fP ()" +.br +.RI "This function could remain static in src/signal\&. " +.ti -1c .RI "void \fBon_clicked_topbar_right_search\fP (GtkWidget *btt_menu, gpointer list_box)" .br .RI "since 2024-06 " @@ -461,6 +465,45 @@ since 2024-06 .RE .PP +.SS "void on_switch_state_rules_data ()" + +.PP +This function could remain static in src/signal\&. It is provisionally non static to be visible from the documentation (2024-10) +.PP +\fBSee also\fP +.RS 4 +\fBfsm_get_state_rules_data()\fP +.PP +\fBwidget_get_main_window()\fP +.PP +\fBwidget_get_page_synth()\fP +.PP +\fBwidget_get_page_state()\fP +.PP +\fBwidget_get_pane_all_rules_left()\fP +.PP +\fBwidget_get_pane_selected_rule_right()\fP +.RE +.PP +? see src/widget/main_window/measure/widget_get_page_measure() +.PP +\fBSee also\fP +.RS 4 +src/widget/main_window/widget_get_page_data() +.PP +\fBon_toggle_exec_edit()\fP +.PP +\fBon_toggle_state_rules_data()\fP +.RE +.PP +The rules page consists of two half-pages in a GtkPaned widget : +.IP "\(bu" 2 +on the left, widgets for controlling or editing all the rules\&. +.IP "\(bu" 2 +on the right, widgets for controlling or editing the selected rule\&. +.PP +.PP +Instead of having a: 'widget_get_rules_page()' function, this distribution is moved here\&. (see also widget/topbar/left design) \fBwindow_design_topbar_left()\fP .SS "void on_toggle_exec_edit (GtkWidget * toggled_button, gpointer user_data)" .PP diff --git a/doc/rtfm/man3/signal.h.3 b/doc/rtfm/man3/signal.h.3 index d80651f..28aab6b 100644 --- a/doc/rtfm/man3/signal.h.3 +++ b/doc/rtfm/man3/signal.h.3 @@ -28,6 +28,10 @@ include/signal.h \- events callbacks header .br .RI "since 2024-06 " .ti -1c +.RI "void \fBon_switch_state_rules_data\fP ()" +.br +.RI "This function could remain static in src/signal\&. " +.ti -1c .RI "void \fBon_save_current_model_before_editing\fP (GtkWidget *btt_SAVE_CURRENT_MODEL, gpointer data)" .br .RI "since 2024-06 " @@ -463,6 +467,45 @@ since 2024-06 .RE .PP +.SS "void on_switch_state_rules_data ()" + +.PP +This function could remain static in src/signal\&. It is provisionally non static to be visible from the documentation (2024-10) +.PP +\fBSee also\fP +.RS 4 +\fBfsm_get_state_rules_data()\fP +.PP +\fBwidget_get_main_window()\fP +.PP +\fBwidget_get_page_synth()\fP +.PP +\fBwidget_get_page_state()\fP +.PP +\fBwidget_get_pane_all_rules_left()\fP +.PP +\fBwidget_get_pane_selected_rule_right()\fP +.RE +.PP +? see src/widget/main_window/measure/widget_get_page_measure() +.PP +\fBSee also\fP +.RS 4 +src/widget/main_window/widget_get_page_data() +.PP +\fBon_toggle_exec_edit()\fP +.PP +\fBon_toggle_state_rules_data()\fP +.RE +.PP +The rules page consists of two half-pages in a GtkPaned widget : +.IP "\(bu" 2 +on the left, widgets for controlling or editing all the rules\&. +.IP "\(bu" 2 +on the right, widgets for controlling or editing the selected rule\&. +.PP +.PP +Instead of having a: 'widget_get_rules_page()' function, this distribution is moved here\&. (see also widget/topbar/left design) \fBwindow_design_topbar_left()\fP .SS "void on_toggle_exec_edit (GtkWidget * toggled_button, gpointer user_data)" .PP diff --git a/doc/rtfm/man3/time.c.3 b/doc/rtfm/man3/time.c.3 index 255588d..16c6801 100644 --- a/doc/rtfm/man3/time.c.3 +++ b/doc/rtfm/man3/time.c.3 @@ -20,13 +20,23 @@ src/widget/main_window/synth/time.c \- main_window synthetic view time dependent .ti -1c .RI "void * \fBwidget_get_time_dependent\fP ()" .br -.RI "Phantom documentation\&. " .in -1c .SH "Detailed Description" .PP main_window synthetic view time dependent functions +.SH "Function Documentation" +.PP +.SS "void * widget_get_time_dependent ()" + +.PP +\fBReturns\fP +.RS 4 +time_box +.RE +.PP + .SH "Author" .PP Generated automatically by Doxygen for Gem-graph from the source code\&. diff --git a/doc/rtfm/man3/top.c.3 b/doc/rtfm/man3/top.c.3 index 24e02d0..a26a559 100644 --- a/doc/rtfm/man3/top.c.3 +++ b/doc/rtfm/man3/top.c.3 @@ -29,7 +29,6 @@ src/widget/main_window/state/top.c \- main_window state view > top part of the v .ti -1c .RI "void * \fBwidget_get_graph_view_control\fP ()" .br -.RI "Phantom documentation\&. " .in -1c .SH "Detailed Description" .PP @@ -38,6 +37,15 @@ main_window state view > top part of the view .SH "Function Documentation" .PP +.SS "void * widget_get_graph_view_control ()" + +.PP +\fBReturns\fP +.RS 4 +objects_vs_situations_horizontal_pane +.RE +.PP + .SS "int widget_get_object_transparency (int rank)" .PP diff --git a/doc/rtfm/man3/utilities.c.3 b/doc/rtfm/man3/utilities.c.3 index 89b09aa..05af058 100644 --- a/doc/rtfm/man3/utilities.c.3 +++ b/doc/rtfm/man3/utilities.c.3 @@ -36,7 +36,6 @@ src/widget/main_window/one_rule/algebra/utilities.c \- Gem-graph-client algebra .ti -1c .RI "GtkEntry \fBwidget_set_item_text\fP (GtkWidget *list_box, const char *text, bool editable)" .br -.RI "Format an entry (a text item) in a list\&. " .in -1c .SH "Detailed Description" .PP @@ -48,9 +47,7 @@ It provides formatting or page layout functions used locally\&. .SH "Function Documentation" .PP .SS "GtkEntry widget_set_item_text (GtkWidget * list_box, const char * text, bool editable)" - -.PP -Format an entry (a text item) in a list\&. +Format an entry (a text item) in a list\&. .PP \fBSince\fP .RS 4 diff --git a/doc/rtfm/man3/widget.h.3 b/doc/rtfm/man3/widget.h.3 index 593bd07..6054955 100644 --- a/doc/rtfm/man3/widget.h.3 +++ b/doc/rtfm/man3/widget.h.3 @@ -128,52 +128,39 @@ include/widget.h \- widgets hierarchy header .ti -1c .RI "GtkWindow * \fBwidget_get_main_window\fP ()" .br -.RI "getter " .ti -1c .RI "GtkWindow * \fBwidget_get_dialog_window\fP ()" .br -.RI "getter " .ti -1c .RI "GtkWindow * \fBwidget_get_text_window\fP ()" .br -.RI "getter " .ti -1c .RI "void \fBwidget_design_main_window\fP (GtkWindow *main_window, GtkApplication *app)" .br .ti -1c .RI "void \fBwidget_design_dialog_window\fP (GtkWindow *main_window, GtkWindow *dialog_window)" .br -.RI "modal " .ti -1c .RI "void \fBwidget_design_text_window\fP (GtkWindow *main_window, GtkWindow *text_window)" .br -.RI "modal " .ti -1c .RI "const char * \fBwidget_get_btt_label_synth\fP ()" .br -.RI "! WARNING ! THE LABELS OF THE PREVIOUS FOUR BUTTONS MUST ONLY BE DEFINED ONCE IN THE PROGRAMME (HERE), AND ONLY USING THE FOUR FOLLOWING FUNCTIONS: " .ti -1c .RI "const char * \fBwidget_get_btt_label_state\fP ()" .br -.RI "btt_state " .ti -1c .RI "const char * \fBwidget_get_btt_label_rules\fP ()" .br -.RI "btt_rules " .ti -1c .RI "const char * \fBwidget_get_btt_label_data\fP ()" .br -.RI "btt_data -.br - " .ti -1c .RI "void \fBwindow_design_topbar_center\fP (GtkWidget *topbar)" .br -.RI "title " .ti -1c .RI "void \fBwindow_design_topbar_left\fP (GtkWidget *header_bar)" .br -.RI "The rules page consists of two half-pages in a GtkPaned widget : " .ti -1c .RI "void \fBwindow_design_topbar_right\fP (GtkWidget *header_bar, GtkApplication *app)" .br @@ -183,46 +170,36 @@ include/widget.h \- widgets hierarchy header .ti -1c .RI "void * \fBwidget_get_page_synth\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_get_page_state\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_get_page_data\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_get_page_measure\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_get_time_dependent\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_get_space_vs_non_time_dependent\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_get_non_time_dependent\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_get_space_view\fP (int partition_space_vs_camera)" .br .ti -1c .RI "void * \fBwidget_get_graph_view_control\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_get_space_edit_control\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_get_sequence_control\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void \fBwidget_set_situations_value\fP (int value)" .br @@ -235,83 +212,63 @@ include/widget.h \- widgets hierarchy header .ti -1c .RI "void \fBwidget_reset_XYZ_in_state_pane\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_get_pane_all_rules_left\fP ()" .br -.RI "phantom documentation " .ti -1c .RI "void * \fBwidget_get_pane_selected_rule_right\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_get_rules_pilot_box\fP ()" .br -.RI "phantom documentation " .ti -1c .RI "void * \fBwidget_get_rules_tree_tools\fP ()" .br -.RI "phantom documentation " .ti -1c .RI "void * \fBwidget_get_rules_use\fP ()" .br -.RI "phantom documentation " .ti -1c .RI "void * \fBwidget_get_selected_rule\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_get_rule_edition_tools\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_get_rule_investigation_tools\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_get_selected_rule_algebra\fP ()" .br -.RI "Provides the three lists needed to describe a rule algebraically\&. " .ti -1c .RI "void * \fBwidget_get_selected_rule_geometry\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_get_selected_rule_conditions_list_btt\fP ()" .br -.RI "Builds and presents the conditions list of a rule\&. " .ti -1c .RI "void * \fBwidget_get_selected_rule_assignments_list_btt\fP ()" .br -.RI "Presents the list of all the elementary actions (assignments) performed when the rule is applied\&. " .ti -1c .RI "void * \fBwidget_get_selected_rule_identity_btt\fP ()" .br -.RI "Hosts a list of character strings that can be combined to provide a 'human readable' rule identifier\&. " .ti -1c .RI "GtkEntry \fBwidget_set_item_text\fP (GtkWidget *list_box, const char *text, bool editable)" .br -.RI "Format an entry (a text item) in a list\&. " .ti -1c .RI "void * \fBwidget_get_selected_rule_camera\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_get_selected_rule_before_after\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_get_results_box_organize\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_get_results_box_display\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_get_results_box_time\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "struct \fBTreeNode_t\fP * \fBwidget_create_user_rules_tree_node\fP (const gchar *text)" .br @@ -324,7 +281,6 @@ include/widget.h \- widgets hierarchy header .ti -1c .RI "void * \fBwidget_get_text_from_address\fP (gchar *text_name)" .br -.RI "getter " .ti -1c .RI "char * \fBwidget_get_address_text_theory\fP ()" .br @@ -337,71 +293,54 @@ include/widget.h \- widgets hierarchy header .ti -1c .RI "void * \fBwidget_get_an_impression_of_what_a_rules_comparator_could_be\fP ()" .br -.RI "phantom documentation " .ti -1c .RI "void \fBwidget_let_us_create_a_complex_useless_and_expensive_tree\fP (struct \fBTreeNode_t\fP *tree_root)" .br -.RI "phantom documentation " .ti -1c .RI "void * \fBwidget_measure_new\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_measure_do_select_rules_first\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_measure_do_depends_on_one_or_two_events\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_measure_do_depends_on_a_single_event\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_measure_do_depends_on_two_events\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_measure_do_select_a_second_rules_set\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_measure_do_choose_an_event_type\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_measure_do_correlate\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_measure_do_insert_in_measurements_list\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_measure_do_end_creation_of_measurement_process\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_measure_event_occurences_nb\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_measure_event_occurences_dates\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_measure_event_occurences_situations\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_measure_time_elapsed_between_two_events\fP ()" .br -.RI "Phantom documentation\&. " .ti -1c .RI "void * \fBwidget_measure_third_event_occurences_in_between\fP ()" .br -.RI "Phantom documentation\&. " .in -1c .SH "Detailed Description" .PP @@ -437,8 +376,6 @@ This file is part of Gem-graph\&. .SS "void widget_design_dialog_window (GtkWindow * main_window, GtkWindow * dialog_window)" -.PP -modal .PP \fBSee also\fP .RS 4 @@ -468,8 +405,6 @@ src/widget/manager/on_windows_activation() .SS "void widget_design_text_window (GtkWindow * main_window, GtkWindow * text_window)" -.PP -modal .PP \fBSee also\fP .RS 4 @@ -513,14 +448,59 @@ src/widget/manager/on_windows_activation() .RE .PP +.SS "void * widget_get_an_impression_of_what_a_rules_comparator_could_be ()" + +.PP +\fBReturns\fP +.RS 4 +comparator +.RE +.PP + +.SS "const char * widget_get_btt_label_data ()" + +.PP +\fBReturns\fP +.RS 4 +'data' +.RE +.PP + +.SS "const char * widget_get_btt_label_rules ()" + +.PP +\fBReturns\fP +.RS 4 +'rules' +.br + +.RE +.PP + +.SS "const char * widget_get_btt_label_state ()" + +.PP +\fBReturns\fP +.RS 4 +'state' +.br + +.RE +.PP + .SS "const char * widget_get_btt_label_synth ()" .PP -! WARNING ! THE LABELS OF THE PREVIOUS FOUR BUTTONS MUST ONLY BE DEFINED ONCE IN THE PROGRAMME (HERE), AND ONLY USING THE FOUR FOLLOWING FUNCTIONS: btt_synth +\fBReturns\fP +.RS 4 +'synth' +.br + +.RE +.PP + .SS "GtkWindow * widget_get_dialog_window ()" -.PP -getter .PP \fBSince\fP .RS 4 @@ -538,10 +518,17 @@ dialog_window .RE .PP -.SS "GtkWindow * widget_get_main_window ()" +.SS "void * widget_get_graph_view_control ()" .PP -getter +\fBReturns\fP +.RS 4 +objects_vs_situations_horizontal_pane +.RE +.PP + +.SS "GtkWindow * widget_get_main_window ()" + .PP \fBSince\fP .RS 4 @@ -559,6 +546,15 @@ main_window .RE .PP +.SS "void * widget_get_non_time_dependent ()" + +.PP +\fBReturns\fP +.RS 4 +results_box +.RE +.PP + .SS "int widget_get_object_transparency (int rank)" .PP @@ -573,10 +569,203 @@ value .RE .PP -.SS "void * widget_get_selected_rule_algebra ()" +.SS "void * widget_get_page_data ()" .PP -Provides the three lists needed to describe a rule algebraically\&. The algebraic definition of a rule comprises three types of character strings organised into three lists: +\fBReturns\fP +.RS 4 +measures_and_results +.RE +.PP + +.SS "void * widget_get_page_measure ()" + +.PP +\fBReturns\fP +.RS 4 +measure_page +.RE +.PP + +.SS "void * widget_get_page_state ()" +L'image de l'état de l'espace (au centre) fait partie d'un panneau 'milieu', qui est encadré par les deux panneaux: 'haut' et 'bas'\&. La partie droite du panneau 'milieu' est elle-même un panneau de commandes\&. +.PP +Si l'on nomme ces panneaux selon leur fonction, on trouvera: +.IP "\(bu" 2 +CONTROL ou EDIT en bas permet de contrôler / choisir un état et / ou de l'éditer\&. ce panneau peut avoir deux apparences (et fonctions) différentes: +.IP " \(bu" 4 +en mode EDIT, seuls les outils d'édition de l'état sont disponibles +.IP " \(bu" 4 +en mode EXEC, seuls les outils de déplacement dans la séquence sont disponibles +.PP + +.IP "\(bu" 2 +CAMERA à droite permet de choisir la position de la caméra +.IP "\(bu" 2 +CONTRAST en haut permet de modifier un à un les contrastes des objets et des situations afin de mieux mettre en évidence l'objet ou le phénomène d'intérêt +.PP +.PP +.PP +.PP +The state page is horizontally divided in three sections +.PP +.IP "\(bu" 2 +top: controls on the colors or transparencies of the model objects +.IP "\(bu" 2 +middle: space view on the left / camera on the right +.IP "\(bu" 2 +bottom: depends on the fsm exec/edit state +.IP "\(bu" 2 +- if fsm in on exec mode, bottom displays sequence control widgets +.IP "\(bu" 2 +- if fsm in on edit mode, bottom displays space edition control widgets +.PP +.PP +.PP +.PP +\fBSee also\fP +.RS 4 +\fBwidget_get_graph_view_control()\fP +.PP +\fBwidget_get_space_view()\fP +.PP +\fBwidget_get_space_edit_control()\fP +.PP +\fBwidget_get_sequence_control()\fP +.PP +\fBfsm_get_exec_edit()\fP +.PP +\fBPARTITION_SPACE_VS_CAMERA_IN_STATE\fP +.PP +\fBPARTITION_SPACE_VS_CONTROLS_1\fP +.PP +\fBPARTITION_SPACE_VS_CONTROLS_2\fP +.PP +\fBon_switch_state_rules_data()\fP +.RE +.PP +\fBReturns\fP +.RS 4 +view_space_vs_controls +.RE +.PP + +.SS "void * widget_get_page_synth ()" + +.PP +\fBReturns\fP +.RS 4 +space_and_analysis_vs_history +.RE +.PP + +.SS "void * widget_get_pane_all_rules_left ()" + +.PP +\fBReturns\fP +.RS 4 +rules_tree_and_pilot_box +.RE +.PP + +.SS "void * widget_get_pane_selected_rule_right ()" + +.PP +\fBReturns\fP +.RS 4 +GTK_WIDGET (rule_itself_vs_explore_edit_pane) +.RE +.PP + +.SS "void * widget_get_results_box_display ()" + +.PP +\fBReturns\fP +.RS 4 +GTK_WIDGET (data_box) +.RE +.PP + +.SS "void * widget_get_results_box_organize ()" + +.PP +\fBReturns\fP +.RS 4 +GTK_WIDGET (all_box) +.RE +.PP + +.SS "void * widget_get_results_box_time ()" + +.PP +\fBReturns\fP +.RS 4 +GTK_WIDGET (time_box) +.RE +.PP + +.SS "void * widget_get_rule_edition_tools ()" + +.PP +\fBReturns\fP +.RS 4 +gtk_label_new ('RULE EDITION') +.RE +.PP + +.SS "void * widget_get_rule_investigation_tools ()" + +.PP +\fBReturns\fP +.RS 4 +gtk_label_new ('RULE INVESTIGATION') +.RE +.PP + +.SS "void * widget_get_rules_pilot_box ()" + +.PP +\fBReturns\fP +.RS 4 +rules_pilot_box +.RE +.PP + +.SS "void * widget_get_rules_tree_tools ()" + +.PP +\fBReturns\fP +.RS 4 +GTK_WIDGET (rules_tree_box) +.RE +.PP + +.SS "void * widget_get_rules_use ()" + +.PP +\fBReturns\fP +.RS 4 +scroll_rules_use +.RE +.PP + +.SS "void * widget_get_selected_rule ()" +start_child in GtkPaned rule_itself_vs_explore_edit_pane +.PP +\fBSee also\fP +.RS 4 +src/widget/main_window/one_rule/algebra/dispatch/widget_get_selected_rule_algebra() +.PP +src/widget/main_window/one_rule/geometry/dispatch/widget_get_selected_rule_geometry() +.PP +src/widget/main_window/one_rule/dispatch/widget_get_pane_selected_rule_right() +.RE +.PP + +.SS "void * widget_get_selected_rule_algebra ()" +Provides the three lists needed to describe a rule algebraically\&. +.PP +The algebraic definition of a rule comprises three types of character strings organised into three lists: .IP "\(bu" 2 conditions .IP "\(bu" 2 @@ -598,14 +787,19 @@ src/widget/one_rule/algebra/assignations() .PP src/widget/one_rule/algebra/identity() .PP -src/widget/one_rule/dispatch() +src/widget/one_rule/dispatch() +.RE +.PP +\fBReturns\fP +.RS 4 +GTK_WIDGET (conditions_actions_names_box) .RE .PP .SS "void * widget_get_selected_rule_assignments_list_btt ()" - +Presents the list of all the elementary actions (assignments) performed when the rule is applied\&. .PP -Presents the list of all the elementary actions (assignments) performed when the rule is applied\&. Today, an arbitrary presentation with no link to the XML model and no verification of compliance with the meta-rules\&. (see below) TODO +Today, an arbitrary presentation with no link to the XML model and no verification of compliance with the meta-rules\&. (see below) TODO .PP |- - - - - - - - - - - - - - meta-rules - - - - - - - - - - - - - - - > .PP @@ -633,10 +827,28 @@ the assignations list .RE .PP -.SS "void * widget_get_selected_rule_conditions_list_btt ()" +.SS "void * widget_get_selected_rule_before_after ()" .PP -Builds and presents the conditions list of a rule\&. This list sets out all the conditions that the rule must meet in order to be applied\&. +\fBReturns\fP +.RS 4 +GTK_WIDGET (before_vs_after) +.RE +.PP + +.SS "void * widget_get_selected_rule_camera ()" + +.PP +\fBReturns\fP +.RS 4 +camera +.RE +.PP + +.SS "void * widget_get_selected_rule_conditions_list_btt ()" +Builds and presents the conditions list of a rule\&. +.PP +This list sets out all the conditions that the rule must meet in order to be applied\&. .PP Today, an arbitrary presentation with no link to the XML model and no verification of compliance with the meta-rules\&. (see below) TODO .PP @@ -668,9 +880,20 @@ the conditions list .RE .PP -.SS "void * widget_get_selected_rule_identity_btt ()" - +.SS "void * widget_get_selected_rule_geometry ()" +split two images versus camera .PP +\fBSee also\fP +.RS 4 +src/widget/main_window/one_rule/dispatch/widget_get_selected_rule() +.PP +\fBwidget_get_selected_rule_before_after()\fP +.PP +\fBwidget_get_selected_rule_camera()\fP +.RE +.PP + +.SS "void * widget_get_selected_rule_identity_btt ()" Hosts a list of character strings that can be combined to provide a 'human readable' rule identifier\&. This list can also contain non-mandatory elements\&. .PP Each rule can have a specific 'human readable' name chosen by its designer\&. This name can be used to identify the rule\&. It is desirable for a unique name to be accepted and shared by as many users as possible\&. @@ -705,6 +928,24 @@ rule identity .RE .PP +.SS "void * widget_get_sequence_control ()" + +.PP +\fBReturns\fP +.RS 4 +GTK_WIDGET (SEQUENCE_CONTROL_box) +.RE +.PP + +.SS "void * widget_get_space_edit_control ()" + +.PP +\fBReturns\fP +.RS 4 +GTK_WIDGET ('SPACE EDIT') +.RE +.PP + .SS "void * widget_get_space_view (int partition_space_vs_camera)" .PP @@ -713,11 +954,23 @@ rule identity \fIpartition_space_vs_camera\fP .RE .PP +\fBReturns\fP +.RS 4 +GTK_WIDGET (view_space_vs_camera) +.RE +.PP + +.SS "void * widget_get_space_vs_non_time_dependent ()" + +.PP +\fBReturns\fP +.RS 4 +space_vs_non_time_dependent_analysis +.RE +.PP .SS "void * widget_get_text_from_address (gchar * text_address)" -.PP -getter .PP \fBSee also\fP .RS 4 @@ -729,11 +982,14 @@ src/widget/modal/widget_design_text_window() \fI*text_address\fP .RE .PP +\fBReturns\fP +.RS 4 +GTK_WIDGET (scrolled_window) +.RE +.PP .SS "GtkWindow * widget_get_text_window ()" -.PP -getter .PP \fBSince\fP .RS 4 @@ -751,6 +1007,15 @@ text_window .RE .PP +.SS "void * widget_get_time_dependent ()" + +.PP +\fBReturns\fP +.RS 4 +time_box +.RE +.PP + .SS "GtkWidget * widget_get_topbar (GtkApplication * app)" .PP @@ -774,10 +1039,147 @@ scrolled_window .RE .PP -.SS "GtkEntry widget_set_item_text (GtkWidget * list_box, const char * text, bool editable)" +.SS "void widget_let_us_create_a_complex_useless_and_expensive_tree (struct \fBTreeNode_t\fP * tree_root)" +phantom documentation in a phantom tree\&.\&.\&. +.SS "void * widget_measure_do_choose_an_event_type ()" .PP -Format an entry (a text item) in a list\&. +\fBReturns\fP +.RS 4 +measure_page +.RE +.PP + +.SS "void * widget_measure_do_correlate ()" + +.PP +\fBReturns\fP +.RS 4 +measure_page +.RE +.PP + +.SS "void * widget_measure_do_depends_on_a_single_event ()" + +.PP +\fBReturns\fP +.RS 4 +measure_page +.RE +.PP + +.SS "void * widget_measure_do_depends_on_one_or_two_events ()" + +.PP +\fBReturns\fP +.RS 4 +measure_page +.RE +.PP + +.SS "void * widget_measure_do_depends_on_two_events ()" + +.PP +\fBReturns\fP +.RS 4 +NULL +.RE +.PP + +.SS "void * widget_measure_do_end_creation_of_measurement_process ()" + +.PP +\fBReturns\fP +.RS 4 +measure_page +.RE +.PP + +.SS "void * widget_measure_do_insert_in_measurements_list ()" + +.PP +\fBReturns\fP +.RS 4 +measure_page +.RE +.PP + +.SS "void * widget_measure_do_select_a_second_rules_set ()" + +.PP +\fBReturns\fP +.RS 4 +measure_page +.RE +.PP + +.SS "void * widget_measure_do_select_rules_first ()" + +.PP +\fBReturns\fP +.RS 4 +measure_page +.RE +.PP + +.SS "void * widget_measure_event_occurences_dates ()" + +.PP +\fBReturns\fP +.RS 4 +measure_page +.RE +.PP + +.SS "void * widget_measure_event_occurences_nb ()" + +.PP +\fBReturns\fP +.RS 4 +measure_page +.RE +.PP + +.SS "void * widget_measure_event_occurences_situations ()" + +.PP +\fBReturns\fP +.RS 4 +measure_page +.RE +.PP + +.SS "void * widget_measure_new ()" + +.PP +\fBReturns\fP +.RS 4 +NULL +.RE +.PP + +.SS "void * widget_measure_third_event_occurences_in_between ()" + +.PP +\fBReturns\fP +.RS 4 +measure_page +.RE +.PP + +.SS "void * widget_measure_time_elapsed_between_two_events ()" + +.PP +\fBReturns\fP +.RS 4 +measure_page +.RE +.PP + +.SS "void widget_reset_XYZ_in_state_pane ()" +phantom documentation +.SS "GtkEntry widget_set_item_text (GtkWidget * list_box, const char * text, bool editable)" +Format an entry (a text item) in a list\&. .PP \fBSince\fP .RS 4 @@ -828,10 +1230,17 @@ src/widget/one_rule/algebra/identity() .RE .PP -.SS "void window_design_topbar_left (GtkWidget * header_bar)" +.SS "void window_design_topbar_center (GtkWidget * topbar)" .PP -The rules page consists of two half-pages in a GtkPaned widget : +\fBParameters\fP +.RS 4 +\fI*topbar\fP +.RE +.PP + +.SS "void window_design_topbar_left (GtkWidget * header_bar)" +The rules page consists of two half-pages in a GtkPaned widget : .IP "\(bu" 2 on the left, widgets for controlling or editing all the rules\&. .IP "\(bu" 2 diff --git a/doc/rtfm/man3/widget_get_selected_rule_assignments_list_btt.3 b/doc/rtfm/man3/widget_get_selected_rule_assignments_list_btt.3 new file mode 100644 index 0000000..f23c759 --- /dev/null +++ b/doc/rtfm/man3/widget_get_selected_rule_assignments_list_btt.3 @@ -0,0 +1 @@ +.so man3/widget.h.3 diff --git a/include/fsm.h b/include/fsm.h index 06fa649..cefcbf3 100644 --- a/include/fsm.h +++ b/include/fsm.h @@ -1,6 +1,6 @@ /** * @file - * fsm (Finite State Machine) header + * FSM (Finite State Machine) header * * This file is part of Gem-graph. * @@ -91,7 +91,7 @@ enum fsm_enum_journal_source { MAIN_WINDOW, DIALOG_WINDOW, MODAL_WINDOW, TEXT_WINDOW, AUTO_NOTIFICATION, TOPBAR, TOPBAR_LEFT, TOPBAR_RIGHT, TOPBAR_CENTER, SYNTH_PAGE, STATE_PAGE, RULES_PAGE, MEASURES_PAGE, RESULTS_PAGE, - SenumYNTH_GLAREA, SYNTH_ALL_RESULTS, + SYNTH_GLAREA, SYNTH_ALL_RESULTS, SYNTH_TIME_DEP_RESULTS, SYNTH_TIME_INDEP_RESULTS, STATE_TOP, STATE_BOTTOM, STATE_GLAREA, STATE_CAMERA, RULE_GEOMETRY, RULE_GLAREA, RULE_CAMERA, @@ -100,7 +100,7 @@ enum fsm_enum_journal_source { MEASURES_TOOLS, MEASURES__ACTIVITY, MEASURES__DISPLAY, RESULTS, TIME_DEP_RESULTS, TIME_INDEP_RESULTS, WIDGET, BUTTON, SCROLL, GLAREA, TEXT, LABEL, TREE, SLIDER, EXPANDER, ENTRY, - SWITCH_STATE_RULES_DATA, + ON_SWITCH_STATE_RULES_DATA, SLIDER_X, SLIDER_Y, SLIDER_Z, SLIDER_A, SLIDER_B, SLIDER_C, }; diff --git a/include/signal.h b/include/signal.h index bae1fa5..1d67c21 100644 --- a/include/signal.h +++ b/include/signal.h @@ -77,6 +77,7 @@ void on_windows_startup (GtkApplication *app); void on_toggle_exec_edit (GtkWidget *btt_XOR_EXEC_EDIT, gpointer user_data); void on_toggle_state_rules_data (GtkWidget *btt_STATE_RULES_DATA, gpointer user_data); // void on_toggle_model_run_stop (GtkWidget *btt_MODEL_RUN_STOP, gpointer data); +void on_switch_state_rules_data(); diff --git a/include/widget.h b/include/widget.h index 304cd99..f7fc7a4 100644 --- a/include/widget.h +++ b/include/widget.h @@ -245,7 +245,7 @@ void *widget_get_results_box_time (); /******************************************************************************/ -/** phantom documentation used to test the functioning of doxygen */ +/** phantom documentation */ struct TreeNode_t { gchar *text; /**< *text phantom documentation */ diff --git a/src/fsm/measures/data_list.c b/src/fsm/measures/data_list.c index d03f4ac..42c6131 100644 --- a/src/fsm/measures/data_list.c +++ b/src/fsm/measures/data_list.c @@ -2,9 +2,14 @@ * @file * a list of available measurements, including those currently in use * - * This file is part of Gem-graph. An editable list of results is defined and - * maintained here. Some operations can be performed on them. - * ex : filter, concat, inverse, scale, correlate, etc. + * This file is part of Gem-graph. The operations that can be performed on the + * measurements include: select, copy, edit, erase, parameter + * (frequency, variable, etc.) + * + * @see http://www.gnuplot.info/ + * @see https://fr.wikipedia.org/wiki/Gnuplot + * @see https://fr.wikibooks.org/wiki/Mathc_gnuplot + * * @see : fsm/measure/manage.c * * @cond LICENSE @@ -59,6 +64,3 @@ int fsm_get_data (fsm_struct_list_data d, int from, int to) {return 0;} */ void fsm_remove_data (fsm_struct_list_data d, int *p_data) {} -// http://www.gnuplot.info/ -// https://fr.wikipedia.org/wiki/Gnuplot -// https://fr.wikibooks.org/wiki/Mathc_gnuplot diff --git a/src/fsm/measures/disp_list.c b/src/fsm/measures/disp_list.c index 9531e98..c6fab0c 100644 --- a/src/fsm/measures/disp_list.c +++ b/src/fsm/measures/disp_list.c @@ -1,11 +1,19 @@ /** * @file - * a list of displayable results, including those currently displayed - * Gem-graph-client list (and current use) + * A list of displayable results (whether currently displayed or not). + * + * This file is part of Gem-graph. The operations that can be performed on the + * results include: select, copy, erase, filter, concat, inverse, scale, + * correlate, etc. + * + * The format of the results must be compatible with the formats recognised by + * the usual presentation software. + * + * "graph", "chart", "plot" and "diagram" are ambiguous terms, used interchangeably. + * + * NB some data may be displayed simultaneously in different pages + * ex : pages 'synth' & 'results' * - * This file is part of Gem-graph. An editable list of results is defined and - * maintained here. Some operations can be performed on them. - * ex : filter, concat, inverse, scale, correlate, etc. * @see : fsm/measure/manage.c * * @cond LICENSE @@ -34,16 +42,6 @@ #include "../../../include/fsm.h" -/******************************************************************************/ -/* An editable list of displayable results is defined and maintained here */ -/* (see : fsm/measure/manage.c) */ -/* - - - */ -/* NB some data may be displayed simultaneously in different pages */ -/* ex : pages SYNTH & RESULTS */ -/******************************************************************************/ - -// "graph", "chart", "plot" and "diagram" are ambiguous terms, used interchangeably. - /** * @param d * @param *p_chart diff --git a/src/signal.c b/src/signal.c index e37ae89..1555cd0 100644 --- a/src/signal.c +++ b/src/signal.c @@ -363,7 +363,8 @@ void on_write_current_model (GtkWidget *btt_write_current_model, /* T O P B A R L E F T W I D G E T S */ /******************************************************************************/ -static void switch_state_rules_data(); +// provisionally non static to be visible from the documentation (2024-10) +// static void on_switch_state_rules_data(); // ----------------------- E X E C / E D I T -------------------------- // @@ -407,7 +408,7 @@ void on_toggle_exec_edit (GtkWidget *toggled_button, gpointer user_data) // TODO set_btt_SYNTH_active (FALSE) } - switch_state_rules_data(); + on_switch_state_rules_data(); } @@ -439,14 +440,42 @@ void on_toggle_state_rules_data (GtkWidget *toggled_button, gpointer widget_all_ if ( ! strcmp (toggled_button_name, widget_get_btt_label_rules())) fsm_set_state_rules_data (RULES); if ( ! strcmp (toggled_button_name, widget_get_btt_label_data())) fsm_set_state_rules_data (DATA); - if (is_active) switch_state_rules_data(); + if (is_active) on_switch_state_rules_data(); } // ----------------------- S T A T I C S W I T C H -------------------- // -/** phantom documentation */ -static void switch_state_rules_data() +/** + * This function could remain static in src/signal. + * It is provisionally non static to be visible from the documentation (2024-10) + * + * @callgraph + * @see fsm_get_state_rules_data() + * @see widget_get_main_window() + * @see widget_get_page_synth() + * @see widget_get_page_state() + * @see widget_get_pane_all_rules_left() + * @see widget_get_pane_selected_rule_right() + * + * ? see src/widget/main_window/measure/widget_get_page_measure() + * + * @see src/widget/main_window/widget_get_page_data() + * + * @callergraph + * @see on_toggle_exec_edit() + * @see on_toggle_state_rules_data() + * + * + * The rules page consists of two half-pages in a GtkPaned widget : + * - on the left, widgets for controlling or editing all the rules. + * - on the right, widgets for controlling or editing the selected rule. + * + * Instead of having a: "widget_get_rules_page()" function, + * this distribution is moved here. (see also widget/topbar/left design) + * window_design_topbar_left() + */ +void on_switch_state_rules_data() { switch (fsm_get_state_rules_data()) { @@ -493,7 +522,7 @@ static void switch_state_rules_data() default : printf("default in signal.on_toggle_state_rule_data()\n"); - fsm_journal_event (INFO, SWITCH_STATE_RULES_DATA, + fsm_journal_event (INFO, ON_SWITCH_STATE_RULES_DATA, "signal", "(switch) default in : switch state rules data()", ""); } } diff --git a/src/widget/dialog.c b/src/widget/dialog.c index c068421..c23c898 100644 --- a/src/widget/dialog.c +++ b/src/widget/dialog.c @@ -36,8 +36,6 @@ /******************************************************************************/ /** - * modal - * * @callgraph * @see src/fsm/dispatch/fsm_journal_event() * diff --git a/src/widget/main_window/all_rules/compare/interest.c b/src/widget/main_window/all_rules/compare/interest.c index 06b3f14..17509cf 100644 --- a/src/widget/main_window/all_rules/compare/interest.c +++ b/src/widget/main_window/all_rules/compare/interest.c @@ -67,7 +67,7 @@ static void free_intlist (struct images_bff *p) // Below is ^c^v from https://www.geeksforgeeks.org/implement-stack-in-c/ -/** phantom documentation*/ +/** @returns popped */ typedef struct { GtkWidget *arr[MAX_SIZE]; /**< *arr[MAX_SIZE] phantom documentation */ int top; /**< top phantom documentation */ @@ -153,7 +153,7 @@ static GtkWidget *peek(Stack *stack) static void *push_images_onto_stack (Stack stack_b); static GtkWidget *do_rtfd (Stack stack_b); -/** phantom documentation */ +/** @returns comparator */ void *widget_get_an_impression_of_what_a_rules_comparator_could_be(){ diff --git a/src/widget/main_window/all_rules/dispatch.c b/src/widget/main_window/all_rules/dispatch.c index c3061a4..c55474d 100644 --- a/src/widget/main_window/all_rules/dispatch.c +++ b/src/widget/main_window/all_rules/dispatch.c @@ -58,7 +58,7 @@ /** - * phantom documentation + * @returns rules_tree_and_pilot_box */ void *widget_get_pane_all_rules_left () { diff --git a/src/widget/main_window/all_rules/tree/freq.c b/src/widget/main_window/all_rules/tree/freq.c index 7c46bc3..28d7c1a 100644 --- a/src/widget/main_window/all_rules/tree/freq.c +++ b/src/widget/main_window/all_rules/tree/freq.c @@ -34,7 +34,7 @@ static GtkScrollbar *rule_bar [n_rules]; static GtkAdjustment *rule_adjust [n_rules]; /** - * phantom documentation + * @returns scroll_rules_use */ void *widget_get_rules_use () { diff --git a/src/widget/main_window/all_rules/tree/labo.c b/src/widget/main_window/all_rules/tree/labo.c index 032f6e8..346efd7 100644 --- a/src/widget/main_window/all_rules/tree/labo.c +++ b/src/widget/main_window/all_rules/tree/labo.c @@ -72,7 +72,7 @@ /** - * phantom documentation + * @details phantom documentation in a phantom tree... */ void widget_let_us_create_a_complex_useless_and_expensive_tree (struct TreeNode_t *tree_root) { struct TreeNode_t *a = widget_create_user_rules_tree_node("aware of"); widget_add_tree_child_node(tree_root, a); diff --git a/src/widget/main_window/all_rules/tree/pilot_box.c b/src/widget/main_window/all_rules/tree/pilot_box.c index de09bd3..b314882 100644 --- a/src/widget/main_window/all_rules/tree/pilot_box.c +++ b/src/widget/main_window/all_rules/tree/pilot_box.c @@ -31,7 +31,7 @@ /** - * phantom documentation + * @returns rules_pilot_box */ void *widget_get_rules_pilot_box () { @@ -48,6 +48,9 @@ void *widget_get_rules_pilot_box () return rules_pilot_box; } +/** + * @returns image_many_bars_vertical_box + */ static void *get_image_many_bars_vertical () { GtkBox *image_many_bars_vertical_box = GTK_BOX (gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0)); @@ -58,7 +61,7 @@ static void *get_image_many_bars_vertical () } /** - * phantom documentation + * @returns GTK_WIDGET (rules_tree_box) */ void *widget_get_rules_tree_tools () { diff --git a/src/widget/main_window/designer.c b/src/widget/main_window/designer.c index 80ea074..bec9052 100644 --- a/src/widget/main_window/designer.c +++ b/src/widget/main_window/designer.c @@ -1,10 +1,8 @@ /** * @file - * builds ans present + * designs and presents * - * This file is part of Gem-graph. - * - * ensure the titlebar and the pages are available and init them + * ensures the titlebar and the pages are available and init them * * triggers assembly of the topbar and the default page * @@ -18,6 +16,7 @@ * * > the "selected rule" page lets you examine and modify one selected rule * + * This file is part of Gem-graph. * * @cond LICENSE * Copyright © 2021 Libre en Communs diff --git a/src/widget/main_window/measure/dispatch.c b/src/widget/main_window/measure/dispatch.c index da1a437..e3753b3 100644 --- a/src/widget/main_window/measure/dispatch.c +++ b/src/widget/main_window/measure/dispatch.c @@ -50,7 +50,7 @@ static GtkBox *measure_page; /** - * Phantom documentation + * @returns measure_page */ void *widget_measure_event_occurences_nb() { @@ -59,7 +59,7 @@ void *widget_measure_event_occurences_nb() } /** - * Phantom documentation + * @returns measure_page */ void *widget_measure_event_occurences_dates() { @@ -68,7 +68,7 @@ void *widget_measure_event_occurences_dates() } /** - * Phantom documentation + * @returns measure_page */ void *widget_measure_event_occurences_situations() { @@ -77,7 +77,7 @@ void *widget_measure_event_occurences_situations() } /** - * Phantom documentation + * @returns measure_page */ void *widget_measure_time_elapsed_between_two_events() { @@ -86,7 +86,7 @@ void *widget_measure_time_elapsed_between_two_events() } /** - * Phantom documentation + * @returns measure_page */ void *widget_measure_third_event_occurences_in_between() { @@ -136,7 +136,7 @@ static GtkWidget *clean; static GtkWidget *btt_end; /** - * Phantom documentation + * @returns measure_page */ void *widget_measure_do_end_creation_of_measurement_process() { @@ -157,7 +157,7 @@ void *widget_measure_do_end_creation_of_measurement_process() } /** - * Phantom documentation + * @returns measure_page */ void *widget_measure_do_insert_in_measurements_list() { @@ -179,7 +179,7 @@ void *widget_measure_do_insert_in_measurements_list() } /** - * Phantom documentation + * @returns measure_page */ void *widget_measure_do_correlate() { @@ -201,7 +201,7 @@ Two measurements or more can be selected there to study potential correlations." } /** - * Phantom documentation + * @returns measure_page */ void *widget_measure_do_depends_on_a_single_event() { @@ -237,7 +237,7 @@ void *widget_measure_do_depends_on_a_single_event() } /** - * Phantom documentation + * @returns measure_page */ void *widget_measure_do_select_a_second_rules_set() { @@ -256,7 +256,7 @@ void *widget_measure_do_select_a_second_rules_set() } /** - * Phantom documentation + * @returns measure_page */ void *widget_measure_do_choose_an_event_type() { @@ -288,17 +288,17 @@ void *widget_measure_do_choose_an_event_type() } /** - * Phantom documentation + * @returns NULL */ void *widget_measure_new() {return NULL;} /** - * Phantom documentation + * @returns NULL */ void *widget_measure_do_depends_on_two_events() {return NULL;} /** - * Phantom documentation + * @returns measure_page */ void *widget_measure_do_depends_on_one_or_two_events() { @@ -324,7 +324,7 @@ void *widget_measure_do_depends_on_one_or_two_events() } /** - * Phantom documentation + * @returns measure_page */ void *widget_measure_do_select_rules_first () { @@ -343,7 +343,7 @@ void *widget_measure_do_select_rules_first () } /** - * Phantom documentation + * @returns measure_page */ void *widget_get_page_measure() { diff --git a/src/widget/main_window/one_rule/algebra/assign.c b/src/widget/main_window/one_rule/algebra/assign.c index 412f515..273a952 100644 --- a/src/widget/main_window/one_rule/algebra/assign.c +++ b/src/widget/main_window/one_rule/algebra/assign.c @@ -33,10 +33,10 @@ /** - * @brief Presents the list of all the elementary actions (assignments) performed + * @details Presents the list of all the elementary actions (assignments) performed * when the rule is applied. * - * @details Today, an arbitrary presentation with no link to the XML model and + * Today, an arbitrary presentation with no link to the XML model and * no verification of compliance with the meta-rules. (see below) TODO * * |- - - - - - - - - - - - - - meta-rules - - - - - - - - - - - - - - - > diff --git a/src/widget/main_window/one_rule/algebra/conditions.c b/src/widget/main_window/one_rule/algebra/conditions.c index 655e6d0..b7c877f 100644 --- a/src/widget/main_window/one_rule/algebra/conditions.c +++ b/src/widget/main_window/one_rule/algebra/conditions.c @@ -35,9 +35,9 @@ /** - * @brief Builds and presents the conditions list of a rule. + * @details Builds and presents the conditions list of a rule. * - * @details This list sets out all the conditions that the rule must meet + * This list sets out all the conditions that the rule must meet * in order to be applied. * * @details Today, an arbitrary presentation with no link to the XML model and diff --git a/src/widget/main_window/one_rule/algebra/dispatch.c b/src/widget/main_window/one_rule/algebra/dispatch.c index c98ba07..ebb0749 100644 --- a/src/widget/main_window/one_rule/algebra/dispatch.c +++ b/src/widget/main_window/one_rule/algebra/dispatch.c @@ -31,9 +31,9 @@ #include "../../../../../include/signal.h" /** - * @brief Provides the three lists needed to describe a rule algebraically. + * @details Provides the three lists needed to describe a rule algebraically. * - * @details The algebraic definition of a rule comprises three types of character + * The algebraic definition of a rule comprises three types of character * strings organised into three lists: * - conditions * - assignations @@ -48,6 +48,8 @@ * * @callergraph * @see src/widget/one_rule/dispatch() + * + * @returns GTK_WIDGET (conditions_actions_names_box) */ void *widget_get_selected_rule_algebra() { diff --git a/src/widget/main_window/one_rule/algebra/identity.c b/src/widget/main_window/one_rule/algebra/identity.c index 361604c..ca4bf48 100644 --- a/src/widget/main_window/one_rule/algebra/identity.c +++ b/src/widget/main_window/one_rule/algebra/identity.c @@ -32,11 +32,10 @@ #include /** - * @brief Hosts a list of character strings that can be combined to provide + * @details Hosts a list of character strings that can be combined to provide * a "human readable" rule identifier. * This list can also contain non-mandatory elements. * - * @details * Each rule can have a specific "human readable" name chosen by its designer. * This name can be used to identify the rule. It is desirable for a unique name * to be accepted and shared by as many users as possible. diff --git a/src/widget/main_window/one_rule/algebra/utilities.c b/src/widget/main_window/one_rule/algebra/utilities.c index 262e138..e31edcc 100644 --- a/src/widget/main_window/one_rule/algebra/utilities.c +++ b/src/widget/main_window/one_rule/algebra/utilities.c @@ -38,7 +38,7 @@ #define LIST_H 114 /**< arbitrary height (same) TODO */ /** - * @brief Format an entry (a text item) in a list. + * @details Format an entry (a text item) in a list. * * @since 2024-08 * diff --git a/src/widget/main_window/one_rule/dispatch.c b/src/widget/main_window/one_rule/dispatch.c index 9f20518..4b1d85a 100644 --- a/src/widget/main_window/one_rule/dispatch.c +++ b/src/widget/main_window/one_rule/dispatch.c @@ -30,7 +30,13 @@ #include "../../../../include/signal.h" /** - * Phantom documentation + * @details start_child in GtkPaned rule_itself_vs_explore_edit_pane + * + * @callgraph + * @see src/widget/main_window/one_rule/algebra/dispatch/widget_get_selected_rule_algebra() + * @see src/widget/main_window/one_rule/geometry/dispatch/widget_get_selected_rule_geometry() + * @callergraph + * @see src/widget/main_window/one_rule/dispatch/widget_get_pane_selected_rule_right() */ void *widget_get_selected_rule() { @@ -45,7 +51,7 @@ void *widget_get_selected_rule() } /** - * Phantom documentation + * @returns GTK_WIDGET (rule_itself_vs_explore_edit_pane) */ void *widget_get_pane_selected_rule_right() // < called in signal switch_state_rules_data() // + on_toggle_state_rules_data() diff --git a/src/widget/main_window/one_rule/geometry/camera.c b/src/widget/main_window/one_rule/geometry/camera.c index bde378b..d583aa2 100644 --- a/src/widget/main_window/one_rule/geometry/camera.c +++ b/src/widget/main_window/one_rule/geometry/camera.c @@ -70,7 +70,7 @@ static GtkBox *rec_ZOOM_box() } /** - * Phantom documentation + * @returns camera */ void *widget_get_selected_rule_camera() { diff --git a/src/widget/main_window/one_rule/geometry/dispatch.c b/src/widget/main_window/one_rule/geometry/dispatch.c index 1094c11..de02592 100644 --- a/src/widget/main_window/one_rule/geometry/dispatch.c +++ b/src/widget/main_window/one_rule/geometry/dispatch.c @@ -30,7 +30,14 @@ #include "../../../../../include/signal.h" /** - * Phantom documentation + * @details split two images versus camera + * + * @callgraph + * @see src/widget/main_window/one_rule/dispatch/widget_get_selected_rule() + * + * @callergraph + * @see widget_get_selected_rule_before_after() + * @see widget_get_selected_rule_camera() */ void *widget_get_selected_rule_geometry() { diff --git a/src/widget/main_window/one_rule/geometry/edit.c b/src/widget/main_window/one_rule/geometry/edit.c index c95d9b2..8ee0b83 100644 --- a/src/widget/main_window/one_rule/geometry/edit.c +++ b/src/widget/main_window/one_rule/geometry/edit.c @@ -31,7 +31,7 @@ /** - * Phantom documentation + * @returns gtk_label_new ("RULE EDITION") */ void *widget_get_rule_edition_tools() { diff --git a/src/widget/main_window/one_rule/geometry/geometry.c b/src/widget/main_window/one_rule/geometry/geometry.c index 4f13941..ee18f99 100644 --- a/src/widget/main_window/one_rule/geometry/geometry.c +++ b/src/widget/main_window/one_rule/geometry/geometry.c @@ -47,7 +47,7 @@ static void *widget_get_selected_rule_geometry_after() } /** - * Phantom documentation + * @returns GTK_WIDGET (before_vs_after) */ void *widget_get_selected_rule_before_after() { diff --git a/src/widget/main_window/one_rule/geometry/investigate.c b/src/widget/main_window/one_rule/geometry/investigate.c index 0e26648..5602101 100644 --- a/src/widget/main_window/one_rule/geometry/investigate.c +++ b/src/widget/main_window/one_rule/geometry/investigate.c @@ -31,7 +31,7 @@ /** - * Phantom documentation + * @returns gtk_label_new ("RULE INVESTIGATION") */ void *widget_get_rule_investigation_tools() { diff --git a/src/widget/main_window/results/dispatch.c b/src/widget/main_window/results/dispatch.c index 79232ec..7ea7309 100644 --- a/src/widget/main_window/results/dispatch.c +++ b/src/widget/main_window/results/dispatch.c @@ -34,7 +34,7 @@ /** - * Phantom documentation + * @returns measures_and_results */ void *widget_get_page_data() { diff --git a/src/widget/main_window/results/display.c b/src/widget/main_window/results/display.c index 5ee1903..35d35e0 100644 --- a/src/widget/main_window/results/display.c +++ b/src/widget/main_window/results/display.c @@ -30,7 +30,7 @@ #include "../../../../include/widget.h" /** - * Phantom documentation + * @returns GTK_WIDGET (time_box) */ void *widget_get_results_box_time () { GtkBox *time_box = GTK_BOX (gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 2)); @@ -47,7 +47,7 @@ void *widget_get_results_box_time () { } /** - * Phantom documentation + * @returns GTK_WIDGET (data_box) */ void *widget_get_results_box_display () { GtkBox *data_box = GTK_BOX (gtk_box_new (GTK_ORIENTATION_VERTICAL, 2)); diff --git a/src/widget/main_window/results/organize.c b/src/widget/main_window/results/organize.c index 811e6cf..d301c04 100644 --- a/src/widget/main_window/results/organize.c +++ b/src/widget/main_window/results/organize.c @@ -31,7 +31,7 @@ #include "../../../../include/widget.h" /** - * Phantom documentation + * @returns GTK_WIDGET (all_box) */ void *widget_get_results_box_organize () { diff --git a/src/widget/main_window/state/bottom.c b/src/widget/main_window/state/bottom.c index ace0753..1329ef5 100644 --- a/src/widget/main_window/state/bottom.c +++ b/src/widget/main_window/state/bottom.c @@ -43,7 +43,7 @@ * afin de mieux mettre en évidence l'objet ou le phénomène d'intérêt */ /** - * Phantom documentation + * @returns GTK_WIDGET ("SPACE EDIT") */ void *widget_get_space_edit_control() { @@ -52,7 +52,7 @@ void *widget_get_space_edit_control() } /** - * Phantom documentation + * @returns GTK_WIDGET (SEQUENCE_CONTROL_box) */ void *widget_get_sequence_control() { diff --git a/src/widget/main_window/state/dispatch.c b/src/widget/main_window/state/dispatch.c index 3ff03f6..c894313 100644 --- a/src/widget/main_window/state/dispatch.c +++ b/src/widget/main_window/state/dispatch.c @@ -2,6 +2,9 @@ * @file * main_window state view dispatcher * + * The only function here is widget_get_page_state() which defines the structure + * of the state page. + * * @cond LICENSE * Copyright © 2021 Libre en Communs * Copyright © 2021-2024 Adrien Bourmault @@ -29,7 +32,8 @@ #include "../../../../include/signal.h" -/* L'image de l'état de l'espace (au centre) fait partie d'un panneau "milieu", +/** + * @details L'image de l'état de l'espace (au centre) fait partie d'un panneau "milieu", * qui est encadré par les deux panneaux: "haut" et "bas". * La partie droite du panneau "milieu" est elle-même un panneau de commandes. * @@ -40,16 +44,37 @@ * - en mode EXEC, seuls les outils de déplacement dans la séquence sont disponibles * - CAMERA à droite permet de choisir la position de la caméra * - CONTRAST en haut permet de modifier un à un les contrastes des objets et des situations - * afin de mieux mettre en évidence l'objet ou le phénomène d'intérêt */ - - - -/******************************************************************************/ -/* g e t S T A T E p a g e */ -/******************************************************************************/ - -/** - * Phantom documentation + * afin de mieux mettre en évidence l'objet ou le phénomène d'intérêt + * + * --- + * + * The state page is horizontally divided in three sections + * + * - top: controls on the colors or transparencies of the model objects + * + * - middle: space view on the left / camera on the right + * + * - bottom: depends on the fsm exec/edit state + * + * - - if fsm in on exec mode, bottom displays sequence control widgets + * + * - - if fsm in on edit mode, bottom displays space edition control widgets + * + * --- + * + * @callgraph + * @see widget_get_graph_view_control() + * @see widget_get_space_view() + * @see widget_get_space_edit_control() + * @see widget_get_sequence_control() + * @see fsm_get_exec_edit() + * @see PARTITION_SPACE_VS_CAMERA_IN_STATE + * @see PARTITION_SPACE_VS_CONTROLS_1 + * @see PARTITION_SPACE_VS_CONTROLS_2 + * @callergraph + * @see on_switch_state_rules_data() + * + * @returns view_space_vs_controls */ void *widget_get_page_state() { diff --git a/src/widget/main_window/state/middle.c b/src/widget/main_window/state/middle.c index cea0169..5d607b6 100644 --- a/src/widget/main_window/state/middle.c +++ b/src/widget/main_window/state/middle.c @@ -33,7 +33,7 @@ static GtkAdjustment *Y_adjust; static GtkAdjustment *Z_adjust; /** - * Phantom documentation + * @details phantom documentation */ void widget_reset_XYZ_in_state_pane() { @@ -46,7 +46,7 @@ void widget_reset_XYZ_in_state_pane() } /** - * Phantom documentation + * @returns XYZ_labels_box */ static void *get_XYZ_box() { @@ -79,6 +79,9 @@ static void *get_XYZ_box() return XYZ_labels_box; } +/** + * @returns ZOOM_box + */ static void *get_ZOOM_box() { GtkBox *ZOOM_box = GTK_BOX (gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0)); @@ -93,8 +96,9 @@ static void *get_ZOOM_box() } /** - * * @param partition_space_vs_camera + * + * @returns GTK_WIDGET (view_space_vs_camera) */ void *widget_get_space_view(int partition_space_vs_camera) { diff --git a/src/widget/main_window/state/top.c b/src/widget/main_window/state/top.c index 500c212..a192b59 100644 --- a/src/widget/main_window/state/top.c +++ b/src/widget/main_window/state/top.c @@ -194,7 +194,7 @@ static void *get_situations_box() /******************************************************************************/ /** - * Phantom documentation + * @returns objects_vs_situations_horizontal_pane */ void *widget_get_graph_view_control() { diff --git a/src/widget/main_window/synth/dispatch.c b/src/widget/main_window/synth/dispatch.c index e53d86f..aff5cce 100644 --- a/src/widget/main_window/synth/dispatch.c +++ b/src/widget/main_window/synth/dispatch.c @@ -28,7 +28,7 @@ #include "../../../../include/widget.h" /** - * Phantom documentation + * @returns results_box */ void *widget_get_non_time_dependent() // for fun ! { @@ -46,7 +46,7 @@ void *widget_get_non_time_dependent() // for fun ! /** - * Phantom documentation + * @returns space_vs_non_time_dependent_analysis */ void *widget_get_space_vs_non_time_dependent() { @@ -63,7 +63,7 @@ void *widget_get_space_vs_non_time_dependent() } /** - * Phantom documentation + * @returns space_and_analysis_vs_history */ void *widget_get_page_synth() { diff --git a/src/widget/main_window/synth/time.c b/src/widget/main_window/synth/time.c index 4e2865d..12f26c0 100644 --- a/src/widget/main_window/synth/time.c +++ b/src/widget/main_window/synth/time.c @@ -28,7 +28,7 @@ #include "../../../../include/widget.h" /** - * Phantom documentation + * @returns time_box */ void *widget_get_time_dependent() { diff --git a/src/widget/main_window/topbar/center.c b/src/widget/main_window/topbar/center.c index 6736811..29a0021 100644 --- a/src/widget/main_window/topbar/center.c +++ b/src/widget/main_window/topbar/center.c @@ -1,6 +1,6 @@ /** * @file - * Topbar center + * Topbar center design * * * @cond LICENSE @@ -31,7 +31,7 @@ /** - * title + * @param *topbar */ void window_design_topbar_center (GtkWidget *topbar) { diff --git a/src/widget/main_window/topbar/left.c b/src/widget/main_window/topbar/left.c index 12d9d6c..b43efe3 100644 --- a/src/widget/main_window/topbar/left.c +++ b/src/widget/main_window/topbar/left.c @@ -1,7 +1,10 @@ /** * @file - * Topbar left + * Topbar left design * + * @warning THE LABELS OF THE FOUR BUTTONS USED TO SELECT A PAGE IN THE MAIN WINDOW + * MUST ONLY BE DEFINED ONCE IN THE PROGRAM (in src/main_window/topbar/left/) + * AND ONLY USING ONE OF THE FOUR 'get_btt_label_' FUNCTIONS DEFINED IN THIS FILE * * @cond LICENSE * Copyright © 2021 Libre en Communs @@ -37,16 +40,18 @@ static GtkButton *btt_SYNTH, *btt_STATE, *btt_RULES, *btt_DATA; -/** ! WARNING ! THE LABELS OF THE PREVIOUS FOUR BUTTONS MUST ONLY BE DEFINED - * ONCE IN THE PROGRAMME (HERE), AND ONLY USING THE FOUR FOLLOWING FUNCTIONS: */ - -/** btt_synth */ const char *widget_get_btt_label_synth () {return "synth";} -/** btt_state */ const char *widget_get_btt_label_state () {return "state";} -/** btt_rules */ const char *widget_get_btt_label_rules () {return "rules";} -/** btt_data */ const char *widget_get_btt_label_data () {return "results";} +/** @returns "synth" */ +const char *widget_get_btt_label_synth() {return "synth";} +/** @returns "state" */ +const char *widget_get_btt_label_state() {return "state";} +/** @returns "rules" */ +const char *widget_get_btt_label_rules() {return "rules";} +/** @returns "data" */ +const char *widget_get_btt_label_data() {return "results";} -/** The rules page consists of two half-pages in a GtkPaned widget : +/** + * @details The rules page consists of two half-pages in a GtkPaned widget : * - on the left, widgets for controlling or editing all the rules. * - on the right, widgets for controlling or editing the selected rule. * diff --git a/src/widget/manager.c b/src/widget/manager.c index 2fd252f..c2897b6 100644 --- a/src/widget/manager.c +++ b/src/widget/manager.c @@ -71,7 +71,6 @@ static GtkWindow *main_window, /** - * @brief getter * @since 2024-07 * @callergraph * @see src/signal @@ -81,7 +80,6 @@ GtkWindow *widget_get_main_window() { return main_window; } /** - * @brief getter * @since 2024-07 * @callergraph * @see src/signal @@ -91,7 +89,6 @@ GtkWindow *widget_get_dialog_window() { return dialog_window; } /** - * @brief getter * @since 2024-07 * @callergraph * @see src/signal diff --git a/src/widget/modal.c b/src/widget/modal.c index 46083ff..0894ac3 100644 --- a/src/widget/modal.c +++ b/src/widget/modal.c @@ -35,8 +35,6 @@ /******************************************************************************/ /** - * modal - * * @callgraph * @see src/widget/modal/widget_get_text_from_address() * @@ -69,12 +67,12 @@ void widget_design_text_window (GtkWindow *main_window, GtkWindow *text_window) /** - * getter - * * @callergraph * @see src/widget/modal/widget_design_text_window() * * @param *text_address + * + * @returns GTK_WIDGET (scrolled_window) */ void *widget_get_text_from_address (gchar *text_address) { GtkWidget *view = gtk_text_view_new ();